3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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();
88 * we allow the controller to set force/reset externally, useful when we are being
89 * driven by the wizard framework
92 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean');
93 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
94 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
95 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
97 $this->assign("context", $this->_context
);
99 // get user submitted values
100 // get it from controller only if form has been submitted, else preProcess has set this
101 if (!empty($_POST)) {
102 $this->_formValues
= $this->controller
->exportValues($this->_name
);
105 $this->_formValues
= $this->get('formValues');
109 $this->postProcess();
110 $this->set('force', 0);
114 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
115 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
116 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
120 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
121 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
129 if ($this->_context
== 'basic') {
130 $prefix = $this->_prefix
;
133 $this->assign("{$prefix}limit", $this->_limit
);
134 $this->assign("{$prefix}single", $this->_single
);
136 $controller = new CRM_Core_Selector_Controller($selector,
137 $this->get(CRM_Utils_Pager
::PAGE_ID
),
139 CRM_Core_Action
::VIEW
,
141 CRM_Core_Selector_Controller
::TRANSFER
,
145 $controller->setEmbedded(TRUE);
146 $controller->moveFromSessionToTemplate();
148 $this->assign('summary', $this->get('summary'));
152 * Build the form object.
154 public function buildQuickForm() {
155 parent
::buildQuickForm();
156 $this->addContactSearchFields();
158 CRM_Member_BAO_Query
::buildSearchForm($this);
160 $rows = $this->get('rows');
161 if (is_array($rows)) {
162 if (!$this->_single
) {
163 $this->addRowSelectors($rows);
166 $this->addTaskMenu(CRM_Member_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
172 * Get the label for the sortName field if email searching is on.
174 * (email searching is a setting under search preferences).
178 protected function getSortNameLabelWithEmail() {
179 return ts('Member Name or Email');
183 * Get the label for the sortName field if email searching is off.
185 * (email searching is a setting under search preferences).
189 protected function getSortNameLabelWithOutEmail() {
190 return ts('Member Name');
194 * Get the label for the tag field.
196 * We do this in a function so the 'ts' wraps the whole string to allow
197 * better translation.
201 protected function getTagLabel() {
202 return ts('Member Tag(s)');
206 * Get the label for the group field.
210 protected function getGroupLabel() {
211 return ts('Member Group(s)');
215 * Get the label for the group field.
219 protected function getContactTypeLabel() {
220 return ts('Member Contact Type');
224 * The post processing of the form gets done here.
226 * Key things done during post processing are
227 * - check for reset or next request. if present, skip post procesing.
228 * - now check if user requested running a saved search, if so, then
229 * the form values associated with the saved search are used for searching.
230 * - if user has done a submit with new values the regular post submissing is
232 * The processing consists of using a Selector / Controller framework for getting the
235 public function postProcess() {
242 $this->_formValues
= $this->controller
->exportValues($this->_name
);
244 $this->fixFormValues();
246 // We don't show test records in summaries or dashboards
247 if (empty($this->_formValues
['member_test']) && $this->_force
) {
248 $this->_formValues
["member_test"] = 0;
251 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
253 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
255 $this->set('formValues', $this->_formValues
);
256 $this->set('queryParams', $this->_queryParams
);
258 $buttonName = $this->controller
->getButtonName();
259 if ($buttonName == $this->_actionButtonName
) {
260 // check actionName and if next, then do not repeat a search, since we are going to the next page
262 // hack, make sure we reset the task values
263 $stateMachine = $this->controller
->getStateMachine();
264 $formName = $stateMachine->getTaskFormName();
265 $this->controller
->resetPage($formName);
270 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
271 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
272 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
276 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
278 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
285 $selector->setKey($this->controller
->_key
);
288 if ($this->_context
== 'basic') {
289 $prefix = $this->_prefix
;
292 $controller = new CRM_Core_Selector_Controller($selector,
293 $this->get(CRM_Utils_Pager
::PAGE_ID
),
295 CRM_Core_Action
::VIEW
,
297 CRM_Core_Selector_Controller
::SESSION
,
300 $controller->setEmbedded(TRUE);
302 $query = &$selector->getQuery();
307 * Set default values.
309 * @todo - can this function override be removed?
313 public function setDefaultValues() {
314 return $this->_defaults
;
318 * If this search has been forced then see if there are any get values, and if so over-ride the post values.
320 * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive.
322 public function fixFormValues() {
323 if (!$this->_force
) {
327 $status = CRM_Utils_Request
::retrieve('status', 'String');
329 $status = explode(',', $status);
330 $this->_formValues
['membership_status_id'] = $this->_defaults
['membership_status_id'] = (array) $status;
333 $membershipType = CRM_Utils_Request
::retrieve('type', 'String');
335 if ($membershipType) {
336 $this->_formValues
['membership_type_id'] = array($membershipType);
337 $this->_defaults
['membership_type_id'] = array($membershipType);
340 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive');
343 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
345 $this->_formValues
['contact_id'] = $cid;
346 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
347 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
350 // also assign individual mode to the template
351 $this->_single
= TRUE;
355 $fromDate = CRM_Utils_Request
::retrieve('start', 'Date');
357 list($date) = CRM_Utils_Date
::setDateDefaults($fromDate);
358 $this->_formValues
['member_start_date_low'] = $this->_defaults
['member_start_date_low'] = $date;
361 $toDate = CRM_Utils_Request
::retrieve('end', 'Date');
363 list($date) = CRM_Utils_Date
::setDateDefaults($toDate);
364 $this->_formValues
['member_start_date_high'] = $this->_defaults
['member_start_date_high'] = $date;
366 $joinDate = CRM_Utils_Request
::retrieve('join', 'Date');
368 list($date) = CRM_Utils_Date
::setDateDefaults($joinDate);
369 $this->_formValues
['member_join_date_low'] = $this->_defaults
['member_join_date_low'] = $date;
372 $joinEndDate = CRM_Utils_Request
::retrieve('joinEnd', 'Date');
374 list($date) = CRM_Utils_Date
::setDateDefaults($joinEndDate);
375 $this->_formValues
['member_join_date_high'] = $this->_defaults
['member_join_date_high'] = $date;
378 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
382 //LCD also allow restrictions to membership owner via GET
383 $owner = CRM_Utils_Request
::retrieve('owner', 'String');
384 if (in_array($owner, array('0', '1'))) {
385 $this->_formValues
['member_is_primary'] = $this->_defaults
['member_is_primary'] = $owner;
390 * Return a descriptive name for the page, used in wizard header.
394 public function getTitle() {
395 return ts('Find Memberships');