INFRA-132 - Comment grammar cleanup
[civicrm-core.git] / CRM / Member / PseudoConstant.php
index 434923bac1f3b992b33713aac3db8d86a7129ebb..03415578db831e34350f9702f840220a46bb7904 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
 class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
 
   /**
-   * membership types
+   * Membership types
    * @var array
    * @static
    */
   private static $membershipType;
 
   /**
-   * membership types
+   * Membership types
    * @var array
    * @static
    */
@@ -56,9 +56,8 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the membership types
    *
-   * @access public
    *
-   * @param null $id
+   * @param int $id
    * @param bool $force
    *
    * @return array - array reference of all membership types if any
@@ -86,9 +85,8 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the membership statuss
    *
-   * @access public
    *
-   * @param null $id
+   * @param int $id
    * @param null $cond
    * @param string $column
    * @param bool $force
@@ -96,7 +94,7 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
    * @return array - array reference of all membership statuss if any
    * @static
    */
-  public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE) {
+  public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE, $allStatus = FALSE) {
     if (self::$membershipStatus === NULL) {
       self::$membershipStatus = array();
     }
@@ -108,7 +106,7 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
     if (!isset(self::$membershipStatus[$cacheKey]) || $force) {
       CRM_Core_PseudoConstant::populate(self::$membershipStatus[$cacheKey],
         'CRM_Member_DAO_MembershipStatus',
-        FALSE, $column, 'is_active', $cond, 'weight'
+        $allStatus, $column, 'is_active', $cond, 'weight'
       );
     }
 
@@ -127,15 +125,13 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
    * Flush given pseudoconstant so it can be reread from db
    * next time it's requested.
    *
-   * @access public
    * @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;
-    }
+   }
   }
 }
-