CRM/Member/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  * Class for member form task actions.
  38  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  39  */
  40 class CRM_Member_Form_Task extends CRM_Core_Form_Task {
  41
  42   /**
  43    * The array that holds all the member ids.
  44    *
  45    * @var array
  46    */
  47   protected $_memberIds;
  48
  49   /**
  50    * Build all the data structures needed to build the form.
  51    *
  52    * @param
  53    *
  54    * @return void
  55    */
  56   public function preProcess() {
  57     self::preProcessCommon($this);
  58   }
  59
  60   /**
  61    * @param CRM_Core_Form $form
  62    * @param bool $useTable
  63    */
  64   public static function preProcessCommon(&$form, $useTable = FALSE) {
  65     $form->_memberIds = array();
  66
  67     $values = $form->controller->exportValues($form->get('searchFormName'));
  68
  69     $form->_task = $values['task'];
  70     $tasks = CRM_Member_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission());
  71     if (!array_key_exists($form->_task, $tasks)) {
  72       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  73     }
  74     $form->assign('taskName', $tasks[$form->_task]);
  75
  76     $ids = array();
  77     if ($values['radio_ts'] == 'ts_sel') {
  78       foreach ($values as $name => $value) {
  79         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  80           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  81         }
  82       }
  83     }
  84     else {
  85       $queryParams = $form->get('queryParams');
  86       $sortOrder = NULL;
  87       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  88         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  89       }
  90       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  91         CRM_Contact_BAO_Query::MODE_MEMBER
  92       );
  93       $query->_distinctComponentClause = ' civicrm_membership.id';
  94       $query->_groupByComponentClause = ' GROUP BY civicrm_membership.id ';
  95       $result = $query->searchQuery(0, 0, $sortOrder);
  96
  97       while ($result->fetch()) {
  98         $ids[] = $result->membership_id;
  99       }
 100     }
 101
 102     if (!empty($ids)) {
 103       $form->_componentClause = ' civicrm_membership.id IN ( ' . implode(',', $ids) . ' ) ';
 104       $form->assign('totalSelectedMembers', count($ids));
 105     }
 106
 107     $form->_memberIds = $form->_componentIds = $ids;
 108
 109     //set the context for redirection for any task actions
 110     $session = CRM_Core_Session::singleton();
 111
 112     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 113     $urlParams = 'force=1';
 114     if (CRM_Utils_Rule::qfKey($qfKey)) {
 115       $urlParams .= "&qfKey=$qfKey";
 116     }
 117
 118     $searchFormName = strtolower($form->get('searchFormName'));
 119     if ($searchFormName == 'search') {
 120       $session->replaceUserContext(CRM_Utils_System::url('civicrm/member/search', $urlParams));
 121     }
 122     else {
 123       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 124         $urlParams
 125       ));
 126     }
 127   }
 128
 129   /**
 130    * Given the membership id, compute the contact id
 131    * since its used for things like send email
 132    */
 133   public function setContactIDs() {
 134     $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($this->_memberIds,
 135       'civicrm_membership'
 136     );
 137   }
 138
 139   /**
 140    * Simple shell that derived classes can call to add buttons to.
 141    * the form with a customized title for the main Submit
 142    *
 143    * @param string $title
 144    *   Title of the main button.
 145    * @param string $nextType
 146    * @param string $backType
 147    * @param bool $submitOnce
 148    *
 149    * @return void
 150    */
 151   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 152     $this->addButtons(array(
 153       array(
 154         'type' => $nextType,
 155         'name' => $title,
 156         'isDefault' => TRUE,
 157       ),
 158       array(
 159         'type' => $backType,
 160         'name' => ts('Cancel'),
 161       ),
 162     ));
 163   }
 164
 165 }