CRM/Member/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Membership search.
  20  *
  21  * Class is a pane in advanced search and the membership search page.
  22  */
  23 class CRM_Member_Form_Search extends CRM_Core_Form_Search {
  24
  25   /**
  26    * The params that are sent to the query.
  27    *
  28    * @var array
  29    */
  30   protected $_queryParams;
  31
  32   /**
  33    * Are we restricting ourselves to a single contact.
  34    *
  35    * @var bool
  36    */
  37   protected $_single = FALSE;
  38
  39   /**
  40    * Are we restricting ourselves to a single contact.
  41    *
  42    * @var bool
  43    */
  44   protected $_limit = NULL;
  45
  46   /**
  47    * Prefix for the controller.
  48    * @var string
  49    */
  50   protected $_prefix = "member_";
  51
  52   /**
  53    * Declare entity reference fields as they will need to be converted to using 'IN'.
  54    *
  55    * @var array
  56    */
  57   protected $entityReferenceFields = ['membership_type_id'];
  58
  59   /**
  60    * Processing needed for buildForm and later.
  61    *
  62    * @throws \CRM_Core_Exception
  63    * @throws \CiviCRM_API3_Exception
  64    */
  65   public function preProcess() {
  66     $this->set('searchFormName', 'Search');
  67
  68     $this->_actionButtonName = $this->getButtonName('next', 'action');
  69
  70     $this->_done = FALSE;
  71
  72     parent::preProcess();
  73
  74     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
  75     $selector = new CRM_Member_Selector_Search($this->_queryParams,
  76       $this->_action,
  77       NULL,
  78       $this->_single,
  79       $this->_limit,
  80       $this->_context
  81     );
  82     $prefix = NULL;
  83     if ($this->_context === 'basic') {
  84       $prefix = $this->_prefix;
  85     }
  86
  87     $this->assign("{$prefix}limit", $this->_limit);
  88     $this->assign("{$prefix}single", $this->_single);
  89
  90     $controller = new CRM_Core_Selector_Controller($selector,
  91       $this->get(CRM_Utils_Pager::PAGE_ID),
  92       $this->getSortID(),
  93       CRM_Core_Action::VIEW,
  94       $this,
  95       CRM_Core_Selector_Controller::TRANSFER,
  96       $prefix
  97     );
  98
  99     $controller->setEmbedded(TRUE);
 100     $controller->moveFromSessionToTemplate();
 101
 102     $this->assign('summary', $this->get('summary'));
 103   }
 104
 105   /**
 106    * Build the form object.
 107    *
 108    * @throws \CRM_Core_Exception
 109    * @throws \CiviCRM_API3_Exception
 110    */
 111   public function buildQuickForm() {
 112     parent::buildQuickForm();
 113     $this->addContactSearchFields();
 114
 115     CRM_Member_BAO_Query::buildSearchForm($this);
 116
 117     $rows = $this->get('rows');
 118     if (is_array($rows)) {
 119       if (!$this->_single) {
 120         $this->addRowSelectors($rows);
 121       }
 122
 123       $this->addTaskMenu(CRM_Member_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission()));
 124     }
 125
 126   }
 127
 128   /**
 129    * Get the label for the sortName field if email searching is on.
 130    *
 131    * (email searching is a setting under search preferences).
 132    *
 133    * @return string
 134    */
 135   protected function getSortNameLabelWithEmail() {
 136     return ts('Member Name or Email');
 137   }
 138
 139   /**
 140    * Get the label for the sortName field if email searching is off.
 141    *
 142    * (email searching is a setting under search preferences).
 143    *
 144    * @return string
 145    */
 146   protected function getSortNameLabelWithOutEmail() {
 147     return ts('Member Name');
 148   }
 149
 150   /**
 151    * Get the label for the tag field.
 152    *
 153    * We do this in a function so the 'ts' wraps the whole string to allow
 154    * better translation.
 155    *
 156    * @return string
 157    */
 158   protected function getTagLabel() {
 159     return ts('Member Tag(s)');
 160   }
 161
 162   /**
 163    * Get the label for the group field.
 164    *
 165    * @return string
 166    */
 167   protected function getGroupLabel() {
 168     return ts('Member Group(s)');
 169   }
 170
 171   /**
 172    * Get the label for the group field.
 173    *
 174    * @return string
 175    */
 176   protected function getContactTypeLabel() {
 177     return ts('Member Contact Type');
 178   }
 179
 180   /**
 181    * Set defaults.
 182    *
 183    * @return array
 184    * @throws \Exception
 185    */
 186   public function setDefaultValues() {
 187     $this->_defaults = parent::setDefaultValues();
 188     //LCD also allow restrictions to membership owner via GET
 189     $owner = CRM_Utils_Request::retrieve('owner', 'String');
 190     if (in_array($owner, ['0', '1'])) {
 191       $this->_defaults['member_is_primary'] = $owner;
 192     }
 193     return $this->_defaults;
 194   }
 195
 196   /**
 197    * The post processing of the form gets done here.
 198    *
 199    * Key things done during post processing are
 200    *      - check for reset or next request. if present, skip post procesing.
 201    *      - now check if user requested running a saved search, if so, then
 202    *        the form values associated with the saved search are used for searching.
 203    *      - if user has done a submit with new values the regular post submissing is
 204    *        done.
 205    * The processing consists of using a Selector / Controller framework for getting the
 206    * search results.
 207    *
 208    * @throws \CRM_Core_Exception
 209    */
 210   public function postProcess() {
 211     if ($this->_done) {
 212       return;
 213     }
 214
 215     $this->_done = TRUE;
 216     $this->setFormValues();
 217
 218     $this->fixFormValues();
 219
 220     // We don't show test records in summaries or dashboards
 221     if (empty($this->_formValues['member_test']) && $this->_force) {
 222       $this->_formValues["member_test"] = 0;
 223     }
 224
 225     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 226
 227     $this->set('queryParams', $this->_queryParams);
 228
 229     $buttonName = $this->controller->getButtonName();
 230     if ($buttonName == $this->_actionButtonName) {
 231       // check actionName and if next, then do not repeat a search, since we are going to the next page
 232
 233       // hack, make sure we reset the task values
 234       $stateMachine = $this->controller->getStateMachine();
 235       $formName = $stateMachine->getTaskFormName();
 236       $this->controller->resetPage($formName);
 237       return;
 238     }
 239
 240     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 241
 242     $selector = new CRM_Member_Selector_Search($this->_queryParams,
 243       $this->_action,
 244       NULL,
 245       $this->_single,
 246       $this->_limit,
 247       $this->_context
 248     );
 249     $selector->setKey($this->controller->_key);
 250
 251     $prefix = NULL;
 252     if ($this->_context === 'basic') {
 253       $prefix = $this->_prefix;
 254     }
 255
 256     $controller = new CRM_Core_Selector_Controller($selector,
 257       $this->get(CRM_Utils_Pager::PAGE_ID),
 258       $this->getSortID(),
 259       CRM_Core_Action::VIEW,
 260       $this,
 261       CRM_Core_Selector_Controller::SESSION,
 262       $prefix
 263     );
 264     $controller->setEmbedded(TRUE);
 265     $controller->run();
 266   }
 267
 268   /**
 269    * If this search has been forced then see if there are any get values, and if so over-ride the post values.
 270    *
 271    * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive.
 272    *
 273    * @throws \CRM_Core_Exception
 274    */
 275   public function fixFormValues() {
 276     if (!$this->_force) {
 277       return;
 278     }
 279
 280     // @todo Most of the  below is likely no longer required.
 281     $status = CRM_Utils_Request::retrieve('membership_status_id', 'String');
 282     if ($status) {
 283       $status = explode(',', $status);
 284       $this->_formValues['membership_status_id'] = $this->_defaults['membership_status_id'] = (array) $status;
 285     }
 286
 287     $membershipType = CRM_Utils_Request::retrieve('type', 'String');
 288
 289     if ($membershipType) {
 290       $this->_formValues['membership_type_id'] = [$membershipType];
 291       $this->_defaults['membership_type_id'] = [$membershipType];
 292     }
 293
 294     $cid = CRM_Utils_Request::retrieve('cid', 'Positive');
 295
 296     if ($cid) {
 297       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 298       if ($cid > 0) {
 299         $this->_formValues['contact_id'] = $cid;
 300         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 301         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 302           'sort_name'
 303         );
 304         // also assign individual mode to the template
 305         $this->_single = TRUE;
 306       }
 307     }
 308
 309     $fromDate = CRM_Utils_Request::retrieve('start', 'Date');
 310     if ($fromDate) {
 311       list($date) = CRM_Utils_Date::setDateDefaults($fromDate);
 312       $this->_formValues['member_start_date_low'] = $this->_defaults['member_start_date_low'] = $date;
 313     }
 314
 315     $toDate = CRM_Utils_Request::retrieve('end', 'Date');
 316     if ($toDate) {
 317       list($date) = CRM_Utils_Date::setDateDefaults($toDate);
 318       $this->_formValues['member_start_date_high'] = $this->_defaults['member_start_date_high'] = $date;
 319     }
 320     $joinDate = CRM_Utils_Request::retrieve('join', 'Date');
 321     if ($joinDate) {
 322       list($date) = CRM_Utils_Date::setDateDefaults($joinDate);
 323       $this->_formValues['member_join_date_low'] = $this->_defaults['member_join_date_low'] = $date;
 324     }
 325
 326     $joinEndDate = CRM_Utils_Request::retrieve('joinEnd', 'Date');
 327     if ($joinEndDate) {
 328       list($date) = CRM_Utils_Date::setDateDefaults($joinEndDate);
 329       $this->_formValues['member_join_date_high'] = $this->_defaults['member_join_date_high'] = $date;
 330     }
 331
 332     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive',
 333       $this
 334     );
 335   }
 336
 337   /**
 338    * Return a descriptive name for the page, used in wizard header.
 339    *
 340    * @return string
 341    */
 342   public function getTitle() {
 343     return ts('Find Memberships');
 344   }
 345
 346   /**
 347    * Set the metadata for the form.
 348    *
 349    * @throws \CiviCRM_API3_Exception
 350    */
 351   protected function setSearchMetadata() {
 352     $this->addSearchFieldMetadata(['Membership' => CRM_Member_BAO_Query::getSearchFieldMetadata()]);
 353   }
 354
 355 }