CRM/Event/Page/ManageEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Page for displaying list of events
  38  */
  39 class CRM_Event_Page_ManageEvent extends CRM_Core_Page {
  40
  41   /**
  42    * The action links that we need to display for the browse screen
  43    *
  44    * @var array
  45    * @static
  46    */
  47   static $_actionLinks = NULL;
  48
  49   static $_links = NULL;
  50
  51   static $_tabLinks = NULL;
  52
  53   protected $_pager = NULL;
  54
  55   protected $_sortByCharacter;
  56
  57   protected $_isTemplate = FALSE;
  58
  59   /**
  60    * Get action Links
  61    *
  62    * @return array (reference) of action links
  63    */
  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?');
  69
  70       self::$_actionLinks = array(
  71         CRM_Core_Action::DISABLE => array(
  72           'name' => ts('Disable'),
  73           'ref' => 'crm-enable-disable',
  74           'title' => ts('Disable Event'),
  75         ),
  76         CRM_Core_Action::ENABLE => array(
  77           'name' => ts('Enable'),
  78           'ref' => 'crm-enable-disable',
  79           'title' => ts('Enable Event'),
  80         ),
  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'),
  87         ),
  88         CRM_Core_Action::COPY => array(
  89           'name' => ts('Copy'),
  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'),
  94         )
  95       );
  96     }
  97     return self::$_actionLinks;
  98   }
  99
 100   /**
 101    * Get tab  Links for events
 102    *
 103    * @param $enableCart
 104    *
 105    * @return array (reference) of tab links
 106    */
 107   public static function &tabs($enableCart) {
 108     $cacheKey = $enableCart ? 1 : 0;
 109     if (!(self::$_tabLinks)) {
 110       self::$_tabLinks = array();
 111     }
 112     if (!isset(self::$_tabLinks[$cacheKey])) {
 113       self::$_tabLinks[$cacheKey]['settings'] =
 114         array(
 115           'title' => ts('Info and Settings'),
 116           'url' => 'civicrm/event/manage/settings',
 117           'field' => 'id'
 118         );
 119       self::$_tabLinks[$cacheKey]['location'] =
 120         array(
 121           'title' => ts('Location'),
 122           'url' => 'civicrm/event/manage/location',
 123           'field' => 'loc_block_id',
 124         );
 125
 126       self::$_tabLinks[$cacheKey]['fee'] =
 127         array(
 128           'title' => ts('Fees'),
 129           'url' => 'civicrm/event/manage/fee',
 130           'field' => 'is_monetary',
 131         );
 132       self::$_tabLinks[$cacheKey]['registration'] =
 133         array(
 134           'title' => ts('Online Registration'),
 135           'url' => 'civicrm/event/manage/registration',
 136           'field' => 'is_online_registration',
 137         );
 138       if (CRM_Core_Permission::check('administer CiviCRM')) {
 139       self::$_tabLinks[$cacheKey]['reminder'] =
 140         array(
 141           'title' => ts('Schedule Reminders'),
 142           'url' => 'civicrm/event/manage/reminder',
 143           'field' => 'reminder',
 144         );
 145       }
 146       self::$_tabLinks[$cacheKey]['conference'] =
 147         array(
 148           'title' => ts('Conference Slots'),
 149           'url' => 'civicrm/event/manage/conference',
 150           'field' => 'slot_label_id',
 151         );
 152       self::$_tabLinks[$cacheKey]['friend'] =
 153         array(
 154           'title' => ts('Tell a Friend'),
 155           'url' => 'civicrm/event/manage/friend',
 156           'field' => 'friend',
 157         );
 158       self::$_tabLinks[$cacheKey]['pcp'] =
 159         array(
 160           'title' => ts('Personal Campaign Pages'),
 161           'url' => 'civicrm/event/manage/pcp',
 162           'field' => 'is_pcp_enabled',
 163         );
 164       self::$_tabLinks[$cacheKey]['repeat'] =
 165         array(
 166           'title' => ts('Repeat'),
 167           'url' => 'civicrm/event/manage/repeat',
 168           'field' => 'is_repeating_event',
 169         );
 170
 171     }
 172
 173     if (!$enableCart) {
 174       unset(self::$_tabLinks[$cacheKey]['conference']);
 175     }
 176
 177     CRM_Utils_Hook::tabset('civicrm/event/manage', self::$_tabLinks[$cacheKey], array());
 178     return self::$_tabLinks[$cacheKey];
 179   }
 180
 181   /**
 182    * Run the page.
 183    *
 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.
 187    *
 188    * @return void
 189    *
 190    */
 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'
 196     );
 197
 198     // assign vars to templates
 199     $this->assign('action', $action);
 200     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 201       $this, FALSE, 0, 'REQUEST'
 202     );
 203
 204     // figure out whether we’re handling an event or an event template
 205     if ($id) {
 206       $this->_isTemplate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $id, 'is_template');
 207     }
 208     elseif ($action & CRM_Core_Action::ADD) {
 209       $this->_isTemplate = CRM_Utils_Request::retrieve('is_template', 'Boolean', $this);
 210     }
 211
 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'),
 215         ));
 216       CRM_Utils_System::appendBreadCrumb($breadCrumb);
 217     }
 218
 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',
 224         'Delete Event',
 225         $action
 226       );
 227       $controller->set('id', $id);
 228       $controller->process();
 229       return $controller->run();
 230     }
 231     elseif ($action & CRM_Core_Action::COPY) {
 232       $this->copy();
 233     }
 234
 235     // finally browse the custom groups
 236     $this->browse();
 237
 238     // parent run
 239     return parent::run();
 240   }
 241
 242   /**
 243    * Browse all events
 244    *
 245    * @return void
 246    */
 247   public function browse() {
 248     $this->assign('includeWysiwygEditor', TRUE);
 249     $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
 250       'String',
 251       $this
 252     );
 253     $createdId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE, 0);
 254     if (strtolower($this->_sortByCharacter) == 'all' ||
 255       !empty($_POST)
 256     ) {
 257       $this->_sortByCharacter = '';
 258       $this->set('sortByCharacter', '');
 259     }
 260
 261     $this->_force = $this->_searchResult = NULL;
 262
 263     $this->search();
 264
 265     $params = array();
 266     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean',
 267       $this, FALSE
 268     );
 269     $this->_searchResult = CRM_Utils_Request::retrieve('searchResult', 'Boolean', $this);
 270
 271     $whereClause = $this->whereClause($params, FALSE, $this->_force);
 272     $this->pagerAToZ($whereClause, $params);
 273
 274     $params = array();
 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)';
 278
 279     $this->pager($whereClause, $params);
 280
 281     list($offset, $rowCount) = $this->_pager->getOffsetAndRowCount();
 282
 283     // get all custom groups sorted by weight
 284     $manageEvent = array();
 285
 286     $query = "
 287   SELECT *
 288     FROM civicrm_event
 289    WHERE $whereClause
 290 ORDER BY start_date desc
 291    LIMIT $offset, $rowCount";
 292
 293     $dao = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Event_DAO_Event');
 294     $permissions = CRM_Event_BAO_Event::checkPermission();
 295
 296     //get all campaigns.
 297     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 298
 299     // get the list of active event pcps
 300     $eventPCPS = array();
 301
 302     $pcpDao = new CRM_PCP_DAO_PCPBlock;
 303     $pcpDao->entity_table = 'civicrm_event';
 304     $pcpDao->find();
 305
 306     while ($pcpDao->fetch()) {
 307       $eventPCPS[$pcpDao->entity_id] = $pcpDao->entity_id;
 308     }
 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,
 311       'enable_cart'
 312     );
 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)';
 324           }
 325           else {
 326             $manageEvent[$dao->id]['repeat'] = 'Recurring Event - (Child)';
 327           }
 328         }
 329         CRM_Core_DAO::storeValues($dao, $manageEvent[$dao->id]);
 330
 331         // form all action links
 332         $action = array_sum(array_keys($this->links()));
 333
 334         if ($dao->is_active) {
 335           $action -= CRM_Core_Action::ENABLE;
 336         }
 337         else {
 338           $action -= CRM_Core_Action::DISABLE;
 339         }
 340
 341         if (!in_array($dao->id, $permissions[CRM_Core_Permission::DELETE])) {
 342           $action -= CRM_Core_Action::DELETE;
 343         }
 344         if (!in_array($dao->id, $permissions[CRM_Core_Permission::EDIT])) {
 345           $action -= CRM_Core_Action::UPDATE;
 346         }
 347
 348         $manageEvent[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(),
 349           $action,
 350           array('id' => $dao->id),
 351           ts('more'),
 352           TRUE,
 353           'event.manage.list',
 354           'Event',
 355           $dao->id
 356         );
 357
 358         $params = array(
 359           'entity_id' => $dao->id,
 360           'entity_table' => 'civicrm_event',
 361           'is_active' => 1,
 362         );
 363
 364         $defaults['location'] = CRM_Core_BAO_Location::getValues($params, TRUE);
 365
 366         $manageEvent[$dao->id]['friend'] = CRM_Friend_BAO_Friend::getValues($params);
 367
 368         if (isset($defaults['location']['address'][1]['city'])) {
 369           $manageEvent[$dao->id]['city'] = $defaults['location']['address'][1]['city'];
 370         }
 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']);
 373         }
 374
 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));
 383       }
 384     }
 385
 386     $manageEvent['tab'] = self::tabs($enableCart);
 387     $this->assign('rows', $manageEvent);
 388
 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);
 394   }
 395
 396   /**
 397    * This function is to make a copy of a Event, including
 398    * all the fields in the event wizard
 399    *
 400    * @return void
 401    */
 402   public function copy() {
 403     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE, 0, 'GET');
 404
 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;
 412     }
 413
 414     return CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
 415   }
 416
 417   public function search() {
 418     if (isset($this->_action) &
 419       (CRM_Core_Action::ADD |
 420         CRM_Core_Action::UPDATE |
 421         CRM_Core_Action::DELETE
 422       )
 423     ) {
 424       return;
 425     }
 426
 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);
 430     $form->process();
 431     $form->run();
 432   }
 433
 434   /**
 435    * @param array $params
 436    * @param bool $sortBy
 437    * @param $force
 438    *
 439    * @return string
 440    */
 441   public function whereClause(&$params, $sortBy = TRUE, $force) {
 442     $values    = array();
 443     $clauses   = array();
 444     $title     = $this->get('title');
 445     $createdId = $this->get('cid');
 446
 447     if ($createdId) {
 448       $clauses[] = "(created_id = {$createdId})";
 449     }
 450
 451     if ($title) {
 452       $clauses[] = "title LIKE %1";
 453       if (strpos($title, '%') !== FALSE) {
 454         $params[1] = array(trim($title), 'String', FALSE);
 455       }
 456       else {
 457         $params[1] = array(trim($title), 'String', TRUE);
 458       }
 459     }
 460
 461     $value = $this->get('event_type_id');
 462     $val = array();
 463     if ($value) {
 464       if (is_array($value)) {
 465         foreach ($value as $k => $v) {
 466           if ($v) {
 467             $val[$k] = $k;
 468           }
 469         }
 470         $type = implode(',', $val);
 471       }
 472       $clauses[] = "event_type_id IN ({$type})";
 473     }
 474
 475     $eventsByDates = $this->get('eventsByDates');
 476     if ($this->_searchResult) {
 477       if ($eventsByDates) {
 478
 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');
 483         }
 484
 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');
 489         }
 490       }
 491       else {
 492         $curDate = date('YmdHis');
 493         $clauses[5] = "(end_date >= {$curDate} OR end_date IS NULL)";
 494       }
 495     }
 496     else {
 497       $curDate = date('YmdHis');
 498       $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
 499     }
 500
 501     if ($sortBy &&
 502       $this->_sortByCharacter !== NULL
 503     ) {
 504       $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . "%'";
 505     }
 506
 507     $campaignIds = $this->get('campaign_id');
 508     if (!CRM_Utils_System::isNull($campaignIds)) {
 509       if (!is_array($campaignIds)) {
 510         $campaignIds = array($campaignIds);
 511       }
 512       $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campaignIds)) . ' ) )';
 513     }
 514
 515     // don't do a the below assignment when doing a
 516     // AtoZ pager clause
 517     if ($sortBy) {
 518       if (count($clauses) > 1 || $eventsByDates) {
 519         $this->assign('isSearch', 1);
 520       }
 521       else {
 522         $this->assign('isSearch', 0);
 523       }
 524     }
 525
 526     return !empty($clauses) ? implode(' AND ', $clauses) : '(1)';
 527   }
 528
 529   /**
 530    * @param $whereClause
 531    * @param array $whereParams
 532    */
 533   public function pager($whereClause, $whereParams) {
 534
 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;
 542     }
 543
 544     $query = "
 545 SELECT count(id)
 546   FROM civicrm_event
 547  WHERE $whereClause";
 548
 549     $params['total'] = CRM_Core_DAO::singleValueQuery($query, $whereParams);
 550
 551     $this->_pager = new CRM_Utils_Pager($params);
 552     $this->assign_by_ref('pager', $this->_pager);
 553   }
 554
 555   /**
 556    * @param $whereClause
 557    * @param array $whereParams
 558    */
 559   public function pagerAtoZ($whereClause, $whereParams) {
 560
 561     $query = "
 562    SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
 563      FROM civicrm_event
 564     WHERE $whereClause
 565  ORDER BY LEFT(title, 1)
 566 ";
 567     $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
 568
 569     $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
 570     $this->assign('aToZ', $aToZBar);
 571   }
 572 }