X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FEvent%2FPseudoConstant.php;h=feaa604bedcca030d915afac84dd2dfaa79459d9;hb=0ea79a6887c97d6682437c9432b708982631da60;hp=1b3250d066d8e7f3dcf71c0b82d5827cb298ff34;hpb=fa92b4af1c4abf280689cea6445c7a9b99858831;p=civicrm-core.git

diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php
index 1b3250d066..feaa604bed 100644
--- a/CRM/Event/PseudoConstant.php
+++ b/CRM/Event/PseudoConstant.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | 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$
  *
  */
@@ -43,7 +43,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * Event
    *
    * @var array
-   * @static
    */
   private static $event;
 
@@ -51,7 +50,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * Participant Status
    *
    * @var array
-   * @static
    */
   private static $participantStatus;
 
@@ -59,7 +57,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * Participant Role
    *
    * @var array
-   * @static
    */
   private static $participantRole;
 
@@ -67,7 +64,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * Participant Listing
    *
    * @var array
-   * @static
    */
   private static $participantListing;
 
@@ -75,7 +71,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * Event Type.
    *
    * @var array
-   * @static
    */
   private static $eventType;
 
@@ -88,7 +83,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Personal campaign pages
    * @var array
-   * @static
    */
   private static $pcPage;
 
@@ -100,8 +94,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * @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}";
@@ -129,15 +123,16 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * Get all the n participant statuses
+   * Get all the n participant statuses.
    *
    *
    * @param int $id
    * @param null $cond
-   * @param string $retColumn tells populate() whether to return 'name' (default) or 'label' values
+   * @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) {
@@ -161,6 +156,11 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
     return self::$participantStatus[$index];
   }
 
+  /**
+   * Get participant status class options.
+   *
+   * @return array
+   */
   public static function participantStatusClassOptions() {
     return array(
       'Positive' => ts('Positive'),
@@ -173,7 +173,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * 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;
@@ -186,14 +187,14 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * 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';
@@ -218,13 +219,13 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * 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) {
@@ -244,8 +245,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    *
    * @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) {
@@ -261,11 +262,12 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * 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) {
@@ -287,23 +289,22 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * 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)) {
+    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) {
@@ -317,4 +318,5 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
     }
     return self::$pcPage;
   }
+
 }