CRM/Admin/Page/EventTemplate.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                 |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * Page for displaying list of event templates.
  36  */
  37 class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic {
  38
  39   /**
  40    * The action links that we need to display for the browse screen.
  41    *
  42    * @var array
  43    */
  44   static $_links = NULL;
  45
  46   /**
  47    * Get BAO Name.
  48    *
  49    * @return string
  50    *   Classname of BAO.
  51    */
  52   public function getBAOName() {
  53     return 'CRM_Event_BAO_Event';
  54   }
  55
  56   /**
  57    * Get action Links.
  58    *
  59    * @return array
  60    *   (reference) of action links
  61    */
  62   public function &links() {
  63     if (!(self::$_links)) {
  64       // helper variable for nicer formatting
  65       self::$_links = array(
  66         CRM_Core_Action::UPDATE => array(
  67           'name' => ts('Edit'),
  68           'url' => 'civicrm/event/manage/settings',
  69           'qs' => 'action=update&id=%%id%%&reset=1',
  70           'title' => ts('Edit Event Template'),
  71         ),
  72         CRM_Core_Action::DELETE => array(
  73           'name' => ts('Delete'),
  74           'url' => 'civicrm/event/manage',
  75           'qs' => 'action=delete&id=%%id%%',
  76           'title' => ts('Delete Event Template'),
  77         ),
  78       );
  79     }
  80
  81     return self::$_links;
  82   }
  83
  84   /**
  85    * Browse all event templates.
  86    */
  87   public function browse() {
  88     //get all event templates.
  89     $allEventTemplates = array();
  90
  91     $eventTemplate = new CRM_Event_DAO_Event();
  92
  93     $eventTypes = CRM_Event_PseudoConstant::eventType();
  94     $participantRoles = CRM_Event_PseudoConstant::participantRole();
  95     $participantListings = CRM_Event_PseudoConstant::participantListing();
  96
  97     //find all event templates.
  98     $eventTemplate->is_template = TRUE;
  99     $eventTemplate->find();
 100     while ($eventTemplate->fetch()) {
 101       CRM_Core_DAO::storeValues($eventTemplate, $allEventTemplates[$eventTemplate->id]);
 102
 103       //get listing types.
 104       if ($eventTemplate->participant_listing_id) {
 105         $allEventTemplates[$eventTemplate->id]['participant_listing'] = $participantListings[$eventTemplate->participant_listing_id];
 106       }
 107
 108       //get participant role
 109       if ($eventTemplate->default_role_id) {
 110         $allEventTemplates[$eventTemplate->id]['participant_role'] = $participantRoles[$eventTemplate->default_role_id];
 111       }
 112
 113       //get event type.
 114       if (isset($eventTypes[$eventTemplate->event_type_id])) {
 115         $allEventTemplates[$eventTemplate->id]['event_type'] = $eventTypes[$eventTemplate->event_type_id];
 116       }
 117
 118       //form all action links
 119       $action = array_sum(array_keys($this->links()));
 120
 121       //add action links.
 122       $allEventTemplates[$eventTemplate->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 123         array('id' => $eventTemplate->id),
 124         ts('more'),
 125         FALSE,
 126         'eventTemplate.manage.action',
 127         'Event',
 128         $eventTemplate->id
 129       );
 130     }
 131     $this->assign('rows', $allEventTemplates);
 132
 133     $session = CRM_Core_Session::singleton();
 134     $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(),
 135       'reset=1&action=browse'
 136     ));
 137   }
 138
 139   /**
 140    * Get name of edit form.
 141    *
 142    * @return string
 143    *   Classname of edit form.
 144    */
 145   public function editForm() {
 146     return 'CRM_Admin_Form_EventTemplate';
 147   }
 148
 149   /**
 150    * Get edit form name.
 151    *
 152    * @return string
 153    *   name of this page.
 154    */
 155   public function editName() {
 156     return 'Event Templates';
 157   }
 158
 159   /**
 160    * Get user context.
 161    *
 162    * @param null $mode
 163    *
 164    * @return string
 165    *   user context.
 166    */
 167   public function userContext($mode = NULL) {
 168     return 'civicrm/admin/eventTemplate';
 169   }
 170
 171 }