3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class holds all the Pseudo constants that are specific to Event. This avoids
38 * polluting the core class and isolates the Event
40 class CRM_Event_PseudoConstant
extends CRM_Core_PseudoConstant
{
48 private static $event;
56 private static $participantStatus;
64 private static $participantRole;
72 private static $participantListing;
80 private static $eventType;
83 * event template titles
86 private static $eventTemplates;
89 * Personal campaign pages
93 private static $pcPage;
96 * Get all the n events
102 * @param null $condition
104 * @return array - array of all events if any
107 public static function event($id = NULL, $all = FALSE, $condition = NULL) {
108 $key = "{$id}_{$all}_{$condition}";
110 if (!isset(self
::$event[$key])) {
111 self
::$event[$key] = array();
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
122 if (array_key_exists($id, self
::$event[$key])) {
123 return self
::$event[$key][$id];
129 return self
::$event[$key];
133 * Get all the n participant statuses
139 * @param string $retColumn
141 * @internal param $string - $retColumn tells populate() whether to return 'name' (default) or 'label' values
143 * @return array - array reference of all participant statuses if any
146 public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') {
147 if (self
::$participantStatus === NULL) {
148 self
::$participantStatus = array();
151 $index = $cond ?
$cond : 'No Condition';
152 $index = "{$index}_{$retColumn}";
153 if (!CRM_Utils_Array
::value($index, self
::$participantStatus)) {
154 self
::$participantStatus[$index] = array();
155 CRM_Core_PseudoConstant
::populate(self
::$participantStatus[$index],
156 'CRM_Event_DAO_ParticipantStatusType',
157 FALSE, $retColumn, 'is_active', $cond, 'weight'
162 return self
::$participantStatus[$index][$id];
165 return self
::$participantStatus[$index];
169 * Return a status-type-keyed array of status classes
171 * @return array of status classes, keyed by status type
173 static function &participantStatusClass() {
174 static $statusClasses = NULL;
176 if ($statusClasses === NULL) {
177 self
::populate($statusClasses, 'CRM_Event_DAO_ParticipantStatusType', TRUE, 'class');
180 return $statusClasses;
184 * Get all the n participant roles
191 * @return array - array reference of all participant roles if any
194 public static function &participantRole($id = NULL, $cond = NULL) {
195 $index = $cond ?
$cond : 'No Condition';
196 if (!CRM_Utils_Array
::value($index, self
::$participantRole)) {
197 self
::$participantRole[$index] = array();
202 $condition = "AND $cond";
205 self
::$participantRole[$index] = CRM_Core_OptionGroup
::values('participant_role', FALSE, FALSE,
211 return self
::$participantRole[$index][$id];
213 return self
::$participantRole[$index];
217 * Get all the participant listings
223 * @return array - array reference of all participant listings if any
226 public static function &participantListing($id = NULL) {
227 if (!self
::$participantListing) {
228 self
::$participantListing = array();
229 self
::$participantListing = CRM_Core_OptionGroup
::values('participant_listing');
233 return self
::$participantListing[$id];
236 return self
::$participantListing;
240 * Get all event types.
245 * @return array - array reference of all event types.
248 public static function &eventType($id = NULL) {
249 if (!self
::$eventType) {
250 self
::$eventType = array();
251 self
::$eventType = CRM_Core_OptionGroup
::values('event_type');
255 return self
::$eventType[$id];
258 return self
::$eventType;
262 * get event template titles
266 * @return array of event id → template title pairs
268 public static function &eventTemplates($id = NULL) {
269 if (!self
::$eventTemplates) {
270 CRM_Core_PseudoConstant
::populate(self
::$eventTemplates,
271 'CRM_Event_DAO_Event',
279 return self
::$eventTemplates[$id];
281 return self
::$eventTemplates;
285 * Flush given pseudoconstant so it can be reread from db
286 * nex time it's requested.
291 * @param bool|string $name pseudoconstant to be flushed
293 public static function flush($name = 'cache') {
294 if (isset(self
::$
$name)) {
300 * Get all the Personal campaign pages
305 * @return array - array reference of all pcp if any
308 public static function &pcPage($id = NULL) {
309 if (!self
::$pcPage) {
310 CRM_Core_PseudoConstant
::populate(self
::$pcPage,
316 return CRM_Utils_Array
::value($id, self
::$pcPage);
318 return self
::$pcPage;