CRM/Financial/Page/FinancialBatch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Page for displaying list of financial types
  38  */
  39 class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic {
  40
  41   /**
  42    * The action links that we need to display for the browse screen
  43    *
  44    * @var array
  45    * @static
  46    */
  47   static $_links = NULL;
  48
  49   /**
  50    * Get BAO Name
  51    *
  52    * @return string classname of BAO.
  53    */
  54   public function getBAOName() {
  55     return 'CRM_Batch_BAO_Batch';
  56   }
  57
  58   /**
  59    * Get action Links
  60    *
  61    * @return array (reference) of action links
  62    */
  63   public function &links() {
  64     if (!(self::$_links)) {
  65       self::$_links = array();
  66     }
  67     return self::$_links;
  68   }
  69
  70   /**
  71    * Run the page.
  72    *
  73    * This method is called after the page is created. It checks for the
  74    * type of action and executes that action.
  75    * Finally it calls the parent's run method.
  76    *
  77    * @return void
  78    *
  79    */
  80   public function run() {
  81     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  82     $this->set("context", $context);
  83     // assign vars to templates
  84     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
  85     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); // default to 'browse'
  86
  87     // what action to take ?
  88     if ($action & (CRM_Core_Action::UPDATE |
  89         CRM_Core_Action::ADD |
  90         CRM_Core_Action::CLOSE |
  91         CRM_Core_Action::REOPEN |
  92         CRM_Core_Action::EXPORT)) {
  93       $this->edit($action, $id);
  94     }
  95     // parent run
  96     return parent::run();
  97   }
  98
  99
 100   /**
 101    * Get name of edit form
 102    *
 103    * @return string classname of edit form.
 104    */
 105   public function editForm() {
 106     return 'CRM_Financial_Form_FinancialBatch';
 107   }
 108
 109   /**
 110    * Get edit form name
 111    *
 112    * @return string name of this page.
 113    */
 114   public function editName() {
 115     return 'Accounting Batch';
 116   }
 117
 118   /**
 119    * Get user context.
 120    *
 121    * Redirect to civicrm home page when clicked on cancel button
 122    *
 123    * @param null $mode
 124    *
 125    * @return string 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 }