CRM/Event/Page/ManageEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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    */
  46   static $_actionLinks = NULL;
  47
  48   static $_links = NULL;
  49
  50   static $_tabLinks = NULL;
  51
  52   protected $_pager = NULL;
  53
  54   protected $_sortByCharacter;
  55
  56   protected $_isTemplate = FALSE;
  57
  58   /**
  59    * Get action Links.
  60    *
  61    * @return array
  62    *   (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
 106    *   (reference) of tab links
 107    */
 108   public static function &tabs($enableCart) {
 109     $cacheKey = $enableCart ? 1 : 0;
 110     if (!(self::$_tabLinks)) {
 111       self::$_tabLinks = array();
 112     }
 113     if (!isset(self::$_tabLinks[$cacheKey])) {
 114       self::$_tabLinks[$cacheKey]['settings']
 115         = array(
 116           'title' => ts('Info and Settings'),
 117           'url' => 'civicrm/event/manage/settings',
 118           'field' => 'id',
 119         );
 120       self::$_tabLinks[$cacheKey]['location']
 121         = array(
 122           'title' => ts('Location'),
 123           'url' => 'civicrm/event/manage/location',
 124           'field' => 'loc_block_id',
 125         );
 126
 127       self::$_tabLinks[$cacheKey]['fee']
 128         = array(
 129           'title' => ts('Fees'),
 130           'url' => 'civicrm/event/manage/fee',
 131           'field' => 'is_monetary',
 132         );
 133       self::$_tabLinks[$cacheKey]['registration']
 134         = array(
 135           'title' => ts('Online Registration'),
 136           'url' => 'civicrm/event/manage/registration',
 137           'field' => 'is_online_registration',
 138         );
 139
 140       if (CRM_Core_Permission::check('administer CiviCRM')) {
 141         self::$_tabLinks[$cacheKey]['reminder']
 142           = array(
 143             'title' => ts('Schedule Reminders'),
 144             'url' => 'civicrm/event/manage/reminder',
 145             'field' => 'reminder',
 146           );
 147       }
 148       self::$_tabLinks[$cacheKey]['conference']
 149         = array(
 150           'title' => ts('Conference Slots'),
 151           'url' => 'civicrm/event/manage/conference',
 152           'field' => 'slot_label_id',
 153         );
 154       self::$_tabLinks[$cacheKey]['friend']
 155         = array(
 156           'title' => ts('Tell a Friend'),
 157           'url' => 'civicrm/event/manage/friend',
 158           'field' => 'friend',
 159         );
 160       self::$_tabLinks[$cacheKey]['pcp']
 161         = array(
 162           'title' => ts('Personal Campaign Pages'),
 163           'url' => 'civicrm/event/manage/pcp',
 164           'field' => 'is_pcp_enabled',
 165         );
 166       self::$_tabLinks[$cacheKey]['repeat']
 167         = array(
 168           'title' => ts('Repeat'),
 169           'url' => 'civicrm/event/manage/repeat',
 170           'field' => 'is_repeating_event',
 171         );
 172     }
 173
 174     if (!$enableCart) {
 175       unset(self::$_tabLinks[$cacheKey]['conference']);
 176     }
 177
 178     CRM_Utils_Hook::tabset('civicrm/event/manage', self::$_tabLinks[$cacheKey], array());
 179     return self::$_tabLinks[$cacheKey];
 180   }
 181
 182   /**
 183    * Run the page.
 184    *
 185    * This method is called after the page is created. It checks for the
 186    * type of action and executes that action.
 187    * Finally it calls the parent's run method.
 188    *
 189    * @return void
 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(
 214         array(
 215           'title' => ts('Manage Events'),
 216           'url' => CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'),
 217         ),
 218       );
 219       CRM_Utils_System::appendBreadCrumb($breadCrumb);
 220     }
 221
 222     // what action to take ?
 223     if ($action & CRM_Core_Action::DELETE) {
 224       $session = CRM_Core_Session::singleton();
 225       $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1&action=browse'));
 226       $controller = new CRM_Core_Controller_Simple('CRM_Event_Form_ManageEvent_Delete',
 227         'Delete Event',
 228         $action
 229       );
 230       $controller->set('id', $id);
 231       $controller->process();
 232       return $controller->run();
 233     }
 234     elseif ($action & CRM_Core_Action::COPY) {
 235       $this->copy();
 236     }
 237
 238     // finally browse the custom groups
 239     $this->browse();
 240
 241     // parent run
 242     return parent::run();
 243   }
 244
 245   /**
 246    * Browse all events.
 247    *
 248    * @return void
 249    */
 250   public function browse() {
 251     $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
 252       'String',
 253       $this
 254     );
 255     $createdId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE, 0);
 256     if (strtolower($this->_sortByCharacter) == 'all' ||
 257       !empty($_POST)
 258     ) {
 259       $this->_sortByCharacter = '';
 260       $this->set('sortByCharacter', '');
 261     }
 262
 263     $this->_force = $this->_searchResult = NULL;
 264
 265     $this->search();
 266
 267     $params = array();
 268     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean',
 269       $this, FALSE
 270     );
 271     $this->_searchResult = CRM_Utils_Request::retrieve('searchResult', 'Boolean', $this);
 272
 273     $whereClause = $this->whereClause($params, FALSE, $this->_force);
 274     $this->pagerAToZ($whereClause, $params);
 275
 276     $params = array();
 277     $whereClause = $this->whereClause($params, TRUE, $this->_force);
 278     // because is_template != 1 would be to simple
 279     $whereClause .= ' AND (is_template = 0 OR is_template IS NULL)';
 280
 281     $this->pager($whereClause, $params);
 282
 283     list($offset, $rowCount) = $this->_pager->getOffsetAndRowCount();
 284
 285     // get all custom groups sorted by weight
 286     $manageEvent = array();
 287
 288     $query = "
 289   SELECT *
 290     FROM civicrm_event
 291    WHERE $whereClause
 292 ORDER BY start_date desc
 293    LIMIT $offset, $rowCount";
 294
 295     $dao = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Event_DAO_Event');
 296     $permissions = CRM_Event_BAO_Event::checkPermission();
 297
 298     //get all campaigns.
 299     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 300
 301     // get the list of active event pcps
 302     $eventPCPS = array();
 303
 304     $pcpDao = new CRM_PCP_DAO_PCPBlock();
 305     $pcpDao->entity_table = 'civicrm_event';
 306     $pcpDao->find();
 307
 308     while ($pcpDao->fetch()) {
 309       $eventPCPS[$pcpDao->entity_id] = $pcpDao->entity_id;
 310     }
 311     // check if we're in shopping cart mode for events
 312     $enableCart = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::EVENT_PREFERENCES_NAME,
 313       'enable_cart'
 314     );
 315     $this->assign('eventCartEnabled', $enableCart);
 316     $mappingID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionMapping', 'civicrm_event', 'id', 'entity_value');
 317     $eventType = CRM_Core_OptionGroup::values('event_type');
 318     while ($dao->fetch()) {
 319       if (in_array($dao->id, $permissions[CRM_Core_Permission::VIEW])) {
 320         $manageEvent[$dao->id] = array();
 321         $isRecurringEvent = CRM_Core_BAO_RecurringEntity::getParentFor($dao->id, 'civicrm_event');
 322         $manageEvent[$dao->id]['repeat'] = '';
 323         if ($isRecurringEvent) {
 324           if ($dao->id == $isRecurringEvent) {
 325             $manageEvent[$dao->id]['repeat'] = 'Recurring Event - (Parent)';
 326           }
 327           else {
 328             $manageEvent[$dao->id]['repeat'] = 'Recurring Event - (Child)';
 329           }
 330         }
 331         CRM_Core_DAO::storeValues($dao, $manageEvent[$dao->id]);
 332
 333         // form all action links
 334         $action = array_sum(array_keys($this->links()));
 335
 336         if ($dao->is_active) {
 337           $action -= CRM_Core_Action::ENABLE;
 338         }
 339         else {
 340           $action -= CRM_Core_Action::DISABLE;
 341         }
 342
 343         if (!in_array($dao->id, $permissions[CRM_Core_Permission::DELETE])) {
 344           $action -= CRM_Core_Action::DELETE;
 345         }
 346         if (!in_array($dao->id, $permissions[CRM_Core_Permission::EDIT])) {
 347           $action -= CRM_Core_Action::UPDATE;
 348         }
 349
 350         $manageEvent[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(),
 351           $action,
 352           array('id' => $dao->id),
 353           ts('more'),
 354           TRUE,
 355           'event.manage.list',
 356           'Event',
 357           $dao->id
 358         );
 359
 360         $params = array(
 361           'entity_id' => $dao->id,
 362           'entity_table' => 'civicrm_event',
 363           'is_active' => 1,
 364         );
 365
 366         $defaults['location'] = CRM_Core_BAO_Location::getValues($params, TRUE);
 367
 368         $manageEvent[$dao->id]['friend'] = CRM_Friend_BAO_Friend::getValues($params);
 369
 370         if (isset($defaults['location']['address'][1]['city'])) {
 371           $manageEvent[$dao->id]['city'] = $defaults['location']['address'][1]['city'];
 372         }
 373         if (isset($defaults['location']['address'][1]['state_province_id'])) {
 374           $manageEvent[$dao->id]['state_province'] = CRM_Core_PseudoConstant::stateProvince($defaults['location']['address'][1]['state_province_id']);
 375         }
 376
 377         //show campaigns on selector.
 378         $manageEvent[$dao->id]['campaign'] = CRM_Utils_Array::value($dao->campaign_id, $allCampaigns);
 379         $manageEvent[$dao->id]['reminder'] = CRM_Core_BAO_ActionSchedule::isConfigured($dao->id, $mappingID);
 380         $manageEvent[$dao->id]['is_pcp_enabled'] = CRM_Utils_Array::value($dao->id, $eventPCPS);
 381         $manageEvent[$dao->id]['event_type'] = CRM_Utils_Array::value($manageEvent[$dao->id]['event_type_id'], $eventType);
 382         $manageEvent[$dao->id]['is_repeating_event'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_RecurringEntity', $dao->id, 'parent_id', 'entity_id');
 383         // allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled
 384         CRM_Utils_Hook::tabset('civicrm/event/manage/rows', $manageEvent, array('event_id' => $dao->id));
 385       }
 386     }
 387
 388     $manageEvent['tab'] = self::tabs($enableCart);
 389     $this->assign('rows', $manageEvent);
 390
 391     $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1');
 392     $statusTypesPending = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 0');
 393     $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
 394     $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
 395     $this->assign('findParticipants', $findParticipants);
 396   }
 397
 398   /**
 399    * make a copy of a Event, including
 400    * all the fields in the event wizard
 401    *
 402    * @return void
 403    */
 404   public function copy() {
 405     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE, 0, 'GET');
 406
 407     $urlString = 'civicrm/event/manage';
 408     $copyEvent = CRM_Event_BAO_Event::copy($id);
 409     $urlParams = 'reset=1';
 410     // Redirect to Copied Event Configuration
 411     if ($copyEvent->id) {
 412       $urlString = 'civicrm/event/manage/settings';
 413       $urlParams .= '&action=update&id=' . $copyEvent->id;
 414     }
 415
 416     return CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
 417   }
 418
 419   public function search() {
 420     if (isset($this->_action) & (CRM_Core_Action::ADD |
 421         CRM_Core_Action::UPDATE |
 422         CRM_Core_Action::DELETE
 423       )
 424     ) {
 425       return;
 426     }
 427
 428     $form = new CRM_Core_Controller_Simple('CRM_Event_Form_SearchEvent', ts('Search Events'), CRM_Core_Action::ADD);
 429     $form->setEmbedded(TRUE);
 430     $form->setParent($this);
 431     $form->process();
 432     $form->run();
 433   }
 434
 435   /**
 436    * @param array $params
 437    * @param bool $sortBy
 438    * @param $force
 439    *
 440    * @return string
 441    */
 442   public function whereClause(&$params, $sortBy = TRUE, $force) {
 443     $values = array();
 444     $clauses = array();
 445     $title = $this->get('title');
 446     $createdId = $this->get('cid');
 447
 448     if ($createdId) {
 449       $clauses[] = "(created_id = {$createdId})";
 450     }
 451
 452     if ($title) {
 453       $clauses[] = "title LIKE %1";
 454       if (strpos($title, '%') !== FALSE) {
 455         $params[1] = array(trim($title), 'String', FALSE);
 456       }
 457       else {
 458         $params[1] = array(trim($title), 'String', TRUE);
 459       }
 460     }
 461
 462     $value = $this->get('event_type_id');
 463     if ($value) {
 464       if (is_array($value)) {
 465         $type = implode(',', $value);
 466       }
 467       $clauses[] = "event_type_id IN ({$type})";
 468     }
 469
 470     $eventsByDates = $this->get('eventsByDates');
 471     if ($this->_searchResult) {
 472       if ($eventsByDates) {
 473
 474         $from = $this->get('start_date');
 475         if (!CRM_Utils_System::isNull($from)) {
 476           $clauses[] = '( start_date >= %3 OR start_date IS NULL )';
 477           $params[3] = array($from, 'String');
 478         }
 479
 480         $to = $this->get('end_date');
 481         if (!CRM_Utils_System::isNull($to)) {
 482           $clauses[] = '( end_date <= %4 OR end_date IS NULL )';
 483           $params[4] = array($to, 'String');
 484         }
 485       }
 486       else {
 487         $curDate = date('YmdHis');
 488         $clauses[5] = "(end_date >= {$curDate} OR end_date IS NULL)";
 489       }
 490     }
 491     else {
 492       $curDate = date('YmdHis');
 493       $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
 494     }
 495
 496     if ($sortBy &&
 497       $this->_sortByCharacter !== NULL
 498     ) {
 499       $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . "%'";
 500     }
 501
 502     $campaignIds = $this->get('campaign_id');
 503     if (!CRM_Utils_System::isNull($campaignIds)) {
 504       if (!is_array($campaignIds)) {
 505         $campaignIds = array($campaignIds);
 506       }
 507       $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campaignIds)) . ' ) )';
 508     }
 509
 510     // don't do a the below assignment when doing a
 511     // AtoZ pager clause
 512     if ($sortBy) {
 513       if (count($clauses) > 1 || $eventsByDates) {
 514         $this->assign('isSearch', 1);
 515       }
 516       else {
 517         $this->assign('isSearch', 0);
 518       }
 519     }
 520
 521     return !empty($clauses) ? implode(' AND ', $clauses) : '(1)';
 522   }
 523
 524   /**
 525    * @param $whereClause
 526    * @param array $whereParams
 527    */
 528   public function pager($whereClause, $whereParams) {
 529
 530     $params['status'] = ts('Event %%StatusMessage%%');
 531     $params['csvString'] = NULL;
 532     $params['buttonTop'] = 'PagerTopButton';
 533     $params['buttonBottom'] = 'PagerBottomButton';
 534     $params['rowCount'] = $this->get(CRM_Utils_Pager::PAGE_ROWCOUNT);
 535     if (!$params['rowCount']) {
 536       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 537     }
 538
 539     $query = "
 540 SELECT count(id)
 541   FROM civicrm_event
 542  WHERE $whereClause";
 543
 544     $params['total'] = CRM_Core_DAO::singleValueQuery($query, $whereParams);
 545
 546     $this->_pager = new CRM_Utils_Pager($params);
 547     $this->assign_by_ref('pager', $this->_pager);
 548   }
 549
 550   /**
 551    * @param $whereClause
 552    * @param array $whereParams
 553    */
 554   public function pagerAtoZ($whereClause, $whereParams) {
 555
 556     $query = "
 557    SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
 558      FROM civicrm_event
 559     WHERE $whereClause
 560  ORDER BY LEFT(title, 1)
 561 ";
 562     $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
 563
 564     $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
 565     $this->assign('aToZ', $aToZBar);
 566   }
 567
 568 }