3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 tells populate() whether to return 'name' (default) or 'label' values
141 * @return array - array reference of all participant statuses if any
144 public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') {
145 if (self
::$participantStatus === NULL) {
146 self
::$participantStatus = array();
149 $index = $cond ?
$cond : 'No Condition';
150 $index = "{$index}_{$retColumn}";
151 if (!CRM_Utils_Array
::value($index, self
::$participantStatus)) {
152 self
::$participantStatus[$index] = array();
153 CRM_Core_PseudoConstant
::populate(self
::$participantStatus[$index],
154 'CRM_Event_DAO_ParticipantStatusType',
155 FALSE, $retColumn, 'is_active', $cond, 'weight'
160 return self
::$participantStatus[$index][$id];
163 return self
::$participantStatus[$index];
167 * Return a status-type-keyed array of status classes
169 * @return array of status classes, keyed by status type
171 public static function &participantStatusClass() {
172 static $statusClasses = NULL;
174 if ($statusClasses === NULL) {
175 self
::populate($statusClasses, 'CRM_Event_DAO_ParticipantStatusType', TRUE, 'class');
178 return $statusClasses;
182 * Get all the n participant roles
189 * @return array - array reference of all participant roles if any
192 public static function &participantRole($id = NULL, $cond = NULL) {
193 $index = $cond ?
$cond : 'No Condition';
194 if (!CRM_Utils_Array
::value($index, self
::$participantRole)) {
195 self
::$participantRole[$index] = array();
200 $condition = "AND $cond";
203 self
::$participantRole[$index] = CRM_Core_OptionGroup
::values('participant_role', FALSE, FALSE,
209 return self
::$participantRole[$index][$id];
211 return self
::$participantRole[$index];
215 * Get all the participant listings
221 * @return array - array reference of all participant listings if any
224 public static function &participantListing($id = NULL) {
225 if (!self
::$participantListing) {
226 self
::$participantListing = array();
227 self
::$participantListing = CRM_Core_OptionGroup
::values('participant_listing');
231 return self
::$participantListing[$id];
234 return self
::$participantListing;
238 * Get all event types.
243 * @return array - array reference of all event types.
246 public static function &eventType($id = NULL) {
247 if (!self
::$eventType) {
248 self
::$eventType = array();
249 self
::$eventType = CRM_Core_OptionGroup
::values('event_type');
253 return self
::$eventType[$id];
256 return self
::$eventType;
260 * Get event template titles
264 * @return array of event id → template title pairs
266 public static function &eventTemplates($id = NULL) {
267 if (!self
::$eventTemplates) {
268 CRM_Core_PseudoConstant
::populate(self
::$eventTemplates,
269 'CRM_Event_DAO_Event',
277 return self
::$eventTemplates[$id];
279 return self
::$eventTemplates;
283 * Flush given pseudoconstant so it can be reread from db
284 * nex time it's requested.
289 * @param bool|string $name pseudoconstant to be flushed
291 public static function flush($name = 'cache') {
292 if (isset(self
::$
$name)) {
298 * Get all the Personal campaign pages
303 * @return array - array reference of all pcp if any
306 public static function &pcPage($id = NULL) {
307 if (!self
::$pcPage) {
308 CRM_Core_PseudoConstant
::populate(self
::$pcPage,
314 return CRM_Utils_Array
::value($id, self
::$pcPage);
316 return self
::$pcPage;