CRM/Event/PseudoConstant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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    *
  99    * @param int $id
 100    * @param bool $all
 101    * @param null $condition
 102    *
 103    * @return array - array of all events if any
 104    * @static
 105    */
 106   public static function event($id = NULL, $all = FALSE, $condition = NULL) {
 107     $key = "{$id}_{$all}_{$condition}";
 108
 109     if (!isset(self::$event[$key])) {
 110       self::$event[$key] = array();
 111     }
 112
 113     if (!self::$event[$key]) {
 114       CRM_Core_PseudoConstant::populate(self::$event[$key],
 115         'CRM_Event_DAO_Event',
 116         $all, 'title', 'is_active', $condition, NULL
 117       );
 118     }
 119
 120     if ($id) {
 121       if (array_key_exists($id, self::$event[$key])) {
 122         return self::$event[$key][$id];
 123       }
 124       else {
 125         return NULL;
 126       }
 127     }
 128     return self::$event[$key];
 129   }
 130
 131   /**
 132    * Get all the n participant statuses
 133    *
 134    *
 135    * @param int $id
 136    * @param null $cond
 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   public static function participantStatusClassOptions() {
 165     return array(
 166       'Positive' => ts('Positive'),
 167       'Pending' => ts('Pending'),
 168       'Waiting' => ts('Waiting'),
 169       'Negative' => ts('Negative'),
 170     );
 171   }
 172
 173   /**
 174    * Return a status-type-keyed array of status classes
 175    *
 176    * @return array  of status classes, keyed by status type
 177    */
 178   public static function &participantStatusClass() {
 179     static $statusClasses = NULL;
 180
 181     if ($statusClasses === NULL) {
 182       self::populate($statusClasses, 'CRM_Event_DAO_ParticipantStatusType', TRUE, 'class');
 183     }
 184
 185     return $statusClasses;
 186   }
 187
 188   /**
 189    * Get all the n participant roles
 190    *
 191    *
 192    * @param int $id
 193    * @param null $cond
 194    *
 195    * @return array - array reference of all participant roles if any
 196    * @static
 197    */
 198   public static function &participantRole($id = NULL, $cond = NULL) {
 199     $index = $cond ? $cond : 'No Condition';
 200     if (!CRM_Utils_Array::value($index, self::$participantRole)) {
 201       self::$participantRole[$index] = array();
 202
 203       $condition = NULL;
 204
 205       if ($cond) {
 206         $condition = "AND $cond";
 207       }
 208
 209       self::$participantRole[$index] = CRM_Core_OptionGroup::values('participant_role', FALSE, FALSE,
 210         FALSE, $condition
 211       );
 212     }
 213
 214     if ($id) {
 215       return self::$participantRole[$index][$id];
 216     }
 217     return self::$participantRole[$index];
 218   }
 219
 220   /**
 221    * Get all the participant listings
 222    *
 223    *
 224    * @param int $id
 225    *
 226    * @return array - array reference of all participant listings if any
 227    * @static
 228    */
 229   public static function &participantListing($id = NULL) {
 230     if (!self::$participantListing) {
 231       self::$participantListing = array();
 232       self::$participantListing = CRM_Core_OptionGroup::values('participant_listing');
 233     }
 234
 235     if ($id) {
 236       return self::$participantListing[$id];
 237     }
 238
 239     return self::$participantListing;
 240   }
 241
 242   /**
 243    * Get all  event types.
 244    *
 245    *
 246    * @param int $id
 247    * @return array - array reference of all event types.
 248    * @static
 249    */
 250   public static function &eventType($id = NULL) {
 251     if (!self::$eventType) {
 252       self::$eventType = array();
 253       self::$eventType = CRM_Core_OptionGroup::values('event_type');
 254     }
 255
 256     if ($id) {
 257       return self::$eventType[$id];
 258     }
 259
 260     return self::$eventType;
 261   }
 262
 263   /**
 264    * Get event template titles
 265    *
 266    * @param int $id
 267    *
 268    * @return array  of event id → template title pairs
 269    */
 270   public static function &eventTemplates($id = NULL) {
 271     if (!self::$eventTemplates) {
 272       CRM_Core_PseudoConstant::populate(self::$eventTemplates,
 273         'CRM_Event_DAO_Event',
 274         FALSE,
 275         'template_title',
 276         'is_active',
 277         'is_template = 1'
 278       );
 279     }
 280     if ($id) {
 281       return self::$eventTemplates[$id];
 282     }
 283     return self::$eventTemplates;
 284   }
 285
 286   /**
 287    * Flush given pseudoconstant so it can be reread from db
 288    * nex time it's requested.
 289    *
 290    * @static
 291    *
 292    * @param bool|string $name pseudoconstant to be flushed
 293    */
 294   public static function flush($name = 'cache') {
 295    if (isset(self::$$name)) {
 296       self::$$name = NULL;
 297     }
 298   }
 299
 300   /**
 301    * Get all the Personal campaign pages
 302    *
 303    *
 304    * @param int $id
 305    * @return array - array reference of all pcp if any
 306    * @static
 307    */
 308   public static function &pcPage($id = NULL) {
 309     if (!self::$pcPage) {
 310       CRM_Core_PseudoConstant::populate(self::$pcPage,
 311         'CRM_PCP_DAO_PCP',
 312         FALSE, 'title'
 313       );
 314     }
 315     if ($id) {
 316       return CRM_Utils_Array::value($id, self::$pcPage);
 317     }
 318     return self::$pcPage;
 319   }
 320 }