CRM/Financial/Page/BatchTransaction.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34
  35 /**
  36  * Page for displaying list of financial batches
  37  */
  38 class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic {
  39   /**
  40    * The action links that we need to display for the browse screen.
  41    *
  42    * @var array
  43    */
  44   public static $_links = NULL;
  45   public static $_entityID;
  46
  47   public static $_columnHeader = NULL;
  48   public static $_returnvalues = NULL;
  49
  50   /**
  51    * Get BAO Name.
  52    *
  53    * @return string
  54    *   Classname of BAO.
  55    */
  56   public function getBAOName() {
  57     return 'CRM_Batch_BAO_Batch';
  58   }
  59
  60   /**
  61    * Get action Links.
  62    *
  63    * @return array
  64    *   (reference) of action links
  65    */
  66   public function &links() {
  67     if (!(self::$_links)) {
  68       self::$_links = [
  69         'view' => [
  70           'name' => ts('View'),
  71           'url' => 'civicrm/contact/view/contribution',
  72           'qs' => 'reset=1&id=%%contid%%&cid=%%cid%%&action=view&context=contribution&selectedChild=contribute',
  73           'title' => ts('View Contribution'),
  74         ],
  75         'remove' => [
  76           'name' => ts('Remove'),
  77           'title' => ts('Remove Transaction'),
  78           'extra' => 'onclick = "assignRemove( %%id%%,\'' . 'remove' . '\' );"',
  79         ],
  80       ];
  81     }
  82     return self::$_links;
  83   }
  84
  85   /**
  86    * Run the page.
  87    *
  88    * This method is called after the page is created. It checks for the
  89    * type of action and executes that action.
  90    * Finally it calls the parent's run method.
  91    */
  92   public function run() {
  93     // get the requested action
  94     // default to 'browse'
  95     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
  96
  97     // assign vars to templates
  98     $this->assign('action', $action);
  99
 100     self::$_entityID = CRM_Utils_Request::retrieve('bid', 'Positive');
 101     $statusID = NULL;
 102     if (isset(self::$_entityID)) {
 103       $statusID = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', self::$_entityID, 'status_id');
 104     }
 105     $breadCrumb
 106       = [
 107         [
 108           'title' => ts('Accounting Batches'),
 109           'url' => CRM_Utils_System::url('civicrm/financial/financialbatches',
 110             "reset=1&batchStatus=$statusID"),
 111         ],
 112       ];
 113
 114     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 115     $this->edit($action, self::$_entityID);
 116     return parent::run();
 117   }
 118
 119   /**
 120    * Get name of edit form.
 121    *
 122    * @return string
 123    *   Classname of edit form.
 124    */
 125   public function editForm() {
 126     return 'CRM_Financial_Form_BatchTransaction';
 127   }
 128
 129   /**
 130    * Get edit form name.
 131    *
 132    * @return string
 133    *   name of this page.
 134    */
 135   public function editName() {
 136     return 'Batch';
 137   }
 138
 139   /**
 140    * Get user context.
 141    *
 142    * @param null $mode
 143    *
 144    * @return string
 145    *   user context.
 146    */
 147   public function userContext($mode = NULL) {
 148     return 'civicrm/batchtransaction';
 149   }
 150
 151 }