3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * Page for displaying list of events
39 class CRM_Event_Page_ManageEvent
extends CRM_Core_Page
{
42 * The action links that we need to display for the browse screen
47 static $_actionLinks = NULL;
49 static $_links = NULL;
51 static $_tabLinks = NULL;
53 protected $_pager = NULL;
55 protected $_sortByCharacter;
57 protected $_isTemplate = FALSE;
62 * @return array (reference) of action links
64 public function &links() {
65 if (!(self
::$_actionLinks)) {
66 // helper variable for nicer formatting
67 $copyExtra = ts('Are you sure you want to make a copy of this Event?');
68 $deleteExtra = ts('Are you sure you want to delete this Event?');
70 self
::$_actionLinks = array(
71 CRM_Core_Action
::DISABLE
=> array(
72 'name' => ts('Disable'),
73 'ref' => 'crm-enable-disable',
74 'title' => ts('Disable Event'),
76 CRM_Core_Action
::ENABLE
=> array(
77 'name' => ts('Enable'),
78 'ref' => 'crm-enable-disable',
79 'title' => ts('Enable Event'),
81 CRM_Core_Action
::DELETE
=> array(
82 'name' => ts('Delete'),
83 'url' => CRM_Utils_System
::currentPath(),
84 'qs' => 'action=delete&id=%%id%%',
85 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
86 'title' => ts('Delete Event'),
88 CRM_Core_Action
::COPY
=> array(
90 'url' => CRM_Utils_System
::currentPath(),
91 'qs' => 'reset=1&action=copy&id=%%id%%',
92 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
93 'title' => ts('Copy Event'),
97 return self
::$_actionLinks;
101 * Get tab Links for events
105 * @return array (reference) of tab links
107 public static function &tabs($enableCart) {
108 $cacheKey = $enableCart ?
1 : 0;
109 if (!(self
::$_tabLinks)) {
110 self
::$_tabLinks = array();
112 if (!isset(self
::$_tabLinks[$cacheKey])) {
113 self
::$_tabLinks[$cacheKey]['settings'] =
115 'title' => ts('Info and Settings'),
116 'url' => 'civicrm/event/manage/settings',
119 self
::$_tabLinks[$cacheKey]['location'] =
121 'title' => ts('Location'),
122 'url' => 'civicrm/event/manage/location',
123 'field' => 'loc_block_id',
126 self
::$_tabLinks[$cacheKey]['fee'] =
128 'title' => ts('Fees'),
129 'url' => 'civicrm/event/manage/fee',
130 'field' => 'is_monetary',
132 self
::$_tabLinks[$cacheKey]['registration'] =
134 'title' => ts('Online Registration'),
135 'url' => 'civicrm/event/manage/registration',
136 'field' => 'is_online_registration',
138 if (CRM_Core_Permission
::check('administer CiviCRM')) {
139 self
::$_tabLinks[$cacheKey]['reminder'] =
141 'title' => ts('Schedule Reminders'),
142 'url' => 'civicrm/event/manage/reminder',
143 'field' => 'reminder',
146 self
::$_tabLinks[$cacheKey]['conference'] =
148 'title' => ts('Conference Slots'),
149 'url' => 'civicrm/event/manage/conference',
150 'field' => 'slot_label_id',
152 self
::$_tabLinks[$cacheKey]['friend'] =
154 'title' => ts('Tell a Friend'),
155 'url' => 'civicrm/event/manage/friend',
158 self
::$_tabLinks[$cacheKey]['pcp'] =
160 'title' => ts('Personal Campaign Pages'),
161 'url' => 'civicrm/event/manage/pcp',
162 'field' => 'is_pcp_enabled',
164 self
::$_tabLinks[$cacheKey]['repeat'] =
166 'title' => ts('Repeat'),
167 'url' => 'civicrm/event/manage/repeat',
168 'field' => 'is_repeating_event',
174 unset(self
::$_tabLinks[$cacheKey]['conference']);
177 CRM_Utils_Hook
::tabset('civicrm/event/manage', self
::$_tabLinks[$cacheKey], array());
178 return self
::$_tabLinks[$cacheKey];
184 * This method is called after the page is created. It checks for the
185 * type of action and executes that action.
186 * Finally it calls the parent's run method.
191 public function run() {
192 // get the requested action
193 $action = CRM_Utils_Request
::retrieve('action', 'String',
194 // default to 'browse'
195 $this, FALSE, 'browse'
198 // assign vars to templates
199 $this->assign('action', $action);
200 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
201 $this, FALSE, 0, 'REQUEST'
204 // figure out whether we’re handling an event or an event template
206 $this->_isTemplate
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $id, 'is_template');
208 elseif ($action & CRM_Core_Action
::ADD
) {
209 $this->_isTemplate
= CRM_Utils_Request
::retrieve('is_template', 'Boolean', $this);
212 if (!$this->_isTemplate
&& $id) {
213 $breadCrumb = array(array('title' => ts('Manage Events'),
214 'url' => CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1'),
216 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
219 // what action to take ?
220 if ($action & CRM_Core_Action
::DELETE
) {
221 $session = CRM_Core_Session
::singleton();
222 $session->pushUserContext(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1&action=browse'));
223 $controller = new CRM_Core_Controller_Simple('CRM_Event_Form_ManageEvent_Delete',
227 $controller->set('id', $id);
228 $controller->process();
229 return $controller->run();
231 elseif ($action & CRM_Core_Action
::COPY
) {
235 // finally browse the custom groups
239 return parent
::run();
247 public function browse() {
248 $this->assign('includeWysiwygEditor', TRUE);
249 $this->_sortByCharacter
= CRM_Utils_Request
::retrieve('sortByCharacter',
253 $createdId = CRM_Utils_Request
::retrieve('cid', 'Positive', $this, FALSE, 0);
254 if (strtolower($this->_sortByCharacter
) == 'all' ||
257 $this->_sortByCharacter
= '';
258 $this->set('sortByCharacter', '');
261 $this->_force
= $this->_searchResult
= NULL;
266 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean',
269 $this->_searchResult
= CRM_Utils_Request
::retrieve('searchResult', 'Boolean', $this);
271 $whereClause = $this->whereClause($params, FALSE, $this->_force
);
272 $this->pagerAToZ($whereClause, $params);
275 $whereClause = $this->whereClause($params, TRUE, $this->_force
);
276 // because is_template != 1 would be to simple
277 $whereClause .= ' AND (is_template = 0 OR is_template IS NULL)';
279 $this->pager($whereClause, $params);
281 list($offset, $rowCount) = $this->_pager
->getOffsetAndRowCount();
283 // get all custom groups sorted by weight
284 $manageEvent = array();
290 ORDER BY start_date desc
291 LIMIT $offset, $rowCount";
293 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Event_DAO_Event');
294 $permissions = CRM_Event_BAO_Event
::checkPermission();
297 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
299 // get the list of active event pcps
300 $eventPCPS = array();
302 $pcpDao = new CRM_PCP_DAO_PCPBlock
;
303 $pcpDao->entity_table
= 'civicrm_event';
306 while ($pcpDao->fetch()) {
307 $eventPCPS[$pcpDao->entity_id
] = $pcpDao->entity_id
;
309 // check if we're in shopping cart mode for events
310 $enableCart = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::EVENT_PREFERENCES_NAME
,
313 $this->assign('eventCartEnabled', $enableCart);
314 $mappingID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionMapping', 'civicrm_event', 'id', 'entity_value');
315 $eventType = CRM_Core_OptionGroup
::values('event_type');
316 while ($dao->fetch()) {
317 if (in_array($dao->id
, $permissions[CRM_Core_Permission
::VIEW
])) {
318 $manageEvent[$dao->id
] = array();
319 $isRecurringEvent = CRM_Core_BAO_RecurringEntity
::getParentFor($dao->id
, 'civicrm_event');
320 $manageEvent[$dao->id
]['repeat'] = '';
321 if ($isRecurringEvent) {
322 if ($dao->id
== $isRecurringEvent) {
323 $manageEvent[$dao->id
]['repeat'] = 'Recurring Event - (Parent)';
326 $manageEvent[$dao->id
]['repeat'] = 'Recurring Event - (Child)';
329 CRM_Core_DAO
::storeValues($dao, $manageEvent[$dao->id
]);
331 // form all action links
332 $action = array_sum(array_keys($this->links()));
334 if ($dao->is_active
) {
335 $action -= CRM_Core_Action
::ENABLE
;
338 $action -= CRM_Core_Action
::DISABLE
;
341 if (!in_array($dao->id
, $permissions[CRM_Core_Permission
::DELETE
])) {
342 $action -= CRM_Core_Action
::DELETE
;
344 if (!in_array($dao->id
, $permissions[CRM_Core_Permission
::EDIT
])) {
345 $action -= CRM_Core_Action
::UPDATE
;
348 $manageEvent[$dao->id
]['action'] = CRM_Core_Action
::formLink(self
::links(),
350 array('id' => $dao->id
),
359 'entity_id' => $dao->id
,
360 'entity_table' => 'civicrm_event',
364 $defaults['location'] = CRM_Core_BAO_Location
::getValues($params, TRUE);
366 $manageEvent[$dao->id
]['friend'] = CRM_Friend_BAO_Friend
::getValues($params);
368 if (isset($defaults['location']['address'][1]['city'])) {
369 $manageEvent[$dao->id
]['city'] = $defaults['location']['address'][1]['city'];
371 if (isset($defaults['location']['address'][1]['state_province_id'])) {
372 $manageEvent[$dao->id
]['state_province'] = CRM_Core_PseudoConstant
::stateProvince($defaults['location']['address'][1]['state_province_id']);
375 //show campaigns on selector.
376 $manageEvent[$dao->id
]['campaign'] = CRM_Utils_Array
::value($dao->campaign_id
, $allCampaigns);
377 $manageEvent[$dao->id
]['reminder'] = CRM_Core_BAO_ActionSchedule
::isConfigured($dao->id
, $mappingID);
378 $manageEvent[$dao->id
]['is_pcp_enabled'] = CRM_Utils_Array
::value($dao->id
, $eventPCPS);
379 $manageEvent[$dao->id
]['event_type'] = CRM_Utils_Array
::value($manageEvent[$dao->id
]['event_type_id'], $eventType);
380 $manageEvent[$dao->id
]['is_repeating_event'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_RecurringEntity', $dao->id
, 'parent_id', 'entity_id');
381 // allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled
382 CRM_Utils_Hook
::tabset('civicrm/event/manage/rows', $manageEvent, array('event_id' => $dao->id
));
386 $manageEvent['tab'] = self
::tabs($enableCart);
387 $this->assign('rows', $manageEvent);
389 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
390 $statusTypesPending = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 0');
391 $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
392 $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
393 $this->assign('findParticipants', $findParticipants);
397 * This function is to make a copy of a Event, including
398 * all the fields in the event wizard
402 public function copy() {
403 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE, 0, 'GET');
405 $urlString = 'civicrm/event/manage';
406 $copyEvent = CRM_Event_BAO_Event
::copy($id);
407 $urlParams = 'reset=1';
408 // Redirect to Copied Event Configuration
409 if ($copyEvent->id
) {
410 $urlString = 'civicrm/event/manage/settings';
411 $urlParams .= '&action=update&id=' . $copyEvent->id
;
414 return CRM_Utils_System
::redirect(CRM_Utils_System
::url($urlString, $urlParams));
417 public function search() {
418 if (isset($this->_action
) &
419 (CRM_Core_Action
::ADD |
420 CRM_Core_Action
::UPDATE |
421 CRM_Core_Action
::DELETE
427 $form = new CRM_Core_Controller_Simple('CRM_Event_Form_SearchEvent', ts('Search Events'), CRM_Core_Action
::ADD
);
428 $form->setEmbedded(TRUE);
429 $form->setParent($this);
435 * @param array $params
436 * @param bool $sortBy
441 public function whereClause(&$params, $sortBy = TRUE, $force) {
444 $title = $this->get('title');
445 $createdId = $this->get('cid');
448 $clauses[] = "(created_id = {$createdId})";
452 $clauses[] = "title LIKE %1";
453 if (strpos($title, '%') !== FALSE) {
454 $params[1] = array(trim($title), 'String', FALSE);
457 $params[1] = array(trim($title), 'String', TRUE);
461 $value = $this->get('event_type_id');
464 if (is_array($value)) {
465 foreach ($value as $k => $v) {
470 $type = implode(',', $val);
472 $clauses[] = "event_type_id IN ({$type})";
475 $eventsByDates = $this->get('eventsByDates');
476 if ($this->_searchResult
) {
477 if ($eventsByDates) {
479 $from = $this->get('start_date');
480 if (!CRM_Utils_System
::isNull($from)) {
481 $clauses[] = '( start_date >= %3 OR start_date IS NULL )';
482 $params[3] = array($from, 'String');
485 $to = $this->get('end_date');
486 if (!CRM_Utils_System
::isNull($to)) {
487 $clauses[] = '( end_date <= %4 OR end_date IS NULL )';
488 $params[4] = array($to, 'String');
492 $curDate = date('YmdHis');
493 $clauses[5] = "(end_date >= {$curDate} OR end_date IS NULL)";
497 $curDate = date('YmdHis');
498 $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
502 $this->_sortByCharacter
!== NULL
504 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($this->_sortByCharacter
)) . "%'";
507 $campaignIds = $this->get('campaign_id');
508 if (!CRM_Utils_System
::isNull($campaignIds)) {
509 if (!is_array($campaignIds)) {
510 $campaignIds = array($campaignIds);
512 $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campaignIds)) . ' ) )';
515 // don't do a the below assignment when doing a
518 if (count($clauses) > 1 ||
$eventsByDates) {
519 $this->assign('isSearch', 1);
522 $this->assign('isSearch', 0);
526 return !empty($clauses) ?
implode(' AND ', $clauses) : '(1)';
530 * @param $whereClause
531 * @param array $whereParams
533 public function pager($whereClause, $whereParams) {
535 $params['status'] = ts('Event %%StatusMessage%%');
536 $params['csvString'] = NULL;
537 $params['buttonTop'] = 'PagerTopButton';
538 $params['buttonBottom'] = 'PagerBottomButton';
539 $params['rowCount'] = $this->get(CRM_Utils_Pager
::PAGE_ROWCOUNT
);
540 if (!$params['rowCount']) {
541 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
549 $params['total'] = CRM_Core_DAO
::singleValueQuery($query, $whereParams);
551 $this->_pager
= new CRM_Utils_Pager($params);
552 $this->assign_by_ref('pager', $this->_pager
);
556 * @param $whereClause
557 * @param array $whereParams
559 public function pagerAtoZ($whereClause, $whereParams) {
562 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
565 ORDER BY LEFT(title, 1)
567 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
569 $aToZBar = CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
570 $this->assign('aToZ', $aToZBar);