| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | Copyright CiviCRM LLC. All rights reserved. | |
| 5 | | | |
| 6 | | This work is published under the GNU AGPLv3 license with some | |
| 7 | | permitted exceptions and without any warranty. For full license | |
| 8 | | and copyright information, see https://civicrm.org/licensing | |
| 9 | +--------------------------------------------------------------------+ |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * |
| 14 | * @package CRM |
| 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
| 16 | */ |
| 17 | |
| 18 | /** |
| 19 | * This class provides the functionality for batch profile update for events. |
| 20 | */ |
| 21 | class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task { |
| 22 | |
| 23 | /** |
| 24 | * The title of the group. |
| 25 | * |
| 26 | * @var string |
| 27 | */ |
| 28 | protected $_title; |
| 29 | |
| 30 | /** |
| 31 | * Maximum profile fields that will be displayed. |
| 32 | * @var int |
| 33 | */ |
| 34 | protected $_maxFields = 9; |
| 35 | |
| 36 | /** |
| 37 | * Variable to store redirect path. |
| 38 | * @var string |
| 39 | */ |
| 40 | protected $_userContext; |
| 41 | |
| 42 | /** |
| 43 | * Variable to store previous status id. |
| 44 | * @var array |
| 45 | */ |
| 46 | protected $_fromStatusIds; |
| 47 | |
| 48 | /** |
| 49 | * Build all the data structures needed to build the form. |
| 50 | * |
| 51 | * @return void |
| 52 | */ |
| 53 | public function preProcess() { |
| 54 | /* |
| 55 | * initialize the task and row fields |
| 56 | */ |
| 57 | parent::preProcess(); |
| 58 | |
| 59 | //get the contact read only fields to display. |
| 60 | $readOnlyFields = array_merge(['sort_name' => ts('Name')], |
| 61 | CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, |
| 62 | 'contact_autocomplete_options', |
| 63 | TRUE, NULL, FALSE, 'name', TRUE |
| 64 | ) |
| 65 | ); |
| 66 | //get the read only field data. |
| 67 | $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1); |
| 68 | $contactDetails = CRM_Contact_BAO_Contact_Utils::contactDetails($this->_participantIds, |
| 69 | 'CiviEvent', $returnProperties |
| 70 | ); |
| 71 | $this->assign('contactDetails', $contactDetails); |
| 72 | $this->assign('readOnlyFields', $readOnlyFields); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Build the form object. |
| 77 | * |
| 78 | * @throws \CRM_Core_Exception |
| 79 | */ |
| 80 | public function buildQuickForm() { |
| 81 | $ufGroupId = $this->get('ufGroupId'); |
| 82 | if (!$ufGroupId) { |
| 83 | CRM_Core_Error::statusBounce('ufGroupId is missing'); |
| 84 | } |
| 85 | |
| 86 | $this->_title = ts('Update multiple participants') . ' - ' . CRM_Core_BAO_UFGroup::getTitle($ufGroupId); |
| 87 | CRM_Utils_System::setTitle($this->_title); |
| 88 | $this->addDefaultButtons(ts('Save')); |
| 89 | |
| 90 | $this->_fields = CRM_Core_BAO_UFGroup::getFields($ufGroupId, FALSE, CRM_Core_Action::VIEW); |
| 91 | if (array_key_exists('participant_status', $this->_fields)) { |
| 92 | $this->assign('statusProfile', 1); |
| 93 | $this->assignToTemplate(); |
| 94 | } |
| 95 | |
| 96 | // remove file type field and then limit fields |
| 97 | $suppressFields = FALSE; |
| 98 | $removehtmlTypes = ['File']; |
| 99 | foreach ($this->_fields as $name => $field) { |
| 100 | if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name) && |
| 101 | in_array($this->_fields[$name]['html_type'], $removehtmlTypes) |
| 102 | ) { |
| 103 | $suppressFields = TRUE; |
| 104 | unset($this->_fields[$name]); |
| 105 | } |
| 106 | |
| 107 | //fix to reduce size as we are using this field in grid |
| 108 | if (is_array($field['attributes']) && $this->_fields[$name]['attributes']['size'] > 19) { |
| 109 | //shrink class to "form-text-medium" |
| 110 | $this->_fields[$name]['attributes']['size'] = 19; |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | $this->_fields = array_slice($this->_fields, 0, $this->_maxFields); |
| 115 | |
| 116 | $this->addButtons([ |
| 117 | [ |
| 118 | 'type' => 'submit', |
| 119 | 'name' => ts('Update Participant(s)'), |
| 120 | 'isDefault' => TRUE, |
| 121 | ], |
| 122 | [ |
| 123 | 'type' => 'cancel', |
| 124 | 'name' => ts('Cancel'), |
| 125 | ], |
| 126 | ]); |
| 127 | |
| 128 | $this->assign('profileTitle', $this->_title); |
| 129 | $this->assign('componentIds', $this->_participantIds); |
| 130 | $fileFieldExists = FALSE; |
| 131 | |
| 132 | //load all campaigns. |
| 133 | if (array_key_exists('participant_campaign_id', $this->_fields)) { |
| 134 | $this->_componentCampaigns = []; |
| 135 | CRM_Core_PseudoConstant::populate($this->_componentCampaigns, |
| 136 | 'CRM_Event_DAO_Participant', |
| 137 | TRUE, 'campaign_id', 'id', |
| 138 | ' id IN (' . implode(' , ', array_values($this->_participantIds)) . ' ) ' |
| 139 | ); |
| 140 | } |
| 141 | |
| 142 | //fix for CRM-2752 |
| 143 | // get the option value for custom data type |
| 144 | $customDataType = CRM_Core_OptionGroup::values('custom_data_type', FALSE, FALSE, FALSE, NULL, 'name'); |
| 145 | $this->_roleCustomDataTypeID = array_search('ParticipantRole', $customDataType); |
| 146 | $this->_eventNameCustomDataTypeID = array_search('ParticipantEventName', $customDataType); |
| 147 | $this->_eventTypeCustomDataTypeID = array_search('ParticipantEventType', $customDataType); |
| 148 | |
| 149 | // build custom data getFields array |
| 150 | $customFieldsRole = CRM_Core_BAO_CustomField::getFields('Participant', FALSE, FALSE, NULL, $this->_roleCustomDataTypeID); |
| 151 | |
| 152 | $customFieldsEvent = CRM_Core_BAO_CustomField::getFields('Participant', FALSE, FALSE, NULL, $this->_eventNameCustomDataTypeID); |
| 153 | $customFieldsEventType = CRM_Core_BAO_CustomField::getFields('Participant', FALSE, FALSE, NULL, $this->_eventTypeCustomDataTypeID); |
| 154 | |
| 155 | $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsRole, |
| 156 | CRM_Core_BAO_CustomField::getFields('Participant', FALSE, FALSE, NULL, NULL, TRUE) |
| 157 | ); |
| 158 | $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsEventType, $customFields); |
| 159 | $this->_customFields = CRM_Utils_Array::crmArrayMerge($customFieldsEvent, $customFields); |
| 160 | |
| 161 | foreach ($this->_participantIds as $participantId) { |
| 162 | $roleId = CRM_Core_DAO::getFieldValue("CRM_Event_DAO_Participant", $participantId, 'role_id'); |
| 163 | $eventId = CRM_Core_DAO::getFieldValue("CRM_Event_DAO_Participant", $participantId, 'event_id'); |
| 164 | $eventTypeId = CRM_Core_DAO::getFieldValue("CRM_Event_DAO_Event", $eventId, 'event_type_id'); |
| 165 | foreach ($this->_fields as $name => $field) { |
| 166 | if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) { |
| 167 | $customValue = $this->_customFields[$customFieldID] ?? NULL; |
| 168 | $entityColumnValue = []; |
| 169 | if (!empty($customValue['extends_entity_column_value'])) { |
| 170 | $entityColumnValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, |
| 171 | $customValue['extends_entity_column_value'] |
| 172 | ); |
| 173 | } |
| 174 | if (($this->_roleCustomDataTypeID == $customValue['extends_entity_column_id']) && |
| 175 | in_array($roleId, $entityColumnValue) |
| 176 | ) { |
| 177 | CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $participantId); |
| 178 | } |
| 179 | elseif (($this->_eventNameCustomDataTypeID == $customValue['extends_entity_column_id']) && |
| 180 | in_array($eventId, $entityColumnValue) |
| 181 | ) { |
| 182 | CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $participantId); |
| 183 | } |
| 184 | elseif ($this->_eventTypeCustomDataTypeID == $customValue['extends_entity_column_id'] && |
| 185 | in_array($eventTypeId, $entityColumnValue) |
| 186 | ) { |
| 187 | CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $participantId); |
| 188 | } |
| 189 | elseif (CRM_Utils_System::isNull($entityColumnValue)) { |
| 190 | CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $participantId); |
| 191 | } |
| 192 | } |
| 193 | else { |
| 194 | if ($field['name'] === 'participant_role') { |
| 195 | $field['is_multiple'] = TRUE; |
| 196 | } |
| 197 | // handle non custom fields |
| 198 | CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $participantId); |
| 199 | } |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | $this->assign('fields', $this->_fields); |
| 204 | |
| 205 | // don't set the status message when form is submitted. |
| 206 | $buttonName = $this->controller->getButtonName('submit'); |
| 207 | |
| 208 | if ($suppressFields && $buttonName !== '_qf_Batch_next') { |
| 209 | CRM_Core_Session::setStatus(ts("File type field(s) in the selected profile are not supported for Update multiple participants."), ts('Unsupported Field Type'), 'info'); |
| 210 | } |
| 211 | |
| 212 | $this->addDefaultButtons(ts('Update Participant(s)')); |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Set default values for the form. |
| 217 | * |
| 218 | * @return array |
| 219 | */ |
| 220 | public function setDefaultValues() { |
| 221 | if (empty($this->_fields)) { |
| 222 | return []; |
| 223 | } |
| 224 | |
| 225 | $defaults = []; |
| 226 | foreach ($this->_participantIds as $participantId) { |
| 227 | $details[$participantId] = []; |
| 228 | |
| 229 | $details[$participantId] = CRM_Event_BAO_Participant::participantDetails($participantId); |
| 230 | CRM_Core_BAO_UFGroup::setProfileDefaults(NULL, $this->_fields, $defaults, FALSE, $participantId, 'Event'); |
| 231 | |
| 232 | //get the from status ids, CRM-4323 |
| 233 | if (array_key_exists('participant_status', $this->_fields)) { |
| 234 | $this->_fromStatusIds[$participantId] = $defaults["field[$participantId][participant_status]"] ?? NULL; |
| 235 | } |
| 236 | if (array_key_exists('participant_role', $this->_fields)) { |
| 237 | if ($defaults["field[{$participantId}][participant_role]"]) { |
| 238 | $roles = $defaults["field[{$participantId}][participant_role]"]; |
| 239 | foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $roles) as $k => $v) { |
| 240 | $defaults["field[$participantId][participant_role][{$v}]"] = 1; |
| 241 | } |
| 242 | unset($defaults["field[{$participantId}][participant_role]"]); |
| 243 | } |
| 244 | } |
| 245 | } |
| 246 | |
| 247 | $this->assign('details', $details); |
| 248 | return $defaults; |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * Process the form after the input has been submitted and validated. |
| 253 | */ |
| 254 | public function postProcess() { |
| 255 | $params = $this->exportValues(); |
| 256 | $this->submit($params); |
| 257 | } |
| 258 | |
| 259 | /** |
| 260 | * @param int $participantId |
| 261 | * @param int $statusId |
| 262 | * |
| 263 | * @throws \CRM_Core_Exception |
| 264 | * @throws \CiviCRM_API3_Exception |
| 265 | */ |
| 266 | public static function updatePendingOnlineContribution($participantId, $statusId) { |
| 267 | |
| 268 | $contributionId = CRM_Contribute_BAO_Contribution::checkOnlinePendingContribution($participantId, |
| 269 | 'Event' |
| 270 | ); |
| 271 | if (!$contributionId) { |
| 272 | return; |
| 273 | } |
| 274 | |
| 275 | //status rules. |
| 276 | //1. participant - positive => contribution - completed. |
| 277 | //2. participant - negative => contribution - cancelled. |
| 278 | |
| 279 | $positiveStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Positive'"); |
| 280 | $negativeStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Negative'"); |
| 281 | $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); |
| 282 | |
| 283 | if (array_key_exists($statusId, $positiveStatuses)) { |
| 284 | $params = [ |
| 285 | 'component_id' => $participantId, |
| 286 | 'contribution_id' => $contributionId, |
| 287 | 'IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved' => 1, |
| 288 | ]; |
| 289 | |
| 290 | //change related contribution status. |
| 291 | self::updateContributionStatus($params); |
| 292 | } |
| 293 | if (array_key_exists($statusId, $negativeStatuses)) { |
| 294 | civicrm_api3('Contribution', 'create', ['id' => $contributionId, 'contribution_status_id' => 'Cancelled']); |
| 295 | return; |
| 296 | } |
| 297 | |
| 298 | } |
| 299 | |
| 300 | /** |
| 301 | * Update contribution status. |
| 302 | * |
| 303 | * @param array $params |
| 304 | * |
| 305 | * @throws \CRM_Core_Exception |
| 306 | * @throws \CiviCRM_API3_Exception |
| 307 | * @throws \Exception |
| 308 | * |
| 309 | * @deprecated |
| 310 | * This is only called from one place in the code & |
| 311 | * it is unclear whether it is a function on the way in or on the way out |
| 312 | * |
| 313 | */ |
| 314 | public static function updateContributionStatus($params) { |
| 315 | // get minimum required values. |
| 316 | $componentId = $params['component_id'] ?? NULL; |
| 317 | $contributionId = $params['contribution_id'] ?? NULL; |
| 318 | |
| 319 | $input = $ids = $objects = []; |
| 320 | |
| 321 | //get the required ids. |
| 322 | $ids['contribution'] = $contributionId; |
| 323 | $ids['participant'] = $params['component_id']; |
| 324 | |
| 325 | if (!$ids['contact'] = CRM_Utils_Array::value('contact_id', $params)) { |
| 326 | $ids['contact'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', |
| 327 | $contributionId, |
| 328 | 'contact_id' |
| 329 | ); |
| 330 | } |
| 331 | |
| 332 | if (!$ids['event'] = CRM_Utils_Array::value('event_id', $params)) { |
| 333 | $ids['event'] = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', |
| 334 | $componentId, |
| 335 | 'event_id' |
| 336 | ); |
| 337 | } |
| 338 | |
| 339 | $input['component'] = 'event'; |
| 340 | |
| 341 | $baseIPN = new CRM_Core_Payment_BaseIPN(); |
| 342 | |
| 343 | // reset template values. |
| 344 | $template = CRM_Core_Smarty::singleton(); |
| 345 | $template->clearTemplateVars(); |
| 346 | |
| 347 | if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) { |
| 348 | throw new CRM_Core_Exception('validation error'); |
| 349 | } |
| 350 | |
| 351 | $contribution = &$objects['contribution']; |
| 352 | |
| 353 | $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [ |
| 354 | 'labelColumn' => 'name', |
| 355 | 'flip' => 1, |
| 356 | ]); |
| 357 | $input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'] = $params['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'] ?? NULL; |
| 358 | |
| 359 | // status is not pending |
| 360 | if ($contribution->contribution_status_id != $contributionStatuses['Pending']) { |
| 361 | return; |
| 362 | } |
| 363 | |
| 364 | //set values for ipn code. |
| 365 | foreach ([ |
| 366 | 'fee_amount', |
| 367 | 'check_number', |
| 368 | 'payment_instrument_id', |
| 369 | ] as $field) { |
| 370 | if (!$input[$field] = CRM_Utils_Array::value($field, $params)) { |
| 371 | $input[$field] = $contribution->$field; |
| 372 | } |
| 373 | } |
| 374 | if (!$input['trxn_id'] = CRM_Utils_Array::value('trxn_id', $params)) { |
| 375 | $input['trxn_id'] = $contribution->invoice_id; |
| 376 | } |
| 377 | if (!$input['amount'] = CRM_Utils_Array::value('total_amount', $params)) { |
| 378 | $input['amount'] = $contribution->total_amount; |
| 379 | } |
| 380 | $input['is_test'] = $contribution->is_test; |
| 381 | $input['net_amount'] = $contribution->net_amount; |
| 382 | if (!empty($input['fee_amount']) && !empty($input['amount'])) { |
| 383 | $input['net_amount'] = $input['amount'] - $input['fee_amount']; |
| 384 | } |
| 385 | |
| 386 | //complete the contribution. |
| 387 | // @todo use the api - ie civicrm_api3('Contribution', 'completetransaction', $input); |
| 388 | // as this method is not preferred / supported. |
| 389 | CRM_Contribute_BAO_Contribution::completeOrder($input, [ |
| 390 | 'related_contact' => $ids['related_contact'] ?? NULL, |
| 391 | 'participant' => !empty($objects['participant']) ? $objects['participant']->id : NULL, |
| 392 | 'contributionRecur' => NULL, |
| 393 | ], $objects); |
| 394 | |
| 395 | // reset template values before processing next transactions |
| 396 | $template->clearTemplateVars(); |
| 397 | } |
| 398 | |
| 399 | /** |
| 400 | * Assign the minimal set of variables to the template. |
| 401 | */ |
| 402 | public function assignToTemplate() { |
| 403 | $notifyingStatuses = ['Pending from waitlist', 'Pending from approval', 'Expired', 'Cancelled']; |
| 404 | $notifyingStatuses = array_intersect($notifyingStatuses, CRM_Event_PseudoConstant::participantStatus()); |
| 405 | $this->assign('status', TRUE); |
| 406 | if (!empty($notifyingStatuses)) { |
| 407 | $s = '<em>' . implode('</em>, <em>', $notifyingStatuses) . '</em>'; |
| 408 | $this->assign('notifyingStatuses', $s); |
| 409 | } |
| 410 | } |
| 411 | |
| 412 | /** |
| 413 | * @param array $params |
| 414 | * |
| 415 | * @throws \CRM_Core_Exception |
| 416 | * @throws \CiviCRM_API3_Exception |
| 417 | */ |
| 418 | public function submit($params) { |
| 419 | $statusClasses = CRM_Event_PseudoConstant::participantStatusClass(); |
| 420 | if (isset($params['field'])) { |
| 421 | foreach ($params['field'] as $participantID => $value) { |
| 422 | |
| 423 | //check for custom data |
| 424 | $value['custom'] = CRM_Core_BAO_CustomField::postProcess($value, |
| 425 | $participantID, |
| 426 | 'Participant' |
| 427 | ); |
| 428 | foreach (array_keys($value) as $fieldName) { |
| 429 | // Unset the original custom field now that it has been formatting to the 'custom' |
| 430 | // array as it may not be in the right format for the api as is (notably for |
| 431 | // multiple checkbox values). |
| 432 | // @todo extract submit functions on other Batch update classes & |
| 433 | // extend CRM_Event_Form_Task_BatchTest::testSubmit with a data provider to test them. |
| 434 | if (substr($fieldName, 0, 7) === 'custom_') { |
| 435 | unset($value[$fieldName]); |
| 436 | } |
| 437 | } |
| 438 | |
| 439 | $value['id'] = $participantID; |
| 440 | |
| 441 | if (!empty($value['participant_role'])) { |
| 442 | if (is_array($value['participant_role'])) { |
| 443 | $value['role_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($value['participant_role'])); |
| 444 | } |
| 445 | else { |
| 446 | $value['role_id'] = $value['participant_role']; |
| 447 | } |
| 448 | } |
| 449 | |
| 450 | //need to send mail when status change |
| 451 | $statusChange = FALSE; |
| 452 | $relatedStatusChange = FALSE; |
| 453 | if (!empty($value['participant_status'])) { |
| 454 | $value['status_id'] = $value['participant_status']; |
| 455 | $fromStatusId = $this->_fromStatusIds[$participantID] ?? NULL; |
| 456 | if (!$fromStatusId) { |
| 457 | $fromStatusId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $participantID, 'status_id'); |
| 458 | } |
| 459 | |
| 460 | if ($fromStatusId != $value['status_id']) { |
| 461 | $relatedStatusChange = TRUE; |
| 462 | } |
| 463 | if ($statusClasses[$fromStatusId] != $statusClasses[$value['status_id']]) { |
| 464 | $statusChange = TRUE; |
| 465 | } |
| 466 | } |
| 467 | |
| 468 | unset($value['participant_status']); |
| 469 | |
| 470 | civicrm_api3('Participant', 'create', $value); |
| 471 | |
| 472 | //need to trigger mails when we change status |
| 473 | if ($statusChange) { |
| 474 | CRM_Event_BAO_Participant::transitionParticipants([$participantID], $value['status_id'], $fromStatusId); |
| 475 | } |
| 476 | if ($relatedStatusChange && $participantID && $value['status_id']) { |
| 477 | //update related contribution status, CRM-4395 |
| 478 | self::updatePendingOnlineContribution((int) $participantID, $value['status_id']); |
| 479 | } |
| 480 | } |
| 481 | CRM_Core_Session::setStatus(ts('The updates have been saved.'), ts('Saved'), 'success'); |
| 482 | } |
| 483 | else { |
| 484 | CRM_Core_Session::setStatus(ts('No updates have been saved.'), ts('Not Saved'), 'alert'); |
| 485 | } |
| 486 | } |
| 487 | |
| 488 | } |