INFRA-132 - Change "else if" to "elseif"
[civicrm-core.git] / CRM / Contribute / PseudoConstant.php
index 5811c002770e065ae40dd931f4eacca3ec4ec443..3e6420392205246066597d45d036a31c7cf13f8e 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
 class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
 
   /**
-   * financial types
+   * Financial types
    * @var array
    * @static
    */
   private static $financialType;
 
   /**
-   * financial types
+   * Financial types
    * @var array
    * @static
    */
@@ -55,28 +55,28 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
 
 
   /**
-   * financial types
+   * Financial types
    * @var array
    * @static
    */
   private static $financialAccount;
 
-    /**
-   * contribution pages
-   * @var array
-   * @static
-   */
+  /**
+     * Contribution pages
+     * @var array
+     * @static
+     */
   private static $contributionPageActive = NULL;
 
   /**
-   * contribution pages
+   * Contribution pages
    * @var array
    * @static
    */
   private static $contributionPageAll = NULL;
 
   /**
-   * payment instruments
+   * Payment instruments
    *
    * @var array
    * @static
@@ -84,7 +84,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   private static $paymentInstrument;
 
   /**
-   * contribution status
+   * Contribution status
    *
    * @var array
    * @static
@@ -99,14 +99,14 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   private static $pcPage;
 
   /**
-   * status of personal campaign page
+   * Status of personal campaign page
    * @var array
    * @static
    */
   private static $pcpStatus;
 
   /**
-   * contribution / financial batches
+   * Contribution / financial batches
    * @var array
    * @static
    */
@@ -117,7 +117,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the financial types
    *
-   * @access public
+   *
+   * @param int $id
    *
    * @return array - array reference of all financial types if any
    * @static
@@ -147,10 +148,9 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the financial Accounts
    *
-   * @access public
    *
-   * @param null $id
-   * @param null $financialAccountTypeId
+   * @param int $id
+   * @param int $financialAccountTypeId
    * @param string $retrieveColumn
    * @param string $key
    *
@@ -158,7 +158,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    * @static
    */
   public static function &financialAccount($id = NULL, $financialAccountTypeId = NULL, $retrieveColumn = 'name', $key = 'id') {
-    $condition = NUll;
+    $condition = NULL;
     if ($financialAccountTypeId) {
       $condition = " financial_account_type_id = ". $financialAccountTypeId;
     }
@@ -187,16 +187,14 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    * Flush given pseudoconstant so it can be reread from db
    * nex time it's requested.
    *
-   * @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)) {
+    if (isset(self::$$name)) {
       self::$$name = NULL;
-    }
+   }
   }
 
   /**
@@ -204,10 +202,11 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the contribution pages
    *
-   * @param integer $id  id of the contribution page
-   * @param boolean $all do we want all pages or only active pages
+   * @param int $id
+   *   Id of the contribution page.
+   * @param bool $all
+   *   Do we want all pages or only active pages.
    *
-   * @access public
    *
    * @return array - array reference of all contribution pages if any
    * @static
@@ -238,7 +237,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the payment instruments
    *
-   * @access public
+   *
+   * @param string $columnName
    *
    * @return array - array reference of all payment instruments if any
    * @static
@@ -256,7 +256,6 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the valid accepted credit cards
    *
-   * @access public
    *
    * @return array - array reference of all payment instruments if any
    * @static
@@ -268,8 +267,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all premiums
    *
-   * @access public
    *
+   * @param int $pageID
    * @return array - array of all Premiums if any
    * @static
    */
@@ -315,8 +314,9 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the contribution statuses
    *
-   * @access public
    *
+   * @param int $id
+   * @param string $columnName
    * @return array - array reference of all contribution statuses
    * @static
    */
@@ -338,7 +338,9 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the Personal campaign pages
    *
-   * @access public
+   *
+   * @param null $pageType
+   * @param int $id
    *
    * @return array - array reference of all pcp if any
    * @static
@@ -369,9 +371,9 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * The static array pcpStatus is returned
    *
-   * @access public
    * @static
    *
+   * @param string $column
    * @return array - array reference of all PCP activity statuses
    */
   public static function &pcpStatus($column = 'label') {
@@ -393,9 +395,10 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * The static array  $financialTypeAccount is returned
    *
-   * @access public
    * @static
    *
+   * @param int $financialTypeId
+   * @param int $relationTypeId
    * @return array - array reference of all financial accounts for a Financial type
    */
   public static function financialAccountType($financialTypeId, $relationTypeId = NULL) {
@@ -404,7 +407,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
       CRM_Core_PseudoConstant::populate(
         self::$financialTypeAccount[$financialTypeId],
         'CRM_Financial_DAO_EntityFinancialAccount',
-        $all = true,
+        $all = TRUE,
         $retrieve = 'financial_account_id',
         $filter = NULL,
         $condition,
@@ -423,8 +426,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all batches
    *
-   * @access public
    *
+   * @param int $id
    * @return array - array reference of all batches if any
    * @static
    */
@@ -449,4 +452,3 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
     return self::$batch;
   }
 }
-