CRM/Grant/Form/Task.php

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