CRM/Grant/Form/Grant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This class generates form components for processing a case
  14  *
  15  */
  16 class CRM_Grant_Form_Grant extends CRM_Core_Form {
  17
  18   /**
  19    * The id of the case that we are proceessing.
  20    *
  21    * @var int
  22    */
  23   protected $_id;
  24
  25   /**
  26    * The id of the contact associated with this contribution.
  27    *
  28    * @var int
  29    */
  30   protected $_contactID;
  31
  32   protected $_context;
  33
  34   /**
  35    * Explicitly declare the entity api name.
  36    */
  37   public function getDefaultEntity() {
  38     return 'Grant';
  39   }
  40
  41   /**
  42    * Set variables up before form is built.
  43    */
  44   public function preProcess() {
  45
  46     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
  47     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  48     $this->_grantType = NULL;
  49     if ($this->_id) {
  50       $this->_grantType = CRM_Core_DAO::getFieldValue('CRM_Grant_DAO_Grant', $this->_id, 'grant_type_id');
  51     }
  52     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
  53
  54     $this->assign('action', $this->_action);
  55     $this->assign('context', $this->_context);
  56
  57     //check permission for action.
  58     if (!CRM_Core_Permission::checkActionPermission('CiviGrant', $this->_action)) {
  59       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  60     }
  61
  62     $this->setPageTitle(ts('Grant'));
  63
  64     if ($this->_action & CRM_Core_Action::DELETE) {
  65       return;
  66     }
  67
  68     $this->_noteId = NULL;
  69     if ($this->_id) {
  70       $noteDAO = new CRM_Core_BAO_Note();
  71       $noteDAO->entity_table = 'civicrm_grant';
  72       $noteDAO->entity_id = $this->_id;
  73       if ($noteDAO->find(TRUE)) {
  74         $this->_noteId = $noteDAO->id;
  75       }
  76     }
  77
  78     // when custom data is included in this page
  79     if (!empty($_POST['hidden_custom'])) {
  80       $grantTypeId = empty($_POST['grant_type_id']) ? NULL : $_POST['grant_type_id'];
  81       $this->set('type', 'Grant');
  82       $this->set('subType', $grantTypeId);
  83       $this->set('entityId', $this->_id);
  84       CRM_Custom_Form_CustomData::preProcess($this, NULL, $grantTypeId, 1, 'Grant', $this->_id);
  85       CRM_Custom_Form_CustomData::buildQuickForm($this);
  86       CRM_Custom_Form_CustomData::setDefaultValues($this);
  87     }
  88   }
  89
  90   /**
  91    * @return array
  92    */
  93   public function setDefaultValues() {
  94
  95     $defaults = parent::setDefaultValues();
  96
  97     if ($this->_action & CRM_Core_Action::DELETE) {
  98       return $defaults;
  99     }
 100
 101     $params['id'] = $this->_id;
 102     if ($this->_noteId) {
 103       $defaults['note'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Note', $this->_noteId, 'note');
 104     }
 105     if ($this->_id) {
 106       CRM_Grant_BAO_Grant::retrieve($params, $defaults);
 107
 108       // fix the display of the monetary value, CRM-4038
 109       if (isset($defaults['amount_total'])) {
 110         $defaults['amount_total'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['amount_total']);
 111       }
 112       if (isset($defaults['amount_requested'])) {
 113         $defaults['amount_requested'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['amount_requested']);
 114       }
 115       if (isset($defaults['amount_granted'])) {
 116         $defaults['amount_granted'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['amount_granted']);
 117       }
 118     }
 119     else {
 120       if ($this->_contactID) {
 121         $defaults['contact_id'] = $this->_contactID;
 122       }
 123     }
 124
 125     return $defaults;
 126   }
 127
 128   /**
 129    * Build the form object.
 130    *
 131    * @return void
 132    */
 133   public function buildQuickForm() {
 134
 135     if ($this->_action & CRM_Core_Action::DELETE) {
 136       $this->addButtons([
 137         [
 138           'type' => 'next',
 139           'name' => ts('Delete'),
 140           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 141           'isDefault' => TRUE,
 142         ],
 143         [
 144           'type' => 'cancel',
 145           'name' => ts('Cancel'),
 146         ],
 147       ]);
 148       return;
 149     }
 150
 151     $attributes = CRM_Core_DAO::getAttribute('CRM_Grant_DAO_Grant');
 152     $this->addSelect('grant_type_id', ['placeholder' => ts('- select type -'), 'onChange' => "CRM.buildCustomData( 'Grant', this.value );"], TRUE);
 153
 154     //need to assign custom data type and subtype to the template
 155     $this->assign('customDataType', 'Grant');
 156     $this->assign('customDataSubType', $this->_grantType);
 157     $this->assign('entityID', $this->_id);
 158
 159     $this->addSelect('status_id', ['placeholder' => ts('- select status -')], TRUE);
 160
 161     $this->add('datepicker', 'application_received_date', ts('Application Received'), [], FALSE, ['time' => FALSE]);
 162     $this->add('datepicker', 'decision_date', ts('Grant Decision'), [], FALSE, ['time' => FALSE]);
 163     $this->add('datepicker', 'money_transfer_date', ts('Money Transferred'), [], FALSE, ['time' => FALSE]);
 164     $this->add('datepicker', 'grant_due_date', ts('Grant Report Due'), [], FALSE, ['time' => FALSE]);
 165
 166     $this->addElement('checkbox', 'grant_report_received', ts('Grant Report Received?'), NULL);
 167     $this->add('textarea', 'rationale', ts('Rationale'), $attributes['rationale']);
 168     $this->add('text', 'amount_total', ts('Amount Requested'), NULL, TRUE);
 169     $this->addRule('amount_total', ts('Please enter a valid amount.'), 'money');
 170
 171     $this->add('text', 'amount_granted', ts('Amount Granted'));
 172     $this->addRule('amount_granted', ts('Please enter a valid amount.'), 'money');
 173
 174     $this->add('text', 'amount_requested', ts('Amount Requested<br />(original currency)'));
 175     $this->addRule('amount_requested', ts('Please enter a valid amount.'), 'money');
 176
 177     $noteAttrib = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Note');
 178     $this->add('textarea', 'note', ts('Notes'), $noteAttrib['note']);
 179
 180     // add attachments part
 181     CRM_Core_BAO_File::buildAttachment($this,
 182       'civicrm_grant',
 183       $this->_id
 184     );
 185
 186     // make this form an upload since we dont know if the custom data injected dynamically
 187     // is of type file etc $uploadNames = $this->get( 'uploadNames' );
 188     $this->addButtons([
 189       [
 190         'type' => 'upload',
 191         'name' => ts('Save'),
 192         'isDefault' => TRUE,
 193       ],
 194       [
 195         'type' => 'upload',
 196         'name' => ts('Save and New'),
 197         'js' => ['onclick' => "return verify( );"],
 198         'subName' => 'new',
 199       ],
 200       [
 201         'type' => 'cancel',
 202         'name' => ts('Cancel'),
 203       ],
 204     ]);
 205
 206     $contactField = $this->addEntityRef('contact_id', ts('Applicant'), ['create' => TRUE], TRUE);
 207     if ($this->_context != 'standalone') {
 208       $contactField->freeze();
 209     }
 210   }
 211
 212   /**
 213    * Process the form submission.
 214    *
 215    *
 216    * @return void
 217    */
 218   public function postProcess() {
 219     if ($this->_action & CRM_Core_Action::DELETE) {
 220       CRM_Grant_BAO_Grant::del($this->_id);
 221       return;
 222     }
 223
 224     if ($this->_action & CRM_Core_Action::UPDATE) {
 225       $ids['grant_id'] = $this->_id;
 226     }
 227
 228     // get the submitted form values.
 229     $params = $this->controller->exportValues($this->_name);
 230
 231     if (empty($params['grant_report_received'])) {
 232       $params['grant_report_received'] = "null";
 233     }
 234
 235     // set the contact, when contact is selected
 236     if ($this->_context == 'standalone') {
 237       $this->_contactID = $params['contact_id'];
 238     }
 239
 240     $params['contact_id'] = $this->_contactID;
 241     $ids['note'] = [];
 242     if ($this->_noteId) {
 243       $ids['note']['id'] = $this->_noteId;
 244     }
 245
 246     // build custom data array
 247     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 248       $this->_id,
 249       'Grant'
 250     );
 251
 252     // add attachments as needed
 253     CRM_Core_BAO_File::formatAttachment($params,
 254       $params,
 255       'civicrm_grant',
 256       $this->_id
 257     );
 258     $moneyFields = [
 259       'amount_total',
 260       'amount_granted',
 261       'amount_requested',
 262     ];
 263     foreach ($moneyFields as $field) {
 264       if (isset($params[$field])) {
 265         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
 266       }
 267     }
 268
 269     $grant = CRM_Grant_BAO_Grant::create($params, $ids);
 270
 271     $buttonName = $this->controller->getButtonName();
 272     $session = CRM_Core_Session::singleton();
 273     if ($this->_context == 'standalone') {
 274       if ($buttonName == $this->getButtonName('upload', 'new')) {
 275         $session->replaceUserContext(CRM_Utils_System::url('civicrm/grant/add',
 276           'reset=1&action=add&context=standalone'
 277         ));
 278       }
 279       else {
 280         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 281           "reset=1&cid={$this->_contactID}&selectedChild=grant"
 282         ));
 283       }
 284     }
 285     elseif ($buttonName == $this->getButtonName('upload', 'new')) {
 286       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/grant',
 287         "reset=1&action=add&context=grant&cid={$this->_contactID}"
 288       ));
 289     }
 290   }
 291
 292 }