CRM/Event/Page/ManageEvent.php

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