CRM/Pledge/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates task actions for CiviEvent
  38  *
  39  */
  40 class CRM_Pledge_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 pledge ids
  65    *
  66    * @var array
  67    */
  68   protected $_pledgeIds;
  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->_pledgeIds = array();
  87
  88     $values = $form->controller->exportValues('Search');
  89
  90     $form->_task = $values['task'];
  91     $pledgeTasks = CRM_Pledge_Task::tasks();
  92     $form->assign('taskName', $pledgeTasks[$form->_task]);
  93
  94     $ids = array();
  95     if ($values['radio_ts'] == 'ts_sel') {
  96       foreach ($values as $name => $value) {
  97         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  98           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  99         }
 100       }
 101     }
 102     else {
 103       $queryParams = $form->get('queryParams');
 104       $sortOrder = null;
 105       if ( $form->get( CRM_Utils_Sort::SORT_ORDER  ) ) {
 106         $sortOrder = $form->get( CRM_Utils_Sort::SORT_ORDER );
 107       }
 108       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
 109         CRM_Contact_BAO_Query::MODE_PLEDGE
 110       );
 111       $query->_distinctComponentClause = ' civicrm_pledge.id';
 112       $query->_groupByComponentClause = ' GROUP BY civicrm_pledge.id ';
 113
 114       $result = $query->searchQuery(0, 0, $sortOrder);
 115       while ($result->fetch()) {
 116         $ids[] = $result->pledge_id;
 117       }
 118     }
 119
 120     if (!empty($ids)) {
 121       $form->_componentClause = ' civicrm_pledge.id IN ( ' . implode(',', $ids) . ' ) ';
 122       $form->assign('totalSelectedPledges', count($ids));
 123     }
 124
 125     $form->_pledgeIds = $form->_componentIds = $ids;
 126
 127     //set the context for redirection for any task actions
 128     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 129     $urlParams = 'force=1';
 130     if (CRM_Utils_Rule::qfKey($qfKey)) {
 131       $urlParams .= "&qfKey=$qfKey";
 132     }
 133
 134     $session = CRM_Core_Session::singleton();
 135     $session->replaceUserContext(CRM_Utils_System::url('civicrm/pledge/search', $urlParams));
 136   }
 137
 138   /**
 139    * Given the signer id, compute the contact id
 140    * since its used for things like send email
 141    */
 142   public function setContactIDs() {
 143     $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($this->_pledgeIds,
 144       'civicrm_pledge'
 145     );
 146   }
 147
 148   /**
 149    * Simple shell that derived classes can call to add buttons to
 150    * the form with a customized title for the main Submit
 151    *
 152    * @param string $title
 153    *   Title of the main button.
 154    * @param string $nextType
 155    * @param string $backType
 156    * @param bool $submitOnce
 157    *
 158    *
 159    * @return void
 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 }