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