Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
0955d6b9 | 35 | * Membership search. |
36 | * | |
37 | * Class is a pane in advanced search and the membership search page. | |
6a488035 | 38 | */ |
3efb5b86 | 39 | class CRM_Member_Form_Search extends CRM_Core_Form_Search { |
6a488035 | 40 | |
6a488035 | 41 | /** |
fe482240 | 42 | * The params that are sent to the query. |
6a488035 TO |
43 | * |
44 | * @var array | |
6a488035 TO |
45 | */ |
46 | protected $_queryParams; | |
47 | ||
6a488035 | 48 | /** |
fe482240 | 49 | * Are we restricting ourselves to a single contact. |
6a488035 | 50 | * |
e5ad0335 | 51 | * @var bool |
6a488035 TO |
52 | */ |
53 | protected $_single = FALSE; | |
54 | ||
55 | /** | |
fe482240 | 56 | * Are we restricting ourselves to a single contact. |
6a488035 | 57 | * |
e5ad0335 | 58 | * @var bool |
6a488035 TO |
59 | */ |
60 | protected $_limit = NULL; | |
61 | ||
6a488035 | 62 | /** |
fe482240 | 63 | * Prefix for the controller. |
6a488035 TO |
64 | */ |
65 | protected $_prefix = "member_"; | |
66 | ||
df60621b | 67 | /** |
68 | * Declare entity reference fields as they will need to be converted to using 'IN'. | |
69 | * | |
70 | * @var array | |
71 | */ | |
72 | protected $entityReferenceFields = array('membership_type_id'); | |
73 | ||
6a488035 | 74 | /** |
fe482240 | 75 | * Processing needed for buildForm and later. |
03e04002 | 76 | */ |
00be9182 | 77 | public function preProcess() { |
6a488035 TO |
78 | $this->set('searchFormName', 'Search'); |
79 | ||
6a488035 | 80 | $this->_searchButtonName = $this->getButtonName('refresh'); |
6a488035 TO |
81 | $this->_actionButtonName = $this->getButtonName('next', 'action'); |
82 | ||
83 | $this->_done = FALSE; | |
84 | ||
85 | $this->defaults = array(); | |
86 | ||
03e04002 | 87 | /* |
d424ffde CW |
88 | * we allow the controller to set force/reset externally, useful when we are being |
89 | * driven by the wizard framework | |
90 | */ | |
6a488035 | 91 | |
e5ad0335 | 92 | $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean'); |
353ffa53 TO |
93 | $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); |
94 | $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this); | |
6a488035 TO |
95 | $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search'); |
96 | ||
97 | $this->assign("context", $this->_context); | |
98 | ||
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); | |
103 | } | |
104 | else { | |
105 | $this->_formValues = $this->get('formValues'); | |
106 | } | |
107 | ||
108 | if ($this->_force) { | |
109 | $this->postProcess(); | |
110 | $this->set('force', 0); | |
111 | } | |
112 | ||
113 | $sortID = NULL; | |
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) | |
117 | ); | |
118 | } | |
119 | ||
df60621b | 120 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields); |
6a488035 TO |
121 | $selector = new CRM_Member_Selector_Search($this->_queryParams, |
122 | $this->_action, | |
123 | NULL, | |
124 | $this->_single, | |
125 | $this->_limit, | |
126 | $this->_context | |
127 | ); | |
128 | $prefix = NULL; | |
129 | if ($this->_context == 'basic') { | |
130 | $prefix = $this->_prefix; | |
131 | } | |
132 | ||
133 | $this->assign("{$prefix}limit", $this->_limit); | |
134 | $this->assign("{$prefix}single", $this->_single); | |
135 | ||
136 | $controller = new CRM_Core_Selector_Controller($selector, | |
137 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
138 | $sortID, | |
139 | CRM_Core_Action::VIEW, | |
140 | $this, | |
141 | CRM_Core_Selector_Controller::TRANSFER, | |
142 | $prefix | |
143 | ); | |
144 | ||
145 | $controller->setEmbedded(TRUE); | |
146 | $controller->moveFromSessionToTemplate(); | |
147 | ||
148 | $this->assign('summary', $this->get('summary')); | |
149 | } | |
150 | ||
151 | /** | |
fe482240 | 152 | * Build the form object. |
6a488035 | 153 | */ |
00be9182 | 154 | public function buildQuickForm() { |
3efb5b86 | 155 | parent::buildQuickForm(); |
e597fc33 | 156 | $this->addSortNameField(); |
6a488035 TO |
157 | |
158 | CRM_Member_BAO_Query::buildSearchForm($this); | |
159 | ||
6a488035 TO |
160 | $rows = $this->get('rows'); |
161 | if (is_array($rows)) { | |
162 | if (!$this->_single) { | |
8d36b801 | 163 | $this->addRowSelectors($rows); |
6a488035 TO |
164 | } |
165 | ||
6a488035 TO |
166 | $permission = CRM_Core_Permission::getPermission(); |
167 | ||
34197a55 | 168 | $this->addTaskMenu(CRM_Member_Task::permissionedTaskTitles($permission)); |
6a488035 TO |
169 | } |
170 | ||
6a488035 TO |
171 | } |
172 | ||
e597fc33 DG |
173 | /** |
174 | * Get the label for the sortName field if email searching is on. | |
175 | * | |
176 | * (email searching is a setting under search preferences). | |
177 | * | |
178 | * @return string | |
179 | */ | |
180 | protected function getSortNameLabelWithEmail() { | |
181 | return ts('Member Name or Email'); | |
182 | } | |
183 | ||
184 | /** | |
185 | * Get the label for the sortName field if email searching is off. | |
186 | * | |
187 | * (email searching is a setting under search preferences). | |
188 | * | |
189 | * @return string | |
190 | */ | |
191 | protected function getSortNameLabelWithOutEmail() { | |
192 | return ts('Member Name'); | |
193 | } | |
194 | ||
6a488035 TO |
195 | /** |
196 | * The post processing of the form gets done here. | |
197 | * | |
198 | * Key things done during post processing are | |
199 | * - check for reset or next request. if present, skip post procesing. | |
200 | * - now check if user requested running a saved search, if so, then | |
201 | * the form values associated with the saved search are used for searching. | |
202 | * - if user has done a submit with new values the regular post submissing is | |
203 | * done. | |
204 | * The processing consists of using a Selector / Controller framework for getting the | |
205 | * search results. | |
6a488035 | 206 | */ |
00be9182 | 207 | public function postProcess() { |
6a488035 TO |
208 | if ($this->_done) { |
209 | return; | |
210 | } | |
211 | ||
212 | $this->_done = TRUE; | |
213 | ||
214 | $this->_formValues = $this->controller->exportValues($this->_name); | |
215 | ||
216 | $this->fixFormValues(); | |
217 | ||
d43b88cc CW |
218 | // We don't show test records in summaries or dashboards |
219 | if (empty($this->_formValues['member_test']) && $this->_force) { | |
6a488035 TO |
220 | $this->_formValues["member_test"] = 0; |
221 | } | |
222 | ||
c94d39fd | 223 | CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues); |
6a488035 | 224 | |
df60621b | 225 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields); |
6a488035 TO |
226 | |
227 | $this->set('formValues', $this->_formValues); | |
228 | $this->set('queryParams', $this->_queryParams); | |
229 | ||
230 | $buttonName = $this->controller->getButtonName(); | |
e341bbee | 231 | if ($buttonName == $this->_actionButtonName) { |
6a488035 TO |
232 | // check actionName and if next, then do not repeat a search, since we are going to the next page |
233 | ||
234 | // hack, make sure we reset the task values | |
95ea77ec | 235 | $stateMachine = $this->controller->getStateMachine(); |
6a488035 TO |
236 | $formName = $stateMachine->getTaskFormName(); |
237 | $this->controller->resetPage($formName); | |
238 | return; | |
239 | } | |
240 | ||
241 | $sortID = NULL; | |
242 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
243 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
244 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
245 | ); | |
246 | } | |
247 | ||
ccc994a1 | 248 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields); |
6a488035 TO |
249 | |
250 | $selector = new CRM_Member_Selector_Search($this->_queryParams, | |
251 | $this->_action, | |
252 | NULL, | |
253 | $this->_single, | |
254 | $this->_limit, | |
255 | $this->_context | |
256 | ); | |
257 | $selector->setKey($this->controller->_key); | |
258 | ||
259 | $prefix = NULL; | |
260 | if ($this->_context == 'basic') { | |
261 | $prefix = $this->_prefix; | |
262 | } | |
263 | ||
264 | $controller = new CRM_Core_Selector_Controller($selector, | |
265 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
266 | $sortID, | |
267 | CRM_Core_Action::VIEW, | |
268 | $this, | |
269 | CRM_Core_Selector_Controller::SESSION, | |
270 | $prefix | |
271 | ); | |
272 | $controller->setEmbedded(TRUE); | |
273 | ||
274 | $query = &$selector->getQuery(); | |
275 | $controller->run(); | |
276 | } | |
277 | ||
0955d6b9 | 278 | /** |
279 | * Set default values. | |
280 | * | |
281 | * @todo - can this function override be removed? | |
282 | * | |
283 | * @return array | |
284 | */ | |
00be9182 | 285 | public function setDefaultValues() { |
6a488035 TO |
286 | return $this->_defaults; |
287 | } | |
288 | ||
0955d6b9 | 289 | /** |
290 | * If this search has been forced then see if there are any get values, and if so over-ride the post values. | |
291 | * | |
292 | * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive. | |
293 | */ | |
00be9182 | 294 | public function fixFormValues() { |
6a488035 TO |
295 | if (!$this->_force) { |
296 | return; | |
297 | } | |
298 | ||
1273d77c | 299 | $status = CRM_Utils_Request::retrieve('status', 'String'); |
6a488035 TO |
300 | if ($status) { |
301 | $status = explode(',', $status); | |
fc5b907d | 302 | $this->_formValues['membership_status_id'] = $this->_defaults['membership_status_id'] = (array) $status; |
6a488035 TO |
303 | } |
304 | ||
1273d77c | 305 | $membershipType = CRM_Utils_Request::retrieve('type', 'String'); |
6a488035 TO |
306 | |
307 | if ($membershipType) { | |
0a74debb | 308 | $this->_formValues['membership_type_id'] = array($membershipType); |
309 | $this->_defaults['membership_type_id'] = array($membershipType); | |
6a488035 TO |
310 | } |
311 | ||
1273d77c | 312 | $cid = CRM_Utils_Request::retrieve('cid', 'Positive'); |
6a488035 TO |
313 | |
314 | if ($cid) { | |
315 | $cid = CRM_Utils_Type::escape($cid, 'Integer'); | |
316 | if ($cid > 0) { | |
317 | $this->_formValues['contact_id'] = $cid; | |
318 | list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid); | |
319 | $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, | |
320 | 'sort_name' | |
321 | ); | |
322 | // also assign individual mode to the template | |
323 | $this->_single = TRUE; | |
324 | } | |
325 | } | |
326 | ||
1273d77c | 327 | $fromDate = CRM_Utils_Request::retrieve('start', 'Date'); |
6a488035 TO |
328 | if ($fromDate) { |
329 | list($date) = CRM_Utils_Date::setDateDefaults($fromDate); | |
330 | $this->_formValues['member_start_date_low'] = $this->_defaults['member_start_date_low'] = $date; | |
331 | } | |
332 | ||
1273d77c | 333 | $toDate = CRM_Utils_Request::retrieve('end', 'Date'); |
6a488035 TO |
334 | if ($toDate) { |
335 | list($date) = CRM_Utils_Date::setDateDefaults($toDate); | |
336 | $this->_formValues['member_start_date_high'] = $this->_defaults['member_start_date_high'] = $date; | |
337 | } | |
1273d77c | 338 | $joinDate = CRM_Utils_Request::retrieve('join', 'Date'); |
6a488035 TO |
339 | if ($joinDate) { |
340 | list($date) = CRM_Utils_Date::setDateDefaults($joinDate); | |
341 | $this->_formValues['member_join_date_low'] = $this->_defaults['member_join_date_low'] = $date; | |
342 | } | |
343 | ||
1273d77c | 344 | $joinEndDate = CRM_Utils_Request::retrieve('joinEnd', 'Date'); |
6a488035 TO |
345 | if ($joinEndDate) { |
346 | list($date) = CRM_Utils_Date::setDateDefaults($joinEndDate); | |
347 | $this->_formValues['member_join_date_high'] = $this->_defaults['member_join_date_high'] = $date; | |
348 | } | |
349 | ||
350 | $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', | |
351 | $this | |
352 | ); | |
353 | ||
354 | //LCD also allow restrictions to membership owner via GET | |
a3d827a7 | 355 | $owner = CRM_Utils_Request::retrieve('owner', 'String'); |
6a488035 TO |
356 | if ($owner) { |
357 | $this->_formValues['member_is_primary'] = $this->_defaults['member_is_primary'] = 2; | |
358 | } | |
359 | } | |
360 | ||
361 | /** | |
0955d6b9 | 362 | * Return a descriptive name for the page, used in wizard header. |
6a488035 TO |
363 | * |
364 | * @return string | |
6a488035 TO |
365 | */ |
366 | public function getTitle() { | |
367 | return ts('Find Memberships'); | |
368 | } | |
96025800 | 369 | |
6a488035 | 370 | } |