CRM/Financial/BAO/FinancialType.php

   1 <?php
   2
   3 /*
   4   +--------------------------------------------------------------------+
   5   | CiviCRM version 4.6                                                |
   6   +--------------------------------------------------------------------+
   7   | Copyright CiviCRM LLC (c) 2004-2014                                |
   8   +--------------------------------------------------------------------+
   9   | This file is a part of CiviCRM.                                    |
  10   |                                                                    |
  11   | CiviCRM is free software; you can copy, modify, and distribute it  |
  12   | under the terms of the GNU Affero General Public License           |
  13   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14   |                                                                    |
  15   | CiviCRM is distributed in the hope that it will be useful, but     |
  16   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18   | See the GNU Affero General Public License for more details.        |
  19   |                                                                    |
  20   | You should have received a copy of the GNU Affero General Public   |
  21   | License and the CiviCRM Licensing Exception along                  |
  22   | with this program; if not, contact CiviCRM LLC                     |
  23   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24   | GNU Affero General Public License or the licensing of CiviCRM,     |
  25   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26   +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
  38
  39   /**
  40    * Static holder for the default LT
  41    */
  42   static $_defaultContributionType = NULL;
  43
  44   /**
  45    * Class constructor
  46    */
  47   public function __construct() {
  48     parent::__construct();
  49   }
  50
  51   /**
  52    * Fetch object based on array of properties
  53    *
  54    * @param array $params
  55    *   (reference ) an assoc array of name/value pairs.
  56    * @param array $defaults
  57    *   (reference ) an assoc array to hold the flattened values.
  58    *
  59    * @return CRM_Contribute_BAO_ContributionType object
  60    * @static
  61    */
  62   public static function retrieve(&$params, &$defaults) {
  63     $financialType = new CRM_Financial_DAO_FinancialType();
  64     $financialType->copyValues($params);
  65     if ($financialType->find(TRUE)) {
  66       CRM_Core_DAO::storeValues($financialType, $defaults);
  67       return $financialType;
  68     }
  69     return NULL;
  70   }
  71
  72   /**
  73    * Update the is_active flag in the db
  74    *
  75    * @param int $id
  76    *   Id of the database record.
  77    * @param bool $is_active
  78    *   Value we want to set the is_active field.
  79    *
  80    * @return Object             DAO object on sucess, null otherwise
  81    * @static
  82    */
  83   public static function setIsActive($id, $is_active) {
  84     return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_FinancialType', $id, 'is_active', $is_active);
  85   }
  86
  87   /**
  88    * Add the financial types
  89    *
  90    * @param array $params
  91    *   Reference array contains the values submitted by the form.
  92    * @param array $ids
  93    *   Reference array contains the id.
  94    *
  95    * @static
  96    * @return object
  97    */
  98   public static function add(&$params, &$ids = array()) {
  99     if (empty($params['id'])) {
 100       $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 101       $params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, FALSE);
 102       $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE);
 103     }
 104
 105     // action is taken depending upon the mode
 106     $financialType = new CRM_Financial_DAO_FinancialType();
 107     $financialType->copyValues($params);
 108     if (!empty($ids['financialType'])) {
 109       $financialType->id = CRM_Utils_Array::value('financialType', $ids);
 110     }
 111     $financialType->save();
 112     // CRM-12470
 113     if (empty($ids['financialType']) && empty($params['id'])) {
 114       $titles = CRM_Financial_BAO_FinancialTypeAccount::createDefaultFinancialAccounts($financialType);
 115       $financialType->titles = $titles;
 116     }
 117     return $financialType;
 118   }
 119
 120   /**
 121    * Delete financial Types
 122    *
 123    * @param int $financialTypeId
 124    *
 125    * @return array|bool
 126    * @static
 127    */
 128   public static function del($financialTypeId) {
 129     $financialType = new CRM_Financial_DAO_FinancialType();
 130     $financialType->id = $financialTypeId;
 131     $financialType->find(TRUE);
 132     // tables to ingore checks for financial_type_id
 133     $ignoreTables = array('CRM_Financial_DAO_EntityFinancialAccount');
 134
 135     //TODO: if (!$financialType->find(true)) {
 136
 137     // ensure that we have no objects that have an FK to this financial type id TODO: that cannot be null
 138     $occurrences = $financialType->findReferences();
 139     if ($occurrences) {
 140       $tables = array();
 141       foreach ($occurrences as $occurence) {
 142         $className = get_class($occurence);
 143         if (!in_array($className, $ignoreTables)) {
 144           $tables[] = $className;
 145         }
 146       }
 147       if (!empty($tables)) {
 148         $message = ts('The following tables have an entry for this financial type: %1', array('%1' => implode(', ', $tables)));
 149
 150         $errors = array();
 151         $errors['is_error'] = 1;
 152         $errors['error_message'] = $message;
 153         return $errors;
 154       }
 155     }
 156
 157     //delete from financial Type table
 158     $financialType->delete();
 159
 160     $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
 161     $entityFinancialType->entity_id = $financialTypeId;
 162     $entityFinancialType->entity_table = 'civicrm_financial_type';
 163     $entityFinancialType->delete();
 164     return FALSE;
 165   }
 166
 167   /**
 168    * fetch financial type having relationship as Income Account is
 169    *
 170    *
 171    * @return array  all financial type with income account is relationship
 172    * @static
 173    */
 174   public static function getIncomeFinancialType() {
 175     // Financial Type
 176     $financialType = CRM_Contribute_PseudoConstant::financialType();
 177     $revenueFinancialType = array();
 178     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
 179     CRM_Core_PseudoConstant::populate(
 180       $revenueFinancialType,
 181       'CRM_Financial_DAO_EntityFinancialAccount',
 182       $all = TRUE,
 183       $retrieve = 'entity_id',
 184       $filter = NULL,
 185       "account_relationship = $relationTypeId AND entity_table = 'civicrm_financial_type' "
 186     );
 187
 188     foreach ($financialType as $key => $financialTypeName) {
 189       if (!in_array($key, $revenueFinancialType)) {
 190         unset($financialType[$key]);
 191       }
 192     }
 193     return $financialType;
 194   }
 195 }