CRM/Financial/Page/FinancialBatch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2017
  32  */
  33
  34 /**
  35  * Page for displaying list of financial types
  36  */
  37 class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic {
  38
  39   /**
  40    * The action links that we need to display for the browse screen.
  41    *
  42    * @var array
  43    */
  44   static $_links = NULL;
  45
  46   /**
  47    * Get BAO Name.
  48    *
  49    * @return string
  50    *   classname of BAO.
  51    */
  52   public function getBAOName() {
  53     return 'CRM_Batch_BAO_Batch';
  54   }
  55
  56   /**
  57    * Get action Links.
  58    *
  59    * @return array
  60    *   (reference) of action links
  61    */
  62   public function &links() {
  63     if (!(self::$_links)) {
  64       self::$_links = array();
  65     }
  66     return self::$_links;
  67   }
  68
  69   /**
  70    * Run the page.
  71    *
  72    * This method is called after the page is created. It checks for the
  73    * type of action and executes that action.
  74    * Finally it calls the parent's run method.
  75    */
  76   public function run() {
  77     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  78     $this->set("context", $context);
  79     // assign vars to templates
  80     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
  81     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); // default to 'browse'
  82
  83     // what action to take ?
  84     if ($action & (CRM_Core_Action::UPDATE |
  85         CRM_Core_Action::ADD |
  86         CRM_Core_Action::CLOSE |
  87         CRM_Core_Action::REOPEN |
  88         CRM_Core_Action::EXPORT)
  89     ) {
  90       $this->edit($action, $id);
  91     }
  92     // parent run
  93     return parent::run();
  94   }
  95
  96
  97   /**
  98    * Get name of edit form.
  99    *
 100    * @return string
 101    *   classname of edit form.
 102    */
 103   public function editForm() {
 104     return 'CRM_Financial_Form_FinancialBatch';
 105   }
 106
 107   /**
 108    * Get edit form name.
 109    *
 110    * @return string
 111    *   name of this page.
 112    */
 113   public function editName() {
 114     return 'Accounting Batch';
 115   }
 116
 117   /**
 118    * Get user context.
 119    *
 120    * Redirect to civicrm home page when clicked on cancel button
 121    *
 122    * @param null $mode
 123    *
 124    * @return string
 125    *   user context.
 126    */
 127   public function userContext($mode = NULL) {
 128     $context = $this->get("context");
 129     if ($mode == CRM_Core_Action::UPDATE || ($mode = CRM_Core_Action::ADD & isset($context))) {
 130       return "civicrm/financial/financialbatches";
 131     }
 132     return 'civicrm';
 133   }
 134
 135   /**
 136    * @param null $mode
 137    *
 138    * @return string
 139    */
 140   public function userContextParams($mode = NULL) {
 141     $context = $this->get("context");
 142     if ($mode == CRM_Core_Action::UPDATE || ($mode = CRM_Core_Action::ADD & isset($context))) {
 143       return "reset=1&batchStatus={$context}";
 144     }
 145   }
 146
 147 }