3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 * This class provides the functionality for batch profile update for contributions.
37 class CRM_Contribute_Form_Task_Batch
extends CRM_Contribute_Form_Task
{
40 * The title of the group
47 * Maximum profile fields that will be displayed
49 protected $_maxFields = 9;
52 * Variable to store redirect path
54 protected $_userContext;
57 * Build all the data structures needed to build the form.
61 public function preProcess() {
62 // initialize the task and row fields
65 //get the contact read only fields to display.
66 $readOnlyFields = array_merge(array('sort_name' => ts('Name')),
67 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
68 'contact_autocomplete_options',
69 TRUE, NULL, FALSE, 'name', TRUE
72 //get the read only field data.
73 $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
74 $contactDetails = CRM_Contact_BAO_Contact_Utils
::contactDetails($this->_contributionIds
,
75 'CiviContribute', $returnProperties
77 $this->assign('contactDetails', $contactDetails);
78 $this->assign('readOnlyFields', $readOnlyFields);
82 * Build the form object.
87 public function buildQuickForm() {
88 $ufGroupId = $this->get('ufGroupId');
91 CRM_Core_Error
::fatal('ufGroupId is missing');
93 $this->_title
= ts('Batch Update for Contributions') . ' - ' . CRM_Core_BAO_UFGroup
::getTitle($ufGroupId);
94 CRM_Utils_System
::setTitle($this->_title
);
96 $this->addDefaultButtons(ts('Save'));
97 $this->_fields
= array();
98 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($ufGroupId, FALSE, CRM_Core_Action
::VIEW
);
100 // remove file type field and then limit fields
101 $suppressFields = FALSE;
102 $removehtmlTypes = array('File', 'Autocomplete-Select');
103 foreach ($this->_fields
as $name => $field) {
104 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name) &&
105 in_array($this->_fields
[$name]['html_type'], $removehtmlTypes)
107 $suppressFields = TRUE;
108 unset($this->_fields
[$name]);
111 //fix to reduce size as we are using this field in grid
112 if (is_array($field['attributes']) && $this->_fields
[$name]['attributes']['size'] > 19) {
113 //shrink class to "form-text-medium"
114 $this->_fields
[$name]['attributes']['size'] = 19;
118 $this->_fields
= array_slice($this->_fields
, 0, $this->_maxFields
);
120 $this->addButtons(array(
123 'name' => ts('Update Contribution(s)'),
128 'name' => ts('Cancel'),
133 $this->assign('profileTitle', $this->_title
);
134 $this->assign('componentIds', $this->_contributionIds
);
136 //load all campaigns.
137 if (array_key_exists('contribution_campaign_id', $this->_fields
)) {
138 $this->_componentCampaigns
= array();
139 CRM_Core_PseudoConstant
::populate($this->_componentCampaigns
,
140 'CRM_Contribute_DAO_Contribution',
141 TRUE, 'campaign_id', 'id',
142 ' id IN (' . implode(' , ', array_values($this->_contributionIds
)) . ' ) '
147 $customFields = CRM_Core_BAO_CustomField
::getFields('Contribution');
148 foreach ($this->_contributionIds
as $contributionId) {
149 $typeId = CRM_Core_DAO
::getFieldValue("CRM_Contribute_DAO_Contribution", $contributionId, 'financial_type_id');
150 foreach ($this->_fields
as $name => $field) {
151 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
152 $customValue = CRM_Utils_Array
::value($customFieldID, $customFields);
153 if (!empty($customValue['extends_entity_column_value'])) {
154 $entityColumnValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
155 $customValue['extends_entity_column_value']
159 if (!empty($entityColumnValue[$typeId]) ||
160 CRM_Utils_System
::isNull($entityColumnValue[$typeId])
162 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $contributionId);
166 // handle non custom fields
167 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $contributionId);
172 $this->assign('fields', $this->_fields
);
174 // don't set the status message when form is submitted.
175 $buttonName = $this->controller
->getButtonName('submit');
177 if ($suppressFields && $buttonName != '_qf_Batch_next') {
178 CRM_Core_Session
::setStatus(ts("File or Autocomplete-Select type field(s) in the selected profile are not supported for Batch Update."), ts('Unsupported Field Type'), 'error');
181 $this->addDefaultButtons(ts('Update Contributions'));
185 * Set default values for the form.
190 public function setDefaultValues() {
191 if (empty($this->_fields
)) {
196 foreach ($this->_contributionIds
as $contributionId) {
197 $details[$contributionId] = array();
198 CRM_Core_BAO_UFGroup
::setProfileDefaults(NULL, $this->_fields
, $defaults, FALSE, $contributionId, 'Contribute');
205 * Process the form after the input has been submitted and validated.
210 public function postProcess() {
211 $params = $this->exportValues();
218 if (isset($params['field'])) {
219 foreach ($params['field'] as $key => $value) {
221 $value['custom'] = CRM_Core_BAO_CustomField
::postProcess($value,
226 $ids['contribution'] = $key;
227 foreach ($dates as $val) {
228 if (isset($value[$val])) {
229 $value[$val] = CRM_Utils_Date
::processDate($value[$val]);
232 if (!empty($value['financial_type'])) {
233 $value['financial_type_id'] = $value['financial_type'];
236 if (!empty($value['payment_instrument'])) {
237 $value['payment_instrument_id'] = $value['payment_instrument'];
240 if (!empty($value['contribution_source'])) {
241 $value['source'] = $value['contribution_source'];
244 unset($value['financial_type']);
245 unset($value['contribution_source']);
246 $contribution = CRM_Contribute_BAO_Contribution
::add($value, $ids);
248 // add custom field values
249 if (!empty($value['custom']) &&
250 is_array($value['custom'])
252 CRM_Core_BAO_CustomValueTable
::store($value['custom'], 'civicrm_contribution', $contribution->id
);
255 CRM_Core_Session
::setStatus(ts("Your updates have been saved."), ts('Saved'), 'success');
258 CRM_Core_Session
::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert');