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
  53    *   classname of BAO.
  54    */
  55   public function getBAOName() {
  56     return 'CRM_Batch_BAO_Batch';
  57   }
  58
  59   /**
  60    * Get action Links
  61    *
  62    * @return array
  63    *   (reference) of action links
  64    */
  65   public function &links() {
  66     if (!(self::$_links)) {
  67       self::$_links = array();
  68     }
  69     return self::$_links;
  70   }
  71
  72   /**
  73    * Run the page.
  74    *
  75    * This method is called after the page is created. It checks for the
  76    * type of action and executes that action.
  77    * Finally it calls the parent's run method.
  78    *
  79    * @return void
  80    */
  81   public function run() {
  82     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  83     $this->set("context", $context);
  84     // assign vars to templates
  85     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
  86     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); // default to 'browse'
  87
  88     // what action to take ?
  89     if ($action & (CRM_Core_Action::UPDATE |
  90         CRM_Core_Action::ADD |
  91         CRM_Core_Action::CLOSE |
  92         CRM_Core_Action::REOPEN |
  93         CRM_Core_Action::EXPORT)
  94     ) {
  95       $this->edit($action, $id);
  96     }
  97     // parent run
  98     return parent::run();
  99   }
 100
 101
 102   /**
 103    * Get name of edit form
 104    *
 105    * @return string
 106    *   classname of edit form.
 107    */
 108   public function editForm() {
 109     return 'CRM_Financial_Form_FinancialBatch';
 110   }
 111
 112   /**
 113    * Get edit form name
 114    *
 115    * @return string
 116    *   name of this page.
 117    */
 118   public function editName() {
 119     return 'Accounting Batch';
 120   }
 121
 122   /**
 123    * Get user context.
 124    *
 125    * Redirect to civicrm home page when clicked on cancel button
 126    *
 127    * @param null $mode
 128    *
 129    * @return string
 130    *   user context.
 131    */
 132   public function userContext($mode = NULL) {
 133     $context = $this->get("context");
 134     if ($mode == CRM_Core_Action::UPDATE || ($mode = CRM_Core_Action::ADD & isset($context))) {
 135       return "civicrm/financial/financialbatches";
 136     }
 137     return 'civicrm';
 138   }
 139
 140   /**
 141    * @param null $mode
 142    *
 143    * @return string
 144    */
 145   public function userContextParams($mode = NULL) {
 146     $context = $this->get("context");
 147     if ($mode == CRM_Core_Action::UPDATE || ($mode = CRM_Core_Action::ADD & isset($context))) {
 148       return "reset=1&batchStatus={$context}";
 149     }
 150   }
 151
 152 }