3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class provides the functionality for batch profile update for contributions
39 class CRM_Contribute_Form_Task_Batch
extends CRM_Contribute_Form_Task
{
42 * the title of the group
49 * maximum profile fields that will be displayed
52 protected $_maxFields = 9;
55 * variable to store redirect path
58 protected $_userContext;
61 * build all the data structures needed to build the form
66 function preProcess() {
68 * initialize the task and row fields
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
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
84 $this->assign('contactDetails', $contactDetails);
85 $this->assign('readOnlyFields', $readOnlyFields);
95 function buildQuickForm() {
96 $ufGroupId = $this->get('ufGroupId');
99 CRM_Core_Error
::fatal('ufGroupId is missing');
101 $this->_title
= ts('Batch Update for Contributions') . ' - ' . CRM_Core_BAO_UFGroup
::getTitle($ufGroupId);
102 CRM_Utils_System
::setTitle($this->_title
);
104 $this->addDefaultButtons(ts('Save'));
105 $this->_fields
= array();
106 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($ufGroupId, FALSE, CRM_Core_Action
::VIEW
);
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)
115 $suppressFields = TRUE;
116 unset($this->_fields
[$name]);
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;
126 $this->_fields
= array_slice($this->_fields
, 0, $this->_maxFields
);
128 $this->addButtons(array(
131 'name' => ts('Update Contribution(s)'),
136 'name' => ts('Cancel'),
142 $this->assign('profileTitle', $this->_title
);
143 $this->assign('componentIds', $this->_contributionIds
);
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
)) . ' ) '
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 (!empty($customValue['extends_entity_column_value'])) {
163 $entityColumnValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
164 $customValue['extends_entity_column_value']
168 if (!empty($entityColumnValue[$typeId]) ||
169 CRM_Utils_System
::isNull($entityColumnValue[$typeId])
171 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $contributionId);
175 // handle non custom fields
176 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $contributionId);
181 $this->assign('fields', $this->_fields
);
183 // don't set the status message when form is submitted.
184 $buttonName = $this->controller
->getButtonName('submit');
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');
190 $this->addDefaultButtons(ts('Update Contributions'));
194 * This function sets the default values for the form.
200 function setDefaultValues() {
201 if (empty($this->_fields
)) {
206 foreach ($this->_contributionIds
as $contributionId) {
207 $details[$contributionId] = array();
208 CRM_Core_BAO_UFGroup
::setProfileDefaults(NULL, $this->_fields
, $defaults, FALSE, $contributionId, 'Contribute');
215 * process the form after the input has been submitted and validated
221 public function postProcess() {
222 $params = $this->exportValues();
229 if (isset($params['field'])) {
230 foreach ($params['field'] as $key => $value) {
232 $value['custom'] = CRM_Core_BAO_CustomField
::postProcess($value,
233 CRM_Core_DAO
::$_nullObject,
238 $ids['contribution'] = $key;
239 foreach ($dates as $val) {
240 if (isset($value[$val])) {
241 $value[$val] = CRM_Utils_Date
::processDate($value[$val]);
244 if (!empty($value['financial_type'])) {
245 $value['financial_type_id'] = $value['financial_type'];
248 if (!empty($value['payment_instrument'])) {
249 $value['payment_instrument_id'] = $value['payment_instrument'];
252 if (!empty($value['contribution_source'])) {
253 $value['source'] = $value['contribution_source'];
256 unset($value['financial_type']);
257 unset($value['contribution_source']);
258 $contribution = CRM_Contribute_BAO_Contribution
::add($value, $ids);
260 // add custom field values
261 if (!empty($value['custom']) &&
262 is_array($value['custom'])
264 CRM_Core_BAO_CustomValueTable
::store($value['custom'], 'civicrm_contribution', $contribution->id
);
267 CRM_Core_Session
::setStatus(ts("Your updates have been saved."), ts('Saved'), 'success');
270 CRM_Core_Session
::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert');