CRM/Contribute/Form/Task/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality for batch profile update for contributions
  38  */
  39 class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task {
  40
  41   /**
  42    * the title of the group
  43    *
  44    * @var string
  45    */
  46   protected $_title;
  47
  48   /**
  49    * maximum profile fields that will be displayed
  50    *
  51    */
  52   protected $_maxFields = 9;
  53
  54   /**
  55    * variable to store redirect path
  56    *
  57    */
  58   protected $_userContext;
  59
  60   /**
  61    * build all the data structures needed to build the form
  62    *
  63    * @return void
  64    * @access public
  65    */
  66   function preProcess() {
  67     /*
  68      * initialize the task and row fields
  69      */
  70     parent::preProcess();
  71
  72     //get the contact read only fields to display.
  73     $readOnlyFields = array_merge(array('sort_name' => ts('Name')),
  74       CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  75         'contact_autocomplete_options',
  76         TRUE, NULL, FALSE, 'name', TRUE
  77       )
  78     );
  79     //get the read only field data.
  80     $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
  81     $contactDetails = CRM_Contact_BAO_Contact_Utils::contactDetails($this->_contributionIds,
  82       'CiviContribute', $returnProperties
  83     );
  84     $this->assign('contactDetails', $contactDetails);
  85     $this->assign('readOnlyFields', $readOnlyFields);
  86   }
  87
  88   /**
  89    * Build the form
  90    *
  91    * @access public
  92    *
  93    * @return void
  94    */
  95   function buildQuickForm() {
  96     $ufGroupId = $this->get('ufGroupId');
  97
  98     if (!$ufGroupId) {
  99       CRM_Core_Error::fatal('ufGroupId is missing');
 100     }
 101     $this->_title = ts('Batch Update for Contributions') . ' - ' . CRM_Core_BAO_UFGroup::getTitle($ufGroupId);
 102     CRM_Utils_System::setTitle($this->_title);
 103
 104     $this->addDefaultButtons(ts('Save'));
 105     $this->_fields = array();
 106     $this->_fields = CRM_Core_BAO_UFGroup::getFields($ufGroupId, FALSE, CRM_Core_Action::VIEW);
 107
 108     // remove file type field and then limit fields
 109     $suppressFields = FALSE;
 110     $removehtmlTypes = array('File', 'Autocomplete-Select');
 111     foreach ($this->_fields as $name => $field) {
 112       if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name) &&
 113         in_array($this->_fields[$name]['html_type'], $removehtmlTypes)
 114       ) {
 115         $suppressFields = TRUE;
 116         unset($this->_fields[$name]);
 117       }
 118
 119       //fix to reduce size as we are using this field in grid
 120       if (is_array($field['attributes']) && $this->_fields[$name]['attributes']['size'] > 19) {
 121         //shrink class to "form-text-medium"
 122         $this->_fields[$name]['attributes']['size'] = 19;
 123       }
 124     }
 125
 126     $this->_fields = array_slice($this->_fields, 0, $this->_maxFields);
 127
 128     $this->addButtons(array(
 129         array(
 130           'type' => 'submit',
 131           'name' => ts('Update Contribution(s)'),
 132           'isDefault' => TRUE,
 133         ),
 134         array(
 135           'type' => 'cancel',
 136           'name' => ts('Cancel'),
 137         ),
 138       )
 139     );
 140
 141
 142     $this->assign('profileTitle', $this->_title);
 143     $this->assign('componentIds', $this->_contributionIds);
 144
 145     //load all campaigns.
 146     if (array_key_exists('contribution_campaign_id', $this->_fields)) {
 147       $this->_componentCampaigns = array();
 148       CRM_Core_PseudoConstant::populate($this->_componentCampaigns,
 149         'CRM_Contribute_DAO_Contribution',
 150         TRUE, 'campaign_id', 'id',
 151         ' id IN (' . implode(' , ', array_values($this->_contributionIds)) . ' ) '
 152       );
 153     }
 154
 155     //fix for CRM-2752
 156     $customFields = CRM_Core_BAO_CustomField::getFields('Contribution');
 157     foreach ($this->_contributionIds as $contributionId) {
 158       $typeId = CRM_Core_DAO::getFieldValue("CRM_Contribute_DAO_Contribution", $contributionId, 'financial_type_id');
 159       foreach ($this->_fields as $name => $field) {
 160         if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
 161           $customValue = CRM_Utils_Array::value($customFieldID, $customFields);
 162           if (CRM_Utils_Array::value('extends_entity_column_value', $customValue)) {
 163             $entityColumnValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 164               $customValue['extends_entity_column_value']
 165             );
 166           }
 167
 168           if (CRM_Utils_Array::value($typeId, $entityColumnValue) ||
 169             CRM_Utils_System::isNull($entityColumnValue[$typeId])
 170           ) {
 171             CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $contributionId);
 172           }
 173         }
 174         else {
 175           // handle non custom fields
 176           CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $contributionId);
 177         }
 178       }
 179     }
 180
 181     $this->assign('fields', $this->_fields);
 182
 183     // don't set the status message when form is submitted.
 184     $buttonName = $this->controller->getButtonName('submit');
 185
 186     if ($suppressFields && $buttonName != '_qf_Batch_next') {
 187       CRM_Core_Session::setStatus(ts("FILE or Autocomplete Select type field(s) in the selected profile are not supported for Batch Update and have been excluded."), ts('Unsupported Field Type'), 'error');
 188     }
 189
 190     $this->addDefaultButtons(ts('Update Contributions'));
 191   }
 192
 193   /**
 194    * This function sets the default values for the form.
 195    *
 196    * @access public
 197    *
 198    * @return void
 199    */
 200   function setDefaultValues() {
 201     if (empty($this->_fields)) {
 202       return;
 203     }
 204
 205     $defaults = array();
 206     foreach ($this->_contributionIds as $contributionId) {
 207       $details[$contributionId] = array();
 208       CRM_Core_BAO_UFGroup::setProfileDefaults(NULL, $this->_fields, $defaults, FALSE, $contributionId, 'Contribute');
 209     }
 210
 211     return $defaults;
 212   }
 213
 214   /**
 215    * process the form after the input has been submitted and validated
 216    *
 217    * @access public
 218    *
 219    * @return void
 220    */
 221   public function postProcess() {
 222     $params = $this->exportValues();
 223     $dates = array(
 224       'receive_date',
 225       'receipt_date',
 226       'thankyou_date',
 227       'cancel_date',
 228     );
 229     if (isset($params['field'])) {
 230       foreach ($params['field'] as $key => $value) {
 231
 232         $value['custom'] = CRM_Core_BAO_CustomField::postProcess($value,
 233           CRM_Core_DAO::$_nullObject,
 234           $key,
 235           'Contribution'
 236         );
 237
 238         $ids['contribution'] = $key;
 239         foreach ($dates as $val) {
 240           if (isset($value[$val])) {
 241             $value[$val] = CRM_Utils_Date::processDate($value[$val]);
 242           }
 243         }
 244         if (CRM_Utils_Array::value('financial_type', $value)) {
 245           $value['financial_type_id'] = $value['financial_type'];
 246         }
 247
 248         if (CRM_Utils_Array::value('payment_instrument', $value)) {
 249           $value['payment_instrument_id'] = $value['payment_instrument'];
 250         }
 251
 252         if (CRM_Utils_Array::value('contribution_source', $value)) {
 253           $value['source'] = $value['contribution_source'];
 254         }
 255
 256         unset($value['financial_type']);
 257         unset($value['contribution_source']);
 258         $contribution = CRM_Contribute_BAO_Contribution::add($value, $ids);
 259
 260         // add custom field values
 261         if (CRM_Utils_Array::value('custom', $value) &&
 262           is_array($value['custom'])
 263         ) {
 264           CRM_Core_BAO_CustomValueTable::store($value['custom'], 'civicrm_contribution', $contribution->id);
 265         }
 266       }
 267       CRM_Core_Session::setStatus(ts("Your updates have been saved."), ts('Saved'), 'success');
 268     }
 269     else {
 270       CRM_Core_Session::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert');
 271     }
 272   }
 273   //end of function
 274 }
 275