CRM/Member/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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  * Class for civimember task actions
  38  *
  39  */
  40 class CRM_Member_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 contact ids
  65    *
  66    * @var array
  67    */
  68   public $_contactIds;
  69
  70   /**
  71    * The array that holds all the member ids
  72    *
  73    * @var array
  74    */
  75   protected $_memberIds;
  76
  77   /**
  78    * build all the data structures needed to build the form
  79    *
  80    * @param
  81    *
  82    * @return void
  83    * @access public
  84    */
  85   function preProcess() {
  86     self::preProcessCommon($this);
  87   }
  88
  89   static function preProcessCommon(&$form, $useTable = FALSE) {
  90     $form->_memberIds = array();
  91
  92     $values = $form->controller->exportValues($form->get('searchFormName'));
  93
  94     $form->_task = $values['task'];
  95     $memberTasks = CRM_Member_Task::tasks();
  96     $form->assign('taskName', $memberTasks[$form->_task]);
  97
  98     $ids = array();
  99     if ($values['radio_ts'] == 'ts_sel') {
 100       foreach ($values as $name => $value) {
 101         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
 102           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
 103         }
 104       }
 105     }
 106     else {
 107       $queryParams = $form->get('queryParams');
 108       $sortOrder = null;
 109       if ( $form->get( CRM_Utils_Sort::SORT_ORDER  ) ) {
 110         $sortOrder = $form->get( CRM_Utils_Sort::SORT_ORDER );
 111       }
 112       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
 113         CRM_Contact_BAO_Query::MODE_MEMBER
 114       );
 115       $query->_distinctComponentClause = ' civicrm_membership.id';
 116       $query->_groupByComponentClause = ' GROUP BY civicrm_membership.id ';
 117       $result = $query->searchQuery(0, 0, $sortOrder);
 118
 119       while ($result->fetch()) {
 120         $ids[] = $result->membership_id;
 121       }
 122     }
 123
 124     if (!empty($ids)) {
 125       $form->_componentClause = ' civicrm_membership.id IN ( ' . implode(',', $ids) . ' ) ';
 126       $form->assign('totalSelectedMembers', count($ids));
 127     }
 128
 129     $form->_memberIds = $form->_componentIds = $ids;
 130
 131     //set the context for redirection for any task actions
 132     $session = CRM_Core_Session::singleton();
 133
 134     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 135     $urlParams = 'force=1';
 136     if (CRM_Utils_Rule::qfKey($qfKey)) {
 137       $urlParams .= "&qfKey=$qfKey";
 138     }
 139
 140     $searchFormName = strtolower($form->get('searchFormName'));
 141     if ($searchFormName == 'search') {
 142       $session->replaceUserContext(CRM_Utils_System::url('civicrm/member/search', $urlParams));
 143     }
 144     else {
 145       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 146           $urlParams
 147         ));
 148     }
 149   }
 150
 151   /**
 152    * Given the membership id, compute the contact id
 153    * since its used for things like send email
 154    */
 155   public function setContactIDs() {
 156     $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($this->_memberIds,
 157       'civicrm_membership'
 158     );
 159   }
 160
 161   /**
 162    * simple shell that derived classes can call to add buttons to
 163    * the form with a customized title for the main Submit
 164    *
 165    * @param string $title title of the main button
 166    * @param string $type  button type for the form after processing
 167    *
 168    * @return void
 169    * @access public
 170    */
 171   function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 172     $this->addButtons(array(
 173         array(
 174           'type' => $nextType,
 175           'name' => $title,
 176           'isDefault' => TRUE,
 177         ),
 178         array(
 179           'type' => $backType,
 180           'name' => ts('Cancel'),
 181         ),
 182       )
 183     );
 184   }
 185 }
 186