3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This class provides the functionality for batch profile update for Activities
37 class CRM_Activity_Form_Task_Batch
extends CRM_Activity_Form_Task
{
40 * The title of the group.
47 * Maximum profile fields that will be displayed.
50 protected $_maxFields = 9;
53 * Variable to store redirect path.
56 protected $_userContext;
59 * Build all the data structures needed to build the form.
61 public function preProcess() {
63 // Initialize the task and row fields.
66 // Get the contact read only fields to display.
67 $readOnlyFields = array_merge(['sort_name' => ts('Added By'), 'target_sort_name' => ts('With Contact')],
68 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
69 'contact_autocomplete_options',
70 TRUE, NULL, FALSE, 'name', TRUE
74 // Get the read only field data.
75 $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
76 $contactDetails = CRM_Contact_BAO_Contact_Utils
::contactDetails($this->_activityHolderIds
,
77 'Activity', $returnProperties
79 $readOnlyFields['assignee_display_name'] = ts('Assigned to');
80 if (!empty($contactDetails)) {
81 foreach ($contactDetails as $key => $value) {
82 $assignee = CRM_Activity_BAO_ActivityAssignment
::retrieveAssigneeIdsByActivityId($key);
83 $assigneeContact = [];
84 foreach ($assignee as $values) {
85 $assigneeContact[] = CRM_Contact_BAO_Contact
::displayName($values);
87 $contactDetails[$key]['assignee_display_name'] = !empty($assigneeContact) ?
implode(';', $assigneeContact) : NULL;
90 $this->assign('contactDetails', $contactDetails);
91 $this->assign('readOnlyFields', $readOnlyFields);
95 * Build the form object.
97 public function buildQuickForm() {
98 $ufGroupId = $this->get('ufGroupId');
101 throw new CRM_Core_Exception('The profile id is missing');
103 $this->_title
= ts('Update multiple activities') . ' - ' . CRM_Core_BAO_UFGroup
::getTitle($ufGroupId);
104 CRM_Utils_System
::setTitle($this->_title
);
106 $this->addDefaultButtons(ts('Save'));
108 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($ufGroupId, FALSE, CRM_Core_Action
::VIEW
);
110 // remove file type field and then limit fields
111 $suppressFields = FALSE;
112 $removehtmlTypes = ['File'];
113 foreach ($this->_fields
as $name => $field) {
114 if (CRM_Core_BAO_CustomField
::getKeyID($name) &&
115 in_array($this->_fields
[$name]['html_type'], $removehtmlTypes)
117 $suppressFields = TRUE;
118 unset($this->_fields
[$name]);
121 // Fix to reduce size as we are using this field in grid.
122 if (is_array($field['attributes']) && !empty($this->_fields
[$name]['attributes']['size']) && $this->_fields
[$name]['attributes']['size'] > 19) {
123 // Shrink class to "form-text-medium".
124 $this->_fields
[$name]['attributes']['size'] = 19;
128 $this->_fields
= array_slice($this->_fields
, 0, $this->_maxFields
);
133 'name' => ts('Update Activities'),
138 'name' => ts('Cancel'),
142 $this->assign('profileTitle', $this->_title
);
143 $this->assign('componentIds', $this->_activityHolderIds
);
145 // Load all campaigns.
146 if (array_key_exists('activity_campaign_id', $this->_fields
)) {
147 $this->_componentCampaigns
= [];
148 CRM_Core_PseudoConstant
::populate($this->_componentCampaigns
,
149 'CRM_Activity_DAO_Activity',
150 TRUE, 'campaign_id', 'id',
151 ' id IN (' . implode(' , ', array_values($this->_activityHolderIds
)) . ' ) '
155 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity');
156 // It is possible to have fields that are required in CiviCRM not be required in the
157 // profile. Overriding that here. Perhaps a better approach would be to
158 // make them required in the schema & read that up through getFields functionality.
159 $requiredFields = ['activity_date_time'];
161 foreach ($this->_activityHolderIds
as $activityId) {
162 $typeId = CRM_Core_DAO
::getFieldValue("CRM_Activity_DAO_Activity", $activityId, 'activity_type_id');
163 foreach ($this->_fields
as $name => $field) {
164 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
165 $customValue = CRM_Utils_Array
::value($customFieldID, $customFields);
166 if (!empty($customValue['extends_entity_column_value'])) {
167 $entityColumnValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
168 $customValue['extends_entity_column_value']
171 if (!empty($entityColumnValue[$typeId]) ||
172 CRM_Utils_System
::isNull($entityColumnValue[$typeId])
174 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $activityId);
178 // Handle non custom fields.
179 if (in_array($field['name'], $requiredFields)) {
180 $field['is_required'] = TRUE;
182 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $activityId);
187 $this->assign('fields', $this->_fields
);
189 // Don't set the status message when form is submitted.
190 // $buttonName = $this->controller->getButtonName('submit');
192 if ($suppressFields) {
193 CRM_Core_Session
::setStatus(ts("File type field(s) in the selected profile are not supported for Update multiple activities."), ts('Some Fields Excluded'), 'info');
196 $this->addDefaultButtons(ts('Update Activities'));
200 * Set default values for the form.
202 public function setDefaultValues() {
203 if (empty($this->_fields
)) {
208 foreach ($this->_activityHolderIds
as $activityId) {
209 CRM_Core_BAO_UFGroup
::setProfileDefaults(NULL, $this->_fields
, $defaults, FALSE, $activityId, 'Activity');
216 * Process the form after the input has been submitted and validated.
218 public function postProcess() {
219 $params = $this->exportValues();
221 if (isset($params['field'])) {
222 foreach ($params['field'] as $key => $value) {
224 $value['custom'] = CRM_Core_BAO_CustomField
::postProcess($value,
229 if (!empty($value['activity_status_id'])) {
230 $value['status_id'] = $value['activity_status_id'];
233 if (!empty($value['activity_details'])) {
234 $value['details'] = $value['activity_details'];
237 if (!empty($value['activity_location'])) {
238 $value['location'] = $value['activity_location'];
241 if (!empty($value['activity_subject'])) {
242 $value['subject'] = $value['activity_subject'];
245 $activityId = civicrm_api3('activity', 'create', $value);
247 // @todo this would be done by the api call above if the parames were passed through.
248 // @todo extract submit functions &
249 // extend CRM_Event_Form_Task_BatchTest::testSubmit with a data provider to test
250 // handling of custom data, specifically checkbox fields.
251 if (!empty($value['custom']) &&
252 is_array($value['custom'])
254 CRM_Core_BAO_CustomValueTable
::store($value['custom'], 'civicrm_activity', $activityId['id']);
257 CRM_Core_Session
::setStatus("", ts("Updates Saved"), "success");
260 CRM_Core_Session
::setStatus("", ts("No Updates Saved"), "info");