CRM/Financial/Form/BatchTransaction.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.6                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Financial Type
  38  *
  39  */
  40 class CRM_Financial_Form_BatchTransaction extends CRM_Contribute_Form {
  41   static $_links = NULL;
  42   static $_entityID;
  43
  44   /**
  45    * Batch status.
  46    * @var
  47    */
  48   protected $_batchStatusId;
  49
  50   public function preProcess() {
  51     // This reuses some styles from search forms
  52     CRM_Core_Resources::singleton()->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
  53
  54     self::$_entityID = CRM_Utils_Request::retrieve('bid', 'Positive') ? CRM_Utils_Request::retrieve('bid', 'Positive') : $_POST['batch_id'];
  55     $this->assign('entityID', self::$_entityID);
  56     if (isset(self::$_entityID)) {
  57       $this->_batchStatusId = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', self::$_entityID, 'status_id');
  58       $this->assign('statusID', $this->_batchStatusId);
  59
  60       $batchTitle = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', self::$_entityID, 'title');
  61       CRM_Utils_System::setTitle(ts('Accounting Batch - %1', array(1 => $batchTitle)));
  62
  63       $columnHeaders = array(
  64         'created_by' => ts('Created By'),
  65         'status' => ts('Status'),
  66         'description' => ts('Description'),
  67         'payment_instrument' => ts('Payment Method'),
  68         'item_count' => ts('Entered Transactions'),
  69         'assigned_item_count' => ts('Assigned Transactions'),
  70         'total' => ts('Entered Total'),
  71         'assigned_total' => ts('Assigned Total'),
  72         'opened_date' => ts('Opened'),
  73       );
  74       $this->assign('columnHeaders', $columnHeaders);
  75     }
  76   }
  77
  78   /**
  79    * Build the form object.
  80    *
  81    * @return void
  82    */
  83   public function buildQuickForm() {
  84     if ($this->_batchStatusId == 2) {
  85       $this->add('submit', 'export_batch', ts('Export Batch'));
  86     }
  87
  88     // do not build rest of form unless it is open batch
  89     if ($this->_batchStatusId != 1) {
  90       return;
  91     }
  92
  93     parent::buildQuickForm();
  94     $this->add('submit', 'close_batch', ts('Close Batch'));
  95     $this->add('submit', 'export_batch', ts('Close & Export Batch'));
  96
  97     // text for sort_name
  98     $this->addElement('text',
  99       'sort_name',
 100       ts('Contributor Name or Email'),
 101       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact',
 102         'sort_name'
 103       )
 104     );
 105
 106     $this->_group = CRM_Core_PseudoConstant::nestedGroup();
 107
 108     // multiselect for groups
 109     if ($this->_group) {
 110       $this->add('select', 'group', ts('Groups'), $this->_group, FALSE,
 111         array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2')
 112       );
 113     }
 114     $contactTags = CRM_Core_BAO_Tag::getTags();
 115
 116     if ($contactTags) {
 117       $this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE,
 118         array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2')
 119       );
 120     }
 121     CRM_Contribute_BAO_Query::buildSearchForm($this);
 122     $this->addElement('checkbox', 'toggleSelects', NULL, NULL);
 123
 124     $this->add('select',
 125       'trans_remove',
 126       ts('Task'),
 127       array('' => ts('- actions -')) + array('Remove' => ts('Remove from Batch')));
 128
 129     $this->add('submit', 'rSubmit', ts('Go'),
 130       array(
 131         'class' => 'crm-form-submit',
 132         'id' => 'GoRemove',
 133       ));
 134
 135     self::$_entityID = CRM_Utils_Request::retrieve('bid', 'Positive');
 136
 137     $this->addButtons(
 138       array(
 139         array(
 140           'type' => 'submit',
 141           'name' => ts('Search'),
 142           'isDefault' => TRUE,
 143         ),
 144       )
 145     );
 146
 147     $this->addElement('checkbox', 'toggleSelect', NULL, NULL);
 148     $this->add('select',
 149       'trans_assign',
 150       ts('Task'),
 151       array('' => ts('- actions -')) + array('Assign' => ts('Assign to Batch')));
 152
 153     $this->add('submit', 'submit', ts('Go'),
 154       array(
 155         'class' => 'crm-form-submit',
 156         'id' => 'Go',
 157       ));
 158     $this->applyFilter('__ALL__', 'trim');
 159
 160     $this->addElement('hidden', 'batch_id', self::$_entityID);
 161
 162     $this->add('text', 'name', ts('Batch Name'));
 163   }
 164
 165   public function setDefaultValues() {
 166     // do not setdefault unless it is open batch
 167     if ($this->_batchStatusId != 1) {
 168       return;
 169     }
 170     if (isset(self::$_entityID)) {
 171       $paymentInstrumentID = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', self::$_entityID, 'payment_instrument_id');
 172       $defaults['contribution_payment_instrument_id'] = $paymentInstrumentID;
 173       $this->assign('paymentInstrumentID', $paymentInstrumentID);
 174     }
 175     return $defaults;
 176   }
 177
 178   /**
 179    * @return array|null
 180    */
 181   public function &links() {
 182     if (!(self::$_links)) {
 183       self::$_links = array(
 184         'view' => array(
 185           'name' => ts('View'),
 186           'url' => 'civicrm/contact/view/contribution',
 187           'qs' => 'reset=1&id=%%contid%%&cid=%%cid%%&action=view&context=contribution&selectedChild=contribute',
 188           'title' => ts('View Contribution'),
 189         ),
 190         'assign' => array(
 191           'name' => ts('Assign'),
 192           'ref' => 'disable-action',
 193           'title' => ts('Assign Transaction'),
 194           'extra' => 'onclick = "assignRemove( %%id%%,\'' . 'assign' . '\' );"',
 195         ),
 196       );
 197     }
 198     return self::$_links;
 199   }
 200
 201 }