Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
35 | * This class generates form components for Financial Account | |
6a488035 TO |
36 | */ |
37 | class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { | |
38 | ||
7d289724 | 39 | /** |
fe482240 | 40 | * Flag if its a AR account type. |
7d289724 | 41 | * |
d51c6add | 42 | * @var bool |
7d289724 PN |
43 | */ |
44 | protected $_isARFlag = FALSE; | |
8ef12e64 | 45 | |
7d289724 | 46 | /** |
fe482240 | 47 | * Set variables up before form is built. |
7d289724 PN |
48 | */ |
49 | public function preProcess() { | |
50 | parent::preProcess(); | |
8ef12e64 | 51 | |
7d289724 | 52 | if ($this->_id) { |
be2fb01f | 53 | $params = [ |
7d289724 | 54 | 'id' => $this->_id, |
be2fb01f | 55 | ]; |
7d289724 | 56 | $financialAccount = CRM_Financial_BAO_FinancialAccount::retrieve($params, CRM_Core_DAO::$_nullArray); |
7d45c236 MM |
57 | $financialAccountTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' ")); |
58 | if ($financialAccount->financial_account_type_id == $financialAccountTypeId | |
8ef12e64 | 59 | && strtolower($financialAccount->account_type_code) == 'ar' |
7d45c236 | 60 | && !CRM_Financial_BAO_FinancialAccount::getARAccounts($this->_id, $financialAccountTypeId) |
353ffa53 | 61 | ) { |
7d289724 PN |
62 | $this->_isARFlag = TRUE; |
63 | if ($this->_action & CRM_Core_Action::DELETE) { | |
134bc82c | 64 | $msg = ts("The selected financial account cannot be deleted because at least one Accounts Receivable type account is required (to ensure that accounting transactions are in balance)."); |
e2046b33 | 65 | CRM_Core_Error::statusBounce($msg); |
7d289724 PN |
66 | } |
67 | } | |
68 | } | |
69 | } | |
70 | ||
6a488035 | 71 | /** |
fe482240 | 72 | * Build the form object. |
6a488035 | 73 | */ |
045f52a3 | 74 | public function buildQuickForm() { |
481a74f4 | 75 | parent::buildQuickForm(); |
e2046b33 | 76 | $this->setPageTitle(ts('Financial Account')); |
6a488035 TO |
77 | |
78 | if ($this->_action & CRM_Core_Action::DELETE) { | |
79 | return; | |
80 | } | |
03e04002 | 81 | |
6a488035 TO |
82 | $this->applyFilter('__ALL__', 'trim'); |
83 | $attributes = CRM_Core_DAO::getAttribute('CRM_Financial_DAO_FinancialAccount'); | |
7d289724 | 84 | $this->add('text', 'name', ts('Name'), $attributes['name'], TRUE); |
6a488035 | 85 | $this->addRule('name', ts('A financial type with this name already exists. Please select another name.'), |
be2fb01f | 86 | 'objectExists', ['CRM_Financial_DAO_FinancialAccount', $this->_id]); |
03e04002 | 87 | |
6a488035 TO |
88 | $this->add('text', 'description', ts('Description'), $attributes['description']); |
89 | $this->add('text', 'accounting_code', ts('Accounting Code'), $attributes['accounting_code']); | |
7d289724 | 90 | $elementAccounting = $this->add('text', 'account_type_code', ts('Account Type Code'), $attributes['account_type_code']); |
be2fb01f CW |
91 | $this->addEntityRef('contact_id', ts('Owner'), [ |
92 | 'api' => ['params' => ['contact_type' => 'Organization']], | |
ae5ffbb7 | 93 | 'create' => TRUE, |
be2fb01f | 94 | ]); |
6a488035 TO |
95 | $this->add('text', 'tax_rate', ts('Tax Rate'), $attributes['tax_rate']); |
96 | $this->add('checkbox', 'is_deductible', ts('Tax-Deductible?')); | |
ddaa8ef1 | 97 | $elementActive = $this->add('checkbox', 'is_active', ts('Enabled?')); |
6a488035 | 98 | $this->add('checkbox', 'is_tax', ts('Is Tax?')); |
d0f466d1 | 99 | |
ddaa8ef1 PN |
100 | $element = $this->add('checkbox', 'is_default', ts('Default?')); |
101 | // CRM-12470 freeze is default if is_default is set | |
102 | if ($this->_id && CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialAccount', $this->_id, 'is_default')) { | |
103 | $element->freeze(); | |
104 | } | |
03e04002 | 105 | |
7611ae71 | 106 | $financialAccountType = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialAccount', 'financial_account_type_id'); |
6a488035 | 107 | if (!empty($financialAccountType)) { |
7d289724 | 108 | $element = $this->add('select', 'financial_account_type_id', ts('Financial Account Type'), |
be2fb01f | 109 | ['' => '- select -'] + $financialAccountType, TRUE, ['class' => 'crm-select2 huge']); |
7d289724 PN |
110 | if ($this->_isARFlag) { |
111 | $element->freeze(); | |
112 | $elementAccounting->freeze(); | |
ddaa8ef1 | 113 | $elementActive->freeze(); |
7d289724 | 114 | } |
235929d0 PN |
115 | elseif ($this->_id && CRM_Financial_BAO_FinancialAccount::validateFinancialAccount($this->_id)) { |
116 | $element->freeze(); | |
117 | } | |
6a488035 | 118 | } |
03e04002 | 119 | |
6a488035 | 120 | if ($this->_action == CRM_Core_Action::UPDATE && |
353ffa53 TO |
121 | CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialAccount', $this->_id, 'is_reserved') |
122 | ) { | |
be2fb01f | 123 | $this->freeze(['name', 'description', 'is_active']); |
6a488035 | 124 | } |
be2fb01f | 125 | $this->addFormRule(['CRM_Financial_Form_FinancialAccount', 'formRule'], $this); |
6a488035 | 126 | } |
03e04002 | 127 | |
6a488035 | 128 | /** |
fe482240 | 129 | * Global validation rules for the form. |
6a488035 | 130 | * |
16b10e64 CW |
131 | * @param array $values |
132 | * posted values of the form | |
da6b46f4 EM |
133 | * @param $files |
134 | * @param $self | |
135 | * | |
a6c01b45 CW |
136 | * @return array |
137 | * list of errors to be posted back to the form | |
6a488035 | 138 | */ |
045f52a3 | 139 | public static function formRule($values, $files, $self) { |
be2fb01f | 140 | $errorMsg = []; |
707f6952 RK |
141 | $financialAccountTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Liability' ")); |
142 | if (isset($values['is_tax'])) { | |
045f52a3 | 143 | if ($values['financial_account_type_id'] != $financialAccountTypeId) { |
707f6952 RK |
144 | $errorMsg['financial_account_type_id'] = ts('Taxable accounts should have Financial Account Type set to Liability.'); |
145 | } | |
146 | if (CRM_Utils_Array::value('tax_rate', $values) == NULL) { | |
147 | $errorMsg['tax_rate'] = ts('Please enter value for tax rate'); | |
148 | } | |
149 | } | |
33421d01 | 150 | if ((CRM_Utils_Array::value('tax_rate', $values) != NULL)) { |
707f6952 | 151 | if ($values['tax_rate'] < 0 || $values['tax_rate'] >= 100) { |
6a488035 TO |
152 | $errorMsg['tax_rate'] = ts('Tax Rate Should be between 0 - 100'); |
153 | } | |
154 | } | |
707f6952 RK |
155 | if ($self->_action & CRM_Core_Action::UPDATE) { |
156 | if (!(isset($values['is_tax']))) { | |
157 | $relationshipId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' ")); | |
be2fb01f | 158 | $params = [ |
353ffa53 | 159 | 'financial_account_id' => $self->_id, |
21dfd5f5 | 160 | 'account_relationship' => $relationshipId, |
be2fb01f | 161 | ]; |
d75f2f47 | 162 | $result = CRM_Financial_BAO_FinancialTypeAccount::retrieve($params, $defaults); |
707f6952 RK |
163 | if ($result) { |
164 | $errorMsg['is_tax'] = ts('Is Tax? must be set for this financial account'); | |
165 | } | |
166 | } | |
167 | } | |
481a74f4 | 168 | return CRM_Utils_Array::crmIsEmptyArray($errorMsg) ? TRUE : $errorMsg; |
6a488035 | 169 | } |
03e04002 | 170 | |
6a488035 | 171 | /** |
c490a46a | 172 | * Set default values for the form. |
cded2ebf | 173 | * the default values are retrieved from the database. |
6a488035 | 174 | */ |
00be9182 | 175 | public function setDefaultValues() { |
6a488035 TO |
176 | $defaults = parent::setDefaultValues(); |
177 | if ($this->_action & CRM_Core_Action::ADD) { | |
178 | $defaults['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config::domainID(), 'contact_id'); | |
6a488035 TO |
179 | } |
180 | return $defaults; | |
181 | } | |
03e04002 | 182 | |
6a488035 | 183 | /** |
fe482240 | 184 | * Process the form submission. |
6a488035 TO |
185 | */ |
186 | public function postProcess() { | |
187 | if ($this->_action & CRM_Core_Action::DELETE) { | |
05b9ff02 PN |
188 | if (CRM_Financial_BAO_FinancialAccount::del($this->_id)) { |
189 | CRM_Core_Session::setStatus(ts('Selected Financial Account has been deleted.')); | |
190 | } | |
191 | else { | |
192 | CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/financial/financialAccount', "reset=1&action=browse")); | |
193 | } | |
6a488035 TO |
194 | } |
195 | else { | |
6a488035 TO |
196 | // store the submitted values in an array |
197 | $params = $this->exportValues(); | |
03e04002 | 198 | |
6a488035 | 199 | if ($this->_action & CRM_Core_Action::UPDATE) { |
235929d0 | 200 | $params['id'] = $this->_id; |
6a488035 | 201 | } |
5a9f7af1 PN |
202 | foreach ([ |
203 | 'is_active', | |
204 | 'is_deductible', | |
205 | 'is_tax', | |
206 | 'is_default', | |
207 | ] as $field) { | |
208 | $params[$field] = CRM_Utils_Array::value($field, $params, FALSE); | |
209 | } | |
235929d0 | 210 | $financialAccount = CRM_Financial_BAO_FinancialAccount::add($params); |
be2fb01f | 211 | CRM_Core_Session::setStatus(ts('The Financial Account \'%1\' has been saved.', [1 => $financialAccount->name]), ts('Saved'), 'success'); |
6a488035 TO |
212 | } |
213 | } | |
e2046b33 | 214 | |
6a488035 | 215 | } |