3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class generates form components for Financial Account
40 class CRM_Financial_Form_FinancialAccount
extends CRM_Contribute_Form
{
43 * Flag if its a AR account type
47 protected $_isARFlag = FALSE;
51 * Function to set variables up before form is built
56 public function preProcess() {
63 $financialAccount = CRM_Financial_BAO_FinancialAccount
::retrieve($params, CRM_Core_DAO
::$_nullArray);
64 $financialAccountType = CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type');
65 if ($financialAccount->financial_account_type_id
== array_search('Asset', $financialAccountType)
66 && strtolower($financialAccount->account_type_code
) == 'ar'
67 && !CRM_Financial_BAO_FinancialAccount
::getARAccounts($this->_id
, array_search('Asset', $financialAccountType))) {
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 if (CRM_Utils_Array
::value('snippet', $_REQUEST) == 'json') {
72 CRM_Core_Page_AJAX
::returnJsonResponse($msg);
74 CRM_Core_Session
::setStatus($msg, '', 'error');
75 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/financial/financialAccount',
76 "reset=1&action=browse"));
83 * Function to build the form
88 public function buildQuickForm( ) {
89 parent
::buildQuickForm( );
91 if ($this->_action
& CRM_Core_Action
::DELETE
) {
95 $this->applyFilter('__ALL__', 'trim');
96 $attributes = CRM_Core_DAO
::getAttribute('CRM_Financial_DAO_FinancialAccount');
97 $this->add('text', 'name', ts('Name'), $attributes['name'], TRUE);
98 $this->addRule('name', ts('A financial type with this name already exists. Please select another name.'),
99 'objectExists', array('CRM_Financial_DAO_FinancialAccount', $this->_id
));
101 $this->add('text', 'description', ts('Description'), $attributes['description']);
102 $this->add('text', 'accounting_code', ts('Accounting Code'), $attributes['accounting_code']);
103 $elementAccounting = $this->add('text', 'account_type_code', ts('Account Type Code'), $attributes['account_type_code']);
104 $this->addEntityRef('contact_id', ts('Owner'), array('api' => array('params' => array('contact_type' => 'Organization')), 'create' => TRUE));
105 $this->add('text', 'tax_rate', ts('Tax Rate'), $attributes['tax_rate']);
106 $this->add('checkbox', 'is_deductible', ts('Tax-Deductible?'));
107 $elementActive = $this->add('checkbox', 'is_active', ts('Enabled?'));
108 $this->add('checkbox', 'is_tax', ts('Is Tax?'));
110 $element = $this->add('checkbox', 'is_default', ts('Default?'));
111 // CRM-12470 freeze is default if is_default is set
112 if ($this->_id
&& CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', $this->_id
, 'is_default')) {
116 $financialAccountType = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_FinancialAccount', 'financial_account_type_id');
117 if (!empty($financialAccountType)) {
118 $element = $this->add('select', 'financial_account_type_id', ts('Financial Account Type'),
119 array('' => '- select -') +
$financialAccountType, TRUE);
120 if ($this->_isARFlag
) {
122 $elementAccounting->freeze();
123 $elementActive->freeze();
127 if ($this->_action
== CRM_Core_Action
::UPDATE
&&
128 CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialAccount', $this->_id
, 'is_reserved')) {
129 $this->freeze(array('name', 'description', 'is_active'));
131 $this->addFormRule(array('CRM_Financial_Form_FinancialAccount', 'formRule'), $this);
135 * global validation rules for the form
141 * @internal param array $fields posted values of the form
143 * @return array list of errors to be posted back to the form
147 static function formRule( $values, $files, $self ) {
148 $errorMsg = array( );
149 if (!empty( $values['tax_rate'])) {
150 if ($values['tax_rate'] <= 0 ||
$values['tax_rate'] > 100) {
151 $errorMsg['tax_rate'] = ts('Tax Rate Should be between 0 - 100');
154 return CRM_Utils_Array
::crmIsEmptyArray( $errorMsg ) ?
true : $errorMsg;
158 * This function sets the default values for the form.
159 * the default values are retrieved from the database
165 function setDefaultValues() {
166 $defaults = parent
::setDefaultValues();
167 if ($this->_action
& CRM_Core_Action
::ADD
) {
168 $defaults['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config
::domainID(), 'contact_id');
174 * Function to process the form
179 public function postProcess() {
180 if ($this->_action
& CRM_Core_Action
::DELETE
) {
181 CRM_Financial_BAO_FinancialAccount
::del($this->_id
);
182 CRM_Core_Session
::setStatus( ts('Selected Financial Account has been deleted.') );
186 // store the submitted values in an array
187 $params = $this->exportValues();
189 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
190 $ids['contributionType'] = $this->_id
;
193 $contributionType = CRM_Financial_BAO_FinancialAccount
::add($params, $ids);
194 CRM_Core_Session
::setStatus(ts('The Financial Account \'%1\' has been saved.', array(1 => $contributionType->name
)));