Merge pull request #4822 from kurund/indentation-fixes

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

diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php
index 5b1d71c5e922127aecfa1d4b3f63dde3e5503293..c86c7a285458c488bec8aed33de31f74972760a9 100644 (file)
--- a/CRM/Financial/BAO/FinancialType.php
+++ b/CRM/Financial/BAO/FinancialType.php
@@ -2,9 +2,9 @@
 
 /*
   +--------------------------------------------------------------------+
-  | CiviCRM version 4.4                                                |
+  | CiviCRM version 4.6                                                |
   +--------------------------------------------------------------------+
-  | 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,32 +37,27 @@
 class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
 
   /**
-   * static holder for the default LT
+   * Static holder for the default LT
    */
   static $_defaultContributionType = null;
 
   /**
-   * class constructor
+   * Class constructor
    */
-  function __construct( ) {
+  public 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_ContributionType object
-   * @access public
+   * @return CRM_Contribute_BAO_ContributionType object
    * @static
    */
-  static function retrieve( &$params, &$defaults ) {
+  public static function retrieve( &$params, &$defaults ) {
     $financialType = new CRM_Financial_DAO_FinancialType( );
     $financialType->copyValues( $params );
     if ($financialType->find(true)) {
@@ -73,7 +68,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
   }
 
   /**
-   * 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
@@ -81,34 +76,35 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
    * @return Object             DAO object on sucess, null otherwise
    * @static
    */
-  static function setIsActive( $id, $is_active ) {
+  public static function setIsActive( $id, $is_active ) {
     return CRM_Core_DAO::setFieldValue( 'CRM_Financial_DAO_FinancialType', $id, 'is_active', $is_active );
   }
 
   /**
-   * 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
    *
-   * @access public
    * @static
    * @return object
    */
-  static function add(&$params, &$ids = array()) {
-    $params['is_active'] = CRM_Utils_Array::value('is_active', $params, false);
-    $params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, false);
-    $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, false);
+  public 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_reserved'] = CRM_Utils_Array::value('is_reserved', $params, false);
+    }
 
     // action is taken depending upon the mode
     $financialType = new CRM_Financial_DAO_FinancialType();
     $financialType->copyValues($params);
-    if (CRM_Utils_Array::value('financialType', $ids)) {
+    if (!empty($ids['financialType'])) {
       $financialType->id = CRM_Utils_Array::value('financialType', $ids);
     }
     $financialType->save();
     // CRM-12470
-    if (!CRM_Utils_Array::value('financialType', $ids)) {
+    if (empty($ids['financialType']) && empty($params['id'])) {
       $titles = CRM_Financial_BAO_FinancialTypeAccount::createDefaultFinancialAccounts($financialType);
       $financialType->titles = $titles;
     }
@@ -116,12 +112,14 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
   }
 
   /**
-   * Function to delete financial Types
+   * Delete financial Types
+   *
+   * @param int $financialTypeId
    *
-   * @param int $contributionTypeId
+   * @return array|bool
    * @static
    */
-  static function del($financialTypeId) {
+  public static function del($financialTypeId) {
     $financialType = new CRM_Financial_DAO_FinancialType( );
     $financialType->id = $financialTypeId;
     $financialType->find(true);
@@ -161,13 +159,13 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
   }
 
   /**
-   * to fetch financial type having relationship as Income Account is
+   * To fetch financial type having relationship as Income Account is
    *
    *
    * @return array  all financial type with income account is relationship
    * @static
    */
-  static function getIncomeFinancialType() {
+  public static function getIncomeFinancialType() {
     // Financial Type
     $financialType = CRM_Contribute_PseudoConstant::financialType();
     $revenueFinancialType = array();
@@ -189,4 +187,3 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
     return $financialType;
   }
 }
-