CRM/Admin/Page/EventTemplate.php

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