CRM/Financial/Form/FinancialAccount.php

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