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->_searchButtonName = $this->getButtonName('refresh');
  69     $this->_actionButtonName = $this->getButtonName('next', 'action');
  70
  71     $this->_done = FALSE;
  72
  73     parent::preProcess();
  74
  75     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
  76     $selector = new CRM_Member_Selector_Search($this->_queryParams,
  77       $this->_action,
  78       NULL,
  79       $this->_single,
  80       $this->_limit,
  81       $this->_context
  82     );
  83     $prefix = NULL;
  84     if ($this->_context == 'basic') {
  85       $prefix = $this->_prefix;
  86     }
  87
  88     $this->assign("{$prefix}limit", $this->_limit);
  89     $this->assign("{$prefix}single", $this->_single);
  90
  91     $controller = new CRM_Core_Selector_Controller($selector,
  92       $this->get(CRM_Utils_Pager::PAGE_ID),
  93       $this->getSortID(),
  94       CRM_Core_Action::VIEW,
  95       $this,
  96       CRM_Core_Selector_Controller::TRANSFER,
  97       $prefix
  98     );
  99
 100     $controller->setEmbedded(TRUE);
 101     $controller->moveFromSessionToTemplate();
 102
 103     $this->assign('summary', $this->get('summary'));
 104   }
 105
 106   /**
 107    * Build the form object.
 108    *
 109    * @throws \CRM_Core_Exception
 110    * @throws \CiviCRM_API3_Exception
 111    */
 112   public function buildQuickForm() {
 113     parent::buildQuickForm();
 114     $this->addContactSearchFields();
 115
 116     CRM_Member_BAO_Query::buildSearchForm($this);
 117
 118     $rows = $this->get('rows');
 119     if (is_array($rows)) {
 120       if (!$this->_single) {
 121         $this->addRowSelectors($rows);
 122       }
 123
 124       $this->addTaskMenu(CRM_Member_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission()));
 125     }
 126
 127   }
 128
 129   /**
 130    * Get the label for the sortName field if email searching is on.
 131    *
 132    * (email searching is a setting under search preferences).
 133    *
 134    * @return string
 135    */
 136   protected function getSortNameLabelWithEmail() {
 137     return ts('Member Name or Email');
 138   }
 139
 140   /**
 141    * Get the label for the sortName field if email searching is off.
 142    *
 143    * (email searching is a setting under search preferences).
 144    *
 145    * @return string
 146    */
 147   protected function getSortNameLabelWithOutEmail() {
 148     return ts('Member Name');
 149   }
 150
 151   /**
 152    * Get the label for the tag field.
 153    *
 154    * We do this in a function so the 'ts' wraps the whole string to allow
 155    * better translation.
 156    *
 157    * @return string
 158    */
 159   protected function getTagLabel() {
 160     return ts('Member Tag(s)');
 161   }
 162
 163   /**
 164    * Get the label for the group field.
 165    *
 166    * @return string
 167    */
 168   protected function getGroupLabel() {
 169     return ts('Member Group(s)');
 170   }
 171
 172   /**
 173    * Get the label for the group field.
 174    *
 175    * @return string
 176    */
 177   protected function getContactTypeLabel() {
 178     return ts('Member Contact Type');
 179   }
 180
 181   /**
 182    * The post processing of the form gets done here.
 183    *
 184    * Key things done during post processing are
 185    *      - check for reset or next request. if present, skip post procesing.
 186    *      - now check if user requested running a saved search, if so, then
 187    *        the form values associated with the saved search are used for searching.
 188    *      - if user has done a submit with new values the regular post submissing is
 189    *        done.
 190    * The processing consists of using a Selector / Controller framework for getting the
 191    * search results.
 192    */
 193   public function postProcess() {
 194     if ($this->_done) {
 195       return;
 196     }
 197
 198     $this->_done = TRUE;
 199     $this->setFormValues();
 200
 201     $this->fixFormValues();
 202
 203     // We don't show test records in summaries or dashboards
 204     if (empty($this->_formValues['member_test']) && $this->_force) {
 205       $this->_formValues["member_test"] = 0;
 206     }
 207
 208     CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);
 209
 210     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 211
 212     $this->set('queryParams', $this->_queryParams);
 213
 214     $buttonName = $this->controller->getButtonName();
 215     if ($buttonName == $this->_actionButtonName) {
 216       // check actionName and if next, then do not repeat a search, since we are going to the next page
 217
 218       // hack, make sure we reset the task values
 219       $stateMachine = $this->controller->getStateMachine();
 220       $formName = $stateMachine->getTaskFormName();
 221       $this->controller->resetPage($formName);
 222       return;
 223     }
 224
 225     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 226
 227     $selector = new CRM_Member_Selector_Search($this->_queryParams,
 228       $this->_action,
 229       NULL,
 230       $this->_single,
 231       $this->_limit,
 232       $this->_context
 233     );
 234     $selector->setKey($this->controller->_key);
 235
 236     $prefix = NULL;
 237     if ($this->_context == 'basic') {
 238       $prefix = $this->_prefix;
 239     }
 240
 241     $controller = new CRM_Core_Selector_Controller($selector,
 242       $this->get(CRM_Utils_Pager::PAGE_ID),
 243       $this->getSortID(),
 244       CRM_Core_Action::VIEW,
 245       $this,
 246       CRM_Core_Selector_Controller::SESSION,
 247       $prefix
 248     );
 249     $controller->setEmbedded(TRUE);
 250
 251     $query = &$selector->getQuery();
 252     $controller->run();
 253   }
 254
 255   /**
 256    * If this search has been forced then see if there are any get values, and if so over-ride the post values.
 257    *
 258    * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive.
 259    */
 260   public function fixFormValues() {
 261     if (!$this->_force) {
 262       return;
 263     }
 264
 265     $status = CRM_Utils_Request::retrieve('status', 'String');
 266     if ($status) {
 267       $status = explode(',', $status);
 268       $this->_formValues['membership_status_id'] = $this->_defaults['membership_status_id'] = (array) $status;
 269     }
 270
 271     $membershipType = CRM_Utils_Request::retrieve('type', 'String');
 272
 273     if ($membershipType) {
 274       $this->_formValues['membership_type_id'] = [$membershipType];
 275       $this->_defaults['membership_type_id'] = [$membershipType];
 276     }
 277
 278     $cid = CRM_Utils_Request::retrieve('cid', 'Positive');
 279
 280     if ($cid) {
 281       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 282       if ($cid > 0) {
 283         $this->_formValues['contact_id'] = $cid;
 284         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 285         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 286           'sort_name'
 287         );
 288         // also assign individual mode to the template
 289         $this->_single = TRUE;
 290       }
 291     }
 292
 293     $fromDate = CRM_Utils_Request::retrieve('start', 'Date');
 294     if ($fromDate) {
 295       list($date) = CRM_Utils_Date::setDateDefaults($fromDate);
 296       $this->_formValues['member_start_date_low'] = $this->_defaults['member_start_date_low'] = $date;
 297     }
 298
 299     $toDate = CRM_Utils_Request::retrieve('end', 'Date');
 300     if ($toDate) {
 301       list($date) = CRM_Utils_Date::setDateDefaults($toDate);
 302       $this->_formValues['member_start_date_high'] = $this->_defaults['member_start_date_high'] = $date;
 303     }
 304     $joinDate = CRM_Utils_Request::retrieve('join', 'Date');
 305     if ($joinDate) {
 306       list($date) = CRM_Utils_Date::setDateDefaults($joinDate);
 307       $this->_formValues['member_join_date_low'] = $this->_defaults['member_join_date_low'] = $date;
 308     }
 309
 310     $joinEndDate = CRM_Utils_Request::retrieve('joinEnd', 'Date');
 311     if ($joinEndDate) {
 312       list($date) = CRM_Utils_Date::setDateDefaults($joinEndDate);
 313       $this->_formValues['member_join_date_high'] = $this->_defaults['member_join_date_high'] = $date;
 314     }
 315
 316     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive',
 317       $this
 318     );
 319
 320     //LCD also allow restrictions to membership owner via GET
 321     $owner = CRM_Utils_Request::retrieve('owner', 'String');
 322     if (in_array($owner, ['0', '1'])) {
 323       $this->_formValues['member_is_primary'] = $this->_defaults['member_is_primary'] = $owner;
 324     }
 325   }
 326
 327   /**
 328    * Return a descriptive name for the page, used in wizard header.
 329    *
 330    * @return string
 331    */
 332   public function getTitle() {
 333     return ts('Find Memberships');
 334   }
 335
 336   /**
 337    * Set the metadata for the form.
 338    *
 339    * @throws \CiviCRM_API3_Exception
 340    */
 341   protected function setSearchMetadata() {
 342     $this->addSearchFieldMetadata(['Membership' => CRM_Member_BAO_Query::getSearchFieldMetadata()]);
 343   }
 344
 345 }