+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
* Event
*
* @var array
- * @static
*/
private static $event;
* Participant Status
*
* @var array
- * @static
*/
private static $participantStatus;
* Participant Role
*
* @var array
- * @static
*/
private static $participantRole;
* Participant Listing
*
* @var array
- * @static
*/
private static $participantListing;
* Event Type.
*
* @var array
- * @static
*/
private static $eventType;
/**
* Personal campaign pages
* @var array
- * @static
*/
private static $pcPage;
* @param bool $all
* @param null $condition
*
- * @return array - array of all events if any
- * @static
+ * @return array
+ * array of all events if any
*/
public static function event($id = NULL, $all = FALSE, $condition = NULL) {
$key = "{$id}_{$all}_{$condition}";
}
/**
- * Get all the n participant statuses
+ * Get all the n participant statuses.
*
*
* @param int $id
* @param string $retColumn
* Tells populate() whether to return 'name' (default) or 'label' values.
*
- * @return array - array reference of all participant statuses if any
- * @static
+ * @return array
+ * array reference of all participant statuses if any
*/
public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') {
if (self::$participantStatus === NULL) {
return self::$participantStatus[$index];
}
+ /**
+ * Get participant status class options.
+ *
+ * @return array
+ */
public static function participantStatusClassOptions() {
return array(
'Positive' => ts('Positive'),
/**
* Return a status-type-keyed array of status classes
*
- * @return array of status classes, keyed by status type
+ * @return array
+ * Array of status classes, keyed by status type
*/
public static function &participantStatusClass() {
static $statusClasses = NULL;
}
/**
- * Get all the n participant roles
+ * Get all the n participant roles.
*
*
* @param int $id
* @param null $cond
*
- * @return array - array reference of all participant roles if any
- * @static
+ * @return array
+ * array reference of all participant roles if any
*/
public static function &participantRole($id = NULL, $cond = NULL) {
$index = $cond ? $cond : 'No Condition';
}
/**
- * Get all the participant listings
+ * Get all the participant listings.
*
*
* @param int $id
*
- * @return array - array reference of all participant listings if any
- * @static
+ * @return array
+ * array reference of all participant listings if any
*/
public static function &participantListing($id = NULL) {
if (!self::$participantListing) {
*
*
* @param int $id
- * @return array - array reference of all event types.
- * @static
+ * @return array
+ * array reference of all event types.
*/
public static function &eventType($id = NULL) {
if (!self::$eventType) {
}
/**
- * Get event template titles
+ * Get event template titles.
*
* @param int $id
*
- * @return array of event id → template title pairs
+ * @return array
+ * Array of event id → template title pairs
*/
public static function &eventTemplates($id = NULL) {
if (!self::$eventTemplates) {
* Flush given pseudoconstant so it can be reread from db
* nex time it's requested.
*
- * @static
*
* @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'cache') {
if (isset(self::$$name)) {
self::$$name = NULL;
- }
+ }
}
/**
- * Get all the Personal campaign pages
+ * Get all the Personal campaign pages.
*
*
* @param int $id
- * @return array - array reference of all pcp if any
- * @static
+ * @return array
+ * array reference of all pcp if any
*/
public static function &pcPage($id = NULL) {
if (!self::$pcPage) {
}
return self::$pcPage;
}
+
}