Merge pull request #5830 from davecivicrm/CRM-16502
[civicrm-core.git] / CRM / Event / PseudoConstant.php
index b906f79b0f1fe53099d459083c3795bb2e590bb0..feaa604bedcca030d915afac84dd2dfaa79459d9 100644 (file)
@@ -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.                                    |
  |                                                                    |
  | 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;
 
@@ -102,7 +96,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @return array
    *   array of all events if any
-   * @static
    */
   public static function event($id = NULL, $all = FALSE, $condition = NULL) {
     $key = "{$id}_{$all}_{$condition}";
@@ -130,7 +123,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * Get all the n participant statuses
+   * Get all the n participant statuses.
    *
    *
    * @param int $id
@@ -140,7 +133,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @return array
    *   array reference of all participant statuses if any
-   * @static
    */
   public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') {
     if (self::$participantStatus === NULL) {
@@ -164,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'),
@@ -190,7 +187,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * Get all the n participant roles
+   * Get all the n participant roles.
    *
    *
    * @param int $id
@@ -198,7 +195,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @return array
    *   array reference of all participant roles if any
-   * @static
    */
   public static function &participantRole($id = NULL, $cond = NULL) {
     $index = $cond ? $cond : 'No Condition';
@@ -223,14 +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
    */
   public static function &participantListing($id = NULL) {
     if (!self::$participantListing) {
@@ -252,7 +247,6 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * @param int $id
    * @return array
    *   array reference of all event types.
-   * @static
    */
   public static function &eventType($id = NULL) {
     if (!self::$eventType) {
@@ -268,7 +262,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * Get event template titles
+   * Get event template titles.
    *
    * @param int $id
    *
@@ -295,7 +289,6 @@ 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
    */
@@ -306,13 +299,12 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   }
 
   /**
-   * 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
    */
   public static function &pcPage($id = NULL) {
     if (!self::$pcPage) {
@@ -326,4 +318,5 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
     }
     return self::$pcPage;
   }
+
 }