Merge pull request #4893 from colemanw/INFRA-132

[civicrm-core.git] / CRM / Contribute / PseudoConstant.php

diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php
index 53454a706909666a8a45e91d678cd0eff6de0720..8128236b90205eb6db5e0d746dc7eceefb7d595f 100644 (file)
--- a/CRM/Contribute/PseudoConstant.php
+++ b/CRM/Contribute/PseudoConstant.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -61,11 +61,11 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    */
   private static $financialAccount;
 
-    /**
-   * Contribution pages
-   * @var array
-   * @static
-   */
+  /**
+     * Contribution pages
+     * @var array
+     * @static
+     */
   private static $contributionPageActive = NULL;
 
   /**
@@ -117,11 +117,11 @@ 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
+   * @return array
+   *   array reference of all financial types if any
    * @static
    */
   public static function &financialType($id = NULL) {
@@ -149,20 +149,20 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the financial Accounts
    *
-   * @access public
    *
    * @param int $id
    * @param int $financialAccountTypeId
    * @param string $retrieveColumn
    * @param string $key
    *
-   * @return array - array reference of all financial accounts if any
+   * @return array
+   *   array reference of all financial accounts if any
    * @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;
+      $condition = " financial_account_type_id = " . $financialAccountTypeId;
     }
     $cacheKey = "{$id}_{$financialAccountTypeId}_{$retrieveColumn}_{$key}";
     if (!isset(self::$financialAccount[$cacheKey])) {
@@ -189,15 +189,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 bool|string $name pseudoconstant to be flushed
    */
   public static function flush($name = 'cache') {
-   if (isset(self::$$name)) {
+    if (isset(self::$$name)) {
       self::$$name = NULL;
-    }
+   }
   }
 
   /**
@@ -205,12 +204,14 @@ 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
+   * @return array
+   *   array reference of all contribution pages if any
    * @static
    */
   public static function &contributionPage($id = NULL, $all = FALSE) {
@@ -239,11 +240,11 @@ 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
+   * @return array
+   *   array reference of all payment instruments if any
    * @static
    */
   public static function &paymentInstrument($columnName = 'label') {
@@ -259,9 +260,9 @@ 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
+   * @return array
+   *   array reference of all payment instruments if any
    * @static
    */
   public static function &creditCard() {
@@ -271,10 +272,10 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all premiums
    *
-   * @access public
    *
    * @param int $pageID
-   * @return array - array of all Premiums if any
+   * @return array
+   *   array of all Premiums if any
    * @static
    */
   public static function products($pageID = NULL) {
@@ -319,11 +320,11 @@ 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
+   * @return array
+   *   array reference of all contribution statuses
    * @static
    */
   public static function &contributionStatus($id = NULL, $columnName = 'label') {
@@ -344,12 +345,12 @@ 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
+   * @return array
+   *   array reference of all pcp if any
    * @static
    */
   public static function &pcPage($pageType = NULL, $id = NULL) {
@@ -378,11 +379,11 @@ 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
+   * @return array
+   *   array reference of all PCP activity statuses
    */
   public static function &pcpStatus($column = 'label') {
     if (NULL === self::$pcpStatus) {
@@ -403,12 +404,12 @@ 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
+   * @return array
+   *   array reference of all financial accounts for a Financial type
    */
   public static function financialAccountType($financialTypeId, $relationTypeId = NULL) {
     if (!CRM_Utils_Array::value($financialTypeId, self::$financialTypeAccount)) {
@@ -416,7 +417,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,
@@ -435,10 +436,10 @@ 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
+   * @return array
+   *   array reference of all batches if any
    * @static
    */
   public static function &batch($id = NULL) {
@@ -462,4 +463,3 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
     return self::$batch;
   }
 }
-