Merge pull request #4812 from colemanw/CRM-15495

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

diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php
index e650b3a0565e97a1036d9317fb22a89dd9da43fd..47a3cb917d1b2db2f0f3c9845c39bdc75fc0a2b5 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                                |
  +--------------------------------------------------------------------+
@@ -40,14 +40,14 @@
 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
+   * 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,9 +117,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the financial types
    *
-   * @access public
    *
-   * @param null $id
+   * @param int $id
    *
    * @return array - array reference of all financial types if any
    * @static
@@ -149,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
    *
@@ -189,7 +187,6 @@ 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
@@ -208,7 +205,6 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    * @param integer $id  id of the contribution page
    * @param boolean $all do we want all pages or only active pages
    *
-   * @access public
    *
    * @return array - array reference of all contribution pages if any
    * @static
@@ -239,7 +235,6 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * Get all the payment instruments
    *
-   * @access public
    *
    * @param string $columnName
    *
@@ -259,7 +254,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
@@ -271,9 +265,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all premiums
    *
-   * @access public
    *
-   * @param null $pageID
+   * @param int $pageID
    * @return array - array of all Premiums if any
    * @static
    */
@@ -319,9 +312,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the contribution statuses
    *
-   * @access public
    *
-   * @param null $id
+   * @param int $id
    * @param string $columnName
    * @return array - array reference of all contribution statuses
    * @static
@@ -344,10 +336,9 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the Personal campaign pages
    *
-   * @access public
    *
    * @param null $pageType
-   * @param null $id
+   * @param int $id
    *
    * @return array - array reference of all pcp if any
    * @static
@@ -378,7 +369,6 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * The static array pcpStatus is returned
    *
-   * @access public
    * @static
    *
    * @param string $column
@@ -403,11 +393,10 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * The static array  $financialTypeAccount is returned
    *
-   * @access public
    * @static
    *
-   * @param $financialTypeId
-   * @param null $relationTypeId
+   * @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) {
@@ -435,9 +424,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all batches
    *
-   * @access public
    *
-   * @param null $id
+   * @param int $id
    * @return array - array reference of all batches if any
    * @static
    */
@@ -462,4 +450,3 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
     return self::$batch;
   }
 }
-