Cleanup phpdoc comments

[civicrm-core.git] / CRM / Financial / BAO / FinancialAccount.php

diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php
index 0be4ddef5de380703347d88cc42eb0bc0ccd8ea7..70aa0596169f830616a8988c8cc05357b158dc70 100644 (file)
--- a/CRM/Financial/BAO/FinancialAccount.php
+++ b/CRM/Financial/BAO/FinancialAccount.php
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -29,7 +29,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -37,28 +37,24 @@
 class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAccount {
 
   /**
-   * static holder for the default LT
+   * Static holder for the default LT
    */
   static $_defaultContributionType = NULL;
 
   /**
-   * class constructor
+   * Class constructor
    */
   function __construct() {
     parent::__construct();
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. Typically the valid params are only
-   * contact_id. We'll tweak this function to be more full featured over a period
-   * of time. This is the inverse function of create. It also stores all the retrieved
-   * values in the default array
+   * Fetch object based on array of properties
    *
    * @param array $params   (reference ) an assoc array of name/value pairs
    * @param array $defaults (reference ) an assoc array to hold the flattened values
    *
-   * @return object CRM_Contribute_BAO_FinancialAccount object
+   * @return CRM_Contribute_BAO_FinancialAccount object
    * @access public
    * @static
    */
@@ -73,7 +69,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * update the is_active flag in the db
+   * Update the is_active flag in the db
    *
    * @param int      $id        id of the database record
    * @param boolean  $is_active value we want to set the is_active field
@@ -86,7 +82,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * function to add the financial types
+   * Add the financial types
    *
    * @param array $params reference array contains the values submitted by the form
    * @param array $ids    reference array contains the id
@@ -95,12 +91,14 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
    * @static
    * @return object
    */
-  static function add(&$params, &$ids) {
-    $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
-    $params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, FALSE);
-    $params['is_tax'] = CRM_Utils_Array::value('is_tax', $params, FALSE);
-    $params['is_header_account'] = CRM_Utils_Array::value('is_header_account', $params, FALSE);
-    $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
+  static function add(&$params, &$ids = array()) {
+    if(empty($params['id'])) {
+      $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
+      $params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, FALSE);
+      $params['is_tax'] = CRM_Utils_Array::value('is_tax', $params, FALSE);
+      $params['is_header_account'] = CRM_Utils_Array::value('is_header_account', $params, FALSE);
+      $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
+    }
     if (!empty($params['is_default'])) {
       $query = 'UPDATE civicrm_financial_account SET is_default = 0 WHERE financial_account_type_id = %1';
       $queryParams = array(1 => array($params['financial_account_type_id'], 'Integer'));
@@ -110,13 +108,15 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
     // action is taken depending upon the mode
     $financialAccount = new CRM_Financial_DAO_FinancialAccount();
     $financialAccount->copyValues($params);
-    $financialAccount->id = CRM_Utils_Array::value('contributionType', $ids);
+    if (!empty($ids['contributionType'])) {
+      $financialAccount->id = CRM_Utils_Array::value('contributionType', $ids);
+    }
     $financialAccount->save();
     return $financialAccount;
   }
 
   /**
-   * Function to delete financial Types
+   * Delete financial Types
    *
    * @param int $financialAccountId
    * @static
@@ -152,10 +152,12 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * get accounting code for a financial type with account relation Income Account is
+   * Get accounting code for a financial type with account relation Income Account is
    *
    * @financialTypeId int      Financial Type Id
    *
+   * @param int $financialTypeId
+   *
    * @return accounting code
    * @static
    */
@@ -175,13 +177,13 @@ WHERE cft.id = %1
   }
 
   /**
-   * get AR account
+   * Get AR account
    *
    * @param $financialAccountId financial account id
    *
    * @param $financialAccountTypeId financial account type id
    *
-   * @param $accountTypeCode account type code
+   * @param \account|string $accountTypeCode account type code
    *
    * @return integer count
    * @static