X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FEvent%2FPseudoConstant.php;h=1543f86709eb1f5b95bab197945e41765d673ab8;hb=291ab38be9b062ee720f99253ab04313d79f9e8f;hp=d99496720c849571fe0c1388b267738af71cdc75;hpb=9c204b425c4f161f3dec52e3d7f0cae2f9f35eb5;p=civicrm-core.git diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index d99496720c..1543f86709 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -13,8 +13,6 @@ * * @package CRM * @copyright CiviCRM LLC https://civicrm.org/licensing - * $Id$ - * */ /** @@ -72,14 +70,14 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { private static $pcPage; /** - * Get all the n events - * + * Get all events * - * @param int $id + * @param int|null $id * @param bool $all - * @param null $condition + * @param string|null $condition + * Optional SQL where condition * - * @return array + * @return array|string|null * array of all events if any */ public static function event($id = NULL, $all = FALSE, $condition = NULL) { @@ -108,16 +106,18 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the n participant statuses. + * Get all the event participant statuses. * * - * @param int $id - * @param null $cond + * @param int|null $id + * Return the specified participant status, or null to return all + * @param string|null $cond + * Optional SQL where condition * @param string $retColumn * Tells populate() whether to return 'name' (default) or 'label' values. * - * @return array - * array reference of all participant statuses if any + * @return array|string + * array reference of all participant statuses if any, or single value if $id was passed */ public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') { if (self::$participantStatus === NULL) { @@ -176,7 +176,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * * @param int $id - * @param null $cond + * @param string|null $cond + * Optional SQL where condition * * @return array|string * array reference of all participant roles if any @@ -272,7 +273,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { /** * Flush given pseudoconstant so it can be reread from db - * nex time it's requested. + * next time it's requested. * * * @param bool|string $name pseudoconstant to be flushed