3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
33 class CRM_Event_BAO_Event
extends CRM_Event_DAO_Event
{
38 public function __construct() {
39 parent
::__construct();
43 * Fetch object based on array of properties.
45 * @param array $params
46 * (reference ) an assoc array of name/value pairs.
47 * @param array $defaults
48 * (reference ) an assoc array to hold the flattened values.
50 * @return CRM_Event_DAO_Event
52 public static function retrieve(&$params, &$defaults) {
53 $event = new CRM_Event_DAO_Event();
54 $event->copyValues($params);
55 if ($event->find(TRUE)) {
56 CRM_Core_DAO
::storeValues($event, $defaults);
63 * Update the is_active flag in the db.
66 * Id of the database record.
67 * @param bool $is_active
68 * Value we want to set the is_active field.
71 * DAO object on success, null otherwise
73 public static function setIsActive($id, $is_active) {
74 return CRM_Core_DAO
::setFieldValue('CRM_Event_DAO_Event', $id, 'is_active', $is_active);
80 * @param array $params
81 * Reference array contains the values submitted by the form.
83 * @return CRM_Event_DAO_Event
85 public static function add(&$params) {
86 CRM_Utils_System
::flushCache();
87 $financialTypeId = NULL;
88 if (!empty($params['id'])) {
89 CRM_Utils_Hook
::pre('edit', 'Event', $params['id'], $params);
90 if (empty($params['skipFinancialType'])) {
91 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['id'], 'financial_type_id');
95 CRM_Utils_Hook
::pre('create', 'Event', NULL, $params);
99 if (!empty($params['financial_type_id'])) {
100 CRM_Financial_BAO_FinancialAccount
::validateFinancialType($params['financial_type_id']);
102 $event = new CRM_Event_DAO_Event();
104 $event->copyValues($params);
105 $result = $event->save();
107 if (!empty($params['id'])) {
108 CRM_Utils_Hook
::post('edit', 'Event', $event->id
, $event);
111 CRM_Utils_Hook
::post('create', 'Event', $event->id
, $event);
113 if ($financialTypeId && !empty($params['financial_type_id']) && $financialTypeId != $params['financial_type_id']) {
114 CRM_Price_BAO_PriceFieldValue
::updateFinancialType($params['id'], 'civicrm_event', $params['financial_type_id']);
122 * @param array $params
123 * Reference array contains the values submitted by the form.
127 public static function create(&$params) {
128 $transaction = new CRM_Core_Transaction();
129 if (empty($params['is_template'])) {
130 $params['is_template'] = 0;
132 // check if new event, if so set the created_id (if not set)
133 // and always set created_date to now
134 if (empty($params['id'])) {
135 if (empty($params['created_id'])) {
136 $session = CRM_Core_Session
::singleton();
137 $params['created_id'] = $session->get('userID');
139 $params['created_date'] = date('YmdHis');
142 $event = self
::add($params);
143 CRM_Price_BAO_PriceSet
::setPriceSets($params, $event, 'event');
144 if (is_a($event, 'CRM_Core_Error')) {
145 CRM_Core_DAO
::transaction('ROLLBACK');
149 $contactId = CRM_Core_Session
::getLoggedInContactID();
151 $contactId = CRM_Utils_Array
::value('contact_id', $params);
154 // Log the information on successful add/edit of Event
156 'entity_table' => 'civicrm_event',
157 'entity_id' => $event->id
,
158 'modified_id' => $contactId,
159 'modified_date' => date('Ymd'),
162 CRM_Core_BAO_Log
::add($logParams);
164 if (!empty($params['custom']) &&
165 is_array($params['custom'])
167 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_event', $event->id
);
170 $transaction->commit();
183 public static function del($id) {
188 CRM_Utils_Hook
::pre('delete', 'Event', $id, CRM_Core_DAO
::$_nullArray);
190 $extends = array('event');
191 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
192 foreach ($groupTree as $values) {
193 $query = "DELETE FROM " . $values['table_name'] . " WHERE entity_id = " . $id;
196 1 => array($values['table_name'], 'string'),
197 2 => array($id, 'integer'),
200 CRM_Core_DAO
::executeQuery($query);
203 // price set cleanup, CRM-5527
204 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_event', $id);
206 $event = new CRM_Event_DAO_Event();
209 if ($event->find(TRUE)) {
210 $locBlockId = $event->loc_block_id
;
211 $result = $event->delete();
213 if (!is_null($locBlockId)) {
214 self
::deleteEventLocBlock($locBlockId, $id);
217 CRM_Utils_Hook
::post('delete', 'Event', $id, $event);
225 * Delete the location block associated with an event.
227 * Function checks that it is not being used by any other event.
229 * @param int $locBlockId
230 * Location block id to be deleted.
231 * @param int $eventId
232 * Event with which loc block is associated.
234 public static function deleteEventLocBlock($locBlockId, $eventId = NULL) {
235 $query = "SELECT count(ce.id) FROM civicrm_event ce WHERE ce.loc_block_id = $locBlockId";
238 $query .= " AND ce.id != $eventId;";
241 $locCount = CRM_Core_DAO
::singleValueQuery($query);
243 if ($locCount == 0) {
244 CRM_Core_BAO_Location
::deleteLocBlock($locBlockId);
249 * Get current/future Events.
252 * 0 returns current and future events.
253 * 1 if events all are required
254 * 2 returns events since 3 months ago
255 * @param int|array $id single int event id or array of multiple event ids to return
256 * @param bool $isActive
257 * true if you need only active events.
258 * @param bool $checkPermission
259 * true if you need to check permission else false.
260 * @param bool $titleOnly
261 * true if you need only title not appended with start date
265 public static function getEvents(
269 $checkPermission = TRUE,
273 SELECT `id`, `title`, `start_date`
275 WHERE ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )";
278 $op = is_array($id) ?
'IN' : '=';
279 $where = CRM_Contact_BAO_Query
::buildClause('id', $op, $id);
280 $query .= " AND {$where}";
283 // find only events ending in the future
284 $endDate = date('YmdHis');
286 AND ( `end_date` >= {$endDate} OR
288 ( end_date IS NULL OR end_date = '' ) AND start_date >= {$endDate}
293 // find only events starting in the last 3 months
294 $startDate = date('YmdHis', strtotime('3 months ago'));
295 $query .= " AND ( `start_date` >= {$startDate} OR start_date IS NULL )";
298 $query .= " AND civicrm_event.is_active = 1";
301 $query .= " ORDER BY title asc";
304 $dao = CRM_Core_DAO
::executeQuery($query);
305 while ($dao->fetch()) {
306 if ((!$checkPermission ||
307 CRM_Event_BAO_Event
::checkPermission($dao->id
)
311 $events[$dao->id
] = $dao->title
;
313 $events[$dao->id
] .= ' - ' . CRM_Utils_Date
::customFormat($dao->start_date
);
322 * Get events Summary.
325 * Array of event summary values
327 public static function getEventSummary() {
328 $eventSummary = $eventIds = array();
329 $config = CRM_Core_Config
::singleton();
331 // get permission and include them here
332 // does not scale, but rearranging code for now
333 // FIXME in a future release
334 $permissions = CRM_Event_BAO_Event
::checkPermission();
336 if (empty($permissions[CRM_Core_Permission
::VIEW
])) {
337 $eventSummary['total_events'] = 0;
338 return $eventSummary;
341 $validEventIDs = " AND civicrm_event.id IN ( " . implode(',', array_values($permissions[CRM_Core_Permission
::VIEW
])) . " ) ";
344 // We're fetching recent and upcoming events (where start date is 7 days ago OR later)
346 SELECT count(id) as total_events
348 WHERE civicrm_event.is_active = 1 AND
349 ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0) AND
350 civicrm_event.start_date >= DATE_SUB( NOW(), INTERVAL 7 day )
353 $dao = CRM_Core_DAO
::executeQuery($query);
356 $eventSummary['total_events'] = $dao->total_events
;
359 if (empty($eventSummary) ||
360 $dao->total_events
== 0
362 return $eventSummary;
365 //get the participant status type values.
366 $cpstObject = new CRM_Event_DAO_ParticipantStatusType();
367 $cpst = $cpstObject->getTableName();
368 $query = "SELECT id, name, label, class FROM $cpst";
369 $status = CRM_Core_DAO
::executeQuery($query);
370 $statusValues = array();
371 while ($status->fetch()) {
372 $statusValues[$status->id
]['id'] = $status->id
;
373 $statusValues[$status->id
]['name'] = $status->name
;
374 $statusValues[$status->id
]['label'] = $status->label
;
375 $statusValues[$status->id
]['class'] = $status->class;
378 // Get the Id of Option Group for Event Types
379 $optionGroupDAO = new CRM_Core_DAO_OptionGroup();
380 $optionGroupDAO->name
= 'event_type';
381 $optionGroupId = NULL;
382 if ($optionGroupDAO->find(TRUE)) {
383 $optionGroupId = $optionGroupDAO->id
;
385 // Get the event summary display preferences
386 $show_max_events = Civi
::settings()->get('show_events');
387 // show all events if show_events is set to a negative value
388 if ($show_max_events >= 0) {
389 $event_summary_limit = "LIMIT 0, $show_max_events";
392 $event_summary_limit = "";
396 SELECT civicrm_event.id as id, civicrm_event.title as event_title, civicrm_event.is_public as is_public,
397 civicrm_event.max_participants as max_participants, civicrm_event.start_date as start_date,
398 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,
399 civicrm_event.slot_label_id,
400 civicrm_event.summary as summary,
401 civicrm_pcp_block.id as is_pcp_enabled,
402 civicrm_recurring_entity.parent_id as is_repeating_event
404 LEFT JOIN civicrm_option_value ON (
405 civicrm_event.event_type_id = civicrm_option_value.value AND
406 civicrm_option_value.option_group_id = %1 )
407 LEFT JOIN civicrm_tell_friend ON ( civicrm_tell_friend.entity_id = civicrm_event.id AND civicrm_tell_friend.entity_table = 'civicrm_event' )
408 LEFT JOIN civicrm_pcp_block ON ( civicrm_pcp_block.entity_id = civicrm_event.id AND civicrm_pcp_block.entity_table = 'civicrm_event')
409 LEFT JOIN civicrm_recurring_entity ON ( civicrm_event.id = civicrm_recurring_entity.entity_id AND civicrm_recurring_entity.entity_table = 'civicrm_event' )
410 WHERE civicrm_event.is_active = 1 AND
411 ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0) AND
412 civicrm_event.start_date >= DATE_SUB( NOW(), INTERVAL 7 day )
414 ORDER BY civicrm_event.start_date ASC
417 $eventParticipant = array();
421 'eventTitle' => 'event_title',
422 'isPublic' => 'is_public',
423 'maxParticipants' => 'max_participants',
424 'startDate' => 'start_date',
425 'endDate' => 'end_date',
426 'eventType' => 'event_type',
428 'participants' => 'participants',
429 'notCountedDueToRole' => 'notCountedDueToRole',
430 'notCountedDueToStatus' => 'notCountedDueToStatus',
431 'notCountedParticipants' => 'notCountedParticipants',
434 $params = array(1 => array($optionGroupId, 'Integer'));
435 $mapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings(array(
436 'id' => CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
,
438 $dao = CRM_Core_DAO
::executeQuery($query, $params);
439 while ($dao->fetch()) {
440 foreach ($properties as $property => $name) {
450 $eventSummary['events'][$dao->id
][$property] = $set;
454 if ($dao->$name && $config->mapAPIKey
) {
457 $params = array('entity_id' => $dao->id
, 'entity_table' => 'civicrm_event');
458 $values['location'] = CRM_Core_BAO_Location
::getValues($params, TRUE);
459 if (is_numeric(CRM_Utils_Array
::value('geo_code_1', $values['location']['address'][1])) ||
461 !empty($values['location']['address'][1]['city']) &&
462 !empty($values['location']['address'][1]['state_province_id'])
465 $set = CRM_Utils_System
::url('civicrm/contact/map/event', "reset=1&eid={$dao->id}");
469 $eventSummary['events'][$dao->id
][$property] = $set;
470 if (is_array($permissions[CRM_Core_Permission
::EDIT
])
471 && in_array($dao->id
, $permissions[CRM_Core_Permission
::EDIT
])) {
472 $eventSummary['events'][$dao->id
]['configure'] = CRM_Utils_System
::url('civicrm/admin/event', "action=update&id=$dao->id&reset=1");
478 $eventSummary['events'][$dao->id
][$property] = CRM_Utils_Date
::customFormat($dao->$name,
484 case 'notCountedDueToRole':
485 case 'notCountedDueToStatus':
486 case 'notCountedParticipants':
489 if ($name == 'participants') {
490 $propertyCnt = self
::getParticipantCount($dao->id
);
492 $set = CRM_Utils_System
::url('civicrm/event/search',
493 "reset=1&force=1&event=$dao->id&status=true&role=true"
497 elseif ($name == 'notCountedParticipants') {
498 $propertyCnt = self
::getParticipantCount($dao->id
, TRUE, FALSE, TRUE, FALSE);
500 // FIXME : selector fail to search w/ OR operator.
501 // $set = CRM_Utils_System::url( 'civicrm/event/search',
502 // "reset=1&force=1&event=$dao->id&status=false&role=false" );
505 elseif ($name == 'notCountedDueToStatus') {
506 $propertyCnt = self
::getParticipantCount($dao->id
, TRUE, FALSE, FALSE, FALSE);
508 $set = CRM_Utils_System
::url('civicrm/event/search',
509 "reset=1&force=1&event=$dao->id&status=false"
514 $propertyCnt = self
::getParticipantCount($dao->id
, FALSE, FALSE, TRUE, FALSE);
516 $set = CRM_Utils_System
::url('civicrm/event/search',
517 "reset=1&force=1&event=$dao->id&role=false"
522 $eventSummary['events'][$dao->id
][$property] = $propertyCnt;
523 $eventSummary['events'][$dao->id
][$name . '_url'] = $set;
527 $eventSummary['events'][$dao->id
][$property] = $dao->$name;
532 // prepare the area for per-status participant counts
533 $statusClasses = array('Positive', 'Pending', 'Waiting', 'Negative');
534 $eventSummary['events'][$dao->id
]['statuses'] = array_fill_keys($statusClasses, array());
536 $eventSummary['events'][$dao->id
]['friend'] = $dao->is_friend_active
;
537 $eventSummary['events'][$dao->id
]['is_monetary'] = $dao->is_monetary
;
538 $eventSummary['events'][$dao->id
]['is_online_registration'] = $dao->is_online_registration
;
539 $eventSummary['events'][$dao->id
]['is_show_location'] = $dao->is_show_location
;
540 $eventSummary['events'][$dao->id
]['is_subevent'] = $dao->slot_label_id
;
541 $eventSummary['events'][$dao->id
]['is_pcp_enabled'] = $dao->is_pcp_enabled
;
542 $eventSummary['events'][$dao->id
]['reminder'] = CRM_Core_BAO_ActionSchedule
::isConfigured($dao->id
, $mapping->getId());
543 $eventSummary['events'][$dao->id
]['is_repeating_event'] = $dao->is_repeating_event
;
545 $statusTypes = CRM_Event_PseudoConstant
::participantStatus();
546 foreach ($statusValues as $statusId => $statusValue) {
547 if (!array_key_exists($statusId, $statusTypes)) {
550 $class = $statusValue['class'];
551 $statusCount = self
::eventTotalSeats($dao->id
, "( participant.status_id = {$statusId} )");
553 $urlString = "reset=1&force=1&event={$dao->id}&status=$statusId";
555 'url' => CRM_Utils_System
::url('civicrm/event/search', $urlString),
556 'name' => $statusValue['name'],
557 'label' => $statusValue['label'],
558 'count' => $statusCount,
560 $eventSummary['events'][$dao->id
]['statuses'][$class][] = $statusInfo;
565 $countedRoles = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
566 $nonCountedRoles = CRM_Event_PseudoConstant
::participantRole(NULL, '( filter = 0 OR filter IS NULL )');
567 $countedStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
568 $nonCountedStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, '( is_counted = 0 OR is_counted IS NULL )');
570 $countedStatusANDRoles = array_merge($countedStatus, $countedRoles);
571 $nonCountedStatusANDRoles = array_merge($nonCountedStatus, $nonCountedRoles);
573 $eventSummary['nonCountedRoles'] = implode('/', array_values($nonCountedRoles));
574 $eventSummary['nonCountedStatus'] = implode('/', array_values($nonCountedStatus));
575 $eventSummary['countedStatusANDRoles'] = implode('/', array_values($countedStatusANDRoles));
576 $eventSummary['nonCountedStatusANDRoles'] = implode('/', array_values($nonCountedStatusANDRoles));
578 return $eventSummary;
582 * Get participant count.
584 * @param int $eventId
585 * @param bool $considerStatus consider status for participant count.
586 * Consider status for participant count.
587 * @param bool $status counted participant.
588 * Consider counted participant.
589 * @param bool $considerRole consider role for participant count.
590 * Consider role for participant count.
591 * @param bool $role consider counted( is filter role) participant.
592 * Consider counted( is filter role) participant.
595 * array with count of participants for each event based on status/role
597 public static function getParticipantCount(
599 $considerStatus = TRUE,
601 $considerRole = TRUE,
605 // consider both role and status for counted participants, CRM-4924.
607 // not counted participant.
608 if ($considerStatus && $considerRole && !$status && !$role) {
612 if ($considerStatus) {
613 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
614 $statusClause = 'NOT IN';
616 $statusClause = 'IN';
618 $status = implode(',', array_keys($statusTypes));
619 if (empty($status)) {
622 $clause[] = "participant.status_id {$statusClause} ( {$status} ) ";
626 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
627 $roleClause = 'NOT IN';
632 if (!empty($roleTypes)) {
633 $escapedRoles = array();
634 foreach (array_keys($roleTypes) as $roleType) {
635 $escapedRoles[] = CRM_Utils_Type
::escape($roleType, 'String');
638 $clause[] = "participant.role_id {$roleClause} ( '" . implode("', '", $escapedRoles) . "' ) ";
643 if (!empty($clause)) {
644 $sqlClause = ' ( ' . implode($operator, $clause) . ' )';
647 return self
::eventTotalSeats($eventId, $sqlClause);
651 * Get the information to map a event.
654 * For which we want map info.
656 * @return null|string
659 public static function &getMapInfo(&$id) {
663 civicrm_event.id AS event_id,
664 civicrm_event.title AS display_name,
665 civicrm_address.street_address AS street_address,
666 civicrm_address.city AS city,
667 civicrm_address.postal_code AS postal_code,
668 civicrm_address.postal_code_suffix AS postal_code_suffix,
669 civicrm_address.geo_code_1 AS latitude,
670 civicrm_address.geo_code_2 AS longitude,
671 civicrm_state_province.abbreviation AS state,
672 civicrm_country.name AS country,
673 civicrm_location_type.name AS location_type
676 LEFT JOIN civicrm_loc_block ON ( civicrm_event.loc_block_id = civicrm_loc_block.id )
677 LEFT JOIN civicrm_address ON ( civicrm_loc_block.address_id = civicrm_address.id )
678 LEFT JOIN civicrm_state_province ON ( civicrm_address.state_province_id = civicrm_state_province.id )
679 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
680 LEFT JOIN civicrm_location_type ON ( civicrm_location_type.id = civicrm_address.location_type_id )
681 WHERE civicrm_address.geo_code_1 IS NOT NULL
682 AND civicrm_address.geo_code_2 IS NOT NULL
683 AND civicrm_event.id = " . CRM_Utils_Type
::escape($id, 'Integer');
685 $dao = new CRM_Core_DAO();
688 $locations = array();
690 $config = CRM_Core_Config
::singleton();
692 while ($dao->fetch()) {
695 $location['displayName'] = addslashes($dao->display_name
);
696 $location['lat'] = $dao->latitude
;
697 $location['marker_class'] = 'Event';
698 $location['lng'] = $dao->longitude
;
700 $params = array('entity_id' => $id, 'entity_table' => 'civicrm_event');
701 $addressValues = CRM_Core_BAO_Location
::getValues($params, TRUE);
702 $location['address'] = str_replace(array(
705 ), '', addslashes(nl2br($addressValues['address'][1]['display_text'])));
707 $location['url'] = CRM_Utils_System
::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id
);
708 $location['location_type'] = $dao->location_type
;
709 $eventImage = '<img src="' . $config->resourceBase
. 'i/contact_org.gif" alt="Organization " height="20" width="15" />';
710 $location['image'] = $eventImage;
711 $location['displayAddress'] = str_replace('<br />', ', ', $location['address']);
712 $locations[] = $location;
718 * Get the complete information for one or more events.
721 * Get events with start date >= this date.
722 * @param int $type Get events on the a specific event type (by event_type_id).
723 * Get events on the a specific event type (by event_type_id).
724 * @param int $eventId Return a single event - by event id.
725 * Return a single event - by event id.
727 * Also get events with end date >= this date.
728 * @param bool $onlyPublic Include public events only, default TRUE.
729 * Include public events only, default TRUE.
732 * array of all the events that are searched
734 public static function &getCompleteInfo(
741 $publicCondition = NULL;
743 $publicCondition = " AND civicrm_event.is_public = 1";
747 // if start and end date are NOT passed, return all events with start_date OR end_date >= today CRM-5133
749 // get events with start_date >= requested start
750 $startDate = CRM_Utils_Type
::escape($start, 'Date');
751 $dateCondition .= " AND ( civicrm_event.start_date >= {$startDate} )";
755 // also get events with end_date <= requested end
756 $endDate = CRM_Utils_Type
::escape($end, 'Date');
757 $dateCondition .= " AND ( civicrm_event.end_date <= '{$endDate}' ) ";
760 // CRM-9421 and CRM-8620 Default mode for ical/rss feeds. No start or end filter passed.
761 // Need to exclude old events with only start date
762 // and not exclude events in progress (start <= today and end >= today). DGG
763 if (empty($start) && empty($end)) {
764 // get events with end date >= today, not sure of this logic
765 // but keeping this for backward compatibility as per issue CRM-5133
766 $today = date("Y-m-d G:i:s");
767 $dateCondition .= " AND ( civicrm_event.end_date >= '{$today}' OR civicrm_event.start_date >= '{$today}' ) ";
771 $typeCondition = " AND civicrm_event.event_type_id = " . CRM_Utils_Type
::escape($type, 'Integer');
774 // Get the Id of Option Group for Event Types
775 $optionGroupDAO = new CRM_Core_DAO_OptionGroup();
776 $optionGroupDAO->name
= 'event_type';
777 $optionGroupId = NULL;
778 if ($optionGroupDAO->find(TRUE)) {
779 $optionGroupId = $optionGroupDAO->id
;
784 civicrm_event.id as event_id,
785 civicrm_email.email as email,
786 civicrm_event.title as title,
787 civicrm_event.summary as summary,
788 civicrm_event.start_date as start,
789 civicrm_event.end_date as end,
790 civicrm_event.description as description,
791 civicrm_event.is_show_location as is_show_location,
792 civicrm_event.is_online_registration as is_online_registration,
793 civicrm_event.registration_link_text as registration_link_text,
794 civicrm_event.registration_start_date as registration_start_date,
795 civicrm_event.registration_end_date as registration_end_date,
796 civicrm_option_value.label as event_type,
797 civicrm_address.name as address_name,
798 civicrm_address.street_address as street_address,
799 civicrm_address.supplemental_address_1 as supplemental_address_1,
800 civicrm_address.supplemental_address_2 as supplemental_address_2,
801 civicrm_address.city as city,
802 civicrm_address.postal_code as postal_code,
803 civicrm_address.postal_code_suffix as postal_code_suffix,
804 civicrm_state_province.abbreviation as state,
805 civicrm_country.name AS country
807 LEFT JOIN civicrm_loc_block ON civicrm_event.loc_block_id = civicrm_loc_block.id
808 LEFT JOIN civicrm_address ON civicrm_loc_block.address_id = civicrm_address.id
809 LEFT JOIN civicrm_state_province ON civicrm_address.state_province_id = civicrm_state_province.id
810 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
811 LEFT JOIN civicrm_email ON civicrm_loc_block.email_id = civicrm_email.id
812 LEFT JOIN civicrm_option_value ON (
813 civicrm_event.event_type_id = civicrm_option_value.value AND
814 civicrm_option_value.option_group_id = %1 )
815 WHERE civicrm_event.is_active = 1
816 AND (is_template = 0 OR is_template IS NULL)
820 if (isset($typeCondition)) {
821 $query .= $typeCondition;
824 if (isset($eventId)) {
825 $query .= " AND civicrm_event.id =$eventId ";
827 $query .= " ORDER BY civicrm_event.start_date ASC";
829 $params = array(1 => array($optionGroupId, 'Integer'));
830 $dao = CRM_Core_DAO
::executeQuery($query, $params);
832 $config = CRM_Core_Config
::singleton();
834 $baseURL = parse_url($config->userFrameworkBaseURL
);
835 $url = "@" . $baseURL['host'];
836 if (!empty($baseURL['path'])) {
837 $url .= substr($baseURL['path'], 0, -1);
840 // check 'view event info' permission
841 //@todo - per CRM-14626 we have resolved that 'view event info' means 'view ALL event info'
842 // and passing in the specific permission here will short-circuit the evaluation of permission to
843 // see specific events (doesn't seem relevant to this call
844 // however, since this function is accessed only by a convoluted call from a joomla block function
845 // it seems safer not to touch here. Suggestion is that CRM_Core_Permission::check(array or relevant permissions) would
846 // be clearer & safer here
847 $permissions = CRM_Core_Permission
::event(CRM_Core_Permission
::VIEW
);
849 // check if we're in shopping cart mode for events
850 $enable_cart = Civi
::settings()->get('enable_cart');
853 while ($dao->fetch()) {
854 if (!empty($permissions) && in_array($dao->event_id
, $permissions)) {
856 $info['uid'] = "CiviCRM_EventID_{$dao->event_id}_" . md5($config->userFrameworkBaseURL
) . $url;
858 $info['title'] = $dao->title
;
859 $info['event_id'] = $dao->event_id
;
860 $info['summary'] = $dao->summary
;
861 $info['description'] = $dao->description
;
862 $info['start_date'] = $dao->start
;
863 $info['end_date'] = $dao->end
;
864 $info['contact_email'] = $dao->email
;
865 $info['event_type'] = $dao->event_type
;
866 $info['is_show_location'] = $dao->is_show_location
;
867 $info['is_online_registration'] = $dao->is_online_registration
;
868 $info['registration_link_text'] = $dao->registration_link_text
;
869 $info['registration_start_date'] = $dao->registration_start_date
;
870 $info['registration_end_date'] = $dao->registration_end_date
;
875 'address_name' => $dao->address_name
,
876 'street_address' => $dao->street_address
,
877 'supplemental_address_1' => $dao->supplemental_address_1
,
878 'supplemental_address_2' => $dao->supplemental_address_2
,
879 'city' => $dao->city
,
880 'state_province' => $dao->state
,
881 'postal_code' => $dao->postal_code
,
882 'postal_code_suffix' => $dao->postal_code_suffix
,
883 'country' => $dao->country
,
887 CRM_Utils_String
::append($address, ', ',
888 CRM_Utils_Address
::format($addrFields)
890 $info['location'] = $address;
891 $info['url'] = CRM_Utils_System
::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id
, TRUE, NULL, FALSE);
894 $reg = CRM_Event_Cart_BAO_EventInCart
::get_registration_link($dao->event_id
);
895 $info['registration_link'] = CRM_Utils_System
::url($reg['path'], $reg['query'], TRUE);
896 $info['registration_link_text'] = $reg['label'];
907 * Make a copy of a Event.
909 * Include all the fields in the event Wizard.
912 * The event id to copy.
913 * boolean $afterCreate call to copy after the create function
914 * @param null $newEvent
915 * @param bool $afterCreate
917 * @return CRM_Event_DAO_Event
919 public static function copy($id, $newEvent = NULL, $afterCreate = FALSE) {
921 $eventValues = array();
923 //get the require event values.
924 $eventParams = array('id' => $id);
925 $returnProperties = array(
929 'default_discount_fee_id',
933 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event', $eventParams, $eventValues, $returnProperties);
935 // since the location is sharable, lets use the same loc_block_id.
936 $locBlockId = CRM_Utils_Array
::value('loc_block_id', $eventValues);
938 $fieldsFix = ($afterCreate) ?
array() : array('prefix' => array('title' => ts('Copy of') . ' '));
939 if (empty($eventValues['is_show_location'])) {
940 $fieldsFix['prefix']['is_show_location'] = 0;
943 if ($newEvent && is_a($newEvent, 'CRM_Event_DAO_Event')) {
944 $copyEvent = $newEvent;
947 if (!isset($copyEvent)) {
948 $copyEvent = &CRM_Core_DAO
::copyGeneric('CRM_Event_DAO_Event',
952 ($locBlockId) ?
$locBlockId : NULL,
957 CRM_Price_BAO_PriceSet
::copyPriceSet('civicrm_event', $id, $copyEvent->id
);
958 $copyUF = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
961 'entity_table' => 'civicrm_event',
963 array('entity_id' => $copyEvent->id
)
966 $copyTellFriend = &CRM_Core_DAO
::copyGeneric('CRM_Friend_DAO_Friend',
969 'entity_table' => 'civicrm_event',
971 array('entity_id' => $copyEvent->id
)
974 $copyPCP = &CRM_Core_DAO
::copyGeneric('CRM_PCP_DAO_PCPBlock',
977 'entity_table' => 'civicrm_event',
979 array('entity_id' => $copyEvent->id
),
980 array('replace' => array('target_entity_id' => $copyEvent->id
))
983 $oldMapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings(array(
984 'id' => ($eventValues['is_template'] ? CRM_Event_ActionMapping
::EVENT_TPL_MAPPING_ID
: CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
),
986 $copyMapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings(array(
987 'id' => ($copyEvent->is_template
== 1 ? CRM_Event_ActionMapping
::EVENT_TPL_MAPPING_ID
: CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
),
989 $copyReminder = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_ActionSchedule',
990 array('entity_value' => $id, 'mapping_id' => $oldMapping->getId()),
991 array('entity_value' => $copyEvent->id
, 'mapping_id' => $copyMapping->getId())
996 $extends = array('event');
997 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
999 foreach ($groupTree as $groupID => $group) {
1000 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
1001 foreach ($group['fields'] as $fieldID => $field) {
1002 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
1006 foreach ($table as $tableName => $tableColumns) {
1007 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
1008 $tableColumns[0] = $copyEvent->id
;
1009 $select = 'SELECT ' . implode(', ', $tableColumns);
1010 $from = ' FROM ' . $tableName;
1011 $where = " WHERE {$tableName}.entity_id = {$id}";
1012 $query = $insert . $select . $from . $where;
1013 $dao = CRM_Core_DAO
::executeQuery($query);
1019 CRM_Utils_System
::flushCache();
1020 if (!$afterCreate) {
1021 CRM_Utils_Hook
::copy('Event', $copyEvent);
1027 * This is sometimes called in a loop (during event search).
1029 * We cache the values to prevent repeated calls to the db.
1035 public static function isMonetary($id) {
1036 static $isMonetary = array();
1037 if (!array_key_exists($id, $isMonetary)) {
1038 $isMonetary[$id] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event',
1043 return $isMonetary[$id];
1047 * This is sometimes called in a loop (during event search).
1049 * We cache the values to prevent repeated calls to the db.
1055 public static function usesPriceSet($id) {
1056 static $usesPriceSet = array();
1057 if (!array_key_exists($id, $usesPriceSet)) {
1058 $usesPriceSet[$id] = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $id);
1060 return $usesPriceSet[$id];
1066 * @param int $contactID
1067 * @param array $values
1068 * @param int $participantId
1069 * @param bool $isTest
1070 * @param bool $returnMessageText
1072 public static function sendMail($contactID, &$values, $participantId, $isTest = FALSE, $returnMessageText = FALSE) {
1074 $template = CRM_Core_Smarty
::singleton();
1076 'custom_pre_id' => $values['custom_pre_id'],
1077 'custom_post_id' => $values['custom_post_id'],
1080 //get the params submitted by participant.
1081 $participantParams = CRM_Utils_Array
::value($participantId, $values['params'], array());
1083 if (!$returnMessageText) {
1084 //send notification email if field values are set (CRM-1941)
1085 foreach ($gIds as $key => $gIdValues) {
1087 if (!is_array($gIdValues)) {
1088 $gIdValues = array($gIdValues);
1091 foreach ($gIdValues as $gId) {
1092 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
1094 //get values of corresponding profile fields for notification
1095 list($profileValues) = self
::buildCustomDisplay($gId,
1104 list($profileValues) = $profileValues;
1107 'values' => $profileValues,
1110 CRM_Core_BAO_UFGroup
::commonSendMail($contactID, $val);
1117 if ($values['event']['is_email_confirm'] ||
$returnMessageText) {
1118 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
1120 //send email only when email is present
1121 if (isset($email) ||
$returnMessageText) {
1122 $preProfileID = CRM_Utils_Array
::value('custom_pre_id', $values);
1123 $postProfileID = CRM_Utils_Array
::value('custom_post_id', $values);
1125 if (!empty($values['params']['additionalParticipant'])) {
1126 $preProfileID = CRM_Utils_Array
::value('additional_custom_pre_id', $values, $preProfileID);
1127 $postProfileID = CRM_Utils_Array
::value('additional_custom_post_id', $values, $postProfileID);
1130 self
::buildCustomDisplay($preProfileID,
1140 self
::buildCustomDisplay($postProfileID,
1150 $sessions = CRM_Event_Cart_BAO_Conference
::get_participant_sessions($participantId);
1152 $tplParams = array_merge($values, $participantParams, array(
1154 'confirm_email_text' => CRM_Utils_Array
::value('confirm_email_text', $values['event']),
1155 'isShowLocation' => CRM_Utils_Array
::value('is_show_location', $values['event']),
1156 // The concept of contributeMode is deprecated.
1157 'contributeMode' => CRM_Utils_Array
::value('contributeMode', $template->_tpl_vars
),
1158 'participantID' => $participantId,
1159 'conference_sessions' => $sessions,
1160 'credit_card_number' =>
1161 CRM_Utils_System
::mungeCreditCard(
1162 CRM_Utils_Array
::value('credit_card_number', $participantParams)),
1163 'credit_card_exp_date' =>
1164 CRM_Utils_Date
::mysqlToIso(
1165 CRM_Utils_Date
::format(
1166 CRM_Utils_Array
::value('credit_card_exp_date', $participantParams))),
1169 // CRM-13890 : NOTE wait list condition need to be given so that
1170 // wait list message is shown properly in email i.e. WRT online event registration template
1171 if (empty($tplParams['participant_status']) && empty($values['params']['isOnWaitlist'])) {
1172 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $participantId, 'status_id', 'id', TRUE);
1173 $tplParams['participant_status'] = CRM_Event_PseudoConstant
::participantStatus($statusId, NULL, 'label');
1175 //CRM-15754 - if participant_status contains status ID
1176 elseif (!empty($tplParams['participant_status']) && CRM_Utils_Rule
::integer($tplParams['participant_status'])) {
1177 $tplParams['participant_status'] = CRM_Event_PseudoConstant
::participantStatus($tplParams['participant_status'], NULL, 'label');
1180 $sendTemplateParams = array(
1181 'groupName' => 'msg_tpl_workflow_event',
1182 'valueName' => 'event_online_receipt',
1183 'contactId' => $contactID,
1184 'isTest' => $isTest,
1185 'tplParams' => $tplParams,
1186 'PDFFilename' => ts('confirmation') . '.pdf',
1189 // address required during receipt processing (pdf and email receipt)
1190 if ($displayAddress = CRM_Utils_Array
::value('address', $values)) {
1191 $sendTemplateParams['tplParams']['address'] = $displayAddress;
1192 // The concept of contributeMode is deprecated.
1193 $sendTemplateParams['tplParams']['contributeMode'] = NULL;
1196 // set lineItem details
1197 if ($lineItem = CRM_Utils_Array
::value('lineItem', $values)) {
1198 // check if additional participant, if so filter only to relevant ones
1200 if (!empty($values['params']['additionalParticipant'])) {
1201 $ownLineItems = array();
1202 foreach ($lineItem as $liKey => $liValue) {
1203 $firstElement = array_pop($liValue);
1204 if ($firstElement['entity_id'] == $participantId) {
1205 $ownLineItems[0] = $lineItem[$liKey];
1209 if (!empty($ownLineItems)) {
1210 $sendTemplateParams['tplParams']['lineItem'] = $ownLineItems;
1214 $sendTemplateParams['tplParams']['lineItem'] = $lineItem;
1218 if ($returnMessageText) {
1219 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1221 'subject' => $subject,
1223 'to' => $displayName,
1228 $sendTemplateParams['from'] = CRM_Utils_Array
::value('confirm_from_name', $values['event']) . " <" . CRM_Utils_Array
::value('confirm_from_email', $values['event']) . ">";
1229 $sendTemplateParams['toName'] = $displayName;
1230 $sendTemplateParams['toEmail'] = $email;
1231 $sendTemplateParams['autoSubmitted'] = TRUE;
1232 $sendTemplateParams['cc'] = CRM_Utils_Array
::value('cc_confirm',
1235 $sendTemplateParams['bcc'] = CRM_Utils_Array
::value('bcc_confirm',
1238 // append invoice pdf to email
1239 $template = CRM_Core_Smarty
::singleton();
1240 $taxAmt = $template->get_template_vars('totalTaxAmount');
1241 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
1242 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
1243 if (isset($invoicing) && isset($prefixValue['is_email_pdf']) && !empty($values['contributionId'])) {
1244 $sendTemplateParams['isEmailPdf'] = TRUE;
1245 $sendTemplateParams['contributionId'] = $values['contributionId'];
1247 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1254 * Add the custom fields OR array of participant's profile info.
1257 * @param string $name
1259 * @param string $template
1260 * @param int $participantId
1261 * @param bool $isTest
1262 * @param bool $isCustomProfile
1263 * @param array $participantParams
1265 * @return array|null
1267 public static function buildCustomDisplay(
1274 $isCustomProfile = FALSE,
1275 $participantParams = array()
1278 return array(NULL, NULL);
1281 if (!is_array($id)) {
1282 $id = CRM_Utils_Type
::escape($id, 'Positive');
1283 $profileIds = array($id);
1289 $val = $groupTitles = NULL;
1290 foreach ($profileIds as $gid) {
1291 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid)) {
1293 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
,
1294 NULL, NULL, FALSE, NULL,
1295 FALSE, NULL, CRM_Core_Permission
::CREATE
,
1299 //this condition is added, since same contact can have multiple event registrations..
1300 $params = array(array('participant_id', '=', $participantId, 0, 0));
1302 //add participant id
1303 $fields['participant_id'] = array(
1304 'name' => 'participant_id',
1305 'title' => ts('Participant ID'),
1307 //check whether its a text drive
1309 $params[] = array('participant_test', '=', 1, 0, 0);
1312 //display campaign on thankyou page.
1313 if (array_key_exists('participant_campaign_id', $fields)) {
1314 if ($participantId) {
1315 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1319 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1320 $values[$fields['participant_campaign_id']['title']] = CRM_Utils_Array
::value($campaignId,
1324 unset($fields['participant_campaign_id']);
1328 foreach ($fields as $k => $v) {
1330 $groupTitle = $v['groupTitle'];
1332 // suppress all file fields from display
1334 CRM_Utils_Array
::value('data_type', $v, '') == 'File' ||
1335 CRM_Utils_Array
::value('name', $v, '') == 'image_URL' ||
1336 CRM_Utils_Array
::value('field_type', $v) == 'Formatting'
1343 $groupTitles[] = $groupTitle;
1345 //display profile groups those are subscribed by participant.
1346 if (($groups = CRM_Utils_Array
::value('group', $participantParams)) &&
1350 foreach ($groups as $grpId => $isSelected) {
1355 if (!empty($grpIds)) {
1356 //get the group titles.
1357 $grpTitles = array();
1358 $query = 'SELECT title FROM civicrm_group where id IN ( ' . implode(',', $grpIds) . ' )';
1359 $grp = CRM_Core_DAO
::executeQuery($query);
1360 while ($grp->fetch()) {
1361 $grpTitles[] = $grp->title
;
1363 if (!empty($grpTitles) &&
1364 CRM_Utils_Array
::value('title', CRM_Utils_Array
::value('group', $fields))
1366 $values[$fields['group']['title']] = implode(', ', $grpTitles);
1368 unset($fields['group']);
1372 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params);
1374 if (isset($fields['participant_status_id']['title']) &&
1375 isset($values[$fields['participant_status_id']['title']]) &&
1376 is_numeric($values[$fields['participant_status_id']['title']])
1379 $status = CRM_Event_PseudoConstant
::participantStatus();
1380 $values[$fields['participant_status_id']['title']] = $status[$values[$fields['participant_status_id']['title']]];
1383 if (isset($fields['participant_role_id']['title']) &&
1384 isset($values[$fields['participant_role_id']['title']]) &&
1385 is_numeric($values[$fields['participant_role_id']['title']])
1388 $roles = CRM_Event_PseudoConstant
::participantRole();
1389 $values[$fields['participant_role_id']['title']] = $roles[$values[$fields['participant_role_id']['title']]];
1392 if (isset($fields['participant_register_date']['title']) &&
1393 isset($values[$fields['participant_register_date']['title']])
1395 $values[$fields['participant_register_date']['title']] = CRM_Utils_Date
::customFormat($values[$fields['participant_register_date']['title']]);
1398 //handle fee_level for price set
1399 if (isset($fields['participant_fee_level']['title']) &&
1400 isset($values[$fields['participant_fee_level']['title']])
1402 $feeLevel = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1403 $values[$fields['participant_fee_level']['title']]
1405 foreach ($feeLevel as $key => $value) {
1407 unset($feeLevel[$key]);
1410 $values[$fields['participant_fee_level']['title']] = implode(',', $feeLevel);
1413 unset($values[$fields['participant_id']['title']]);
1420 $template->assign($name, $val);
1423 if (count($groupTitles)) {
1424 $template->assign($name . '_grouptitle', $groupTitles);
1427 //return if we only require array of participant's info.
1428 if ($isCustomProfile) {
1430 return array($val, $groupTitles);
1439 * Build the array for display the profile fields.
1441 * @param array $params
1445 * @param array $groupTitle
1446 * Profile Group Title.
1447 * @param array $values
1448 * Formatted array of key value.
1450 * @param array $profileFields
1452 public static function displayProfile(&$params, $gid, &$groupTitle, &$values, &$profileFields = array()) {
1454 $config = CRM_Core_Config
::singleton();
1455 $session = CRM_Core_Session
::singleton();
1456 $contactID = $session->get('userID');
1458 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $contactID)) {
1459 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
1463 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::ADD
);
1466 foreach ($fields as $v) {
1467 if (!empty($v['groupTitle'])) {
1468 $groupTitle['groupTitle'] = $v['groupTitle'];
1473 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
1474 //start of code to set the default values
1475 foreach ($fields as $name => $field) {
1478 // skip fields that should not be displayed separately
1479 if ($field['skipDisplay']) {
1483 $index = $field['title'];
1484 if ($name === 'organization_name') {
1485 $values[$index] = $params[$name];
1488 if ('state_province' == substr($name, 0, 14)) {
1489 if ($params[$name]) {
1490 $values[$index] = CRM_Core_PseudoConstant
::stateProvince($params[$name]);
1493 $values[$index] = '';
1496 elseif ('date' == substr($name, -4)) {
1497 $values[$index] = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::processDate($params[$name]),
1498 $config->dateformatFull
);
1500 elseif ('country' == substr($name, 0, 7)) {
1501 if ($params[$name]) {
1502 $values[$index] = CRM_Core_PseudoConstant
::country($params[$name]);
1505 $values[$index] = '';
1508 elseif ('county' == substr($name, 0, 6)) {
1509 if ($params[$name]) {
1510 $values[$index] = CRM_Core_PseudoConstant
::county($params[$name]);
1513 $values[$index] = '';
1516 elseif (in_array(substr($name, 0, -3), array('gender', 'prefix', 'suffix', 'communication_style'))) {
1517 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', $name, $params[$name]);
1519 elseif (in_array($name, array(
1524 $filterCondition = array('greeting_type' => $name);
1525 $greeting = CRM_Core_PseudoConstant
::greeting($filterCondition);
1526 $values[$index] = $greeting[$params[$name]];
1528 elseif ($name === 'preferred_communication_method') {
1529 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1531 $pref = $params[$name];
1532 if (is_array($pref)) {
1533 foreach ($pref as $k => $v) {
1535 $compref[] = $communicationFields[$k];
1539 $values[$index] = implode(',', $compref);
1541 elseif ($name == 'contact_sub_type') {
1542 $values[$index] = implode(', ', $params[$name]);
1544 elseif ($name == 'group') {
1545 $groups = CRM_Contact_BAO_GroupContact
::getGroupList();
1547 foreach ($params[$name] as $gId => $dontCare) {
1549 $title[] = $groups[$gId];
1552 $values[$index] = implode(', ', $title);
1554 elseif ($name == 'tag') {
1555 $entityTags = $params[$name];
1556 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1558 if (is_array($entityTags)) {
1559 foreach ($entityTags as $tagId => $dontCare) {
1560 $title[] = $allTags[$tagId];
1563 $values[$index] = implode(', ', $title);
1565 elseif ('participant_role_id' == $name OR
1566 'participant_role' == $name
1568 $roles = CRM_Event_PseudoConstant
::participantRole();
1569 $values[$index] = $roles[$params[$name]];
1571 elseif ('participant_status_id' == $name OR
1572 'participant_status' == $name
1574 $status = CRM_Event_PseudoConstant
::participantStatus();
1575 $values[$index] = $status[$params[$name]];
1577 elseif (substr($name, -11) == 'campaign_id') {
1578 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($params[$name]);
1579 $values[$index] = CRM_Utils_Array
::value($params[$name], $campaigns);
1581 elseif (strpos($name, '-') !== FALSE) {
1582 list($fieldName, $id) = CRM_Utils_System
::explode('-', $name, 2);
1583 $detailName = str_replace(' ', '_', $name);
1584 if (in_array($fieldName, array(
1589 $values[$index] = $params[$detailName];
1590 $idx = $detailName . '_id';
1591 $values[$index] = $params[$idx];
1593 elseif ($fieldName == 'im') {
1594 $providerName = NULL;
1595 if ($providerId = $detailName . '-provider_id') {
1596 $providerName = CRM_Utils_Array
::value($params[$providerId], $imProviders);
1598 if ($providerName) {
1599 $values[$index] = $params[$detailName] . " (" . $providerName . ")";
1602 $values[$index] = $params[$detailName];
1605 elseif ($fieldName == 'phone') {
1606 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1607 if (isset($params[$phoneExtField])) {
1608 $values[$index] = $params[$detailName] . " (" . $params[$phoneExtField] . ")";
1611 $values[$index] = $params[$detailName];
1615 $values[$index] = $params[$detailName];
1619 if (substr($name, 0, 7) === 'do_not_' or substr($name, 0, 3) === 'is_') {
1620 if ($params[$name]) {
1621 $values[$index] = '[ x ]';
1625 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1627 SELECT html_type, data_type
1628 FROM civicrm_custom_field
1631 $dao = CRM_Core_DAO
::executeQuery($query);
1633 $htmlType = $dao->html_type
;
1635 if ($htmlType == 'File') {
1636 $values[$index] = $params[$index];
1639 if ($dao->data_type
== 'Int' ||
1640 $dao->data_type
== 'Boolean'
1642 $v = $params[$name];
1643 if (!CRM_Utils_System
::isNull($v)) {
1644 $customVal = (int) $v;
1647 elseif ($dao->data_type
== 'Float') {
1648 $customVal = (float ) ($params[$name]);
1650 elseif ($dao->data_type
== 'Date') {
1651 //@todo note the currently we are using default date time formatting. Since you can select/set
1652 // different date and time format specific to custom field we should consider fixing this
1653 // sometime in the future
1654 $customVal = $displayValue = CRM_Utils_Date
::customFormat(
1655 CRM_Utils_Date
::processDate($params[$name]), $config->dateformatFull
);
1657 if (!empty($params[$name . '_time'])) {
1658 $customVal = $displayValue = CRM_Utils_Date
::customFormat(
1659 CRM_Utils_Date
::processDate($params[$name], $params[$name . '_time']),
1660 $config->dateformatDatetime
);
1665 $customVal = $params[$name];
1667 //take the custom field options
1668 $returnProperties = array($name => 1);
1669 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
1671 $displayValue = CRM_Core_BAO_CustomField
::displayValue($customVal, $cfID);
1673 //Hack since we dont have function to check empty.
1674 //FIXME in 2.3 using crmIsEmptyArray()
1675 $customValue = TRUE;
1676 if (is_array($customVal) && is_array($displayValue)) {
1677 $customValue = array_diff($customVal, $displayValue);
1679 //use difference of arrays
1680 if (empty($customValue) ||
!$customValue) {
1681 $values[$index] = '';
1684 $values[$index] = $displayValue;
1688 elseif ($name == 'home_URL' &&
1689 !empty($params[$name])
1691 $url = CRM_Utils_System
::fixURL($params[$name]);
1692 $values[$index] = "<a href=\"$url\">{$params[$name]}</a>";
1694 elseif (in_array($name, array(
1697 'participant_register_date',
1699 $values[$index] = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format($params[$name]));
1702 $values[$index] = CRM_Utils_Array
::value($name, $params);
1706 $profileFields[$name] = $field;
1712 * Build the array for Additional participant's information array of primary and additional Ids.
1714 * @param int $participantId
1715 * Id of Primary participant.
1716 * @param array $values
1717 * Key/value event info.
1718 * @param int $contactId
1719 * Contact id of Primary participant.
1720 * @param bool $isTest
1721 * Whether test or live transaction.
1722 * @param bool $isIdsArray
1723 * To return an array of Ids.
1725 * @param bool $skipCancel
1728 * array of Additional participant's info OR array of Ids.
1730 public static function buildCustomProfile(
1735 $isIdsArray = FALSE,
1739 $customProfile = $additionalIDs = array();
1740 if (!$participantId) {
1741 CRM_Core_Error
::fatal(ts('Cannot find participant ID'));
1744 //set Ids of Primary Participant also.
1745 if ($isIdsArray && $contactId) {
1746 $additionalIDs[$participantId] = $contactId;
1749 //hack to skip cancelled participants, CRM-4320
1750 $where = "participant.registered_by_id={$participantId}";
1752 $cancelStatusId = 0;
1753 $negativeStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Negative'");
1754 $cancelStatusId = array_search('Cancelled', $negativeStatuses);
1755 $where .= " AND participant.status_id != {$cancelStatusId}";
1758 SELECT participant.id, participant.contact_id
1759 FROM civicrm_participant participant
1762 $dao = CRM_Core_DAO
::executeQuery($query);
1763 while ($dao->fetch()) {
1764 $additionalIDs[$dao->id
] = $dao->contact_id
;
1767 //return if only array is required.
1768 if ($isIdsArray && $contactId) {
1769 return $additionalIDs;
1772 $preProfileID = CRM_Utils_Array
::value('additional_custom_pre_id', $values);
1773 $postProfileID = CRM_Utils_Array
::value('additional_custom_post_id', $values);
1774 //else build array of Additional participant's information.
1775 if (count($additionalIDs)) {
1776 if ($preProfileID ||
$postProfileID) {
1777 $template = CRM_Core_Smarty
::singleton();
1779 $isCustomProfile = TRUE;
1781 $title = $groupTitles = array();
1782 foreach ($additionalIDs as $pId => $cId) {
1783 //get the params submitted by participant.
1784 $participantParams = CRM_Utils_Array
::value($pId, $values['params'], array());
1786 list($profilePre, $groupTitles) = self
::buildCustomDisplay($preProfileID,
1787 'additionalCustomPre',
1797 $profile = $profilePre;
1798 // $customProfile[$i] = array_merge( $groupTitles, $customProfile[$i] );
1800 $title = $groupTitles;
1804 list($profilePost, $groupTitles) = self
::buildCustomDisplay($postProfileID,
1805 'additionalCustomPost',
1815 if (isset($profilePre)) {
1816 $profile = array_merge($profilePre, $profilePost);
1818 $title = array_merge($title, $groupTitles);
1822 $profile = $profilePost;
1824 $title = $groupTitles;
1828 $profiles[] = $profile;
1831 $customProfile['title'] = $title;
1832 $customProfile['profile'] = $profiles;
1836 return $customProfile;
1839 /* Function to retrieve all events those having location block set.
1842 * array of all events.
1847 public static function getLocationEvents() {
1851 SELECT CONCAT_WS(' :: ' , ca.name, ca.street_address, ca.city, sp.name, ca.supplemental_address_1, ca.supplemental_address_2) title, ce.loc_block_id
1852 FROM civicrm_event ce
1853 INNER JOIN civicrm_loc_block lb ON ce.loc_block_id = lb.id
1854 INNER JOIN civicrm_address ca ON lb.address_id = ca.id
1855 LEFT JOIN civicrm_state_province sp ON ca.state_province_id = sp.id
1856 ORDER BY sp.name, ca.city, ca.street_address ASC
1859 $dao = CRM_Core_DAO
::executeQuery($query);
1860 while ($dao->fetch()) {
1861 $events[$dao->loc_block_id
] = $dao->title
;
1868 * @param int $locBlockId
1870 * @return int|null|string
1872 public static function countEventsUsingLocBlockId($locBlockId) {
1877 $locBlockId = CRM_Utils_Type
::escape($locBlockId, 'Integer');
1880 SELECT count(*) FROM civicrm_event ce
1881 WHERE ce.loc_block_id = $locBlockId";
1883 return CRM_Core_DAO
::singleValueQuery($query);
1887 * Check if event registration is valid according to permissions AND Dates.
1889 * @param array $values
1890 * @param int $eventID
1893 public static function validRegistrationRequest($values, $eventID) {
1894 // check that the user has permission to register for this event
1895 $hasPermission = CRM_Core_Permission
::event(CRM_Core_Permission
::EDIT
,
1896 $eventID, 'register for events'
1899 return $hasPermission && self
::validRegistrationDate($values);
1907 public static function validRegistrationDate(&$values) {
1908 // make sure that we are between registration start date and end dates
1909 // and that if the event has ended, registration is still specifically open
1910 $startDate = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('registration_start_date', $values));
1911 $endDate = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('registration_end_date', $values));
1912 $eventEnd = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('end_date', $values));
1915 if ($startDate && $startDate >= $now) {
1918 elseif ($endDate && $endDate < $now) {
1921 elseif ($eventEnd && $eventEnd < $now && !$endDate) {
1928 /* Function to Show - Hide the Registration Link.
1930 * @param array $values
1931 * Key/value event info.
1933 * true if allow registration otherwise false
1940 public static function showHideRegistrationLink($values) {
1942 $session = CRM_Core_Session
::singleton();
1943 $contactID = $session->get('userID');
1944 $alreadyRegistered = FALSE;
1947 $params = array('contact_id' => $contactID);
1949 if ($eventId = CRM_Utils_Array
::value('id', $values['event'])) {
1950 $params['event_id'] = $eventId;
1952 if ($roleId = CRM_Utils_Array
::value('default_role_id', $values['event'])) {
1953 $params['role_id'] = $roleId;
1955 $alreadyRegistered = self
::checkRegistration($params);
1958 if (!empty($values['event']['allow_same_participant_emails']) ||
1966 /* Function to check if given contact is already registered.
1968 * @param array $params
1969 * Key/value participant info.
1973 * @param array $params
1977 public static function checkRegistration($params) {
1978 $alreadyRegistered = FALSE;
1979 if (empty($params['contact_id'])) {
1980 return $alreadyRegistered;
1983 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
1985 $participant = new CRM_Event_DAO_Participant();
1986 $participant->copyValues($params);
1988 $participant->is_test
= CRM_Utils_Array
::value('is_test', $params, 0);
1989 $participant->selectAdd();
1990 $participant->selectAdd('status_id');
1991 if ($participant->find(TRUE) && array_key_exists($participant->status_id
, $statusTypes)) {
1992 $alreadyRegistered = TRUE;
1995 return $alreadyRegistered;
1999 * Make sure that the user has permission to access this event.
2001 * @param int $eventId
2005 * the permission that the user has (or null)
2007 public static function checkPermission($eventId = NULL, $type = CRM_Core_Permission
::VIEW
) {
2008 static $permissions = NULL;
2010 if (empty($permissions)) {
2011 $allEvents = CRM_Event_PseudoConstant
::event(NULL, TRUE);
2012 $createdEvents = array();
2014 $session = CRM_Core_Session
::singleton();
2015 if ($userID = $session->get('userID')) {
2016 $createdEvents = array_keys(CRM_Event_PseudoConstant
::event(NULL, TRUE, "created_id={$userID}"));
2019 // Note: for a multisite setup, a user with edit all events, can edit all events
2020 // including those from other sites
2021 if (CRM_Core_Permission
::check('edit all events')) {
2022 $permissions[CRM_Core_Permission
::EDIT
] = array_keys($allEvents);
2025 $permissions[CRM_Core_Permission
::EDIT
] = CRM_ACL_API
::group(CRM_Core_Permission
::EDIT
, NULL, 'civicrm_event', $allEvents, $createdEvents);
2028 if (CRM_Core_Permission
::check('edit all events')) {
2029 $permissions[CRM_Core_Permission
::VIEW
] = array_keys($allEvents);
2032 if (CRM_Core_Permission
::check('access CiviEvent') &&
2033 CRM_Core_Permission
::check('view event participants')
2035 // use case: allow "view all events" but NOT "edit all events"
2036 // so for a normal site allow users with these two permissions to view all events AND
2037 // at the same time also allow any hook to override if needed.
2038 $createdEvents = array_keys($allEvents);
2040 $permissions[CRM_Core_Permission
::VIEW
] = CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_event', $allEvents, $createdEvents);
2043 $permissions[CRM_Core_Permission
::DELETE
] = array();
2044 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
2045 // Note: we want to restrict the scope of delete permission to
2046 // events that are editable/viewable (usecase multisite).
2047 // We can remove array_intersect once we have ACL support for delete functionality.
2048 $permissions[CRM_Core_Permission
::DELETE
] = array_intersect($permissions[CRM_Core_Permission
::EDIT
],
2049 $permissions[CRM_Core_Permission
::VIEW
]
2055 return in_array($eventId, $permissions[$type]) ?
TRUE : FALSE;
2058 return $permissions;
2062 * Build From Email as the combination of all the email ids of the logged in user,
2063 * the domain email id and the email id configured for the event
2065 * @param int $eventId
2066 * The id of the event.
2069 * an array of email ids
2071 public static function getFromEmailIds($eventId = NULL) {
2072 $fromEmailValues['from_email_id'] = CRM_Core_BAO_Email
::getFromEmail();
2075 // add the email id configured for the event
2076 $params = array('id' => $eventId);
2077 $returnProperties = array('confirm_from_name', 'confirm_from_email', 'cc_confirm', 'bcc_confirm');
2078 $eventEmail = array();
2080 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event', $params, $eventEmail, $returnProperties);
2081 if (!empty($eventEmail['confirm_from_name']) && !empty($eventEmail['confirm_from_email'])) {
2082 $eventEmailId = "{$eventEmail['confirm_from_name']} <{$eventEmail['confirm_from_email']}>";
2084 $fromEmailValues['from_email_id'][$eventEmailId] = htmlspecialchars($eventEmailId);
2085 $fromEmailId = array(
2086 'cc' => CRM_Utils_Array
::value('cc_confirm', $eventEmail),
2087 'bcc' => CRM_Utils_Array
::value('bcc_confirm', $eventEmail),
2089 $fromEmailValues = array_merge($fromEmailValues, $fromEmailId);
2093 return $fromEmailValues;
2097 * Calculate event total seats occupied.
2099 * @param int $eventId
2101 * @param sting $extraWhereClause
2102 * Extra filter on participants.
2105 * event total seats w/ given criteria.
2107 public static function eventTotalSeats($eventId, $extraWhereClause = NULL) {
2108 if (empty($eventId)) {
2112 $extraWhereClause = trim($extraWhereClause);
2113 if (!empty($extraWhereClause)) {
2114 $extraWhereClause = " AND ( {$extraWhereClause} )";
2117 //event seats calculation :
2118 //1. consider event seat as a single when participant does not have line item.
2119 //2. consider event seat as a single when participant has line items but does not
2120 // have count for corresponding price field value ( ie price field value does not carry any seat )
2121 //3. consider event seat as a sum of all seats from line items in case price field value carries count.
2124 SELECT IF ( SUM( value.count*lineItem.qty ),
2125 SUM( value.count*lineItem.qty ) +
2126 COUNT( DISTINCT participant.id ) -
2127 COUNT( DISTINCT IF ( value.count, participant.id, NULL ) ),
2128 COUNT( DISTINCT participant.id ) )
2129 FROM civicrm_participant participant
2130 INNER JOIN civicrm_contact contact ON ( contact.id = participant.contact_id AND contact.is_deleted = 0 )
2131 INNER JOIN civicrm_event event ON ( event.id = participant.event_id )
2132 LEFT JOIN civicrm_line_item lineItem ON ( lineItem.entity_id = participant.id
2133 AND lineItem.entity_table = 'civicrm_participant' )
2134 LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_value_id AND value.count )
2135 WHERE ( participant.event_id = %1 )
2136 AND participant.is_test = 0
2138 GROUP BY participant.event_id";
2140 return (int) CRM_Core_DAO
::singleValueQuery($query, array(1 => array($eventId, 'Positive')));
2144 * Retrieve event template default values to be set.
2145 * as default values for current new event.
2147 * @param int $templateId
2148 * Event template id.
2151 * Array of custom data defaults.
2153 public static function getTemplateDefaultValues($templateId) {
2154 $defaults = array();
2159 $templateParams = array('id' => $templateId);
2160 CRM_Event_BAO_Event
::retrieve($templateParams, $defaults);
2161 $fieldsToExclude = array(
2164 'default_discount_fee_id',
2170 $defaults = array_diff_key($defaults, array_flip($fieldsToExclude));
2175 * @param int $event_id
2179 public static function get_sub_events($event_id) {
2180 $params = array('parent_event_id' => $event_id);
2181 $defaults = array();
2182 return CRM_Event_BAO_Event
::retrieve($params, $defaults);
2186 * Update the Campaign Id of all the participants of the given event.
2188 * @param int $eventID
2190 * @param int $eventCampaignID
2191 * Campaign id of that event.
2193 public static function updateParticipantCampaignID($eventID, $eventCampaignID) {
2195 $params[1] = array($eventID, 'Integer');
2197 if (empty($eventCampaignID)) {
2198 $query = "UPDATE civicrm_participant SET campaign_id = NULL WHERE event_id = %1";
2201 $query = "UPDATE civicrm_participant SET campaign_id = %2 WHERE event_id = %1";
2202 $params[2] = array($eventCampaignID, 'Integer');
2204 CRM_Core_DAO
::executeQuery($query, $params);
2208 * Get options for a given field.
2209 * @see CRM_Core_DAO::buildOptions
2211 * @param string $fieldName
2212 * @param string $context : @see CRM_Core_DAO::buildOptionsContext
2213 * @param array $props : whatever is known about this dao object
2215 * @return array|bool
2217 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2219 // Special logic for fields whose options depend on context or properties
2220 switch ($fieldName) {
2221 case 'financial_type_id':
2222 // Fixme - this is going to ignore context, better to get conditions, add params, and call PseudoConstant::get
2223 return CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
2227 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);