CRM/Financial/Page/BatchTransaction.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 /**
  38  * Page for displaying list of financial batches
  39  */
  40 class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic {
  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   static $_entityID;
  49
  50   static $_columnHeader = NULL;
  51   static $_returnvalues = NULL;
  52   /**
  53    * Get BAO Name
  54    *
  55    * @return string Classname of BAO.
  56    */
  57   public function getBAOName() {
  58     return 'CRM_Batch_BAO_Batch';
  59   }
  60
  61   /**
  62    * Get action Links
  63    *
  64    * @return array (reference) of action links
  65    */
  66   public function &links() {
  67     if (!(self::$_links)) {
  68       self::$_links = array(
  69         'view'  => array(
  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'  => array(
  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    * @return void
  93    *
  94    */
  95   public function run() {
  96     // get the requested action
  97     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); // default to 'browse'
  98
  99     // assign vars to templates
 100     $this->assign('action', $action);
 101
 102     self::$_entityID = CRM_Utils_Request::retrieve('bid', 'Positive');
 103     if (isset(self::$_entityID)) {
 104       $statusID = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', self::$_entityID, 'status_id');
 105     }
 106     $breadCrumb =
 107       array(
 108         array(
 109           'title' => ts('Accounting Batches'),
 110           'url' => CRM_Utils_System::url('civicrm/financial/financialbatches',
 111             "reset=1&batchStatus=$statusID"),
 112         )
 113       );
 114
 115     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 116     $this->edit($action, self::$_entityID);
 117     return parent::run();
 118   }
 119
 120   /**
 121    * Browse all financial batch transactions
 122    *
 123    *
 124    * @return void
 125    * @static
 126    */
 127   public function browse() {
 128   }
 129
 130   /**
 131    * Get name of edit form
 132    *
 133    * @return string Classname of edit form.
 134    */
 135   public function editForm() {
 136     return 'CRM_Financial_Form_BatchTransaction';
 137   }
 138
 139   /**
 140    * Get edit form name
 141    *
 142    * @return string name of this page.
 143    */
 144   public function editName() {
 145     return 'Batch';
 146   }
 147
 148   /**
 149    * Get user context.
 150    *
 151    * @param null $mode
 152    *
 153    * @return string user context.
 154    */
 155   public function userContext($mode = NULL) {
 156     return 'civicrm/batchtransaction';
 157   }
 158 }