Commit | Line | Data |
---|---|---|
7f254ad8 AE |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.6 | | |
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 | ||
36 | /** | |
37 | * This class generates form components for Financial Account | |
38 | * | |
39 | */ | |
40 | class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { | |
41 | ||
42 | /** | |
43 | * Flag if its a AR account type. | |
44 | * | |
45 | * @var boolean | |
46 | */ | |
47 | protected $_isARFlag = FALSE; | |
48 | ||
49 | ||
50 | /** | |
51 | * Set variables up before form is built. | |
52 | * | |
53 | * @return void | |
54 | */ | |
55 | public function preProcess() { | |
56 | parent::preProcess(); | |
57 | ||
58 | if ($this->_id) { | |
59 | $params = array( | |
60 | 'id' => $this->_id, | |
61 | ); | |
62 | $financialAccount = CRM_Financial_BAO_FinancialAccount::retrieve($params, CRM_Core_DAO::$_nullArray); | |
63 | $financialAccountType = CRM_Core_PseudoConstant::accountOptionValues('financial_account_type'); | |
64 | if ($financialAccount->financial_account_type_id == array_search('Asset', $financialAccountType) | |
65 | && strtolower($financialAccount->account_type_code) == 'ar' | |
66 | && !CRM_Financial_BAO_FinancialAccount::getARAccounts($this->_id, array_search('Asset', $financialAccountType)) | |
67 | ) { | |
68 | $this->_isARFlag = TRUE; | |
69 | if ($this->_action & CRM_Core_Action::DELETE) { | |
70 | $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)."); | |
71 | CRM_Core_Error::statusBounce($msg); | |
72 | } | |
73 | } | |
74 | } | |
75 | } | |
76 | ||
77 | /** | |
78 | * Build the form object. | |
79 | * | |
80 | * @return void | |
81 | */ | |
82 | public function buildQuickForm() { | |
83 | parent::buildQuickForm(); | |
84 | $this->setPageTitle(ts('Financial Account')); | |
85 | ||
86 | if ($this->_action & CRM_Core_Action::DELETE) { | |
87 | return; | |
88 | } | |
89 | ||
90 | $this->applyFilter('__ALL__', 'trim'); | |
91 | $attributes = CRM_Core_DAO::getAttribute('CRM_Financial_DAO_FinancialAccount'); | |
92 | $this->add('text', 'name', ts('Name'), $attributes['name'], TRUE); | |
93 | $this->addRule('name', ts('A financial type with this name already exists. Please select another name.'), | |
94 | 'objectExists', array('CRM_Financial_DAO_FinancialAccount', $this->_id)); | |
95 | ||
96 | $this->add('text', 'description', ts('Description'), $attributes['description']); | |
97 | $this->add('text', 'accounting_code', ts('Accounting Code'), $attributes['accounting_code']); | |
98 | $elementAccounting = $this->add('text', 'account_type_code', ts('Account Type Code'), $attributes['account_type_code']); | |
99 | $this->addEntityRef('contact_id', ts('Owner'), array( | |
100 | 'api' => array('params' => array('contact_type' => 'Organization')), | |
101 | 'create' => TRUE, | |
102 | )); | |
103 | $this->add('text', 'tax_rate', ts('Tax Rate'), $attributes['tax_rate']); | |
104 | $this->add('checkbox', 'is_deductible', ts('Tax-Deductible?')); | |
105 | $elementActive = $this->add('checkbox', 'is_active', ts('Enabled?')); | |
106 | $this->add('checkbox', 'is_tax', ts('Is Tax?')); | |
107 | ||
108 | $element = $this->add('checkbox', 'is_default', ts('Default?')); | |
109 | // CRM-12470 freeze is default if is_default is set | |
110 | if ($this->_id && CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialAccount', $this->_id, 'is_default')) { | |
111 | $element->freeze(); | |
112 | } | |
113 | ||
114 | $financialAccountType = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialAccount', 'financial_account_type_id'); | |
115 | if (!empty($financialAccountType)) { | |
116 | $element = $this->add('select', 'financial_account_type_id', ts('Financial Account Type'), | |
117 | array('' => '- select -') + $financialAccountType, TRUE, array('class' => 'crm-select2 huge')); | |
118 | if ($this->_isARFlag) { | |
119 | $element->freeze(); | |
120 | $elementAccounting->freeze(); | |
121 | $elementActive->freeze(); | |
122 | } | |
123 | } | |
124 | ||
125 | if ($this->_action == CRM_Core_Action::UPDATE && | |
126 | CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialAccount', $this->_id, 'is_reserved') | |
127 | ) { | |
128 | $this->freeze(array('name', 'description', 'is_active')); | |
129 | } | |
130 | $this->addFormRule(array('CRM_Financial_Form_FinancialAccount', 'formRule'), $this); | |
131 | } | |
132 | ||
133 | /** | |
134 | * Global validation rules for the form. | |
135 | * | |
136 | * @param array $values | |
137 | * posted values of the form | |
138 | * @param $files | |
139 | * @param $self | |
140 | * | |
141 | * @return array | |
142 | * list of errors to be posted back to the form | |
143 | */ | |
144 | public static function formRule($values, $files, $self) { | |
145 | $errorMsg = array(); | |
146 | $financialAccountTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Liability' ")); | |
147 | if (isset($values['is_tax'])) { | |
148 | if ($values['financial_account_type_id'] != $financialAccountTypeId) { | |
149 | $errorMsg['financial_account_type_id'] = ts('Taxable accounts should have Financial Account Type set to Liability.'); | |
150 | } | |
151 | if (CRM_Utils_Array::value('tax_rate', $values) == NULL) { | |
152 | $errorMsg['tax_rate'] = ts('Please enter value for tax rate'); | |
153 | } | |
154 | } | |
155 | if ((CRM_Utils_Array::value('tax_rate', $values) != NULL)) { | |
156 | if ($values['tax_rate'] < 0 || $values['tax_rate'] >= 100) { | |
157 | $errorMsg['tax_rate'] = ts('Tax Rate Should be between 0 - 100'); | |
158 | } | |
159 | } | |
160 | if ($self->_action & CRM_Core_Action::UPDATE) { | |
161 | if (!(isset($values['is_tax']))) { | |
162 | $relationshipId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' ")); | |
163 | $params = array( | |
164 | 'financial_account_id' => $self->_id, | |
165 | 'account_relationship' => $relationshipId, | |
166 | ); | |
167 | $result = CRM_Financial_BAO_FinancialTypeAccount::retrieve($params, $defaults); | |
168 | if ($result) { | |
169 | $errorMsg['is_tax'] = ts('Is Tax? must be set for this financial account'); | |
170 | } | |
171 | } | |
172 | } | |
173 | return CRM_Utils_Array::crmIsEmptyArray($errorMsg) ? TRUE : $errorMsg; | |
174 | } | |
175 | ||
176 | /** | |
177 | * Set default values for the form. | |
178 | * the default values are retrieved from the database | |
179 | * | |
180 | * | |
181 | * @return void | |
182 | */ | |
183 | public function setDefaultValues() { | |
184 | $defaults = parent::setDefaultValues(); | |
185 | if ($this->_action & CRM_Core_Action::ADD) { | |
186 | $defaults['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config::domainID(), 'contact_id'); | |
187 | } | |
188 | return $defaults; | |
189 | } | |
190 | ||
191 | /** | |
192 | * Process the form submission. | |
193 | * | |
194 | * @return void | |
195 | */ | |
196 | public function postProcess() { | |
197 | if ($this->_action & CRM_Core_Action::DELETE) { | |
198 | CRM_Financial_BAO_FinancialAccount::del($this->_id); | |
199 | CRM_Core_Session::setStatus(ts('Selected Financial Account has been deleted.')); | |
200 | } | |
201 | else { | |
202 | $ids = array(); | |
203 | // store the submitted values in an array | |
204 | $params = $this->exportValues(); | |
205 | ||
206 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
207 | $ids['contributionType'] = $this->_id; | |
208 | } | |
209 | ||
210 | $contributionType = CRM_Financial_BAO_FinancialAccount::add($params, $ids); | |
211 | CRM_Core_Session::setStatus(ts('The Financial Account \'%1\' has been saved.', array(1 => $contributionType->name))); | |
212 | } | |
213 | } | |
214 | ||
215 | } |