CRM-15172 - Refactor forms to use addChainSelect method
[civicrm-core.git] / CRM / Event / PseudoConstant.php
index a38cfaaba67625251efecadacc4f613c46468601..39536722add33c66de1a9f6b5a52a87692c84596 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -97,10 +97,14 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @access public
    *
-   * @return array - array reference of all events if any
+   * @param null $id
+   * @param bool $all
+   * @param null $condition
+   *
+   * @return array - array of all events if any
    * @static
    */
-  public static function &event($id = NULL, $all = FALSE, $condition = NULL) {
+  public static function event($id = NULL, $all = FALSE, $condition = NULL) {
     $key = "{$id}_{$all}_{$condition}";
 
     if (!isset(self::$event[$key])) {
@@ -130,7 +134,11 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @access public
    *
-   * @param  string - $retColumn  tells populate() whether to return 'name' (default) or 'label' values
+   * @param null $id
+   * @param null $cond
+   * @param string $retColumn
+   *
+   * @internal param $string - $retColumn  tells populate() whether to return 'name' (default) or 'label' values
    *
    * @return array  - array reference of all participant statuses if any
    * @static
@@ -177,6 +185,9 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @access public
    *
+   * @param null $id
+   * @param null $cond
+   *
    * @return array - array reference of all participant roles if any
    * @static
    */
@@ -207,6 +218,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @access public
    *
+   * @param null $id
+   *
    * @return array - array reference of all participant listings if any
    * @static
    */
@@ -228,6 +241,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @access public
    *
+   * @param null $id
    * @return array - array reference of all event types.
    * @static
    */
@@ -247,6 +261,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * get event template titles
    *
+   * @param null $id
+   *
    * @return array  of event id → template title pairs
    */
   public static function &eventTemplates($id = NULL) {
@@ -272,8 +288,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    * @access public
    * @static
    *
-   * @param boolean $name pseudoconstant to be flushed
-   *
+   * @param bool|string $name pseudoconstant to be flushed
    */
   public static function flush($name = 'cache') {
    if (isset(self::$$name)) {
@@ -286,6 +301,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @access public
    *
+   * @param null $id
    * @return array - array reference of all pcp if any
    * @static
    */