3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
37 * Class is a pane in advanced search and the membership search page.
39 class CRM_Member_Form_Search
extends CRM_Core_Form_Search
{
42 * The params that are sent to the query.
46 protected $_queryParams;
49 * Are we restricting ourselves to a single contact.
53 protected $_single = FALSE;
56 * Are we restricting ourselves to a single contact.
60 protected $_limit = NULL;
63 * Prefix for the controller.
65 protected $_prefix = "member_";
68 * Declare entity reference fields as they will need to be converted to using 'IN'.
72 protected $entityReferenceFields = array('membership_type_id');
75 * Processing needed for buildForm and later.
77 public function preProcess() {
78 $this->set('searchFormName', 'Search');
80 $this->_searchButtonName
= $this->getButtonName('refresh');
81 $this->_actionButtonName
= $this->getButtonName('next', 'action');
85 $this->defaults
= array();
87 $this->loadStandardSearchOptionsFromUrl();
89 // get user submitted values
90 // get it from controller only if form has been submitted, else preProcess has set this
92 $this->_formValues
= $this->controller
->exportValues($this->_name
);
95 $this->_formValues
= $this->get('formValues');
100 $this->set('force', 0);
104 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
105 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
106 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
110 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
111 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
119 if ($this->_context
== 'basic') {
120 $prefix = $this->_prefix
;
123 $this->assign("{$prefix}limit", $this->_limit
);
124 $this->assign("{$prefix}single", $this->_single
);
126 $controller = new CRM_Core_Selector_Controller($selector,
127 $this->get(CRM_Utils_Pager
::PAGE_ID
),
129 CRM_Core_Action
::VIEW
,
131 CRM_Core_Selector_Controller
::TRANSFER
,
135 $controller->setEmbedded(TRUE);
136 $controller->moveFromSessionToTemplate();
138 $this->assign('summary', $this->get('summary'));
142 * Build the form object.
144 public function buildQuickForm() {
145 parent
::buildQuickForm();
146 $this->addContactSearchFields();
148 CRM_Member_BAO_Query
::buildSearchForm($this);
150 $rows = $this->get('rows');
151 if (is_array($rows)) {
152 if (!$this->_single
) {
153 $this->addRowSelectors($rows);
156 $this->addTaskMenu(CRM_Member_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
162 * Get the label for the sortName field if email searching is on.
164 * (email searching is a setting under search preferences).
168 protected function getSortNameLabelWithEmail() {
169 return ts('Member Name or Email');
173 * Get the label for the sortName field if email searching is off.
175 * (email searching is a setting under search preferences).
179 protected function getSortNameLabelWithOutEmail() {
180 return ts('Member Name');
184 * Get the label for the tag field.
186 * We do this in a function so the 'ts' wraps the whole string to allow
187 * better translation.
191 protected function getTagLabel() {
192 return ts('Member Tag(s)');
196 * Get the label for the group field.
200 protected function getGroupLabel() {
201 return ts('Member Group(s)');
205 * Get the label for the group field.
209 protected function getContactTypeLabel() {
210 return ts('Member Contact Type');
214 * The post processing of the form gets done here.
216 * Key things done during post processing are
217 * - check for reset or next request. if present, skip post procesing.
218 * - now check if user requested running a saved search, if so, then
219 * the form values associated with the saved search are used for searching.
220 * - if user has done a submit with new values the regular post submissing is
222 * The processing consists of using a Selector / Controller framework for getting the
225 public function postProcess() {
232 $this->_formValues
= $this->controller
->exportValues($this->_name
);
234 $this->fixFormValues();
236 // We don't show test records in summaries or dashboards
237 if (empty($this->_formValues
['member_test']) && $this->_force
) {
238 $this->_formValues
["member_test"] = 0;
241 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
243 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
245 $this->set('formValues', $this->_formValues
);
246 $this->set('queryParams', $this->_queryParams
);
248 $buttonName = $this->controller
->getButtonName();
249 if ($buttonName == $this->_actionButtonName
) {
250 // check actionName and if next, then do not repeat a search, since we are going to the next page
252 // hack, make sure we reset the task values
253 $stateMachine = $this->controller
->getStateMachine();
254 $formName = $stateMachine->getTaskFormName();
255 $this->controller
->resetPage($formName);
260 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
261 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
262 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
266 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
268 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
275 $selector->setKey($this->controller
->_key
);
278 if ($this->_context
== 'basic') {
279 $prefix = $this->_prefix
;
282 $controller = new CRM_Core_Selector_Controller($selector,
283 $this->get(CRM_Utils_Pager
::PAGE_ID
),
285 CRM_Core_Action
::VIEW
,
287 CRM_Core_Selector_Controller
::SESSION
,
290 $controller->setEmbedded(TRUE);
292 $query = &$selector->getQuery();
297 * Set default values.
299 * @todo - can this function override be removed?
303 public function setDefaultValues() {
304 return $this->_defaults
;
308 * If this search has been forced then see if there are any get values, and if so over-ride the post values.
310 * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive.
312 public function fixFormValues() {
313 if (!$this->_force
) {
317 $status = CRM_Utils_Request
::retrieve('status', 'String');
319 $status = explode(',', $status);
320 $this->_formValues
['membership_status_id'] = $this->_defaults
['membership_status_id'] = (array) $status;
323 $membershipType = CRM_Utils_Request
::retrieve('type', 'String');
325 if ($membershipType) {
326 $this->_formValues
['membership_type_id'] = array($membershipType);
327 $this->_defaults
['membership_type_id'] = array($membershipType);
330 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive');
333 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
335 $this->_formValues
['contact_id'] = $cid;
336 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
337 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
340 // also assign individual mode to the template
341 $this->_single
= TRUE;
345 $fromDate = CRM_Utils_Request
::retrieve('start', 'Date');
347 list($date) = CRM_Utils_Date
::setDateDefaults($fromDate);
348 $this->_formValues
['member_start_date_low'] = $this->_defaults
['member_start_date_low'] = $date;
351 $toDate = CRM_Utils_Request
::retrieve('end', 'Date');
353 list($date) = CRM_Utils_Date
::setDateDefaults($toDate);
354 $this->_formValues
['member_start_date_high'] = $this->_defaults
['member_start_date_high'] = $date;
356 $joinDate = CRM_Utils_Request
::retrieve('join', 'Date');
358 list($date) = CRM_Utils_Date
::setDateDefaults($joinDate);
359 $this->_formValues
['member_join_date_low'] = $this->_defaults
['member_join_date_low'] = $date;
362 $joinEndDate = CRM_Utils_Request
::retrieve('joinEnd', 'Date');
364 list($date) = CRM_Utils_Date
::setDateDefaults($joinEndDate);
365 $this->_formValues
['member_join_date_high'] = $this->_defaults
['member_join_date_high'] = $date;
368 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
372 //LCD also allow restrictions to membership owner via GET
373 $owner = CRM_Utils_Request
::retrieve('owner', 'String');
374 if (in_array($owner, array('0', '1'))) {
375 $this->_formValues
['member_is_primary'] = $this->_defaults
['member_is_primary'] = $owner;
380 * Return a descriptive name for the page, used in wizard header.
384 public function getTitle() {
385 return ts('Find Memberships');