CRM/Event/PseudoConstant.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  * This class holds all the Pseudo constants that are specific to Event. This avoids
  38  * polluting the core class and isolates the Event
  39  */
  40 class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
  41
  42   /**
  43    * Event
  44    *
  45    * @var array
  46    * @static
  47    */
  48   private static $event;
  49
  50   /**
  51    * Participant Status
  52    *
  53    * @var array
  54    * @static
  55    */
  56   private static $participantStatus;
  57
  58   /**
  59    * Participant Role
  60    *
  61    * @var array
  62    * @static
  63    */
  64   private static $participantRole;
  65
  66   /**
  67    * Participant Listing
  68    *
  69    * @var array
  70    * @static
  71    */
  72   private static $participantListing;
  73
  74   /**
  75    * Event Type.
  76    *
  77    * @var array
  78    * @static
  79    */
  80   private static $eventType;
  81
  82   /**
  83    * event template titles
  84    * @var array
  85    */
  86   private static $eventTemplates;
  87
  88   /**
  89    * Personal campaign pages
  90    * @var array
  91    * @static
  92    */
  93   private static $pcPage;
  94
  95   /**
  96    * Get all the n events
  97    *
  98    * @access public
  99    *
 100    * @param null $id
 101    * @param bool $all
 102    * @param null $condition
 103    *
 104    * @return array - array of all events if any
 105    * @static
 106    */
 107   public static function event($id = NULL, $all = FALSE, $condition = NULL) {
 108     $key = "{$id}_{$all}_{$condition}";
 109
 110     if (!isset(self::$event[$key])) {
 111       self::$event[$key] = array();
 112     }
 113
 114     if (!self::$event[$key]) {
 115       CRM_Core_PseudoConstant::populate(self::$event[$key],
 116         'CRM_Event_DAO_Event',
 117         $all, 'title', 'is_active', $condition, NULL
 118       );
 119     }
 120
 121     if ($id) {
 122       if (array_key_exists($id, self::$event[$key])) {
 123         return self::$event[$key][$id];
 124       }
 125       else {
 126         return NULL;
 127       }
 128     }
 129     return self::$event[$key];
 130   }
 131
 132   /**
 133    * Get all the n participant statuses
 134    *
 135    * @access public
 136    *
 137    * @param  string - $retColumn  tells populate() whether to return 'name' (default) or 'label' values
 138    *
 139    * @return array  - array reference of all participant statuses if any
 140    * @static
 141    */
 142   public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') {
 143     if (self::$participantStatus === NULL) {
 144       self::$participantStatus = array();
 145     }
 146
 147     $index = $cond ? $cond : 'No Condition';
 148     $index = "{$index}_{$retColumn}";
 149     if (!CRM_Utils_Array::value($index, self::$participantStatus)) {
 150       self::$participantStatus[$index] = array();
 151       CRM_Core_PseudoConstant::populate(self::$participantStatus[$index],
 152         'CRM_Event_DAO_ParticipantStatusType',
 153         FALSE, $retColumn, 'is_active', $cond, 'weight'
 154       );
 155     }
 156
 157     if ($id) {
 158       return self::$participantStatus[$index][$id];
 159     }
 160
 161     return self::$participantStatus[$index];
 162   }
 163
 164   /**
 165    * Return a status-type-keyed array of status classes
 166    *
 167    * @return array  of status classes, keyed by status type
 168    */
 169   static function &participantStatusClass() {
 170     static $statusClasses = NULL;
 171
 172     if ($statusClasses === NULL) {
 173       self::populate($statusClasses, 'CRM_Event_DAO_ParticipantStatusType', TRUE, 'class');
 174     }
 175
 176     return $statusClasses;
 177   }
 178
 179   /**
 180    * Get all the n participant roles
 181    *
 182    * @access public
 183    *
 184    * @return array - array reference of all participant roles if any
 185    * @static
 186    */
 187   public static function &participantRole($id = NULL, $cond = NULL) {
 188     $index = $cond ? $cond : 'No Condition';
 189     if (!CRM_Utils_Array::value($index, self::$participantRole)) {
 190       self::$participantRole[$index] = array();
 191
 192       $condition = NULL;
 193
 194       if ($cond) {
 195         $condition = "AND $cond";
 196       }
 197
 198       self::$participantRole[$index] = CRM_Core_OptionGroup::values('participant_role', FALSE, FALSE,
 199         FALSE, $condition
 200       );
 201     }
 202
 203     if ($id) {
 204       return self::$participantRole[$index][$id];
 205     }
 206     return self::$participantRole[$index];
 207   }
 208
 209   /**
 210    * Get all the participant listings
 211    *
 212    * @access public
 213    *
 214    * @param null $id
 215    *
 216    * @return array - array reference of all participant listings if any
 217    * @static
 218    */
 219   public static function &participantListing($id = NULL) {
 220     if (!self::$participantListing) {
 221       self::$participantListing = array();
 222       self::$participantListing = CRM_Core_OptionGroup::values('participant_listing');
 223     }
 224
 225     if ($id) {
 226       return self::$participantListing[$id];
 227     }
 228
 229     return self::$participantListing;
 230   }
 231
 232   /**
 233    * Get all  event types.
 234    *
 235    * @access public
 236    *
 237    * @return array - array reference of all event types.
 238    * @static
 239    */
 240   public static function &eventType($id = NULL) {
 241     if (!self::$eventType) {
 242       self::$eventType = array();
 243       self::$eventType = CRM_Core_OptionGroup::values('event_type');
 244     }
 245
 246     if ($id) {
 247       return self::$eventType[$id];
 248     }
 249
 250     return self::$eventType;
 251   }
 252
 253   /**
 254    * get event template titles
 255    *
 256    * @param null $id
 257    *
 258    * @return array  of event id → template title pairs
 259    */
 260   public static function &eventTemplates($id = NULL) {
 261     if (!self::$eventTemplates) {
 262       CRM_Core_PseudoConstant::populate(self::$eventTemplates,
 263         'CRM_Event_DAO_Event',
 264         FALSE,
 265         'template_title',
 266         'is_active',
 267         'is_template = 1'
 268       );
 269     }
 270     if ($id) {
 271       return self::$eventTemplates[$id];
 272     }
 273     return self::$eventTemplates;
 274   }
 275
 276   /**
 277    * Flush given pseudoconstant so it can be reread from db
 278    * nex time it's requested.
 279    *
 280    * @access public
 281    * @static
 282    *
 283    * @param boolean $name pseudoconstant to be flushed
 284    *
 285    */
 286   public static function flush($name = 'cache') {
 287    if (isset(self::$$name)) {
 288       self::$$name = NULL;
 289     }
 290   }
 291
 292   /**
 293    * Get all the Personal campaign pages
 294    *
 295    * @access public
 296    *
 297    * @return array - array reference of all pcp if any
 298    * @static
 299    */
 300   public static function &pcPage($id = NULL) {
 301     if (!self::$pcPage) {
 302       CRM_Core_PseudoConstant::populate(self::$pcPage,
 303         'CRM_PCP_DAO_PCP',
 304         FALSE, 'title'
 305       );
 306     }
 307     if ($id) {
 308       return CRM_Utils_Array::value($id, self::$pcPage);
 309     }
 310     return self::$pcPage;
 311   }
 312 }
 313