3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 class CRM_Event_BAO_Event
extends CRM_Event_DAO_Event
{
40 public function __construct() {
41 parent
::__construct();
45 * Fetch object based on array of properties.
47 * @param array $params
48 * (reference ) an assoc array of name/value pairs.
49 * @param array $defaults
50 * (reference ) an assoc array to hold the flattened values.
52 * @return CRM_Event_BAO_ManageEvent
54 public static function retrieve(&$params, &$defaults) {
55 $event = new CRM_Event_DAO_Event();
56 $event->copyValues($params);
57 if ($event->find(TRUE)) {
58 CRM_Core_DAO
::storeValues($event, $defaults);
65 * Update the is_active flag in the db.
68 * Id of the database record.
69 * @param bool $is_active
70 * Value we want to set the is_active field.
73 * DAO object on success, null otherwise
75 public static function setIsActive($id, $is_active) {
76 return CRM_Core_DAO
::setFieldValue('CRM_Event_DAO_Event', $id, 'is_active', $is_active);
82 * @param array $params
83 * Reference array contains the values submitted by the form.
88 public static function add(&$params) {
89 CRM_Utils_System
::flushCache();
90 $financialTypeId = NULL;
91 if (!empty($params['id'])) {
92 CRM_Utils_Hook
::pre('edit', 'Event', $params['id'], $params);
93 if (empty($params['skipFinancialType'])) {
94 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['id'], 'financial_type_id');
98 CRM_Utils_Hook
::pre('create', 'Event', NULL, $params);
101 $event = new CRM_Event_DAO_Event();
103 $event->copyValues($params);
104 $result = $event->save();
106 if (!empty($params['id'])) {
107 CRM_Utils_Hook
::post('edit', 'Event', $event->id
, $event);
110 CRM_Utils_Hook
::post('create', 'Event', $event->id
, $event);
112 if ($financialTypeId && !empty($params['financial_type_id']) && $financialTypeId != $params['financial_type_id']) {
113 CRM_Price_BAO_PriceFieldValue
::updateFinancialType($params['id'], 'civicrm_event', $params['financial_type_id']);
121 * @param array $params
122 * Reference array contains the values submitted by the form.
126 public static function create(&$params) {
127 $transaction = new CRM_Core_Transaction();
128 if (empty($params['is_template'])) {
129 $params['is_template'] = 0;
131 // check if new event, if so set the created_id (if not set)
132 // and always set created_date to now
133 if (empty($params['id'])) {
134 if (empty($params['created_id'])) {
135 $session = CRM_Core_Session
::singleton();
136 $params['created_id'] = $session->get('userID');
138 $params['created_date'] = date('YmdHis');
141 $event = self
::add($params);
142 CRM_Price_BAO_PriceSet
::setPriceSets($params, $event, 'event');
143 if (is_a($event, 'CRM_Core_Error')) {
144 CRM_Core_DAO
::transaction('ROLLBACK');
148 $session = CRM_Core_Session
::singleton();
149 $contactId = $session->get('userID');
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, CRM_Core_DAO
::$_nullArray);
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,
226 * if not being used by any other event.
229 * Location block id to be deleted.
230 * @param int $eventId
231 * 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.
326 * Array of event summary values
328 public static function getEventSummary() {
329 $eventSummary = $eventIds = array();
330 $config = CRM_Core_Config
::singleton();
332 // get permission and include them here
333 // does not scale, but rearranging code for now
334 // FIXME in a future release
335 $permissions = CRM_Event_BAO_Event
::checkPermission();
337 if (empty($permissions[CRM_Core_Permission
::VIEW
])) {
338 $eventSummary['total_events'] = 0;
339 return $eventSummary;
342 $validEventIDs = " AND civicrm_event.id IN ( " . implode(',', array_values($permissions[CRM_Core_Permission
::VIEW
])) . " ) ";
345 // We're fetching recent and upcoming events (where start date is 7 days ago OR later)
347 SELECT count(id) as total_events
349 WHERE civicrm_event.is_active = 1 AND
350 ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0) AND
351 civicrm_event.start_date >= DATE_SUB( NOW(), INTERVAL 7 day )
354 $dao = CRM_Core_DAO
::executeQuery($query);
357 $eventSummary['total_events'] = $dao->total_events
;
360 if (empty($eventSummary) ||
361 $dao->total_events
== 0
363 return $eventSummary;
366 //get the participant status type values.
367 $cpstObject = new CRM_Event_DAO_ParticipantStatusType();
368 $cpst = $cpstObject->getTableName();
369 $query = "SELECT id, name, label, class FROM $cpst";
370 $status = CRM_Core_DAO
::executeQuery($query);
371 $statusValues = array();
372 while ($status->fetch()) {
373 $statusValues[$status->id
]['id'] = $status->id
;
374 $statusValues[$status->id
]['name'] = $status->name
;
375 $statusValues[$status->id
]['label'] = $status->label
;
376 $statusValues[$status->id
]['class'] = $status->class;
379 // Get the Id of Option Group for Event Types
380 $optionGroupDAO = new CRM_Core_DAO_OptionGroup();
381 $optionGroupDAO->name
= 'event_type';
382 $optionGroupId = NULL;
383 if ($optionGroupDAO->find(TRUE)) {
384 $optionGroupId = $optionGroupDAO->id
;
386 // Get the event summary display preferences
387 $show_max_events = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::EVENT_PREFERENCES_NAME
,
390 // default to 10 if no option is set
391 if (is_null($show_max_events)) {
392 $show_max_events = 10;
394 // show all events if show_events is set to a negative value
395 if ($show_max_events >= 0) {
396 $event_summary_limit = "LIMIT 0, $show_max_events";
399 $event_summary_limit = "";
403 SELECT civicrm_event.id as id, civicrm_event.title as event_title, civicrm_event.is_public as is_public,
404 civicrm_event.max_participants as max_participants, civicrm_event.start_date as start_date,
405 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,
406 civicrm_event.slot_label_id,
407 civicrm_event.summary as summary,
408 civicrm_pcp_block.id as is_pcp_enabled,
409 civicrm_recurring_entity.parent_id as is_repeating_event
411 LEFT JOIN civicrm_option_value ON (
412 civicrm_event.event_type_id = civicrm_option_value.value AND
413 civicrm_option_value.option_group_id = %1 )
414 LEFT JOIN civicrm_tell_friend ON ( civicrm_tell_friend.entity_id = civicrm_event.id AND civicrm_tell_friend.entity_table = 'civicrm_event' )
415 LEFT JOIN civicrm_pcp_block ON ( civicrm_pcp_block.entity_id = civicrm_event.id AND civicrm_pcp_block.entity_table = 'civicrm_event')
416 LEFT JOIN civicrm_recurring_entity ON ( civicrm_event.id = civicrm_recurring_entity.entity_id AND civicrm_recurring_entity.entity_table = 'civicrm_event' )
417 WHERE civicrm_event.is_active = 1 AND
418 ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0) AND
419 civicrm_event.start_date >= DATE_SUB( NOW(), INTERVAL 7 day )
421 GROUP BY civicrm_event.id
422 ORDER BY civicrm_event.start_date ASC
425 $eventParticipant = array();
429 'eventTitle' => 'event_title',
430 'isPublic' => 'is_public',
431 'maxParticipants' => 'max_participants',
432 'startDate' => 'start_date',
433 'endDate' => 'end_date',
434 'eventType' => 'event_type',
436 'participants' => 'participants',
437 'notCountedDueToRole' => 'notCountedDueToRole',
438 'notCountedDueToStatus' => 'notCountedDueToStatus',
439 'notCountedParticipants' => 'notCountedParticipants',
442 $params = array(1 => array($optionGroupId, 'Integer'));
443 $mapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings(array(
444 'id' => CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
,
446 $dao = CRM_Core_DAO
::executeQuery($query, $params);
447 while ($dao->fetch()) {
448 foreach ($properties as $property => $name) {
458 $eventSummary['events'][$dao->id
][$property] = $set;
462 if ($dao->$name && $config->mapAPIKey
) {
465 $params = array('entity_id' => $dao->id
, 'entity_table' => 'civicrm_event');
466 $values['location'] = CRM_Core_BAO_Location
::getValues($params, TRUE);
467 if (is_numeric(CRM_Utils_Array
::value('geo_code_1', $values['location']['address'][1])) ||
469 !empty($values['location']['address'][1]['city']) &&
470 !empty($values['location']['address'][1]['state_province_id'])
473 $set = CRM_Utils_System
::url('civicrm/contact/map/event', "reset=1&eid={$dao->id}");
477 $eventSummary['events'][$dao->id
][$property] = $set;
478 if (is_array($permissions[CRM_Core_Permission
::EDIT
])
479 && in_array($dao->id
, $permissions[CRM_Core_Permission
::EDIT
])) {
480 $eventSummary['events'][$dao->id
]['configure'] = CRM_Utils_System
::url('civicrm/admin/event', "action=update&id=$dao->id&reset=1");
486 $eventSummary['events'][$dao->id
][$property] = CRM_Utils_Date
::customFormat($dao->$name,
492 case 'notCountedDueToRole':
493 case 'notCountedDueToStatus':
494 case 'notCountedParticipants':
497 if ($name == 'participants') {
498 $propertyCnt = self
::getParticipantCount($dao->id
);
500 $set = CRM_Utils_System
::url('civicrm/event/search',
501 "reset=1&force=1&event=$dao->id&status=true&role=true"
505 elseif ($name == 'notCountedParticipants') {
506 $propertyCnt = self
::getParticipantCount($dao->id
, TRUE, FALSE, TRUE, FALSE);
508 // FIXME : selector fail to search w/ OR operator.
509 // $set = CRM_Utils_System::url( 'civicrm/event/search',
510 // "reset=1&force=1&event=$dao->id&status=false&role=false" );
513 elseif ($name == 'notCountedDueToStatus') {
514 $propertyCnt = self
::getParticipantCount($dao->id
, TRUE, FALSE, FALSE, FALSE);
516 $set = CRM_Utils_System
::url('civicrm/event/search',
517 "reset=1&force=1&event=$dao->id&status=false"
522 $propertyCnt = self
::getParticipantCount($dao->id
, FALSE, FALSE, TRUE, FALSE);
524 $set = CRM_Utils_System
::url('civicrm/event/search',
525 "reset=1&force=1&event=$dao->id&role=false"
530 $eventSummary['events'][$dao->id
][$property] = $propertyCnt;
531 $eventSummary['events'][$dao->id
][$name . '_url'] = $set;
535 $eventSummary['events'][$dao->id
][$property] = $dao->$name;
540 // prepare the area for per-status participant counts
541 $statusClasses = array('Positive', 'Pending', 'Waiting', 'Negative');
542 $eventSummary['events'][$dao->id
]['statuses'] = array_fill_keys($statusClasses, array());
544 $eventSummary['events'][$dao->id
]['friend'] = $dao->is_friend_active
;
545 $eventSummary['events'][$dao->id
]['is_monetary'] = $dao->is_monetary
;
546 $eventSummary['events'][$dao->id
]['is_online_registration'] = $dao->is_online_registration
;
547 $eventSummary['events'][$dao->id
]['is_show_location'] = $dao->is_show_location
;
548 $eventSummary['events'][$dao->id
]['is_subevent'] = $dao->slot_label_id
;
549 $eventSummary['events'][$dao->id
]['is_pcp_enabled'] = $dao->is_pcp_enabled
;
550 $eventSummary['events'][$dao->id
]['reminder'] = CRM_Core_BAO_ActionSchedule
::isConfigured($dao->id
, $mapping->getId());
551 $eventSummary['events'][$dao->id
]['is_repeating_event'] = $dao->is_repeating_event
;
553 $statusTypes = CRM_Event_PseudoConstant
::participantStatus();
554 foreach ($statusValues as $statusId => $statusValue) {
555 if (!array_key_exists($statusId, $statusTypes)) {
558 $class = $statusValue['class'];
559 $statusCount = self
::eventTotalSeats($dao->id
, "( participant.status_id = {$statusId} )");
561 $urlString = "reset=1&force=1&event={$dao->id}&status=$statusId";
563 'url' => CRM_Utils_System
::url('civicrm/event/search', $urlString),
564 'name' => $statusValue['name'],
565 'label' => $statusValue['label'],
566 'count' => $statusCount,
568 $eventSummary['events'][$dao->id
]['statuses'][$class][] = $statusInfo;
573 $countedRoles = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
574 $nonCountedRoles = CRM_Event_PseudoConstant
::participantRole(NULL, '( filter = 0 OR filter IS NULL )');
575 $countedStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
576 $nonCountedStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, '( is_counted = 0 OR is_counted IS NULL )');
578 $countedStatusANDRoles = array_merge($countedStatus, $countedRoles);
579 $nonCountedStatusANDRoles = array_merge($nonCountedStatus, $nonCountedRoles);
581 $eventSummary['nonCountedRoles'] = implode('/', array_values($nonCountedRoles));
582 $eventSummary['nonCountedStatus'] = implode('/', array_values($nonCountedStatus));
583 $eventSummary['countedStatusANDRoles'] = implode('/', array_values($countedStatusANDRoles));
584 $eventSummary['nonCountedStatusANDRoles'] = implode('/', array_values($nonCountedStatusANDRoles));
586 return $eventSummary;
590 * Get participant count.
592 * @param int $eventId
593 * @param bool $considerStatus consider status for participant count.
594 * Consider status for participant count.
595 * @param bool $status counted participant.
596 * Consider counted participant.
597 * @param bool $considerRole consider role for participant count.
598 * Consider role for participant count.
599 * @param bool $role consider counted( is filter role) participant.
600 * Consider counted( is filter role) participant.
604 * array with count of participants for each event based on status/role
606 public static function getParticipantCount(
608 $considerStatus = TRUE,
610 $considerRole = TRUE,
614 // consider both role and status for counted participants, CRM-4924.
616 // not counted participant.
617 if ($considerStatus && $considerRole && !$status && !$role) {
621 if ($considerStatus) {
622 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
623 $statusClause = 'NOT IN';
625 $statusClause = 'IN';
627 $status = implode(',', array_keys($statusTypes));
628 if (empty($status)) {
631 $clause[] = "participant.status_id {$statusClause} ( {$status} ) ";
635 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
636 $roleClause = 'NOT IN';
640 $roles = implode(',', array_keys($roleTypes));
644 $clause[] = "participant.role_id {$roleClause} ( $roles )";
648 if (!empty($clause)) {
649 $sqlClause = ' ( ' . implode($operator, $clause) . ' )';
652 return self
::eventTotalSeats($eventId, $sqlClause);
656 * Get the information to map a event.
659 * For which we want map info.
661 * @return null|string
664 public static function &getMapInfo(&$id) {
668 civicrm_event.id AS event_id,
669 civicrm_event.title AS display_name,
670 civicrm_address.street_address AS street_address,
671 civicrm_address.city AS city,
672 civicrm_address.postal_code AS postal_code,
673 civicrm_address.postal_code_suffix AS postal_code_suffix,
674 civicrm_address.geo_code_1 AS latitude,
675 civicrm_address.geo_code_2 AS longitude,
676 civicrm_state_province.abbreviation AS state,
677 civicrm_country.name AS country,
678 civicrm_location_type.name AS location_type
681 LEFT JOIN civicrm_loc_block ON ( civicrm_event.loc_block_id = civicrm_loc_block.id )
682 LEFT JOIN civicrm_address ON ( civicrm_loc_block.address_id = civicrm_address.id )
683 LEFT JOIN civicrm_state_province ON ( civicrm_address.state_province_id = civicrm_state_province.id )
684 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
685 LEFT JOIN civicrm_location_type ON ( civicrm_location_type.id = civicrm_address.location_type_id )
686 WHERE civicrm_address.geo_code_1 IS NOT NULL
687 AND civicrm_address.geo_code_2 IS NOT NULL
688 AND civicrm_event.id = " . CRM_Utils_Type
::escape($id, 'Integer');
690 $dao = new CRM_Core_DAO();
693 $locations = array();
695 $config = CRM_Core_Config
::singleton();
697 while ($dao->fetch()) {
700 $location['displayName'] = addslashes($dao->display_name
);
701 $location['lat'] = $dao->latitude
;
702 $location['marker_class'] = 'Event';
703 $location['lng'] = $dao->longitude
;
705 $params = array('entity_id' => $id, 'entity_table' => 'civicrm_event');
706 $addressValues = CRM_Core_BAO_Location
::getValues($params, TRUE);
707 $location['address'] = str_replace(array(
710 ), '', addslashes(nl2br($addressValues['address'][1]['display_text'])));
712 $location['url'] = CRM_Utils_System
::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id
);
713 $location['location_type'] = $dao->location_type
;
714 $eventImage = '<img src="' . $config->resourceBase
. 'i/contact_org.gif" alt="Organization " height="20" width="15" />';
715 $location['image'] = $eventImage;
716 $location['displayAddress'] = str_replace('<br />', ', ', $location['address']);
717 $locations[] = $location;
723 * Get the complete information for one or more events.
726 * Get events with start date >= this date.
727 * @param int $type Get events on the a specific event type (by event_type_id).
728 * Get events on the a specific event type (by event_type_id).
729 * @param int $eventId Return a single event - by event id.
730 * Return a single event - by event id.
732 * Also get events with end date >= this date.
733 * @param bool $onlyPublic Include public events only, default TRUE.
734 * Include public events only, default TRUE.
737 * array of all the events that are searched
739 public static function &getCompleteInfo(
746 $publicCondition = NULL;
748 $publicCondition = " AND civicrm_event.is_public = 1";
752 // if start and end date are NOT passed, return all events with start_date OR end_date >= today CRM-5133
754 // get events with start_date >= requested start
755 $startDate = CRM_Utils_Type
::escape($start, 'Date');
756 $dateCondition .= " AND ( civicrm_event.start_date >= {$startDate} )";
760 // also get events with end_date <= requested end
761 $endDate = CRM_Utils_Type
::escape($end, 'Date');
762 $dateCondition .= " AND ( civicrm_event.end_date <= '{$endDate}' ) ";
765 // CRM-9421 and CRM-8620 Default mode for ical/rss feeds. No start or end filter passed.
766 // Need to exclude old events with only start date
767 // and not exclude events in progress (start <= today and end >= today). DGG
768 if (empty($start) && empty($end)) {
769 // get events with end date >= today, not sure of this logic
770 // but keeping this for backward compatibility as per issue CRM-5133
771 $today = date("Y-m-d G:i:s");
772 $dateCondition .= " AND ( civicrm_event.end_date >= '{$today}' OR civicrm_event.start_date >= '{$today}' ) ";
776 $typeCondition = " AND civicrm_event.event_type_id = " . CRM_Utils_Type
::escape($type, 'Integer');
779 // Get the Id of Option Group for Event Types
780 $optionGroupDAO = new CRM_Core_DAO_OptionGroup();
781 $optionGroupDAO->name
= 'event_type';
782 $optionGroupId = NULL;
783 if ($optionGroupDAO->find(TRUE)) {
784 $optionGroupId = $optionGroupDAO->id
;
789 civicrm_event.id as event_id,
790 civicrm_email.email as email,
791 civicrm_event.title as title,
792 civicrm_event.summary as summary,
793 civicrm_event.start_date as start,
794 civicrm_event.end_date as end,
795 civicrm_event.description as description,
796 civicrm_event.is_show_location as is_show_location,
797 civicrm_event.is_online_registration as is_online_registration,
798 civicrm_event.registration_link_text as registration_link_text,
799 civicrm_event.registration_start_date as registration_start_date,
800 civicrm_event.registration_end_date as registration_end_date,
801 civicrm_option_value.label as event_type,
802 civicrm_address.name as address_name,
803 civicrm_address.street_address as street_address,
804 civicrm_address.supplemental_address_1 as supplemental_address_1,
805 civicrm_address.supplemental_address_2 as supplemental_address_2,
806 civicrm_address.city as city,
807 civicrm_address.postal_code as postal_code,
808 civicrm_address.postal_code_suffix as postal_code_suffix,
809 civicrm_state_province.abbreviation as state,
810 civicrm_country.name AS country
812 LEFT JOIN civicrm_loc_block ON civicrm_event.loc_block_id = civicrm_loc_block.id
813 LEFT JOIN civicrm_address ON civicrm_loc_block.address_id = civicrm_address.id
814 LEFT JOIN civicrm_state_province ON civicrm_address.state_province_id = civicrm_state_province.id
815 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
816 LEFT JOIN civicrm_email ON civicrm_loc_block.email_id = civicrm_email.id
817 LEFT JOIN civicrm_option_value ON (
818 civicrm_event.event_type_id = civicrm_option_value.value AND
819 civicrm_option_value.option_group_id = %1 )
820 WHERE civicrm_event.is_active = 1
821 AND (is_template = 0 OR is_template IS NULL)
825 if (isset($typeCondition)) {
826 $query .= $typeCondition;
829 if (isset($eventId)) {
830 $query .= " AND civicrm_event.id =$eventId ";
832 $query .= " ORDER BY civicrm_event.start_date ASC";
834 $params = array(1 => array($optionGroupId, 'Integer'));
835 $dao = CRM_Core_DAO
::executeQuery($query, $params);
837 $config = CRM_Core_Config
::singleton();
839 $baseURL = parse_url($config->userFrameworkBaseURL
);
840 $url = "@" . $baseURL['host'];
841 if (!empty($baseURL['path'])) {
842 $url .= substr($baseURL['path'], 0, -1);
845 // check 'view event info' permission
846 //@todo - per CRM-14626 we have resolved that 'view event info' means 'view ALL event info'
847 // and passing in the specific permission here will short-circuit the evaluation of permission to
848 // see specific events (doesn't seem relevant to this call
849 // however, since this function is accessed only by a convoluted call from a joomla block function
850 // it seems safer not to touch here. Suggestion is that CRM_Core_Permission::check(array or relevant permissions) would
851 // be clearer & safer here
852 $permissions = CRM_Core_Permission
::event(CRM_Core_Permission
::VIEW
);
854 // check if we're in shopping cart mode for events
855 $enable_cart = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::EVENT_PREFERENCES_NAME
,
860 while ($dao->fetch()) {
861 if (!empty($permissions) && in_array($dao->event_id
, $permissions)) {
863 $info['uid'] = "CiviCRM_EventID_{$dao->event_id}_" . md5($config->userFrameworkBaseURL
) . $url;
865 $info['title'] = $dao->title
;
866 $info['event_id'] = $dao->event_id
;
867 $info['summary'] = $dao->summary
;
868 $info['description'] = $dao->description
;
869 $info['start_date'] = $dao->start
;
870 $info['end_date'] = $dao->end
;
871 $info['contact_email'] = $dao->email
;
872 $info['event_type'] = $dao->event_type
;
873 $info['is_show_location'] = $dao->is_show_location
;
874 $info['is_online_registration'] = $dao->is_online_registration
;
875 $info['registration_link_text'] = $dao->registration_link_text
;
876 $info['registration_start_date'] = $dao->registration_start_date
;
877 $info['registration_end_date'] = $dao->registration_end_date
;
882 'address_name' => $dao->address_name
,
883 'street_address' => $dao->street_address
,
884 'supplemental_address_1' => $dao->supplemental_address_1
,
885 'supplemental_address_2' => $dao->supplemental_address_2
,
886 'city' => $dao->city
,
887 'state_province' => $dao->state
,
888 'postal_code' => $dao->postal_code
,
889 'postal_code_suffix' => $dao->postal_code_suffix
,
890 'country' => $dao->country
,
894 CRM_Utils_String
::append($address, ', ',
895 CRM_Utils_Address
::format($addrFields)
897 $info['location'] = $address;
898 $info['url'] = CRM_Utils_System
::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id
, TRUE, NULL, FALSE);
901 $reg = CRM_Event_Cart_BAO_EventInCart
::get_registration_link($dao->event_id
);
902 $info['registration_link'] = CRM_Utils_System
::url($reg['path'], $reg['query'], TRUE);
903 $info['registration_link_text'] = $reg['label'];
914 * make a copy of a Event, including
915 * all the fields in the event Wizard
918 * The event id to copy.
919 * boolean $afterCreate call to copy after the create function
920 * @param null $newEvent
921 * @param bool $afterCreate
923 * @return CRM_Event_DAO_Event
925 public static function copy($id, $newEvent = NULL, $afterCreate = FALSE) {
927 $eventValues = array();
929 //get the require event values.
930 $eventParams = array('id' => $id);
931 $returnProperties = array(
935 'default_discount_fee_id',
939 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event', $eventParams, $eventValues, $returnProperties);
941 // since the location is sharable, lets use the same loc_block_id.
942 $locBlockId = CRM_Utils_Array
::value('loc_block_id', $eventValues);
944 $fieldsFix = ($afterCreate) ?
array() : array('prefix' => array('title' => ts('Copy of') . ' '));
945 if (empty($eventValues['is_show_location'])) {
946 $fieldsFix['prefix']['is_show_location'] = 0;
949 if ($newEvent && is_a($newEvent, 'CRM_Event_DAO_Event')) {
950 $copyEvent = $newEvent;
953 if (!isset($copyEvent)) {
954 $copyEvent = &CRM_Core_DAO
::copyGeneric('CRM_Event_DAO_Event',
958 ($locBlockId) ?
$locBlockId : NULL,
963 CRM_Price_BAO_PriceSet
::copyPriceSet('civicrm_event', $id, $copyEvent->id
);
964 $copyUF = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
967 'entity_table' => 'civicrm_event',
969 array('entity_id' => $copyEvent->id
)
972 $copyTellFriend = &CRM_Core_DAO
::copyGeneric('CRM_Friend_DAO_Friend',
975 'entity_table' => 'civicrm_event',
977 array('entity_id' => $copyEvent->id
)
980 $copyPCP = &CRM_Core_DAO
::copyGeneric('CRM_PCP_DAO_PCPBlock',
983 'entity_table' => 'civicrm_event',
985 array('entity_id' => $copyEvent->id
),
986 array('replace' => array('target_entity_id' => $copyEvent->id
))
989 $oldMapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings(array(
990 'id' => ($eventValues['is_template'] ? CRM_Event_ActionMapping
::EVENT_TPL_MAPPING_ID
: CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
),
992 $copyMapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings(array(
993 'id' => ($copyEvent->is_template
== 1 ? CRM_Event_ActionMapping
::EVENT_TPL_MAPPING_ID
: CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
),
995 $copyReminder = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_ActionSchedule',
996 array('entity_value' => $id, 'mapping_id' => $oldMapping->getId()),
997 array('entity_value' => $copyEvent->id
, 'mapping_id' => $copyMapping->getId())
1000 if (!$afterCreate) {
1002 $extends = array('event');
1003 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
1005 foreach ($groupTree as $groupID => $group) {
1006 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
1007 foreach ($group['fields'] as $fieldID => $field) {
1008 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
1012 foreach ($table as $tableName => $tableColumns) {
1013 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
1014 $tableColumns[0] = $copyEvent->id
;
1015 $select = 'SELECT ' . implode(', ', $tableColumns);
1016 $from = ' FROM ' . $tableName;
1017 $where = " WHERE {$tableName}.entity_id = {$id}";
1018 $query = $insert . $select . $from . $where;
1019 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
1025 CRM_Utils_System
::flushCache();
1026 if (!$afterCreate) {
1027 CRM_Utils_Hook
::copy('Event', $copyEvent);
1033 * This is sometimes called in a loop (during event search)
1034 * hence we cache the values to prevent repeated calls to the db
1036 public static function isMonetary($id) {
1037 static $isMonetary = array();
1038 if (!array_key_exists($id, $isMonetary)) {
1039 $isMonetary[$id] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event',
1044 return $isMonetary[$id];
1048 * This is sometimes called in a loop (during event search)
1049 * hence we cache the values to prevent repeated calls to the db
1051 public static function usesPriceSet($id) {
1052 static $usesPriceSet = array();
1053 if (!array_key_exists($id, $usesPriceSet)) {
1054 $usesPriceSet[$id] = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $id);
1056 return $usesPriceSet[$id];
1060 * Process that send e-mails
1062 * @param int $contactID
1064 * @param int $participantId
1065 * @param bool $isTest
1066 * @param bool $returnMessageText
1070 public static function sendMail($contactID, &$values, $participantId, $isTest = FALSE, $returnMessageText = FALSE) {
1072 $template = CRM_Core_Smarty
::singleton();
1074 'custom_pre_id' => $values['custom_pre_id'],
1075 'custom_post_id' => $values['custom_post_id'],
1078 //get the params submitted by participant.
1079 $participantParams = CRM_Utils_Array
::value($participantId, $values['params'], array());
1081 if (!$returnMessageText) {
1082 //send notification email if field values are set (CRM-1941)
1083 foreach ($gIds as $key => $gIdValues) {
1085 if (!is_array($gIdValues)) {
1086 $gIdValues = array($gIdValues);
1089 foreach ($gIdValues as $gId) {
1090 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
1092 //get values of corresponding profile fields for notification
1093 list($profileValues) = self
::buildCustomDisplay($gId,
1102 list($profileValues) = $profileValues;
1105 'values' => $profileValues,
1108 CRM_Core_BAO_UFGroup
::commonSendMail($contactID, $val);
1115 if ($values['event']['is_email_confirm'] ||
$returnMessageText) {
1116 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
1118 //send email only when email is present
1119 if (isset($email) ||
$returnMessageText) {
1120 $preProfileID = CRM_Utils_Array
::value('custom_pre_id', $values);
1121 $postProfileID = CRM_Utils_Array
::value('custom_post_id', $values);
1123 if (!empty($values['params']['additionalParticipant'])) {
1124 $preProfileID = CRM_Utils_Array
::value('additional_custom_pre_id', $values, $preProfileID);
1125 $postProfileID = CRM_Utils_Array
::value('additional_custom_post_id', $values, $postProfileID);
1128 self
::buildCustomDisplay($preProfileID,
1138 self
::buildCustomDisplay($postProfileID,
1148 $sessions = CRM_Event_Cart_BAO_Conference
::get_participant_sessions($participantId);
1150 $tplParams = array_merge($values, $participantParams, array(
1152 'confirm_email_text' => CRM_Utils_Array
::value('confirm_email_text', $values['event']),
1153 'isShowLocation' => CRM_Utils_Array
::value('is_show_location', $values['event']),
1154 'contributeMode' => CRM_Utils_Array
::value('contributeMode', $template->_tpl_vars
),
1155 'participantID' => $participantId,
1156 'conference_sessions' => $sessions,
1157 'credit_card_number' =>
1158 CRM_Utils_System
::mungeCreditCard(
1159 CRM_Utils_Array
::value('credit_card_number', $participantParams)),
1160 'credit_card_exp_date' =>
1161 CRM_Utils_Date
::mysqlToIso(
1162 CRM_Utils_Date
::format(
1163 CRM_Utils_Array
::value('credit_card_exp_date', $participantParams))),
1166 // CRM-13890 : NOTE wait list condition need to be given so that
1167 // wait list message is shown properly in email i.e. WRT online event registration template
1168 if (empty($tplParams['participant_status']) && empty($values['params']['isOnWaitlist'])) {
1169 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $participantId, 'status_id', 'id', TRUE);
1170 $tplParams['participant_status'] = CRM_Event_PseudoConstant
::participantStatus($statusId, NULL, 'label');
1172 //CRM-15754 - if participant_status contains status ID
1173 elseif (!empty($tplParams['participant_status']) && CRM_Utils_Rule
::integer($tplParams['participant_status'])) {
1174 $tplParams['participant_status'] = CRM_Event_PseudoConstant
::participantStatus($tplParams['participant_status'], NULL, 'label');
1177 $sendTemplateParams = array(
1178 'groupName' => 'msg_tpl_workflow_event',
1179 'valueName' => 'event_online_receipt',
1180 'contactId' => $contactID,
1181 'isTest' => $isTest,
1182 'tplParams' => $tplParams,
1183 'PDFFilename' => ts('confirmation') . '.pdf',
1186 // address required during receipt processing (pdf and email receipt)
1187 if ($displayAddress = CRM_Utils_Array
::value('address', $values)) {
1188 $sendTemplateParams['tplParams']['address'] = $displayAddress;
1189 $sendTemplateParams['tplParams']['contributeMode'] = NULL;
1192 // set lineItem details
1193 if ($lineItem = CRM_Utils_Array
::value('lineItem', $values)) {
1194 // check if additional prticipant, if so filter only to relevant ones
1196 if (!empty($values['params']['additionalParticipant'])) {
1197 $ownLineItems = array();
1198 foreach ($lineItem as $liKey => $liValue) {
1199 $firstElement = array_pop($liValue);
1200 if ($firstElement['entity_id'] == $participantId) {
1201 $ownLineItems[0] = $lineItem[$liKey];
1205 if (!empty($ownLineItems)) {
1206 $sendTemplateParams['tplParams']['lineItem'] = $ownLineItems;
1210 $sendTemplateParams['tplParams']['lineItem'] = $lineItem;
1214 if ($returnMessageText) {
1215 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1217 'subject' => $subject,
1219 'to' => $displayName,
1224 $sendTemplateParams['from'] = CRM_Utils_Array
::value('confirm_from_name', $values['event']) . " <" . CRM_Utils_Array
::value('confirm_from_email', $values['event']) . ">";
1225 $sendTemplateParams['toName'] = $displayName;
1226 $sendTemplateParams['toEmail'] = $email;
1227 $sendTemplateParams['autoSubmitted'] = TRUE;
1228 $sendTemplateParams['cc'] = CRM_Utils_Array
::value('cc_confirm',
1231 $sendTemplateParams['bcc'] = CRM_Utils_Array
::value('bcc_confirm',
1234 // append invoice pdf to email
1235 $template = CRM_Core_Smarty
::singleton();
1236 $taxAmt = $template->get_template_vars('totalTaxAmount');
1237 $prefixValue = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1238 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
1239 if (isset($invoicing) && isset($prefixValue['is_email_pdf']) && !empty($values['contributionId'])) {
1240 $sendTemplateParams['isEmailPdf'] = TRUE;
1241 $sendTemplateParams['contributionId'] = $values['contributionId'];
1243 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1250 * Add the custom fields OR array of participant's
1254 * @param string $name
1257 * @param int $participantId
1259 * @param bool $isCustomProfile
1260 * @param array $participantParams
1264 public static function buildCustomDisplay(
1271 $isCustomProfile = FALSE,
1272 $participantParams = array()
1275 return array(NULL, NULL);
1278 if (!is_array($id)) {
1279 $id = CRM_Utils_Type
::escape($id, 'Positive');
1280 $profileIds = array($id);
1286 $val = $groupTitles = NULL;
1287 foreach ($profileIds as $gid) {
1288 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid)) {
1290 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
,
1291 NULL, NULL, FALSE, NULL,
1292 FALSE, NULL, CRM_Core_Permission
::CREATE
,
1296 //this condition is added, since same contact can have multiple event registrations..
1297 $params = array(array('participant_id', '=', $participantId, 0, 0));
1299 //add participant id
1300 $fields['participant_id'] = array(
1301 'name' => 'participant_id',
1302 'title' => ts('Participant ID'),
1304 //check whether its a text drive
1306 $params[] = array('participant_test', '=', 1, 0, 0);
1309 //display campaign on thankyou page.
1310 if (array_key_exists('participant_campaign_id', $fields)) {
1311 if ($participantId) {
1312 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1316 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1317 $values[$fields['participant_campaign_id']['title']] = CRM_Utils_Array
::value($campaignId,
1321 unset($fields['participant_campaign_id']);
1325 foreach ($fields as $k => $v) {
1327 $groupTitle = $v['groupTitle'];
1329 // suppress all file fields from display
1331 CRM_Utils_Array
::value('data_type', $v, '') == 'File' ||
1332 CRM_Utils_Array
::value('name', $v, '') == 'image_URL' ||
1333 CRM_Utils_Array
::value('field_type', $v) == 'Formatting'
1340 $groupTitles[] = $groupTitle;
1342 //display profile groups those are subscribed by participant.
1343 if (($groups = CRM_Utils_Array
::value('group', $participantParams)) &&
1347 foreach ($groups as $grpId => $isSelected) {
1352 if (!empty($grpIds)) {
1353 //get the group titles.
1354 $grpTitles = array();
1355 $query = 'SELECT title FROM civicrm_group where id IN ( ' . implode(',', $grpIds) . ' )';
1356 $grp = CRM_Core_DAO
::executeQuery($query);
1357 while ($grp->fetch()) {
1358 $grpTitles[] = $grp->title
;
1360 if (!empty($grpTitles) &&
1361 CRM_Utils_Array
::value('title', CRM_Utils_Array
::value('group', $fields))
1363 $values[$fields['group']['title']] = implode(', ', $grpTitles);
1365 unset($fields['group']);
1369 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params);
1371 if (isset($fields['participant_status_id']['title']) &&
1372 isset($values[$fields['participant_status_id']['title']]) &&
1373 is_numeric($values[$fields['participant_status_id']['title']])
1376 $status = CRM_Event_PseudoConstant
::participantStatus();
1377 $values[$fields['participant_status_id']['title']] = $status[$values[$fields['participant_status_id']['title']]];
1380 if (isset($fields['participant_role_id']['title']) &&
1381 isset($values[$fields['participant_role_id']['title']]) &&
1382 is_numeric($values[$fields['participant_role_id']['title']])
1385 $roles = CRM_Event_PseudoConstant
::participantRole();
1386 $values[$fields['participant_role_id']['title']] = $roles[$values[$fields['participant_role_id']['title']]];
1389 if (isset($fields['participant_register_date']['title']) &&
1390 isset($values[$fields['participant_register_date']['title']])
1392 $values[$fields['participant_register_date']['title']] = CRM_Utils_Date
::customFormat($values[$fields['participant_register_date']['title']]);
1395 //handle fee_level for price set
1396 if (isset($fields['participant_fee_level']['title']) &&
1397 isset($values[$fields['participant_fee_level']['title']])
1399 $feeLevel = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1400 $values[$fields['participant_fee_level']['title']]
1402 foreach ($feeLevel as $key => $value) {
1404 unset($feeLevel[$key]);
1407 $values[$fields['participant_fee_level']['title']] = implode(',', $feeLevel);
1410 unset($values[$fields['participant_id']['title']]);
1417 $template->assign($name, $val);
1420 if (count($groupTitles)) {
1421 $template->assign($name . '_grouptitle', $groupTitles);
1424 //return if we only require array of participant's info.
1425 if ($isCustomProfile) {
1427 return array($val, $groupTitles);
1436 * Build the array for display the profile fields.
1438 * @param array $params
1442 * @param array $groupTitle
1443 * Profile Group Title.
1444 * @param array $values
1445 * Formatted array of key value.
1447 * @param array $profileFields
1451 public static function displayProfile(&$params, $gid, &$groupTitle, &$values, &$profileFields = array()) {
1453 $config = CRM_Core_Config
::singleton();
1454 $session = CRM_Core_Session
::singleton();
1455 $contactID = $session->get('userID');
1457 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $contactID)) {
1458 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
1462 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::ADD
);
1465 foreach ($fields as $v) {
1466 if (!empty($v['groupTitle'])) {
1467 $groupTitle['groupTitle'] = $v['groupTitle'];
1472 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
1473 //start of code to set the default values
1474 foreach ($fields as $name => $field) {
1476 // skip fields that should not be displayed separately
1477 if ($field['skipDisplay']) {
1481 $index = $field['title'];
1482 if ($name === 'organization_name') {
1483 $values[$index] = $params[$name];
1486 if ('state_province' == substr($name, 0, 14)) {
1487 if ($params[$name]) {
1488 $values[$index] = CRM_Core_PseudoConstant
::stateProvince($params[$name]);
1491 $values[$index] = '';
1494 elseif ('date' == substr($name, -4)) {
1495 $values[$index] = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::processDate($params[$name]),
1496 $config->dateformatFull
);
1498 elseif ('country' == substr($name, 0, 7)) {
1499 if ($params[$name]) {
1500 $values[$index] = CRM_Core_PseudoConstant
::country($params[$name]);
1503 $values[$index] = '';
1506 elseif ('county' == substr($name, 0, 6)) {
1507 if ($params[$name]) {
1508 $values[$index] = CRM_Core_PseudoConstant
::county($params[$name]);
1511 $values[$index] = '';
1514 elseif (in_array(substr($name, 0, -3), array('gender', 'prefix', 'suffix', 'communication_style'))) {
1515 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', $name, $params[$name]);
1517 elseif (in_array($name, array(
1522 $filterCondition = array('greeting_type' => $name);
1523 $greeting = CRM_Core_PseudoConstant
::greeting($filterCondition);
1524 $values[$index] = $greeting[$params[$name]];
1526 elseif ($name === 'preferred_communication_method') {
1527 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1529 $pref = $params[$name];
1530 if (is_array($pref)) {
1531 foreach ($pref as $k => $v) {
1533 $compref[] = $communicationFields[$k];
1537 $values[$index] = implode(',', $compref);
1539 elseif ($name == 'contact_sub_type') {
1540 $values[$index] = implode(', ', $params[$name]);
1542 elseif ($name == 'group') {
1543 $groups = CRM_Contact_BAO_GroupContact
::getGroupList();
1545 foreach ($params[$name] as $gId => $dontCare) {
1547 $title[] = $groups[$gId];
1550 $values[$index] = implode(', ', $title);
1552 elseif ($name == 'tag') {
1553 $entityTags = $params[$name];
1554 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1556 if (is_array($entityTags)) {
1557 foreach ($entityTags as $tagId => $dontCare) {
1558 $title[] = $allTags[$tagId];
1561 $values[$index] = implode(', ', $title);
1563 elseif ('participant_role_id' == $name OR
1564 'participant_role' == $name
1566 $roles = CRM_Event_PseudoConstant
::participantRole();
1567 $values[$index] = $roles[$params[$name]];
1569 elseif ('participant_status_id' == $name OR
1570 'participant_status' == $name
1572 $status = CRM_Event_PseudoConstant
::participantStatus();
1573 $values[$index] = $status[$params[$name]];
1575 elseif (substr($name, -11) == 'campaign_id') {
1576 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($params[$name]);
1577 $values[$index] = CRM_Utils_Array
::value($params[$name], $campaigns);
1579 elseif (strpos($name, '-') !== FALSE) {
1580 list($fieldName, $id) = CRM_Utils_System
::explode('-', $name, 2);
1581 $detailName = str_replace(' ', '_', $name);
1582 if (in_array($fieldName, array(
1587 $values[$index] = $params[$detailName];
1588 $idx = $detailName . '_id';
1589 $values[$index] = $params[$idx];
1591 elseif ($fieldName == 'im') {
1592 $providerName = NULL;
1593 if ($providerId = $detailName . '-provider_id') {
1594 $providerName = CRM_Utils_Array
::value($params[$providerId], $imProviders);
1596 if ($providerName) {
1597 $values[$index] = $params[$detailName] . " (" . $providerName . ")";
1600 $values[$index] = $params[$detailName];
1603 elseif ($fieldName == 'phone') {
1604 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1605 if (isset($params[$phoneExtField])) {
1606 $values[$index] = $params[$detailName] . " (" . $params[$phoneExtField] . ")";
1609 $values[$index] = $params[$detailName];
1613 $values[$index] = $params[$detailName];
1617 if (substr($name, 0, 7) === 'do_not_' or substr($name, 0, 3) === 'is_') {
1618 if ($params[$name]) {
1619 $values[$index] = '[ x ]';
1623 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1625 SELECT html_type, data_type
1626 FROM civicrm_custom_field
1629 $dao = CRM_Core_DAO
::executeQuery($query);
1631 $htmlType = $dao->html_type
;
1633 if ($htmlType == 'File') {
1634 $values[$index] = $params[$index];
1637 if ($dao->data_type
== 'Int' ||
1638 $dao->data_type
== 'Boolean'
1640 $v = $params[$name];
1641 if (!CRM_Utils_System
::isNull($v)) {
1642 $customVal = (int) $v;
1645 elseif ($dao->data_type
== 'Float') {
1646 $customVal = (float ) ($params[$name]);
1648 elseif ($dao->data_type
== 'Date') {
1649 //@todo note the currently we are using default date time formatting. Since you can select/set
1650 // different date and time format specific to custom field we should consider fixing this
1651 // sometime in the future
1652 $customVal = $displayValue = CRM_Utils_Date
::customFormat(
1653 CRM_Utils_Date
::processDate($params[$name]), $config->dateformatFull
);
1655 if (!empty($params[$name . '_time'])) {
1656 $customVal = $displayValue = CRM_Utils_Date
::customFormat(
1657 CRM_Utils_Date
::processDate($params[$name], $params[$name . '_time']),
1658 $config->dateformatDatetime
);
1663 $customVal = $params[$name];
1665 //take the custom field options
1666 $returnProperties = array($name => 1);
1667 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
1668 $options = &$query->_options
;
1670 $displayValue = CRM_Core_BAO_CustomField
::getDisplayValue($customVal, $cfID, $options);
1672 //Hack since we dont have function to check empty.
1673 //FIXME in 2.3 using crmIsEmptyArray()
1674 $customValue = TRUE;
1675 if (is_array($customVal) && is_array($displayValue)) {
1676 $customValue = array_diff($customVal, $displayValue);
1678 //use difference of arrays
1679 if (empty($customValue) ||
!$customValue) {
1680 $values[$index] = '';
1683 $values[$index] = $displayValue;
1687 elseif ($name == 'home_URL' &&
1688 !empty($params[$name])
1690 $url = CRM_Utils_System
::fixURL($params[$name]);
1691 $values[$index] = "<a href=\"$url\">{$params[$name]}</a>";
1693 elseif (in_array($name, array(
1696 'participant_register_date',
1698 $values[$index] = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format($params[$name]));
1701 $values[$index] = CRM_Utils_Array
::value($name, $params);
1705 $profileFields[$name] = $field;
1711 * Build the array for Additional participant's information array of priamry and additional Ids
1713 * @param int $participantId
1714 * Id of Primary participant.
1715 * @param array $values
1716 * Key/value event info.
1717 * @param int $contactId
1718 * Contact id of Primary participant.
1719 * @param bool $isTest
1720 * Whether test or live transaction.
1721 * @param bool $isIdsArray
1722 * To return an array of Ids.
1724 * @param bool $skipCancel
1727 * array of Additional participant's info OR array of Ids.
1729 public static function buildCustomProfile(
1734 $isIdsArray = FALSE,
1738 $customProfile = $additionalIDs = array();
1739 if (!$participantId) {
1740 CRM_Core_Error
::fatal(ts('Cannot find participant ID'));
1743 //set Ids of Primary Participant also.
1744 if ($isIdsArray && $contactId) {
1745 $additionalIDs[$participantId] = $contactId;
1748 //hack to skip cancelled participants, CRM-4320
1749 $where = "participant.registered_by_id={$participantId}";
1751 $cancelStatusId = 0;
1752 $negativeStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Negative'");
1753 $cancelStatusId = array_search('Cancelled', $negativeStatuses);
1754 $where .= " AND participant.status_id != {$cancelStatusId}";
1757 SELECT participant.id, participant.contact_id
1758 FROM civicrm_participant participant
1761 $dao = CRM_Core_DAO
::executeQuery($query);
1762 while ($dao->fetch()) {
1763 $additionalIDs[$dao->id
] = $dao->contact_id
;
1766 //return if only array is required.
1767 if ($isIdsArray && $contactId) {
1768 return $additionalIDs;
1771 $preProfileID = CRM_Utils_Array
::value('additional_custom_pre_id', $values);
1772 $postProfileID = CRM_Utils_Array
::value('additional_custom_post_id', $values);
1773 //else build array of Additional participant's information.
1774 if (count($additionalIDs)) {
1775 if ($preProfileID ||
$postProfileID) {
1776 $template = CRM_Core_Smarty
::singleton();
1778 $isCustomProfile = TRUE;
1780 $title = $groupTitles = array();
1781 foreach ($additionalIDs as $pId => $cId) {
1782 //get the params submitted by participant.
1783 $participantParams = CRM_Utils_Array
::value($pId, $values['params'], array());
1785 list($profilePre, $groupTitles) = self
::buildCustomDisplay($preProfileID,
1786 'additionalCustomPre',
1796 $profile = $profilePre;
1797 // $customProfile[$i] = array_merge( $groupTitles, $customProfile[$i] );
1799 $title = $groupTitles;
1803 list($profilePost, $groupTitles) = self
::buildCustomDisplay($postProfileID,
1804 'additionalCustomPost',
1814 if (isset($profilePre)) {
1815 $profile = array_merge($profilePre, $profilePost);
1817 $title = array_merge($title, $groupTitles);
1821 $profile = $profilePost;
1823 $title = $groupTitles;
1827 $profiles[] = $profile;
1830 $customProfile['title'] = $title;
1831 $customProfile['profile'] = $profiles;
1835 return $customProfile;
1838 /* Function to retrieve all events those having location block set.
1841 * array of all events.
1846 public static function getLocationEvents() {
1850 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
1851 FROM civicrm_event ce
1852 INNER JOIN civicrm_loc_block lb ON ce.loc_block_id = lb.id
1853 INNER JOIN civicrm_address ca ON lb.address_id = ca.id
1854 LEFT JOIN civicrm_state_province sp ON ca.state_province_id = sp.id
1855 ORDER BY sp.name, ca.city, ca.street_address ASC
1858 $dao = CRM_Core_DAO
::executeQuery($query);
1859 while ($dao->fetch()) {
1860 $events[$dao->loc_block_id
] = $dao->title
;
1867 * @param int $locBlockId
1869 * @return int|null|string
1871 public static function countEventsUsingLocBlockId($locBlockId) {
1876 $locBlockId = CRM_Utils_Type
::escape($locBlockId, 'Integer');
1879 SELECT count(*) FROM civicrm_event ce
1880 WHERE ce.loc_block_id = $locBlockId";
1882 return CRM_Core_DAO
::singleValueQuery($query);
1886 * Check if event registration is valid according to permissions AND Dates.
1888 * @param array $values
1889 * @param int $eventID
1892 public static function validRegistrationRequest($values, $eventID) {
1893 // check that the user has permission to register for this event
1894 $hasPermission = CRM_Core_Permission
::event(CRM_Core_Permission
::EDIT
,
1895 $eventID, 'register for events'
1898 return $hasPermission && self
::validRegistrationDate($values);
1906 public static function validRegistrationDate(&$values) {
1907 // make sure that we are between registration start date and registration end date
1908 $startDate = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('registration_start_date', $values));
1909 $endDate = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('registration_end_date', $values));
1910 $eventEnd = CRM_Utils_Date
::unixTime(CRM_Utils_Array
::value('end_date', $values));
1913 if ($startDate && $startDate >= $now) {
1916 if ($endDate && $endDate < $now && $eventEnd && $eventEnd < $now) {
1923 /* Function to Show - Hide the Registration Link.
1925 * @param array $values
1926 * Key/value event info.
1928 * true if allow registration otherwise false
1935 public static function showHideRegistrationLink($values) {
1937 $session = CRM_Core_Session
::singleton();
1938 $contactID = $session->get('userID');
1939 $alreadyRegistered = FALSE;
1942 $params = array('contact_id' => $contactID);
1944 if ($eventId = CRM_Utils_Array
::value('id', $values['event'])) {
1945 $params['event_id'] = $eventId;
1947 if ($roleId = CRM_Utils_Array
::value('default_role_id', $values['event'])) {
1948 $params['role_id'] = $roleId;
1950 $alreadyRegistered = self
::checkRegistration($params);
1953 if (!empty($values['event']['allow_same_participant_emails']) ||
1961 /* Function to check if given contact is already registered.
1963 * @param array $params
1964 * Key/value participant info.
1968 * @param array $params
1972 public static function checkRegistration($params) {
1973 $alreadyRegistered = FALSE;
1974 if (empty($params['contact_id'])) {
1975 return $alreadyRegistered;
1978 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
1980 $participant = new CRM_Event_DAO_Participant();
1981 $participant->copyValues($params);
1983 $participant->is_test
= CRM_Utils_Array
::value('is_test', $params, 0);
1984 $participant->selectAdd();
1985 $participant->selectAdd('status_id');
1986 if ($participant->find(TRUE) && array_key_exists($participant->status_id
, $statusTypes)) {
1987 $alreadyRegistered = TRUE;
1990 return $alreadyRegistered;
1994 * Make sure that the user has permission to access this event.
1996 * @param int $eventId
2000 * the permission that the user has (or null)
2002 public static function checkPermission($eventId = NULL, $type = CRM_Core_Permission
::VIEW
) {
2003 static $permissions = NULL;
2005 if (empty($permissions)) {
2006 $allEvents = CRM_Event_PseudoConstant
::event(NULL, TRUE);
2007 $createdEvents = array();
2009 $session = CRM_Core_Session
::singleton();
2010 if ($userID = $session->get('userID')) {
2011 $createdEvents = array_keys(CRM_Event_PseudoConstant
::event(NULL, TRUE, "created_id={$userID}"));
2014 // Note: for a multisite setup, a user with edit all events, can edit all events
2015 // including those from other sites
2016 if (CRM_Core_Permission
::check('edit all events')) {
2017 $permissions[CRM_Core_Permission
::EDIT
] = array_keys($allEvents);
2020 $permissions[CRM_Core_Permission
::EDIT
] = CRM_ACL_API
::group(CRM_Core_Permission
::EDIT
, NULL, 'civicrm_event', $allEvents, $createdEvents);
2023 if (CRM_Core_Permission
::check('edit all events')) {
2024 $permissions[CRM_Core_Permission
::VIEW
] = array_keys($allEvents);
2027 if (CRM_Core_Permission
::check('access CiviEvent') &&
2028 CRM_Core_Permission
::check('view event participants')
2030 // use case: allow "view all events" but NOT "edit all events"
2031 // so for a normal site allow users with these two permissions to view all events AND
2032 // at the same time also allow any hook to override if needed.
2033 $createdEvents = array_keys($allEvents);
2035 $permissions[CRM_Core_Permission
::VIEW
] = CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_event', $allEvents, $createdEvents);
2038 $permissions[CRM_Core_Permission
::DELETE
] = array();
2039 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
2040 // Note: we want to restrict the scope of delete permission to
2041 // events that are editable/viewable (usecase multisite).
2042 // We can remove array_intersect once we have ACL support for delete functionality.
2043 $permissions[CRM_Core_Permission
::DELETE
] = array_intersect($permissions[CRM_Core_Permission
::EDIT
],
2044 $permissions[CRM_Core_Permission
::VIEW
]
2050 return in_array($eventId, $permissions[$type]) ?
TRUE : FALSE;
2053 return $permissions;
2057 * Build From Email as the combination of all the email ids of the logged in user,
2058 * the domain email id and the email id configured for the event
2060 * @param int $eventId
2061 * The id of the event.
2064 * an array of email ids
2066 public static function getFromEmailIds($eventId = NULL) {
2067 $fromEmailValues['from_email_id'] = CRM_Core_BAO_Email
::getFromEmail();
2070 // add the email id configured for the event
2071 $params = array('id' => $eventId);
2072 $returnProperties = array('confirm_from_name', 'confirm_from_email', 'cc_confirm', 'bcc_confirm');
2073 $eventEmail = array();
2075 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event', $params, $eventEmail, $returnProperties);
2076 if (!empty($eventEmail['confirm_from_name']) && !empty($eventEmail['confirm_from_email'])) {
2077 $eventEmailId = "{$eventEmail['confirm_from_name']} <{$eventEmail['confirm_from_email']}>";
2079 $fromEmailValues['from_email_id'][$eventEmailId] = htmlspecialchars($eventEmailId);
2080 $fromEmailId = array(
2081 'cc' => CRM_Utils_Array
::value('cc_confirm', $eventEmail),
2082 'bcc' => CRM_Utils_Array
::value('bcc_confirm', $eventEmail),
2084 $fromEmailValues = array_merge($fromEmailValues, $fromEmailId);
2088 return $fromEmailValues;
2092 * Calculate event total seats occupied.
2094 * @param int $eventId
2096 * @param sting $extraWhereClause
2097 * Extra filter on participants.
2100 * event total seats w/ given criteria.
2102 public static function eventTotalSeats($eventId, $extraWhereClause = NULL) {
2103 if (empty($eventId)) {
2107 $extraWhereClause = trim($extraWhereClause);
2108 if (!empty($extraWhereClause)) {
2109 $extraWhereClause = " AND ( {$extraWhereClause} )";
2112 //event seats calculation :
2113 //1. consider event seat as a single when participant does not have line item.
2114 //2. consider event seat as a single when participant has line items but does not
2115 // have count for corresponding price field value ( ie price field value does not carry any seat )
2116 //3. consider event seat as a sum of all seats from line items in case price field value carries count.
2119 SELECT IF ( SUM( value.count*lineItem.qty ),
2120 SUM( value.count*lineItem.qty ) +
2121 COUNT( DISTINCT participant.id ) -
2122 COUNT( DISTINCT IF ( value.count, participant.id, NULL ) ),
2123 COUNT( DISTINCT participant.id ) )
2124 FROM civicrm_participant participant
2125 INNER JOIN civicrm_contact contact ON ( contact.id = participant.contact_id AND contact.is_deleted = 0 )
2126 INNER JOIN civicrm_event event ON ( event.id = participant.event_id )
2127 LEFT JOIN civicrm_line_item lineItem ON ( lineItem.entity_id = participant.id
2128 AND lineItem.entity_table = 'civicrm_participant' )
2129 LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_value_id AND value.count )
2130 WHERE ( participant.event_id = %1 )
2131 AND participant.is_test = 0
2133 GROUP BY participant.event_id";
2135 return (int) CRM_Core_DAO
::singleValueQuery($query, array(1 => array($eventId, 'Positive')));
2139 * Retrieve event template default values to be set.
2140 * as default values for current new event.
2142 * @param int $templateId
2143 * Event template id.
2146 * Array of custom data defaults.
2148 public static function getTemplateDefaultValues($templateId) {
2149 $defaults = array();
2154 $templateParams = array('id' => $templateId);
2155 CRM_Event_BAO_Event
::retrieve($templateParams, $defaults);
2156 $fieldsToExclude = array(
2159 'default_discount_fee_id',
2165 $defaults = array_diff_key($defaults, array_flip($fieldsToExclude));
2170 * @param int $event_id
2174 public static function get_sub_events($event_id) {
2175 $params = array('parent_event_id' => $event_id);
2176 $defaults = array();
2177 return CRM_Event_BAO_Event
::retrieve($params, $defaults);
2181 * Update the Campaign Id of all the participants of the given event.
2183 * @param int $eventID
2185 * @param int $eventCampaignID
2186 * Campaign id of that event.
2188 public static function updateParticipantCampaignID($eventID, $eventCampaignID) {
2190 $params[1] = array($eventID, 'Integer');
2192 if (empty($eventCampaignID)) {
2193 $query = "UPDATE civicrm_participant SET campaign_id = NULL WHERE event_id = %1";
2196 $query = "UPDATE civicrm_participant SET campaign_id = %2 WHERE event_id = %1";
2197 $params[2] = array($eventCampaignID, 'Integer');
2199 CRM_Core_DAO
::executeQuery($query, $params);
2203 * Get options for a given field.
2204 * @see CRM_Core_DAO::buildOptions
2206 * @param string $fieldName
2207 * @param string $context : @see CRM_Core_DAO::buildOptionsContext
2208 * @param array $props : whatever is known about this dao object
2210 * @return array|bool
2212 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2214 // Special logic for fields whose options depend on context or properties
2215 switch ($fieldName) {
2216 case 'financial_type_id':
2217 // Fixme - this is going to ignore context, better to get conditions, add params, and call PseudoConstant::get
2218 return CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
2222 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);