CRM/Pledge/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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    * @access public
  77    */
  78   function preProcess() {
  79     self::preProcessCommon($this);
  80   }
  81
  82   static function preProcessCommon(&$form, $useTable = FALSE) {
  83     $form->_pledgeIds = array();
  84
  85     $values = $form->controller->exportValues('Search');
  86
  87     $form->_task = $values['task'];
  88     $pledgeTasks = CRM_Pledge_Task::tasks();
  89     $form->assign('taskName', $pledgeTasks[$form->_task]);
  90
  91     $ids = array();
  92     if ($values['radio_ts'] == 'ts_sel') {
  93       foreach ($values as $name => $value) {
  94         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  95           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  96         }
  97       }
  98     }
  99     else {
 100       $queryParams = $form->get('queryParams');
 101       $sortOrder = null;
 102       if ( $form->get( CRM_Utils_Sort::SORT_ORDER  ) ) {
 103         $sortOrder = $form->get( CRM_Utils_Sort::SORT_ORDER );
 104       }
 105       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
 106         CRM_Contact_BAO_Query::MODE_PLEDGE
 107       );
 108       $query->_distinctComponentClause = ' civicrm_pledge.id';
 109       $query->_groupByComponentClause = ' GROUP BY civicrm_pledge.id ';
 110
 111       $result = $query->searchQuery(0, 0, $sortOrder);
 112       while ($result->fetch()) {
 113         $ids[] = $result->pledge_id;
 114       }
 115     }
 116
 117     if (!empty($ids)) {
 118       $form->_componentClause = ' civicrm_pledge.id IN ( ' . implode(',', $ids) . ' ) ';
 119       $form->assign('totalSelectedPledges', count($ids));
 120     }
 121
 122     $form->_pledgeIds = $form->_componentIds = $ids;
 123
 124     //set the context for redirection for any task actions
 125     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 126     $urlParams = 'force=1';
 127     if (CRM_Utils_Rule::qfKey($qfKey)) {
 128       $urlParams .= "&qfKey=$qfKey";
 129     }
 130
 131     $session = CRM_Core_Session::singleton();
 132     $session->replaceUserContext(CRM_Utils_System::url('civicrm/pledge/search', $urlParams));
 133   }
 134
 135   /**
 136    * Given the signer id, compute the contact id
 137    * since its used for things like send email
 138    */
 139   public function setContactIDs() {
 140     $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($this->_pledgeIds,
 141       'civicrm_pledge'
 142     );
 143   }
 144
 145   /**
 146    * simple shell that derived classes can call to add buttons to
 147    * the form with a customized title for the main Submit
 148    *
 149    * @param string $title title of the main button
 150    * @param string $type  button type for the form after processing
 151    *
 152    * @return void
 153    * @access public
 154    */
 155   function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 156     $this->addButtons(array(
 157         array(
 158           'type' => $nextType,
 159           'name' => $title,
 160           'isDefault' => TRUE,
 161         ),
 162         array(
 163           'type' => $backType,
 164           'name' => ts('Cancel'),
 165         ),
 166       )
 167     );
 168   }
 169 }
 170