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->loadStandardSearchOptionsFromUrl();
87 // get user submitted values
88 // get it from controller only if form has been submitted, else preProcess has set this
90 $this->_formValues
= $this->controller
->exportValues($this->_name
);
93 $this->_formValues
= $this->get('formValues');
98 $this->set('force', 0);
102 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
103 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
104 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
108 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
109 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
117 if ($this->_context
== 'basic') {
118 $prefix = $this->_prefix
;
121 $this->assign("{$prefix}limit", $this->_limit
);
122 $this->assign("{$prefix}single", $this->_single
);
124 $controller = new CRM_Core_Selector_Controller($selector,
125 $this->get(CRM_Utils_Pager
::PAGE_ID
),
127 CRM_Core_Action
::VIEW
,
129 CRM_Core_Selector_Controller
::TRANSFER
,
133 $controller->setEmbedded(TRUE);
134 $controller->moveFromSessionToTemplate();
136 $this->assign('summary', $this->get('summary'));
140 * Build the form object.
142 public function buildQuickForm() {
143 parent
::buildQuickForm();
144 $this->addContactSearchFields();
146 CRM_Member_BAO_Query
::buildSearchForm($this);
148 $rows = $this->get('rows');
149 if (is_array($rows)) {
150 if (!$this->_single
) {
151 $this->addRowSelectors($rows);
154 $this->addTaskMenu(CRM_Member_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
160 * Get the label for the sortName field if email searching is on.
162 * (email searching is a setting under search preferences).
166 protected function getSortNameLabelWithEmail() {
167 return ts('Member Name or Email');
171 * Get the label for the sortName field if email searching is off.
173 * (email searching is a setting under search preferences).
177 protected function getSortNameLabelWithOutEmail() {
178 return ts('Member Name');
182 * Get the label for the tag field.
184 * We do this in a function so the 'ts' wraps the whole string to allow
185 * better translation.
189 protected function getTagLabel() {
190 return ts('Member Tag(s)');
194 * Get the label for the group field.
198 protected function getGroupLabel() {
199 return ts('Member Group(s)');
203 * Get the label for the group field.
207 protected function getContactTypeLabel() {
208 return ts('Member Contact Type');
212 * The post processing of the form gets done here.
214 * Key things done during post processing are
215 * - check for reset or next request. if present, skip post procesing.
216 * - now check if user requested running a saved search, if so, then
217 * the form values associated with the saved search are used for searching.
218 * - if user has done a submit with new values the regular post submissing is
220 * The processing consists of using a Selector / Controller framework for getting the
223 public function postProcess() {
230 $this->_formValues
= $this->controller
->exportValues($this->_name
);
232 $this->fixFormValues();
234 // We don't show test records in summaries or dashboards
235 if (empty($this->_formValues
['member_test']) && $this->_force
) {
236 $this->_formValues
["member_test"] = 0;
239 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
241 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
243 $this->set('formValues', $this->_formValues
);
244 $this->set('queryParams', $this->_queryParams
);
246 $buttonName = $this->controller
->getButtonName();
247 if ($buttonName == $this->_actionButtonName
) {
248 // check actionName and if next, then do not repeat a search, since we are going to the next page
250 // hack, make sure we reset the task values
251 $stateMachine = $this->controller
->getStateMachine();
252 $formName = $stateMachine->getTaskFormName();
253 $this->controller
->resetPage($formName);
258 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
259 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
260 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
264 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
266 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
273 $selector->setKey($this->controller
->_key
);
276 if ($this->_context
== 'basic') {
277 $prefix = $this->_prefix
;
280 $controller = new CRM_Core_Selector_Controller($selector,
281 $this->get(CRM_Utils_Pager
::PAGE_ID
),
283 CRM_Core_Action
::VIEW
,
285 CRM_Core_Selector_Controller
::SESSION
,
288 $controller->setEmbedded(TRUE);
290 $query = &$selector->getQuery();
295 * Set default values.
297 * @todo - can this function override be removed?
301 public function setDefaultValues() {
302 return $this->_defaults
;
306 * If this search has been forced then see if there are any get values, and if so over-ride the post values.
308 * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive.
310 public function fixFormValues() {
311 if (!$this->_force
) {
315 $status = CRM_Utils_Request
::retrieve('status', 'String');
317 $status = explode(',', $status);
318 $this->_formValues
['membership_status_id'] = $this->_defaults
['membership_status_id'] = (array) $status;
321 $membershipType = CRM_Utils_Request
::retrieve('type', 'String');
323 if ($membershipType) {
324 $this->_formValues
['membership_type_id'] = array($membershipType);
325 $this->_defaults
['membership_type_id'] = array($membershipType);
328 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive');
331 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
333 $this->_formValues
['contact_id'] = $cid;
334 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
335 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
338 // also assign individual mode to the template
339 $this->_single
= TRUE;
343 $fromDate = CRM_Utils_Request
::retrieve('start', 'Date');
345 list($date) = CRM_Utils_Date
::setDateDefaults($fromDate);
346 $this->_formValues
['member_start_date_low'] = $this->_defaults
['member_start_date_low'] = $date;
349 $toDate = CRM_Utils_Request
::retrieve('end', 'Date');
351 list($date) = CRM_Utils_Date
::setDateDefaults($toDate);
352 $this->_formValues
['member_start_date_high'] = $this->_defaults
['member_start_date_high'] = $date;
354 $joinDate = CRM_Utils_Request
::retrieve('join', 'Date');
356 list($date) = CRM_Utils_Date
::setDateDefaults($joinDate);
357 $this->_formValues
['member_join_date_low'] = $this->_defaults
['member_join_date_low'] = $date;
360 $joinEndDate = CRM_Utils_Request
::retrieve('joinEnd', 'Date');
362 list($date) = CRM_Utils_Date
::setDateDefaults($joinEndDate);
363 $this->_formValues
['member_join_date_high'] = $this->_defaults
['member_join_date_high'] = $date;
366 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
370 //LCD also allow restrictions to membership owner via GET
371 $owner = CRM_Utils_Request
::retrieve('owner', 'String');
372 if (in_array($owner, array('0', '1'))) {
373 $this->_formValues
['member_is_primary'] = $this->_defaults
['member_is_primary'] = $owner;
378 * Return a descriptive name for the page, used in wizard header.
382 public function getTitle() {
383 return ts('Find Memberships');