3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Event_BAO_Event
extends CRM_Event_DAO_Event
{
20 * Retrieve DB object and copy to defaults array.
22 * @param array $params
23 * Array of criteria values.
24 * @param array $defaults
25 * Array to be populated with found values.
28 * The DAO object, if found.
32 public static function retrieve($params, &$defaults) {
33 return self
::commonRetrieve(self
::class, $params, $defaults);
37 * Update the is_active flag in the db.
40 * Id of the database record.
41 * @param bool $is_active
42 * Value we want to set the is_active field.
45 * true if we found and updated the object, else false
47 public static function setIsActive($id, $is_active) {
48 return CRM_Core_DAO
::setFieldValue('CRM_Event_DAO_Event', $id, 'is_active', $is_active);
54 * @param array $params
55 * Reference array contains the values submitted by the form.
57 * @return CRM_Event_DAO_Event
59 public static function add(&$params) {
60 $financialTypeId = NULL;
61 if (!empty($params['id'])) {
62 CRM_Utils_Hook
::pre('edit', 'Event', $params['id'], $params);
63 if (empty($params['skipFinancialType'])) {
64 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['id'], 'financial_type_id');
68 CRM_Utils_Hook
::pre('create', 'Event', NULL, $params);
71 $event = new CRM_Event_DAO_Event();
73 $event->copyValues($params);
74 $result = $event->save();
76 if (!empty($params['id'])) {
77 CRM_Utils_Hook
::post('edit', 'Event', $event->id
, $event);
80 CRM_Utils_Hook
::post('create', 'Event', $event->id
, $event);
82 if ($financialTypeId && !empty($params['financial_type_id']) && $financialTypeId != $params['financial_type_id']) {
83 CRM_Price_BAO_PriceFieldValue
::updateFinancialType($params['id'], 'civicrm_event', $params['financial_type_id']);
91 * @param array $params
92 * Reference array contains the values submitted by the form.
96 public static function create(&$params) {
97 $transaction = new CRM_Core_Transaction();
98 if (empty($params['is_template'])) {
99 $params['is_template'] = 0;
101 // check if new event, if so set the created_id (if not set)
102 // and always set created_date to now
103 if (empty($params['id'])) {
104 if (empty($params['created_id'])) {
105 $session = CRM_Core_Session
::singleton();
106 $params['created_id'] = $session->get('userID');
108 $params['created_date'] = date('YmdHis');
110 // Clone from template
111 if (!empty($params['template_id'])) {
112 $copy = self
::copy($params['template_id']);
113 $params['id'] = $copy->id
;
114 unset($params['template_id']);
118 $event = self
::add($params);
119 CRM_Price_BAO_PriceSet
::setPriceSets($params, $event, 'event');
120 if (is_a($event, 'CRM_Core_Error')) {
121 CRM_Core_DAO
::transaction('ROLLBACK');
125 $contactId = CRM_Core_Session
::getLoggedInContactID();
127 $contactId = $params['contact_id'] ??
NULL;
130 // Log the information on successful add/edit of Event
132 'entity_table' => 'civicrm_event',
133 'entity_id' => $event->id
,
134 'modified_id' => $contactId,
135 'modified_date' => date('Ymd'),
138 CRM_Core_BAO_Log
::add($logParams);
140 if (!empty($params['custom']) &&
141 is_array($params['custom'])
143 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_event', $event->id
);
146 $transaction->commit();
147 if (!empty($params['id'])) {
148 // Note that this will specifically clear cached event tokens.
149 Civi
::cache('metadata')->clear();
162 public static function del($id) {
167 CRM_Utils_Hook
::pre('delete', 'Event', $id);
169 $extends = ['event'];
170 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
171 foreach ($groupTree as $values) {
172 $query = "DELETE FROM %1 WHERE entity_id = %2";
173 CRM_Core_DAO
::executeQuery($query, [
174 1 => [$values['table_name'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
],
175 2 => [$id, 'Integer'],
179 // Clean up references to profiles used by the event (CRM-20935)
181 'module' => 'CiviEvent',
182 'entity_table' => 'civicrm_event',
185 CRM_Core_BAO_UFJoin
::deleteAll($ufJoinParams);
187 'module' => 'CiviEvent_Additional',
188 'entity_table' => 'civicrm_event',
191 CRM_Core_BAO_UFJoin
::deleteAll($ufJoinParams);
193 // price set cleanup, CRM-5527
194 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_event', $id);
196 $event = new CRM_Event_DAO_Event();
199 if ($event->find(TRUE)) {
200 $locBlockId = $event->loc_block_id
;
201 $result = $event->delete();
203 if (!is_null($locBlockId)) {
204 self
::deleteEventLocBlock($locBlockId, $id);
207 CRM_Utils_Hook
::post('delete', 'Event', $id, $event);
215 * Delete the location block associated with an event.
217 * Function checks that it is not being used by any other event.
219 * @param int $locBlockId
220 * Location block id to be deleted.
221 * @param int $eventId
222 * Event with which loc block is associated.
224 public static function deleteEventLocBlock($locBlockId, $eventId = NULL) {
225 $query = "SELECT count(ce.id) FROM civicrm_event ce WHERE ce.loc_block_id = $locBlockId";
228 $query .= " AND ce.id != $eventId;";
231 $locCount = CRM_Core_DAO
::singleValueQuery($query);
233 if ($locCount == 0) {
234 CRM_Core_BAO_Location
::deleteLocBlock($locBlockId);
239 * Get current/future Events.
242 * 0 returns current and future events.
243 * 1 if events all are required
244 * 2 returns events since 3 months ago
245 * @param int|array $id single int event id or array of multiple event ids to return
246 * @param bool $isActive
247 * true if you need only active events.
248 * @param bool $checkPermission
249 * true if you need to check permission else false.
250 * @param bool $titleOnly
251 * true if you need only title not appended with start date
255 public static function getEvents(
259 $checkPermission = TRUE,
263 SELECT `id`, `title`, `start_date`
265 WHERE ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )";
268 $op = is_array($id) ?
'IN' : '=';
269 $where = CRM_Contact_BAO_Query
::buildClause('id', $op, $id);
270 $query .= " AND {$where}";
273 // find only events ending in the future
274 $endDate = date('YmdHis');
276 AND ( `end_date` >= {$endDate} OR
278 ( end_date IS NULL OR end_date = '' ) AND start_date >= {$endDate}
283 // find only events starting in the last 3 months
284 $startDate = date('YmdHis', strtotime('3 months ago'));
285 $query .= " AND ( `start_date` >= {$startDate} OR start_date IS NULL )";
288 $query .= " AND civicrm_event.is_active = 1";
291 $query .= " ORDER BY title asc";
294 $dao = CRM_Core_DAO
::executeQuery($query);
295 while ($dao->fetch()) {
296 if ((!$checkPermission ||
297 CRM_Event_BAO_Event
::checkPermission($dao->id
)
301 $events[$dao->id
] = $dao->title
;
303 $events[$dao->id
] .= ' - ' . CRM_Utils_Date
::customFormat($dao->start_date
);
312 * Get events Summary.
315 * Array of event summary values
317 * @throws \CiviCRM_API3_Exception
319 public static function getEventSummary() {
320 $eventSummary = $eventIds = [];
321 $config = CRM_Core_Config
::singleton();
323 // get permission and include them here
324 // does not scale, but rearranging code for now
325 // FIXME in a future release
326 $permissions = self
::getAllPermissions();
328 if (empty($permissions[CRM_Core_Permission
::VIEW
])) {
329 $eventSummary['total_events'] = 0;
330 return $eventSummary;
333 $validEventIDs = " AND civicrm_event.id IN ( " . implode(',', array_values($permissions[CRM_Core_Permission
::VIEW
])) . " ) ";
336 // We're fetching recent and upcoming events (where start date is 7 days ago OR later)
338 SELECT count(id) as total_events
340 WHERE civicrm_event.is_active = 1 AND
341 ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0) AND
342 civicrm_event.start_date >= DATE_SUB( NOW(), INTERVAL 7 day )
345 $dao = CRM_Core_DAO
::executeQuery($query);
348 $eventSummary['total_events'] = $dao->total_events
;
351 if (empty($eventSummary) ||
352 $dao->total_events
== 0
354 return $eventSummary;
357 //get the participant status type values.
358 $cpstObject = new CRM_Event_DAO_ParticipantStatusType();
359 $cpst = $cpstObject->getTableName();
360 $query = "SELECT id, name, label, class FROM $cpst";
361 $status = CRM_Core_DAO
::executeQuery($query);
363 while ($status->fetch()) {
364 $statusValues[$status->id
]['id'] = $status->id
;
365 $statusValues[$status->id
]['name'] = $status->name
;
366 $statusValues[$status->id
]['label'] = $status->label
;
367 $statusValues[$status->id
]['class'] = $status->class;
370 // Get the Id of Option Group for Event Types
371 $optionGroupDAO = new CRM_Core_DAO_OptionGroup();
372 $optionGroupDAO->name
= 'event_type';
373 $optionGroupId = NULL;
374 if ($optionGroupDAO->find(TRUE)) {
375 $optionGroupId = $optionGroupDAO->id
;
377 // Get the event summary display preferences
378 $show_max_events = Civi
::settings()->get('show_events');
379 // show all events if show_events is set to a negative value
380 if (isset($show_max_events) && $show_max_events >= 0) {
381 $event_summary_limit = "LIMIT 0, $show_max_events";
384 $event_summary_limit = "";
388 SELECT civicrm_event.id as id, civicrm_event.title as event_title, civicrm_event.is_public as is_public,
389 civicrm_event.max_participants as max_participants, civicrm_event.start_date as start_date,
390 civicrm_event.end_date as end_date, civicrm_event.is_online_registration, civicrm_event.is_monetary, civicrm_event.is_show_location,civicrm_event.is_map as is_map, civicrm_option_value.label as event_type, civicrm_tell_friend.is_active as is_friend_active,
391 civicrm_event.slot_label_id,
392 civicrm_event.summary as summary,
393 civicrm_pcp_block.id as is_pcp_enabled,
394 civicrm_recurring_entity.parent_id as is_repeating_event
396 LEFT JOIN civicrm_option_value ON (
397 civicrm_event.event_type_id = civicrm_option_value.value AND
398 civicrm_option_value.option_group_id = %1 )
399 LEFT JOIN civicrm_tell_friend ON ( civicrm_tell_friend.entity_id = civicrm_event.id AND civicrm_tell_friend.entity_table = 'civicrm_event' )
400 LEFT JOIN civicrm_pcp_block ON ( civicrm_pcp_block.entity_id = civicrm_event.id AND civicrm_pcp_block.entity_table = 'civicrm_event')
401 LEFT JOIN civicrm_recurring_entity ON ( civicrm_event.id = civicrm_recurring_entity.entity_id AND civicrm_recurring_entity.entity_table = 'civicrm_event' )
402 WHERE civicrm_event.is_active = 1 AND
403 ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0) AND
404 civicrm_event.start_date >= DATE_SUB( NOW(), INTERVAL 7 day )
406 ORDER BY civicrm_event.start_date ASC
409 $eventParticipant = [];
413 'eventTitle' => 'event_title',
414 'isPublic' => 'is_public',
415 'maxParticipants' => 'max_participants',
416 'startDate' => 'start_date',
417 'endDate' => 'end_date',
418 'eventType' => 'event_type',
420 'participants' => 'participants',
421 'notCountedDueToRole' => 'notCountedDueToRole',
422 'notCountedDueToStatus' => 'notCountedDueToStatus',
423 'notCountedParticipants' => 'notCountedParticipants',
426 $params = [1 => [$optionGroupId, 'Integer']];
427 $mapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings([
428 'id' => CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
,
430 $dao = CRM_Core_DAO
::executeQuery($query, $params);
431 while ($dao->fetch()) {
432 foreach ($properties as $property => $name) {
442 $eventSummary['events'][$dao->id
][$property] = $set;
446 if ($dao->$name && $config->mapAPIKey
) {
449 $params = ['entity_id' => $dao->id
, 'entity_table' => 'civicrm_event'];
450 $values['location'] = CRM_Core_BAO_Location
::getValues($params, TRUE);
451 if (is_numeric(CRM_Utils_Array
::value('geo_code_1', $values['location']['address'][1])) ||
453 !empty($values['location']['address'][1]['city']) &&
454 !empty($values['location']['address'][1]['state_province_id'])
457 $set = CRM_Utils_System
::url('civicrm/contact/map/event', "reset=1&eid={$dao->id}");
461 $eventSummary['events'][$dao->id
][$property] = $set;
462 if (is_array($permissions[CRM_Core_Permission
::EDIT
])
463 && in_array($dao->id
, $permissions[CRM_Core_Permission
::EDIT
])) {
464 $eventSummary['events'][$dao->id
]['configure'] = CRM_Utils_System
::url('civicrm/admin/event', "action=update&id=$dao->id&reset=1");
470 $eventSummary['events'][$dao->id
][$property] = CRM_Utils_Date
::customFormat($dao->$name,
476 case 'notCountedDueToRole':
477 case 'notCountedDueToStatus':
478 case 'notCountedParticipants':
481 if ($name == 'participants') {
482 $propertyCnt = self
::getParticipantCount($dao->id
);
484 $set = CRM_Utils_System
::url('civicrm/event/search',
485 "reset=1&force=1&event=$dao->id&status=true&role=true"
489 elseif ($name == 'notCountedParticipants') {
490 $propertyCnt = self
::getParticipantCount($dao->id
, TRUE, FALSE, TRUE, FALSE);
492 // FIXME : selector fail to search w/ OR operator.
493 // $set = CRM_Utils_System::url( 'civicrm/event/search',
494 // "reset=1&force=1&event=$dao->id&status=false&role=false" );
497 elseif ($name == 'notCountedDueToStatus') {
498 $propertyCnt = self
::getParticipantCount($dao->id
, TRUE, FALSE, FALSE, FALSE);
500 $set = CRM_Utils_System
::url('civicrm/event/search',
501 "reset=1&force=1&event=$dao->id&status=false"
506 $propertyCnt = self
::getParticipantCount($dao->id
, FALSE, FALSE, TRUE, FALSE);
508 $set = CRM_Utils_System
::url('civicrm/event/search',
509 "reset=1&force=1&event=$dao->id&role=false"
514 $eventSummary['events'][$dao->id
][$property] = $propertyCnt;
515 $eventSummary['events'][$dao->id
][$name . '_url'] = $set;
519 $eventSummary['events'][$dao->id
][$property] = $dao->$name;
524 // prepare the area for per-status participant counts
525 $statusClasses = ['Positive', 'Pending', 'Waiting', 'Negative'];
526 $eventSummary['events'][$dao->id
]['statuses'] = array_fill_keys($statusClasses, []);
528 $eventSummary['events'][$dao->id
]['friend'] = $dao->is_friend_active
;
529 $eventSummary['events'][$dao->id
]['is_monetary'] = $dao->is_monetary
;
530 $eventSummary['events'][$dao->id
]['is_online_registration'] = $dao->is_online_registration
;
531 $eventSummary['events'][$dao->id
]['is_show_location'] = $dao->is_show_location
;
532 $eventSummary['events'][$dao->id
]['is_subevent'] = $dao->slot_label_id
;
533 $eventSummary['events'][$dao->id
]['is_pcp_enabled'] = $dao->is_pcp_enabled
;
534 $eventSummary['events'][$dao->id
]['reminder'] = CRM_Core_BAO_ActionSchedule
::isConfigured($dao->id
, $mapping->getId());
535 $eventSummary['events'][$dao->id
]['is_repeating_event'] = $dao->is_repeating_event
;
537 $statusTypes = CRM_Event_PseudoConstant
::participantStatus();
538 foreach ($statusValues as $statusId => $statusValue) {
539 if (!array_key_exists($statusId, $statusTypes)) {
542 $class = $statusValue['class'];
543 $statusCount = self
::eventTotalSeats($dao->id
, "( participant.status_id = {$statusId} )");
545 $urlString = "reset=1&force=1&event={$dao->id}&status=$statusId";
547 'url' => CRM_Utils_System
::url('civicrm/event/search', $urlString),
548 'name' => $statusValue['name'],
549 'label' => $statusValue['label'],
550 'count' => $statusCount,
552 $eventSummary['events'][$dao->id
]['statuses'][$class][] = $statusInfo;
557 $countedRoles = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
558 $nonCountedRoles = CRM_Event_PseudoConstant
::participantRole(NULL, '( filter = 0 OR filter IS NULL )');
559 $countedStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
560 $nonCountedStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, '( is_counted = 0 OR is_counted IS NULL )');
562 $countedStatusANDRoles = array_merge($countedStatus, $countedRoles);
563 $nonCountedStatusANDRoles = array_merge($nonCountedStatus, $nonCountedRoles);
565 $eventSummary['nonCountedRoles'] = implode('/', array_values($nonCountedRoles));
566 $eventSummary['nonCountedStatus'] = implode('/', array_values($nonCountedStatus));
567 $eventSummary['countedStatusANDRoles'] = implode('/', array_values($countedStatusANDRoles));
568 $eventSummary['nonCountedStatusANDRoles'] = implode('/', array_values($nonCountedStatusANDRoles));
570 return $eventSummary;
574 * Get participant count.
576 * @param int $eventId
577 * @param bool $considerStatus consider status for participant count.
578 * Consider status for participant count.
579 * @param bool $status counted participant.
580 * Consider counted participant.
581 * @param bool $considerRole consider role for participant count.
582 * Consider role for participant count.
583 * @param bool $role consider counted( is filter role) participant.
584 * Consider counted( is filter role) participant.
587 * array with count of participants for each event based on status/role
589 public static function getParticipantCount(
591 $considerStatus = TRUE,
593 $considerRole = TRUE,
597 // consider both role and status for counted participants, CRM-4924.
599 // not counted participant.
600 if ($considerStatus && $considerRole && !$status && !$role) {
604 if ($considerStatus) {
605 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
606 $statusClause = 'NOT IN';
608 $statusClause = 'IN';
610 $status = implode(',', array_keys($statusTypes));
611 if (empty($status)) {
614 $clause[] = "participant.status_id {$statusClause} ( {$status} ) ";
618 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
619 $roleClause = 'NOT IN';
624 if (!empty($roleTypes)) {
626 foreach (array_keys($roleTypes) as $roleType) {
627 $escapedRoles[] = CRM_Utils_Type
::escape($roleType, 'String');
630 $clause[] = "participant.role_id {$roleClause} ( '" . implode("', '", $escapedRoles) . "' ) ";
635 if (!empty($clause)) {
636 $sqlClause = ' ( ' . implode($operator, $clause) . ' )';
639 return self
::eventTotalSeats($eventId, $sqlClause);
643 * Get the information to map an event.
646 * For which we want map info.
650 public static function &getMapInfo(&$id) {
654 civicrm_event.id AS event_id,
655 civicrm_event.title AS display_name,
656 civicrm_address.street_address AS street_address,
657 civicrm_address.city AS city,
658 civicrm_address.postal_code AS postal_code,
659 civicrm_address.postal_code_suffix AS postal_code_suffix,
660 civicrm_address.geo_code_1 AS latitude,
661 civicrm_address.geo_code_2 AS longitude,
662 civicrm_state_province.abbreviation AS state,
663 civicrm_country.name AS country,
664 civicrm_location_type.name AS location_type
667 LEFT JOIN civicrm_loc_block ON ( civicrm_event.loc_block_id = civicrm_loc_block.id )
668 LEFT JOIN civicrm_address ON ( civicrm_loc_block.address_id = civicrm_address.id )
669 LEFT JOIN civicrm_state_province ON ( civicrm_address.state_province_id = civicrm_state_province.id )
670 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
671 LEFT JOIN civicrm_location_type ON ( civicrm_location_type.id = civicrm_address.location_type_id )
672 WHERE civicrm_address.geo_code_1 IS NOT NULL
673 AND civicrm_address.geo_code_2 IS NOT NULL
674 AND civicrm_event.id = " . CRM_Utils_Type
::escape($id, 'Integer');
676 $dao = new CRM_Core_DAO();
681 $config = CRM_Core_Config
::singleton();
683 while ($dao->fetch()) {
686 $location['displayName'] = addslashes($dao->display_name
);
687 $location['lat'] = $dao->latitude
;
688 $location['marker_class'] = 'Event';
689 $location['lng'] = $dao->longitude
;
691 $params = ['entity_id' => $id, 'entity_table' => 'civicrm_event'];
692 $addressValues = CRM_Core_BAO_Location
::getValues($params, TRUE);
693 $location['address'] = str_replace([
696 ], '', addslashes(nl2br($addressValues['address'][1]['display_text'])));
698 $location['url'] = CRM_Utils_System
::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id
);
699 $location['location_type'] = $dao->location_type
;
700 $eventImage = '<img src="' . $config->resourceBase
. 'i/contact_org.gif" alt="Organization " height="20" width="15" />';
701 $location['image'] = $eventImage;
702 $location['displayAddress'] = str_replace('<br />', ', ', $location['address']);
703 $locations[] = $location;
709 * Get the complete information for one or more events.
712 * Get events with start date >= this date.
713 * @param int $type Get events on the a specific event type (by event_type_id).
714 * Get events on the a specific event type (by event_type_id).
715 * @param int $eventId Return a single event - by event id.
716 * Return a single event - by event id.
718 * Also get events with end date >= this date.
719 * @param bool $onlyPublic Include public events only, default TRUE.
720 * Include public events only, default TRUE.
723 * array of all the events that are searched
725 public static function getCompleteInfo(
732 $publicCondition = NULL;
734 $publicCondition = " AND civicrm_event.is_public = 1";
738 // if start and end date are NOT passed, return all events with start_date OR end_date >= today CRM-5133
740 // get events with start_date >= requested start
741 $startDate = CRM_Utils_Type
::escape($start, 'Date');
742 $dateCondition .= " AND ( civicrm_event.start_date >= {$startDate} )";
746 // also get events with end_date <= requested end
747 $endDate = CRM_Utils_Type
::escape($end, 'Date');
748 $dateCondition .= " AND ( civicrm_event.end_date <= '{$endDate}' ) ";
751 // CRM-9421 and CRM-8620 Default mode for ical/rss feeds. No start or end filter passed.
752 // Need to exclude old events with only start date
753 // and not exclude events in progress (start <= today and end >= today). DGG
754 if (empty($start) && empty($end)) {
755 // get events with end date >= today, not sure of this logic
756 // but keeping this for backward compatibility as per issue CRM-5133
757 $today = date("Y-m-d G:i:s");
758 $dateCondition .= " AND ( civicrm_event.end_date >= '{$today}' OR civicrm_event.start_date >= '{$today}' ) ";
762 $typeCondition = " AND civicrm_event.event_type_id = " . CRM_Utils_Type
::escape($type, 'Integer');
765 // Get the Id of Option Group for Event Types
766 $optionGroupDAO = new CRM_Core_DAO_OptionGroup();
767 $optionGroupDAO->name
= 'event_type';
768 $optionGroupId = NULL;
769 if ($optionGroupDAO->find(TRUE)) {
770 $optionGroupId = $optionGroupDAO->id
;
775 civicrm_event.id as event_id,
776 civicrm_email.email as email,
777 civicrm_event.title as title,
778 civicrm_event.summary as summary,
779 civicrm_event.start_date as start,
780 civicrm_event.end_date as end,
781 civicrm_event.description as description,
782 civicrm_event.is_show_location as is_show_location,
783 civicrm_event.is_online_registration as is_online_registration,
784 civicrm_event.registration_link_text as registration_link_text,
785 civicrm_event.registration_start_date as registration_start_date,
786 civicrm_event.registration_end_date as registration_end_date,
787 civicrm_option_value.label as event_type,
788 civicrm_address.name as address_name,
789 civicrm_address.street_address as street_address,
790 civicrm_address.supplemental_address_1 as supplemental_address_1,
791 civicrm_address.supplemental_address_2 as supplemental_address_2,
792 civicrm_address.supplemental_address_3 as supplemental_address_3,
793 civicrm_address.city as city,
794 civicrm_address.postal_code as postal_code,
795 civicrm_address.postal_code_suffix as postal_code_suffix,
796 civicrm_state_province.abbreviation as state,
797 civicrm_country.name AS country
799 LEFT JOIN civicrm_loc_block ON civicrm_event.loc_block_id = civicrm_loc_block.id
800 LEFT JOIN civicrm_address ON civicrm_loc_block.address_id = civicrm_address.id
801 LEFT JOIN civicrm_state_province ON civicrm_address.state_province_id = civicrm_state_province.id
802 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
803 LEFT JOIN civicrm_email ON civicrm_loc_block.email_id = civicrm_email.id
804 LEFT JOIN civicrm_option_value ON (
805 civicrm_event.event_type_id = civicrm_option_value.value AND
806 civicrm_option_value.option_group_id = %1 )
807 WHERE civicrm_event.is_active = 1
808 AND (is_template = 0 OR is_template IS NULL)
812 if (isset($typeCondition)) {
813 $query .= $typeCondition;
816 if (isset($eventId)) {
817 $query .= " AND civicrm_event.id =$eventId ";
819 $query .= " ORDER BY civicrm_event.start_date ASC";
821 $params = [1 => [$optionGroupId, 'Integer']];
822 $dao = CRM_Core_DAO
::executeQuery($query, $params);
824 $config = CRM_Core_Config
::singleton();
826 $baseURL = parse_url($config->userFrameworkBaseURL
);
827 $url = "@" . $baseURL['host'];
828 if (!empty($baseURL['path'])) {
829 $url .= substr($baseURL['path'], 0, -1);
832 // check 'view event info' permission
833 //@todo - per CRM-14626 we have resolved that 'view event info' means 'view ALL event info'
834 if (CRM_Core_Permission
::check('view event info')) {
838 $permissions = CRM_Core_Permission
::event(CRM_Core_Permission
::VIEW
);
841 while ($dao->fetch()) {
842 if (!empty($permissions) && ($permissions === TRUE ||
in_array($dao->event_id
, $permissions))) {
844 $info['uid'] = "CiviCRM_EventID_{$dao->event_id}_" . md5($config->userFrameworkBaseURL
) . $url;
846 $info['title'] = $dao->title
;
847 $info['event_id'] = $dao->event_id
;
848 $info['summary'] = $dao->summary
;
849 $info['description'] = $dao->description
;
850 $info['start_date'] = $dao->start
;
851 $info['end_date'] = $dao->end
;
852 $info['contact_email'] = $dao->email
;
853 $info['event_type'] = $dao->event_type
;
854 $info['is_show_location'] = $dao->is_show_location
;
855 $info['is_online_registration'] = $dao->is_online_registration
;
856 $info['registration_link_text'] = $dao->registration_link_text
;
857 $info['registration_start_date'] = $dao->registration_start_date
;
858 $info['registration_end_date'] = $dao->registration_end_date
;
863 'address_name' => $dao->address_name
,
864 'street_address' => $dao->street_address
,
865 'supplemental_address_1' => $dao->supplemental_address_1
,
866 'supplemental_address_2' => $dao->supplemental_address_2
,
867 'supplemental_address_3' => $dao->supplemental_address_3
,
868 'city' => $dao->city
,
869 'state_province' => $dao->state
,
870 'postal_code' => $dao->postal_code
,
871 'postal_code_suffix' => $dao->postal_code_suffix
,
872 'country' => $dao->country
,
876 CRM_Utils_String
::append($address, ', ',
877 CRM_Utils_Address
::format($addrFields)
879 $info['location'] = $address;
880 $info['url'] = CRM_Utils_System
::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id
, TRUE, NULL, FALSE);
882 // @todo Move to eventcart extension
883 // check if we're in shopping cart mode for events
884 if ((bool) Civi
::settings()->get('enable_cart')) {
885 $reg = CRM_Event_Cart_BAO_EventInCart
::get_registration_link($dao->event_id
);
886 $info['registration_link'] = CRM_Utils_System
::url($reg['path'], $reg['query'], TRUE);
887 $info['registration_link_text'] = $reg['label'];
898 * Make a copy of a Event.
900 * Include all the fields in the event Wizard.
903 * The event id to copy.
904 * @param array $params
906 * @return CRM_Event_DAO_Event
907 * @throws \CRM_Core_Exception
909 public static function copy($id, $params = []) {
910 $session = CRM_Core_Session
::singleton();
913 //get the required event values.
914 $eventParams = ['id' => $id];
915 $returnProperties = [
919 'default_discount_fee_id',
923 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event', $eventParams, $eventValues, $returnProperties);
927 'title' => ts('Copy of') . ' ',
930 'created_id' => $session->get('userID'),
931 'created_date' => date('YmdHis'),
934 if (empty($eventValues['is_show_location'])) {
935 $fieldsFix['prefix']['is_show_location'] = 0;
938 $blockCopyOfCustomValue = (!empty($params['custom']));
940 /** @var \CRM_Event_DAO_Event $copyEvent */
941 $copyEvent = CRM_Core_DAO
::copyGeneric('CRM_Event_DAO_Event',
943 // since the location is sharable, lets use the same loc_block_id.
944 ['loc_block_id' => CRM_Utils_Array
::value('loc_block_id', $eventValues)] +
$params,
947 $blockCopyOfCustomValue
949 CRM_Price_BAO_PriceSet
::copyPriceSet('civicrm_event', $id, $copyEvent->id
);
950 CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
953 'entity_table' => 'civicrm_event',
955 ['entity_id' => $copyEvent->id
]
958 CRM_Core_DAO
::copyGeneric('CRM_Friend_DAO_Friend',
961 'entity_table' => 'civicrm_event',
963 ['entity_id' => $copyEvent->id
]
966 CRM_Core_DAO
::copyGeneric('CRM_PCP_DAO_PCPBlock',
969 'entity_table' => 'civicrm_event',
971 ['entity_id' => $copyEvent->id
],
972 ['replace' => ['target_entity_id' => $copyEvent->id
]]
975 $oldMapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings([
976 'id' => ($eventValues['is_template'] ? CRM_Event_ActionMapping
::EVENT_TPL_MAPPING_ID
: CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
),
978 $copyMapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings([
979 'id' => ($copyEvent->is_template
== 1 ? CRM_Event_ActionMapping
::EVENT_TPL_MAPPING_ID
: CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
),
981 CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_ActionSchedule',
982 ['entity_value' => $id, 'mapping_id' => $oldMapping->getId()],
983 ['entity_value' => $copyEvent->id
, 'mapping_id' => $copyMapping->getId()]
988 if ($blockCopyOfCustomValue) {
989 foreach ($params['custom'] as &$values) {
990 foreach ($values as &$value) {
991 // Ensure we don't copy over the template's id if it is passed in
992 // This is a bit hacky but it's unclear what the
993 // right behaviour is given the whole 'custom'
994 // field is form layer formatting that is reaching the BAO.
998 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_event', $copyEvent->id
);
1001 CRM_Utils_System
::flushCache();
1002 CRM_Utils_Hook
::copy('Event', $copyEvent);
1008 * This is sometimes called in a loop (during event search).
1010 * We cache the values to prevent repeated calls to the db.
1016 public static function isMonetary($id) {
1017 static $isMonetary = [];
1018 if (!array_key_exists($id, $isMonetary)) {
1019 $isMonetary[$id] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event',
1024 return $isMonetary[$id];
1028 * This is sometimes called in a loop (during event search).
1030 * We cache the values to prevent repeated calls to the db.
1036 public static function usesPriceSet($id) {
1037 static $usesPriceSet = [];
1038 if (!array_key_exists($id, $usesPriceSet)) {
1039 $usesPriceSet[$id] = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $id);
1041 return $usesPriceSet[$id];
1047 * @param int $contactID
1048 * @param array $values
1049 * @param int $participantId
1050 * @param bool $isTest
1051 * @param bool $returnMessageText
1053 * @return array|null
1054 * @throws \CiviCRM_API3_Exception
1056 public static function sendMail($contactID, $values, $participantId, $isTest = FALSE, $returnMessageText = FALSE) {
1058 $template = CRM_Core_Smarty
::singleton();
1060 'custom_pre_id' => $values['custom_pre_id'],
1061 'custom_post_id' => $values['custom_post_id'],
1064 //get the params submitted by participant.
1065 $participantParams = CRM_Utils_Array
::value($participantId, $values['params'], []);
1067 if (!$returnMessageText) {
1068 //send notification email if field values are set (CRM-1941)
1069 foreach ($gIds as $key => $gIdValues) {
1071 if (!is_array($gIdValues)) {
1072 $gIdValues = [$gIdValues];
1075 foreach ($gIdValues as $gId) {
1076 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
1078 //get values of corresponding profile fields for notification
1079 [$profileValues] = self
::buildCustomDisplay($gId,
1088 [$profileValues] = $profileValues;
1091 'values' => $profileValues,
1094 CRM_Core_BAO_UFGroup
::commonSendMail($contactID, $val);
1101 if ($values['event']['is_email_confirm'] ||
$returnMessageText) {
1102 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
1103 $notifyEmail = CRM_Utils_Array
::valueByRegexKey('/^email-/', $participantParams) ??
$email;
1104 //send email only when email is present
1105 if (isset($notifyEmail) ||
$returnMessageText) {
1106 $preProfileID = $values['custom_pre_id'] ??
NULL;
1107 $postProfileID = $values['custom_post_id'] ??
NULL;
1109 if (!empty($values['params']['additionalParticipant'])) {
1110 $preProfileID = CRM_Utils_Array
::value('additional_custom_pre_id', $values, $preProfileID);
1111 $postProfileID = CRM_Utils_Array
::value('additional_custom_post_id', $values, $postProfileID);
1114 $profilePre = self
::buildCustomDisplay($preProfileID,
1124 $profilePost = self
::buildCustomDisplay($postProfileID,
1134 $sessions = CRM_Event_Cart_BAO_Conference
::get_participant_sessions($participantId);
1136 // @todo - the goal is that all params available to the message template are explicitly defined here rather than
1137 // 'in a smattering of places'. Note that leakage can happen between mailings when not explicitly defined.
1138 if ($postProfileID) {
1139 $customPostTitles = empty($profilePost[1]) ?
NULL : [];
1140 foreach ($postProfileID as $offset => $id) {
1141 $customPostTitles[$offset] = CRM_Core_BAO_UFGroup
::getFrontEndTitle((int) $id);
1145 $customPostTitles = NULL;
1147 $tplParams = array_merge($values, $participantParams, [
1148 'email' => $notifyEmail,
1149 'confirm_email_text' => $values['event']['confirm_email_text'] ??
NULL,
1150 'isShowLocation' => $values['event']['is_show_location'] ??
NULL,
1151 // The concept of contributeMode is deprecated.
1152 'contributeMode' => $template->_tpl_vars
['contributeMode'] ??
NULL,
1153 'customPre' => $profilePre[0],
1154 'customPre_grouptitle' => empty($profilePre[1]) ?
NULL : [CRM_Core_BAO_UFGroup
::getFrontEndTitle((int) $preProfileID)],
1155 'customPost' => $profilePost[0],
1156 'customPost_grouptitle' => $customPostTitles,
1157 'participantID' => $participantId,
1158 'contactID' => $contactID,
1159 'conference_sessions' => $sessions,
1160 'credit_card_number' => CRM_Utils_System
::mungeCreditCard(CRM_Utils_Array
::value('credit_card_number', $participantParams)),
1161 'credit_card_exp_date' => CRM_Utils_Date
::mysqlToIso(CRM_Utils_Date
::format(CRM_Utils_Array
::value('credit_card_exp_date', $participantParams))),
1162 'selfcancelxfer_time' => abs($values['event']['selfcancelxfer_time']),
1163 'selfservice_preposition' => $values['event']['selfcancelxfer_time'] < 0 ?
ts('after') : ts('before'),
1164 'currency' => $values['event']['currency'] ?? CRM_Core_Config
::singleton()->defaultCurrency
,
1167 // CRM-13890 : NOTE wait list condition need to be given so that
1168 // wait list message is shown properly in email i.e. WRT online event registration template
1169 if (empty($tplParams['participant_status']) && empty($values['params']['isOnWaitlist'])) {
1170 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $participantId, 'status_id', 'id', TRUE);
1171 $tplParams['participant_status'] = CRM_Event_PseudoConstant
::participantStatus($statusId, NULL, 'label');
1173 //CRM-15754 - if participant_status contains status ID
1174 elseif (!empty($tplParams['participant_status']) && CRM_Utils_Rule
::integer($tplParams['participant_status'])) {
1175 $tplParams['participant_status'] = CRM_Event_PseudoConstant
::participantStatus($tplParams['participant_status'], NULL, 'label');
1178 $sendTemplateParams = [
1179 'groupName' => 'msg_tpl_workflow_event',
1180 'valueName' => 'event_online_receipt',
1181 'contactId' => $contactID,
1182 'isTest' => $isTest,
1183 'tplParams' => $tplParams,
1184 'PDFFilename' => ts('confirmation') . '.pdf',
1187 // address required during receipt processing (pdf and email receipt)
1188 if ($displayAddress = CRM_Utils_Array
::value('address', $values)) {
1189 $sendTemplateParams['tplParams']['address'] = $displayAddress;
1190 // The concept of contributeMode is deprecated.
1191 $sendTemplateParams['tplParams']['contributeMode'] = NULL;
1194 // set lineItem details
1195 if ($lineItem = CRM_Utils_Array
::value('lineItem', $values)) {
1196 // check if additional participant, if so filter only to relevant ones
1198 if (!empty($values['params']['additionalParticipant'])) {
1200 foreach ($lineItem as $liKey => $liValue) {
1201 $firstElement = array_pop($liValue);
1202 if ($firstElement['entity_id'] == $participantId) {
1203 $ownLineItems[0] = $lineItem[$liKey];
1207 if (!empty($ownLineItems)) {
1208 $sendTemplateParams['tplParams']['lineItem'] = $ownLineItems;
1212 $sendTemplateParams['tplParams']['lineItem'] = $lineItem;
1216 if ($returnMessageText) {
1217 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1219 'subject' => $subject,
1221 'to' => $displayName,
1226 $sendTemplateParams['from'] = CRM_Utils_Array
::value('confirm_from_name', $values['event']) . " <" . CRM_Utils_Array
::value('confirm_from_email', $values['event']) . ">";
1227 $sendTemplateParams['toName'] = $displayName;
1228 $sendTemplateParams['toEmail'] = $notifyEmail;
1229 $sendTemplateParams['autoSubmitted'] = TRUE;
1230 $sendTemplateParams['cc'] = CRM_Utils_Array
::value('cc_confirm',
1233 $sendTemplateParams['bcc'] = CRM_Utils_Array
::value('bcc_confirm',
1237 if (Civi
::settings()->get('invoice_is_email_pdf') && !empty($values['contributionId'])) {
1238 $sendTemplateParams['isEmailPdf'] = TRUE;
1239 $sendTemplateParams['contributionId'] = $values['contributionId'];
1241 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1248 * Add the custom fields OR array of participant's profile info.
1251 * @param string $name
1253 * @param \CRM_Core_Smarty $template
1254 * @param int $participantId
1255 * @param bool $isTest
1256 * @param bool $returnResults
1257 * @param array $participantParams
1259 * @return array|null
1260 * @throws \CRM_Core_Exception
1262 public static function buildCustomDisplay(
1269 $returnResults = FALSE,
1270 $participantParams = []
1273 return [NULL, NULL];
1276 if (!is_array($id)) {
1277 $id = CRM_Utils_Type
::escape($id, 'Positive');
1278 $profileIds = [$id];
1284 $val = $groupTitles = NULL;
1285 foreach ($profileIds as $gid) {
1286 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid)) {
1288 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
,
1289 NULL, NULL, FALSE, NULL,
1290 FALSE, NULL, CRM_Core_Permission
::CREATE
,
1294 //this condition is added, since same contact can have multiple event registrations..
1295 $params = [['participant_id', '=', $participantId, 0, 0]];
1297 //add participant id
1298 $fields['participant_id'] = [
1299 'name' => 'participant_id',
1300 'title' => ts('Participant ID'),
1302 //check whether its a text drive
1304 $params[] = ['participant_test', '=', 1, 0, 0];
1307 //display campaign on thankyou page.
1308 if (array_key_exists('participant_campaign_id', $fields)) {
1309 if ($participantId) {
1310 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1314 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1315 $values[$fields['participant_campaign_id']['title']] = CRM_Utils_Array
::value($campaignId,
1319 unset($fields['participant_campaign_id']);
1323 foreach ($fields as $k => $v) {
1325 $groupTitle = $v['groupDisplayTitle'];
1327 // suppress all file fields from display
1329 CRM_Utils_Array
::value('data_type', $v, '') == 'File' ||
1330 CRM_Utils_Array
::value('name', $v, '') == 'image_URL' ||
1331 CRM_Utils_Array
::value('field_type', $v) == 'Formatting'
1338 $groupTitles[] = $groupTitle;
1340 //display profile groups those are subscribed by participant.
1341 if (($groups = CRM_Utils_Array
::value('group', $participantParams)) &&
1345 foreach ($groups as $grpId => $isSelected) {
1350 if (!empty($grpIds)) {
1351 //get the group titles.
1353 $query = 'SELECT title FROM civicrm_group where id IN ( ' . implode(',', $grpIds) . ' )';
1354 $grp = CRM_Core_DAO
::executeQuery($query);
1355 while ($grp->fetch()) {
1356 $grpTitles[] = $grp->title
;
1358 if (!empty($grpTitles) &&
1359 CRM_Utils_Array
::value('title', CRM_Utils_Array
::value('group', $fields))
1361 $values[$fields['group']['title']] = implode(', ', $grpTitles);
1363 unset($fields['group']);
1367 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params);
1370 //If the event profile includes a note field and the submitted value of
1371 //that field is "", then remove the old note returned by getValues.
1372 if (isset($participantParams['note']) && empty($participantParams['note'])) {
1373 $noteKeyPos = array_search('note', array_keys($fields));
1374 $valuesKeys = array_keys($values);
1375 $values[$valuesKeys[$noteKeyPos]] = "";
1378 if (isset($fields['participant_status_id']['title']) &&
1379 isset($values[$fields['participant_status_id']['title']]) &&
1380 is_numeric($values[$fields['participant_status_id']['title']])
1383 $status = CRM_Event_PseudoConstant
::participantStatus();
1384 $values[$fields['participant_status_id']['title']] = $status[$values[$fields['participant_status_id']['title']]];
1387 if (isset($fields['participant_role_id']['title']) &&
1388 isset($values[$fields['participant_role_id']['title']]) &&
1389 is_numeric($values[$fields['participant_role_id']['title']])
1392 $roles = CRM_Event_PseudoConstant
::participantRole();
1393 $values[$fields['participant_role_id']['title']] = $roles[$values[$fields['participant_role_id']['title']]];
1396 if (isset($fields['participant_register_date']['title']) &&
1397 isset($values[$fields['participant_register_date']['title']])
1399 $values[$fields['participant_register_date']['title']] = CRM_Utils_Date
::customFormat($values[$fields['participant_register_date']['title']]);
1402 //handle fee_level for price set
1403 if (isset($fields['participant_fee_level']['title']) &&
1404 isset($values[$fields['participant_fee_level']['title']])
1406 $feeLevel = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1407 $values[$fields['participant_fee_level']['title']]
1409 foreach ($feeLevel as $key => $value) {
1411 unset($feeLevel[$key]);
1414 $values[$fields['participant_fee_level']['title']] = implode(',', $feeLevel);
1417 unset($values[$fields['participant_id']['title']]);
1424 $template->assign($name, $val);
1427 if (count($groupTitles)) {
1428 $template->assign($name . '_grouptitle', $groupTitles);
1431 //return if we only require array of participant's info.
1432 if ($returnResults) {
1434 return [$val, $groupTitles];
1443 * Build the array for display the profile fields.
1445 * @param array $params
1449 * @param array $groupTitle
1450 * Profile Group Title.
1451 * @param array $values
1452 * Formatted array of key value.
1454 * @param array $profileFields
1456 * @throws \CRM_Core_Exception
1457 * @throws \API_Exception
1458 * @throws \CiviCRM_API3_Exception
1460 public static function displayProfile(&$params, $gid, &$groupTitle, &$values, &$profileFields = []) {
1462 $config = CRM_Core_Config
::singleton();
1463 $session = CRM_Core_Session
::singleton();
1464 $contactID = $session->get('userID');
1466 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $contactID)) {
1467 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
1471 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::ADD
);
1474 if (!empty($fields)) {
1475 $groupTitle['groupTitle'] = CRM_Core_BAO_UFGroup
::getFrontEndTitle((int) $gid);
1478 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
1479 //start of code to set the default values
1480 foreach ($fields as $name => $field) {
1483 // skip fields that should not be displayed separately
1484 if ($field['skipDisplay']) {
1488 $index = $field['title'];
1489 if ($name === 'organization_name') {
1490 $values[$index] = $params[$name];
1493 if ('state_province' == substr($name, 0, 14)) {
1494 if ($params[$name]) {
1495 $values[$index] = CRM_Core_PseudoConstant
::stateProvince($params[$name]);
1498 $values[$index] = '';
1501 elseif ('date' == substr($name, -4)) {
1502 $values[$index] = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::processDate($params[$name]),
1503 $config->dateformatFull
);
1505 elseif ('country' == substr($name, 0, 7)) {
1506 if ($params[$name]) {
1507 $values[$index] = CRM_Core_PseudoConstant
::country($params[$name]);
1510 $values[$index] = '';
1513 elseif ('county' == substr($name, 0, 6)) {
1514 if ($params[$name]) {
1515 $values[$index] = CRM_Core_PseudoConstant
::county($params[$name]);
1518 $values[$index] = '';
1521 elseif (in_array(substr($name, 0, -3), ['gender', 'prefix', 'suffix', 'communication_style'])) {
1522 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', $name, $params[$name]);
1524 elseif (in_array($name, [
1529 $filterCondition = ['greeting_type' => $name];
1530 $greeting = CRM_Core_PseudoConstant
::greeting($filterCondition);
1531 $values[$index] = $greeting[$params[$name]];
1533 elseif ($name === 'preferred_communication_method') {
1534 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1536 $pref = $params[$name];
1537 if (is_array($pref)) {
1538 foreach ($pref as $k => $v) {
1540 $compref[] = $communicationFields[$k];
1544 $values[$index] = implode(',', $compref);
1546 elseif ($name == 'contact_sub_type') {
1547 $values[$index] = implode(', ', $params[$name]);
1549 elseif ($name == 'group') {
1550 $groups = CRM_Contact_BAO_GroupContact
::getGroupList();
1552 foreach ($params[$name] as $gId => $dontCare) {
1554 $title[] = $groups[$gId];
1557 $values[$index] = implode(', ', $title);
1559 elseif ($name == 'tag') {
1560 $entityTags = $params[$name];
1561 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', ['onlyActive' => FALSE]);
1563 if (is_array($entityTags)) {
1564 foreach ($entityTags as $tagId => $dontCare) {
1565 $title[] = $allTags[$tagId];
1568 $values[$index] = implode(', ', $title);
1570 elseif ('participant_role_id' == $name or
1571 'participant_role' == $name
1573 $roles = CRM_Event_PseudoConstant
::participantRole();
1574 $values[$index] = $roles[$params[$name]];
1576 elseif ('participant_status_id' == $name or
1577 'participant_status' == $name
1579 $status = CRM_Event_PseudoConstant
::participantStatus();
1580 $values[$index] = $status[$params[$name]];
1582 elseif (substr($name, -11) == 'campaign_id') {
1583 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($params[$name]);
1584 $values[$index] = $campaigns[$params[$name]] ??
NULL;
1586 elseif (strpos($name, '-') !== FALSE) {
1587 list($fieldName, $id) = CRM_Utils_System
::explode('-', $name, 2);
1588 $detailName = str_replace(' ', '_', $name);
1589 if (in_array($fieldName, [
1594 $values[$index] = $params[$detailName];
1595 $idx = $detailName . '_id';
1596 $values[$index] = $params[$idx];
1598 elseif ($fieldName == 'im') {
1599 $providerName = NULL;
1600 if ($providerId = $detailName . '-provider_id') {
1601 $providerName = $imProviders[$params[$providerId]] ??
NULL;
1603 if ($providerName) {
1604 $values[$index] = $params[$detailName] . " (" . $providerName . ")";
1607 $values[$index] = $params[$detailName];
1610 elseif ($fieldName == 'phone') {
1611 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1612 if (isset($params[$phoneExtField])) {
1613 $values[$index] = $params[$detailName] . " (" . $params[$phoneExtField] . ")";
1616 $values[$index] = $params[$detailName];
1620 $values[$index] = $params[$detailName];
1624 if (substr($name, 0, 7) === 'do_not_' or substr($name, 0, 3) === 'is_') {
1625 if ($params[$name]) {
1626 $values[$index] = '[ x ]';
1630 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1632 SELECT html_type, data_type
1633 FROM civicrm_custom_field
1636 $dao = CRM_Core_DAO
::executeQuery($query);
1638 $htmlType = $dao->html_type
;
1640 if ($htmlType == 'File') {
1641 $path = $params[$name]['name'] ??
NULL;
1642 $fileType = $params[$name]['type'] ??
NULL;
1643 $values[$index] = CRM_Utils_File
::getFileURL($path, $fileType);
1646 if ($dao->data_type
== 'Int' ||
1647 $dao->data_type
== 'Boolean'
1649 $v = $params[$name];
1650 if (!CRM_Utils_System
::isNull($v)) {
1651 $customVal = (int) $v;
1654 elseif ($dao->data_type
== 'Float') {
1655 $customVal = (float) ($params[$name]);
1657 elseif ($dao->data_type
== 'Date') {
1658 //@todo note the currently we are using default date time formatting. Since you can select/set
1659 // different date and time format specific to custom field we should consider fixing this
1660 // sometime in the future
1661 $customVal = $displayValue = CRM_Utils_Date
::customFormat(
1662 CRM_Utils_Date
::processDate($params[$name]), $config->dateformatFull
);
1664 if (!empty($params[$name . '_time'])) {
1665 $customVal = $displayValue = CRM_Utils_Date
::customFormat(
1666 CRM_Utils_Date
::processDate($params[$name], $params[$name . '_time']),
1667 $config->dateformatDatetime
);
1671 // for checkboxes, change array of [key => bool] to array of [idx => key]
1672 elseif ($dao->html_type
== 'CheckBox') {
1673 $customVal = array_keys(array_filter($params[$name]));
1676 $customVal = $params[$name];
1678 //take the custom field options
1679 $returnProperties = [$name => 1];
1680 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
1682 $displayValue = CRM_Core_BAO_CustomField
::displayValue($customVal, $cfID);
1684 //Hack since we dont have function to check empty.
1685 //FIXME in 2.3 using crmIsEmptyArray()
1686 $customValue = TRUE;
1687 if (is_array($customVal) && is_array($displayValue)) {
1688 $customValue = array_diff($customVal, $displayValue);
1690 //use difference of arrays
1691 if (empty($customValue) ||
!$customValue) {
1692 $values[$index] = '';
1695 $values[$index] = $displayValue;
1699 elseif ($name == 'home_URL' &&
1700 !empty($params[$name])
1702 $url = CRM_Utils_System
::fixURL($params[$name]);
1703 $values[$index] = "<a href=\"$url\">{$params[$name]}</a>";
1705 elseif (in_array($name, [
1708 'participant_register_date',
1710 $values[$index] = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format($params[$name]));
1713 $values[$index] = $params[$name] ??
NULL;
1717 $profileFields[$name] = $field;
1723 * Build the array for Additional participant's information array of primary and additional Ids.
1725 * @param int $participantId
1726 * Id of Primary participant.
1727 * @param array $values
1728 * Key/value event info.
1729 * @param int $contactId
1730 * Contact id of Primary participant.
1731 * @param bool $isTest
1732 * Whether test or live transaction.
1733 * @param bool $isIdsArray
1734 * To return an array of Ids.
1736 * @param bool $skipCancel
1739 * array of Additional participant's info OR array of Ids.
1741 public static function buildCustomProfile(
1746 $isIdsArray = FALSE,
1750 $customProfile = $additionalIDs = [];
1751 if (!$participantId) {
1752 throw new CRM_Core_Exception(ts('Cannot find participant ID'));
1755 //set Ids of Primary Participant also.
1756 if ($isIdsArray && $contactId) {
1757 $additionalIDs[$participantId] = $contactId;
1760 //hack to skip cancelled participants, CRM-4320
1761 $where = "participant.registered_by_id={$participantId}";
1763 $cancelStatusId = 0;
1764 $negativeStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Negative'");
1765 $cancelStatusId = array_search('Cancelled', $negativeStatuses);
1766 $where .= " AND participant.status_id != {$cancelStatusId}";
1769 SELECT participant.id, participant.contact_id
1770 FROM civicrm_participant participant
1773 $dao = CRM_Core_DAO
::executeQuery($query);
1774 while ($dao->fetch()) {
1775 $additionalIDs[$dao->id
] = $dao->contact_id
;
1778 //return if only array is required.
1779 if ($isIdsArray && $contactId) {
1780 return $additionalIDs;
1783 $preProfileID = $values['additional_custom_pre_id'] ??
NULL;
1784 $postProfileID = $values['additional_custom_post_id'] ??
NULL;
1785 //else build array of Additional participant's information.
1786 if (count($additionalIDs)) {
1787 if ($preProfileID ||
$postProfileID) {
1788 $template = CRM_Core_Smarty
::singleton();
1790 $isCustomProfile = TRUE;
1792 $title = $groupTitles = [];
1793 foreach ($additionalIDs as $pId => $cId) {
1794 //get the params submitted by participant.
1795 $participantParams = NULL;
1796 if (isset($values['params'])) {
1797 $participantParams = CRM_Utils_Array
::value($pId, $values['params'], []);
1800 list($profilePre, $groupTitles) = self
::buildCustomDisplay($preProfileID,
1801 'additionalCustomPre',
1811 $profile = $profilePre;
1812 // $customProfile[$i] = array_merge( $groupTitles, $customProfile[$i] );
1814 $title = $groupTitles;
1818 list($profilePost, $groupTitles) = self
::buildCustomDisplay($postProfileID,
1819 'additionalCustomPost',
1829 if (isset($profilePre)) {
1830 $profile = array_merge($profilePre, $profilePost);
1832 $title = array_merge($title, $groupTitles);
1836 $profile = $profilePost;
1838 $title = $groupTitles;
1842 $profiles[] = $profile;
1845 $customProfile['title'] = $title;
1846 $customProfile['profile'] = $profiles;
1850 return $customProfile;
1854 * Retrieve all event addresses.
1858 public static function getLocationEvents() {
1862 'loc_block_id.address_id.name',
1863 'loc_block_id.address_id.street_address',
1864 'loc_block_id.address_id.supplemental_address_1',
1865 'loc_block_id.address_id.supplemental_address_2',
1866 'loc_block_id.address_id.supplemental_address_3',
1867 'loc_block_id.address_id.city',
1868 'loc_block_id.address_id.state_province_id.name',
1871 $result = civicrm_api3('Event', 'get', [
1872 'check_permissions' => TRUE,
1874 'loc_block_id.address_id' => ['IS NOT NULL' => 1],
1880 foreach ($result['values'] as $event) {
1882 foreach ($ret as $field) {
1883 if ($field != 'loc_block_id' && !empty($event[$field])) {
1884 $address .= ($address ?
' :: ' : '') . $event[$field];
1888 $events[$event['loc_block_id']] = $address;
1892 return CRM_Utils_Array
::asort($events);
1896 * @param int $locBlockId
1898 * @return int|null|string
1900 public static function countEventsUsingLocBlockId($locBlockId) {
1905 $locBlockId = CRM_Utils_Type
::escape($locBlockId, 'Integer');
1908 SELECT count(*) FROM civicrm_event ce
1909 WHERE ce.loc_block_id = $locBlockId";
1911 return CRM_Core_DAO
::singleValueQuery($query);
1915 * Check if event registration is valid according to permissions AND Dates.
1917 * @param array $values
1918 * @param int $eventID
1921 public static function validRegistrationRequest($values, $eventID) {
1922 // check that the user has permission to register for this event
1923 $hasPermission = CRM_Core_Permission
::event(CRM_Core_Permission
::EDIT
,
1924 $eventID, 'register for events'
1927 return $hasPermission && self
::validRegistrationDate($values);
1935 public static function validRegistrationDate(&$values) {
1936 // make sure that we are between registration start date and end dates
1937 // and that if the event has ended, registration is still specifically open
1938 $startDate = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('registration_start_date', $values));
1939 $endDate = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('registration_end_date', $values));
1940 $eventEnd = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('end_date', $values));
1943 if ($startDate && $startDate >= $now) {
1946 elseif ($endDate && $endDate < $now) {
1949 elseif ($eventEnd && $eventEnd < $now && !$endDate) {
1956 /* Function to Show - Hide the Registration Link.
1958 * @param array $values
1959 * Key/value event info.
1961 * true if allow registration otherwise false
1969 public static function showHideRegistrationLink($values) {
1971 $session = CRM_Core_Session
::singleton();
1972 $contactID = $session->get('userID');
1973 $alreadyRegistered = FALSE;
1976 $params = ['contact_id' => $contactID];
1978 if ($eventId = CRM_Utils_Array
::value('id', $values['event'])) {
1979 $params['event_id'] = $eventId;
1981 if ($roleId = CRM_Utils_Array
::value('default_role_id', $values['event'])) {
1982 $params['role_id'] = $roleId;
1984 $alreadyRegistered = self
::checkRegistration($params);
1987 if (!empty($values['event']['allow_same_participant_emails']) ||
1995 /* Function to check if given contact is already registered.
1997 * @param array $params
1998 * Key/value participant info.
2003 * @param array $params
2007 public static function checkRegistration($params) {
2008 $alreadyRegistered = FALSE;
2009 if (empty($params['contact_id'])) {
2010 return $alreadyRegistered;
2013 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
2015 $participant = new CRM_Event_DAO_Participant();
2016 $participant->copyValues($params);
2018 $participant->is_test
= CRM_Utils_Array
::value('is_test', $params, 0);
2019 $participant->selectAdd();
2020 $participant->selectAdd('status_id');
2021 if ($participant->find(TRUE) && array_key_exists($participant->status_id
, $statusTypes)) {
2022 $alreadyRegistered = TRUE;
2025 return $alreadyRegistered;
2029 * Make sure that the user has permission to access this event.
2030 * FIXME: We have separate caches for checkPermission('permission') and getAllPermissions['permissions'] so they don't interfere.
2031 * But it would be nice to clean this up some more.
2033 * @param int $eventId
2034 * @param int $permissionType
2036 * @return bool|array
2037 * Whether the user has permission for this event (or if eventId=NULL an array of permissions)
2038 * @throws \CiviCRM_API3_Exception
2040 public static function checkPermission(int $eventId, $permissionType = CRM_Core_Permission
::VIEW
) {
2041 switch ($permissionType) {
2042 case CRM_Core_Permission
::EDIT
:
2043 // We also set the cached "view" permission to TRUE if "edit" is TRUE
2044 if (isset(Civi
::$statics[__CLASS__
]['permission']['edit'][$eventId])) {
2045 return Civi
::$statics[__CLASS__
]['permission']['edit'][$eventId];
2047 Civi
::$statics[__CLASS__
]['permission']['edit'][$eventId] = FALSE;
2049 list($allEvents, $createdEvents) = self
::checkPermissionGetInfo($eventId);
2050 // Note: for a multisite setup, a user with edit all events, can edit all events
2051 // including those from other sites
2052 if (($permissionType == CRM_Core_Permission
::EDIT
) && CRM_Core_Permission
::check('edit all events')) {
2053 Civi
::$statics[__CLASS__
]['permission']['edit'][$eventId] = TRUE;
2054 Civi
::$statics[__CLASS__
]['permission']['view'][$eventId] = TRUE;
2056 elseif (in_array($eventId, CRM_ACL_API
::group(CRM_Core_Permission
::EDIT
, NULL, 'civicrm_event', $allEvents, $createdEvents))) {
2057 Civi
::$statics[__CLASS__
]['permission']['edit'][$eventId] = TRUE;
2058 Civi
::$statics[__CLASS__
]['permission']['view'][$eventId] = TRUE;
2060 return Civi
::$statics[__CLASS__
]['permission']['edit'][$eventId];
2062 case CRM_Core_Permission
::VIEW
:
2063 if (isset(Civi
::$statics[__CLASS__
]['permission']['view'][$eventId])) {
2064 return Civi
::$statics[__CLASS__
]['permission']['view'][$eventId];
2066 Civi
::$statics[__CLASS__
]['permission']['view'][$eventId] = FALSE;
2068 list($allEvents, $createdEvents) = self
::checkPermissionGetInfo($eventId);
2069 if (CRM_Core_Permission
::check('access CiviEvent')) {
2070 if (in_array($eventId, CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_event', $allEvents, array_keys($createdEvents)))) {
2071 // User created this event so has permission to view it
2072 return Civi
::$statics[__CLASS__
]['permission']['view'][$eventId] = TRUE;
2074 if (CRM_Core_Permission
::check('view event participants')) {
2075 // User has permission to view all events
2076 // use case: allow "view all events" but NOT "edit all events"
2077 // so for a normal site allow users with these two permissions to view all events AND
2078 // at the same time also allow any hook to override if needed.
2079 if (in_array($eventId, CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_event', $allEvents, array_keys($allEvents)))) {
2080 Civi
::$statics[__CLASS__
]['permission']['view'][$eventId] = TRUE;
2084 return Civi
::$statics[__CLASS__
]['permission']['view'][$eventId];
2086 case CRM_Core_Permission
::DELETE
:
2087 if (isset(Civi
::$statics[__CLASS__
]['permission']['delete'][$eventId])) {
2088 return Civi
::$statics[__CLASS__
]['permission']['delete'][$eventId];
2090 Civi
::$statics[__CLASS__
]['permission']['delete'][$eventId] = FALSE;
2091 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
2092 Civi
::$statics[__CLASS__
]['permission']['delete'][$eventId] = TRUE;
2094 return Civi
::$statics[__CLASS__
]['permission']['delete'][$eventId];
2102 * This is a helper for refactoring checkPermission
2103 * FIXME: We should be able to get rid of these arrays, but that would require understanding how CRM_ACL_API::group actually works!
2105 * @param int $eventId
2107 * @return array $allEvents, $createdEvents
2108 * @throws \CiviCRM_API3_Exception
2110 private static function checkPermissionGetInfo($eventId = NULL) {
2112 'check_permissions' => 1,
2113 'return' => 'id, created_id',
2114 'options' => ['limit' => 0],
2117 $params['id'] = $eventId;
2121 $createdEvents = [];
2122 $eventResult = civicrm_api3('Event', 'get', $params);
2123 if ($eventResult['count'] > 0) {
2124 $contactId = CRM_Core_Session
::getLoggedInContactID();
2125 foreach ($eventResult['values'] as $eventId => $eventDetail) {
2126 $allEvents[$eventId] = $eventId;
2127 if (isset($eventDetail['created_id']) && $contactId == $eventDetail['created_id']) {
2128 $createdEvents[$eventId] = $eventId;
2132 return [$allEvents, $createdEvents];
2136 * Make sure that the user has permission to access this event.
2137 * TODO: This function needs refactoring / cleaning up after being split from checkPermissions()
2140 * Array of events with permissions (array_keys=permissions)
2141 * @throws \CiviCRM_API3_Exception
2143 public static function getAllPermissions() {
2144 if (!isset(Civi
::$statics[__CLASS__
]['permissions'])) {
2145 list($allEvents, $createdEvents) = self
::checkPermissionGetInfo();
2147 // Note: for a multisite setup, a user with edit all events, can edit all events
2148 // including those from other sites
2149 if (CRM_Core_Permission
::check('edit all events')) {
2150 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::EDIT
] = array_keys($allEvents);
2153 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::EDIT
] = CRM_ACL_API
::group(CRM_Core_Permission
::EDIT
, NULL, 'civicrm_event', $allEvents, $createdEvents);
2156 if (CRM_Core_Permission
::check('edit all events')) {
2157 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::VIEW
] = array_keys($allEvents);
2160 if (CRM_Core_Permission
::check('access CiviEvent') &&
2161 CRM_Core_Permission
::check('view event participants')
2163 // use case: allow "view all events" but NOT "edit all events"
2164 // so for a normal site allow users with these two permissions to view all events AND
2165 // at the same time also allow any hook to override if needed.
2166 $createdEvents = array_keys($allEvents);
2168 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::VIEW
] = CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_event', $allEvents, $createdEvents);
2171 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::DELETE
] = [];
2172 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
2173 // Note: we want to restrict the scope of delete permission to
2174 // events that are editable/viewable (usecase multisite).
2175 // We can remove array_intersect once we have ACL support for delete functionality.
2176 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::DELETE
] = array_intersect(Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::EDIT
],
2177 Civi
::$statics[__CLASS__
]['permissions'][CRM_Core_Permission
::VIEW
]
2182 return Civi
::$statics[__CLASS__
]['permissions'];
2186 * Build From Email as the combination of all the email ids of the logged in user,
2187 * the domain email id and the email id configured for the event
2189 * @param int $eventId
2190 * The id of the event.
2193 * an array of email ids
2195 public static function getFromEmailIds($eventId = NULL) {
2196 $fromEmailValues['from_email_id'] = CRM_Core_BAO_Email
::getFromEmail();
2199 // add the email id configured for the event
2200 $params = ['id' => $eventId];
2201 $returnProperties = ['confirm_from_name', 'confirm_from_email', 'cc_confirm', 'bcc_confirm'];
2204 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event', $params, $eventEmail, $returnProperties);
2205 if (!empty($eventEmail['confirm_from_name']) && !empty($eventEmail['confirm_from_email'])) {
2206 $eventEmailId = "{$eventEmail['confirm_from_name']} <{$eventEmail['confirm_from_email']}>";
2208 $fromEmailValues['from_email_id'][$eventEmailId] = htmlspecialchars($eventEmailId);
2210 'cc' => $eventEmail['cc_confirm'] ??
NULL,
2211 'bcc' => $eventEmail['bcc_confirm'] ??
NULL,
2213 $fromEmailValues = array_merge($fromEmailValues, $fromEmailId);
2217 return $fromEmailValues;
2221 * Calculate event total seats occupied.
2223 * @param int $eventId
2225 * @param string $extraWhereClause
2226 * Extra filter on participants.
2229 * event total seats w/ given criteria.
2231 public static function eventTotalSeats($eventId, $extraWhereClause = NULL) {
2232 if (empty($eventId)) {
2236 $extraWhereClause = trim($extraWhereClause);
2237 if (!empty($extraWhereClause)) {
2238 $extraWhereClause = " AND ( {$extraWhereClause} )";
2241 //event seats calculation :
2242 //1. consider event seat as a single when participant does not have line item.
2243 //2. consider event seat as a single when participant has line items but does not
2244 // have count for corresponding price field value ( ie price field value does not carry any seat )
2245 //3. consider event seat as a sum of all seats from line items in case price field value carries count.
2248 SELECT IF ( SUM( value.count*lineItem.qty ),
2249 SUM( value.count*lineItem.qty ) +
2250 COUNT( DISTINCT participant.id ) -
2251 COUNT( DISTINCT IF ( value.count, participant.id, NULL ) ),
2252 COUNT( DISTINCT participant.id ) )
2253 FROM civicrm_participant participant
2254 INNER JOIN civicrm_contact contact ON ( contact.id = participant.contact_id AND contact.is_deleted = 0 )
2255 INNER JOIN civicrm_event event ON ( event.id = participant.event_id )
2256 LEFT JOIN civicrm_line_item lineItem ON ( lineItem.entity_id = participant.id
2257 AND lineItem.entity_table = 'civicrm_participant' )
2258 LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_value_id AND value.count )
2259 WHERE ( participant.event_id = %1 )
2260 AND participant.is_test = 0
2262 GROUP BY participant.event_id";
2264 return (int) CRM_Core_DAO
::singleValueQuery($query, [1 => [$eventId, 'Positive']]);
2268 * Retrieve event template default values to be set.
2269 * as default values for current new event.
2271 * @param int $templateId
2272 * Event template id.
2275 * Array of custom data defaults.
2277 public static function getTemplateDefaultValues($templateId) {
2283 $templateParams = ['id' => $templateId];
2284 CRM_Event_BAO_Event
::retrieve($templateParams, $defaults);
2285 $fieldsToExclude = [
2288 'default_discount_fee_id',
2294 $defaults = array_diff_key($defaults, array_flip($fieldsToExclude));
2295 foreach ($defaults as $key => $value) {
2296 $customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
2297 if (!empty($customFieldInfo[1])) {
2298 $defaults[str_replace($customFieldInfo[1], '-' . $customFieldInfo[1], $key)] = $value;
2299 unset($defaults[$key]);
2306 * @param int $event_id
2310 public static function get_sub_events($event_id) {
2311 $params = ['parent_event_id' => $event_id];
2313 return CRM_Event_BAO_Event
::retrieve($params, $defaults);
2317 * Update the Campaign Id of all the participants of the given event.
2319 * @param int $eventID
2321 * @param int $eventCampaignID
2322 * Campaign id of that event.
2324 public static function updateParticipantCampaignID($eventID, $eventCampaignID) {
2326 $params[1] = [$eventID, 'Integer'];
2328 if (empty($eventCampaignID)) {
2329 $query = "UPDATE civicrm_participant SET campaign_id = NULL WHERE event_id = %1";
2332 $query = "UPDATE civicrm_participant SET campaign_id = %2 WHERE event_id = %1";
2333 $params[2] = [$eventCampaignID, 'Integer'];
2335 CRM_Core_DAO
::executeQuery($query, $params);
2339 * Get options for a given field.
2340 * @see CRM_Core_DAO::buildOptions
2342 * @param string $fieldName
2343 * @param string $context : @see CRM_Core_DAO::buildOptionsContext
2344 * @param array $props : whatever is known about this dao object
2346 * @return array|bool
2348 public static function buildOptions($fieldName, $context = NULL, $props = []) {
2350 // Special logic for fields whose options depend on context or properties
2351 switch ($fieldName) {
2352 case 'financial_type_id':
2353 // https://lab.civicrm.org/dev/core/issues/547 if CiviContribute not enabled this causes an invalid query
2354 // @todo - the component is enabled check should be done within getIncomeFinancialType
2355 // It looks to me like test cover was NOT added to cover the change
2356 // that added this so we need to assume there is no test cover
2357 if (CRM_Core_Component
::isEnabled('CiviContribute')) {
2358 return CRM_Financial_BAO_FinancialType
::getIncomeFinancialType($props['check_permissions'] ??
TRUE);
2362 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
2368 public static function getEntityRefFilters() {
2370 ['key' => 'event_type_id', 'value' => ts('Event Type')],
2372 'key' => 'start_date',
2373 'value' => ts('Start Date'),
2375 ['key' => '{">":"now"}', 'value' => ts('Upcoming')],
2377 'key' => '{"BETWEEN":["now - 3 month","now"]}',
2378 'value' => ts('Past 3 Months'),
2381 'key' => '{"BETWEEN":["now - 6 month","now"]}',
2382 'value' => ts('Past 6 Months'),
2385 'key' => '{"BETWEEN":["now - 1 year","now"]}',
2386 'value' => ts('Past Year'),
2394 * Get the appropriate links to iCal pages/feeds.
2396 * @param int $eventId
2399 * All of the icons to show.
2401 public static function getICalLinks($eventId = NULL) {
2402 $return = $eventId ?
[] : [
2404 'url' => CRM_Utils_System
::url('civicrm/event/ical', 'reset=1&list=1&html=1', TRUE, NULL, TRUE),
2405 'text' => ts('HTML listing of current and future public events.'),
2406 'icon' => 'fa-th-list',
2409 'url' => CRM_Utils_System
::url('civicrm/event/ical', 'reset=1&list=1&rss=1', TRUE, NULL, TRUE),
2410 'text' => ts('Get RSS 2.0 feed for current and future public events.'),
2418 $query['id'] = $eventId;
2421 'url' => CRM_Utils_System
::url('civicrm/event/ical', $query, TRUE, NULL, TRUE),
2422 'text' => $eventId ?
ts('Download iCalendar entry for this event.') : ts('Download iCalendar entry for current and future public events.'),
2423 'icon' => 'fa-download',
2427 'url' => CRM_Utils_System
::url('civicrm/event/ical', $query, TRUE, NULL, TRUE),
2428 'text' => $eventId ?
ts('iCalendar feed for this event.') : ts('iCalendar feed for current and future public events.'),
2429 'icon' => 'fa-link',