CRM/Grant/Form/Task.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  * Class for grant form task actions.
  14  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  15  */
  16 class CRM_Grant_Form_Task extends CRM_Core_Form_Task {
  17
  18   /**
  19    * The array that holds all the grant ids.
  20    *
  21    * @var array
  22    */
  23   protected $_grantIds;
  24
  25   /**
  26    * Build all the data structures needed to build the form.
  27    *
  28    * @param
  29    *
  30    * @return void
  31    */
  32   public function preProcess() {
  33     self::preProcessCommon($this);
  34   }
  35
  36   /**
  37    * @param \CRM_Core_Form_Task $form
  38    *
  39    * @throws \CRM_Core_Exception
  40    */
  41   public static function preProcessCommon(&$form) {
  42     $form->_grantIds = [];
  43
  44     $values = $form->getSearchFormValues();
  45
  46     $form->_task = $values['task'];
  47     $tasks = CRM_Grant_Task::tasks();
  48     if (!array_key_exists($form->_task, $tasks)) {
  49       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  50     }
  51
  52     $ids = [];
  53     if ($values['radio_ts'] == 'ts_sel') {
  54       foreach ($values as $name => $value) {
  55         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  56           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  57         }
  58       }
  59     }
  60     else {
  61       $queryParams = $form->get('queryParams');
  62       $sortOrder = NULL;
  63       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  64         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  65       }
  66       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  67         CRM_Contact_BAO_Query::MODE_GRANT
  68       );
  69       $query->_distinctComponentClause = ' civicrm_grant.id';
  70       $query->_groupByComponentClause = ' GROUP BY civicrm_grant.id ';
  71       $result = $query->searchQuery(0, 0, $sortOrder);
  72       while ($result->fetch()) {
  73         $ids[] = $result->grant_id;
  74       }
  75     }
  76
  77     if (!empty($ids)) {
  78       $form->_componentClause = ' civicrm_grant.id IN ( ' . implode(',', $ids) . ' ) ';
  79       $form->assign('totalSelectedGrants', count($ids));
  80     }
  81
  82     $form->_grantIds = $form->_componentIds = $ids;
  83
  84     $form->setNextUrl('grant');
  85   }
  86
  87   /**
  88    * Given the grant id, compute the contact id
  89    * since its used for things like send email
  90    */
  91   public function setContactIDs() {
  92     $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent($this->_grantIds,
  93       'civicrm_grant'
  94     );
  95   }
  96
  97   /**
  98    * Simple shell that derived classes can call to add buttons to.
  99    * the form with a customized title for the main Submit
 100    *
 101    * @param string $title
 102    *   Title of the main button.
 103    * @param string $nextType
 104    * @param string $backType
 105    *
 106    * @param bool $submitOnce
 107    */
 108   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 109     $this->addButtons([
 110       [
 111         'type' => $nextType,
 112         'name' => $title,
 113         'isDefault' => TRUE,
 114       ],
 115       [
 116         'type' => $backType,
 117         'name' => ts('Cancel'),
 118       ],
 119     ]);
 120   }
 121
 122 }