CRM/Grant/Form/Grant.php

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