CRM/Member/Form/Task.php

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