CRM/Grant/Form/Task.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  * Class for grant form task actions.
  38  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  39  */
  40 class CRM_Grant_Form_Task extends CRM_Core_Form_Task {
  41
  42   /**
  43    * The array that holds all the grant ids.
  44    *
  45    * @var array
  46    */
  47   protected $_grantIds;
  48
  49   /**
  50    * Build all the data structures needed to build the form.
  51    *
  52    * @param
  53    *
  54    * @return void
  55    */
  56   public function preProcess() {
  57     self::preProcessCommon($this);
  58   }
  59
  60   /**
  61    * @param CRM_Core_Form $form
  62    */
  63   public static function preProcessCommon(&$form) {
  64     $form->_grantIds = [];
  65
  66     $values = $form->controller->exportValues($form->get('searchFormName'));
  67
  68     $form->_task = $values['task'];
  69     $tasks = CRM_Grant_Task::tasks();
  70     if (!array_key_exists($form->_task, $tasks)) {
  71       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  72     }
  73     $form->assign('taskName', $tasks[$form->_task]);
  74
  75     $ids = [];
  76     if ($values['radio_ts'] == 'ts_sel') {
  77       foreach ($values as $name => $value) {
  78         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  79           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  80         }
  81       }
  82     }
  83     else {
  84       $queryParams = $form->get('queryParams');
  85       $sortOrder = NULL;
  86       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  87         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  88       }
  89       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  90         CRM_Contact_BAO_Query::MODE_GRANT
  91       );
  92       $query->_distinctComponentClause = ' civicrm_grant.id';
  93       $query->_groupByComponentClause = ' GROUP BY civicrm_grant.id ';
  94       $result = $query->searchQuery(0, 0, $sortOrder);
  95       while ($result->fetch()) {
  96         $ids[] = $result->grant_id;
  97       }
  98     }
  99
 100     if (!empty($ids)) {
 101       $form->_componentClause = ' civicrm_grant.id IN ( ' . implode(',', $ids) . ' ) ';
 102       $form->assign('totalSelectedGrants', count($ids));
 103     }
 104
 105     $form->_grantIds = $form->_componentIds = $ids;
 106
 107     //set the context for redirection for any task actions
 108     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 109     $urlParams = 'force=1';
 110     if (CRM_Utils_Rule::qfKey($qfKey)) {
 111       $urlParams .= "&qfKey=$qfKey";
 112     }
 113
 114     $session = CRM_Core_Session::singleton();
 115     $session->replaceUserContext(CRM_Utils_System::url('civicrm/grant/search', $urlParams));
 116   }
 117
 118   /**
 119    * Given the grant id, compute the contact id
 120    * since its used for things like send email
 121    */
 122   public function setContactIDs() {
 123     $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent($this->_grantIds,
 124       'civicrm_grant'
 125     );
 126   }
 127
 128   /**
 129    * Simple shell that derived classes can call to add buttons to.
 130    * the form with a customized title for the main Submit
 131    *
 132    * @param string $title
 133    *   Title of the main button.
 134    * @param string $nextType
 135    * @param string $backType
 136    *
 137    * @param bool $submitOnce
 138    */
 139   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 140     $this->addButtons([
 141       [
 142         'type' => $nextType,
 143         'name' => $title,
 144         'isDefault' => TRUE,
 145       ],
 146       [
 147         'type' => $backType,
 148         'name' => ts('Cancel'),
 149       ],
 150     ]);
 151   }
 152
 153 }