Merge pull request #4893 from colemanw/INFRA-132

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

diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php
index c86c7a285458c488bec8aed33de31f74972760a9..8fe113f6b2a8f2f27136a8788b347190a7162d56 100644 (file)
--- a/CRM/Financial/BAO/FinancialType.php
+++ b/CRM/Financial/BAO/FinancialType.php
@@ -39,61 +39,68 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
   /**
    * Static holder for the default LT
    */
-  static $_defaultContributionType = null;
+  static $_defaultContributionType = NULL;
 
   /**
    * Class constructor
    */
-  public function __construct( ) {
-    parent::__construct( );
+  public function __construct() {
+    parent::__construct();
   }
 
   /**
    * 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
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Contribute_BAO_ContributionType object
    * @static
    */
-  public static function retrieve( &$params, &$defaults ) {
-    $financialType = new CRM_Financial_DAO_FinancialType( );
-    $financialType->copyValues( $params );
-    if ($financialType->find(true)) {
-      CRM_Core_DAO::storeValues( $financialType, $defaults );
+  public static function retrieve(&$params, &$defaults) {
+    $financialType = new CRM_Financial_DAO_FinancialType();
+    $financialType->copyValues($params);
+    if ($financialType->find(TRUE)) {
+      CRM_Core_DAO::storeValues($financialType, $defaults);
       return $financialType;
     }
-    return null;
+    return NULL;
   }
 
   /**
    * 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
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
-   * @return Object             DAO object on sucess, null otherwise
+   * @return Object
+   *   DAO object on sucess, null otherwise
    * @static
    */
-  public static function setIsActive( $id, $is_active ) {
-    return CRM_Core_DAO::setFieldValue( 'CRM_Financial_DAO_FinancialType', $id, 'is_active', $is_active );
+  public static function setIsActive($id, $is_active) {
+    return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_FinancialType', $id, 'is_active', $is_active);
   }
 
   /**
    * Add the financial types
    *
-   * @param array $params reference array contains the values submitted by the form
-   * @param array $ids    reference array contains the id
+   * @param array $params
+   *   Reference array contains the values submitted by the form.
+   * @param array $ids
+   *   Reference array contains the id.
    *
    * @static
    * @return object
    */
   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);
+    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
@@ -120,9 +127,9 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
    * @static
    */
   public static function del($financialTypeId) {
-    $financialType = new CRM_Financial_DAO_FinancialType( );
+    $financialType = new CRM_Financial_DAO_FinancialType();
     $financialType->id = $financialTypeId;
-    $financialType->find(true);
+    $financialType->find(TRUE);
     // tables to ingore checks for financial_type_id
     $ignoreTables = array('CRM_Financial_DAO_EntityFinancialAccount');
 
@@ -135,7 +142,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
       foreach ($occurrences as $occurence) {
         $className = get_class($occurence);
         if (!in_array($className, $ignoreTables)) {
-        $tables[] = $className;
+          $tables[] = $className;
         }
       }
       if (!empty($tables)) {
@@ -151,7 +158,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
     //delete from financial Type table
     $financialType->delete();
 
-    $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount( );
+    $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
     $entityFinancialType->entity_id = $financialTypeId;
     $entityFinancialType->entity_table = 'civicrm_financial_type';
     $entityFinancialType->delete();
@@ -159,10 +166,11 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
   }
 
   /**
-   * To fetch financial type having relationship as Income Account is
+   * fetch financial type having relationship as Income Account is
    *
    *
-   * @return array  all financial type with income account is relationship
+   * @return array
+   *   all financial type with income account is relationship
    * @static
    */
   public static function getIncomeFinancialType() {
@@ -173,9 +181,9 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
     CRM_Core_PseudoConstant::populate(
       $revenueFinancialType,
       'CRM_Financial_DAO_EntityFinancialAccount',
-      $all = True,
+      $all = TRUE,
       $retrieve = 'entity_id',
-      $filter = null,
+      $filter = NULL,
       "account_relationship = $relationTypeId AND entity_table = 'civicrm_financial_type' "
     );