3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
41 * Class is a pane in advanced search and the membership search page.
43 class CRM_Member_Form_Search
extends CRM_Core_Form_Search
{
46 * The params that are sent to the query.
50 protected $_queryParams;
53 * Are we restricting ourselves to a single contact.
57 protected $_single = FALSE;
60 * Are we restricting ourselves to a single contact.
64 protected $_limit = NULL;
67 * Prefix for the controller.
69 protected $_prefix = "member_";
72 * Declare entity reference fields as they will need to be converted to using 'IN'.
76 protected $entityReferenceFields = array('membership_type_id');
79 * Processing needed for buildForm and later.
81 public function preProcess() {
82 $this->set('searchFormName', 'Search');
84 $this->_searchButtonName
= $this->getButtonName('refresh');
85 $this->_actionButtonName
= $this->getButtonName('next', 'action');
89 $this->defaults
= array();
92 * we allow the controller to set force/reset externally, useful when we are being
93 * driven by the wizard framework
96 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
97 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
98 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
99 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
101 $this->assign("context", $this->_context
);
103 // get user submitted values
104 // get it from controller only if form has been submitted, else preProcess has set this
105 if (!empty($_POST)) {
106 $this->_formValues
= $this->controller
->exportValues($this->_name
);
109 $this->_formValues
= $this->get('formValues');
113 $this->postProcess();
114 $this->set('force', 0);
118 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
119 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
120 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
124 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
125 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
133 if ($this->_context
== 'basic') {
134 $prefix = $this->_prefix
;
137 $this->assign("{$prefix}limit", $this->_limit
);
138 $this->assign("{$prefix}single", $this->_single
);
140 $controller = new CRM_Core_Selector_Controller($selector,
141 $this->get(CRM_Utils_Pager
::PAGE_ID
),
143 CRM_Core_Action
::VIEW
,
145 CRM_Core_Selector_Controller
::TRANSFER
,
149 $controller->setEmbedded(TRUE);
150 $controller->moveFromSessionToTemplate();
152 $this->assign('summary', $this->get('summary'));
156 * Build the form object.
158 public function buildQuickForm() {
159 parent
::buildQuickForm();
160 $this->addSortNameField();
162 CRM_Member_BAO_Query
::buildSearchForm($this);
164 $rows = $this->get('rows');
165 if (is_array($rows)) {
166 if (!$this->_single
) {
167 $this->addRowSelectors($rows);
170 $permission = CRM_Core_Permission
::getPermission();
172 $this->addTaskMenu(CRM_Member_Task
::permissionedTaskTitles($permission));
178 * Get the label for the sortName field if email searching is on.
180 * (email searching is a setting under search preferences).
184 protected function getSortNameLabelWithEmail() {
185 return ts('Member Name or Email');
189 * Get the label for the sortName field if email searching is off.
191 * (email searching is a setting under search preferences).
195 protected function getSortNameLabelWithOutEmail() {
196 return ts('Member Name');
200 * The post processing of the form gets done here.
202 * Key things done during post processing are
203 * - check for reset or next request. if present, skip post procesing.
204 * - now check if user requested running a saved search, if so, then
205 * the form values associated with the saved search are used for searching.
206 * - if user has done a submit with new values the regular post submissing is
208 * The processing consists of using a Selector / Controller framework for getting the
211 public function postProcess() {
218 $this->_formValues
= $this->controller
->exportValues($this->_name
);
220 $this->fixFormValues();
222 // We don't show test records in summaries or dashboards
223 if (empty($this->_formValues
['member_test']) && $this->_force
) {
224 $this->_formValues
["member_test"] = 0;
227 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
229 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
231 $this->set('formValues', $this->_formValues
);
232 $this->set('queryParams', $this->_queryParams
);
234 $buttonName = $this->controller
->getButtonName();
235 if ($buttonName == $this->_actionButtonName
) {
236 // check actionName and if next, then do not repeat a search, since we are going to the next page
238 // hack, make sure we reset the task values
239 $stateMachine = $this->controller
->getStateMachine();
240 $formName = $stateMachine->getTaskFormName();
241 $this->controller
->resetPage($formName);
246 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
247 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
248 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
252 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
254 $selector = new CRM_Member_Selector_Search($this->_queryParams
,
261 $selector->setKey($this->controller
->_key
);
264 if ($this->_context
== 'basic') {
265 $prefix = $this->_prefix
;
268 $controller = new CRM_Core_Selector_Controller($selector,
269 $this->get(CRM_Utils_Pager
::PAGE_ID
),
271 CRM_Core_Action
::VIEW
,
273 CRM_Core_Selector_Controller
::SESSION
,
276 $controller->setEmbedded(TRUE);
278 $query = &$selector->getQuery();
283 * Set default values.
285 * @todo - can this function override be removed?
289 public function setDefaultValues() {
290 return $this->_defaults
;
294 * If this search has been forced then see if there are any get values, and if so over-ride the post values.
296 * Note that this means that GET over-rides POST :) & that force with no parameters can be very destructive.
298 public function fixFormValues() {
299 if (!$this->_force
) {
303 $status = CRM_Utils_Request
::retrieve('status', 'String',
304 CRM_Core_DAO
::$_nullObject
307 $status = explode(',', $status);
308 $this->_formValues
['membership_status_id'] = $this->_defaults
['membership_status_id'] = (array) $status;
311 $membershipType = CRM_Utils_Request
::retrieve('type', 'String',
312 CRM_Core_DAO
::$_nullObject
315 if ($membershipType) {
316 $this->_formValues
['membership_type_id'] = array($membershipType);
317 $this->_defaults
['membership_type_id'] = array($membershipType);
320 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive',
321 CRM_Core_DAO
::$_nullObject
325 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
327 $this->_formValues
['contact_id'] = $cid;
328 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
329 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
332 // also assign individual mode to the template
333 $this->_single
= TRUE;
337 $fromDate = CRM_Utils_Request
::retrieve('start', 'Date',
338 CRM_Core_DAO
::$_nullObject
341 list($date) = CRM_Utils_Date
::setDateDefaults($fromDate);
342 $this->_formValues
['member_start_date_low'] = $this->_defaults
['member_start_date_low'] = $date;
345 $toDate = CRM_Utils_Request
::retrieve('end', 'Date',
346 CRM_Core_DAO
::$_nullObject
349 list($date) = CRM_Utils_Date
::setDateDefaults($toDate);
350 $this->_formValues
['member_start_date_high'] = $this->_defaults
['member_start_date_high'] = $date;
352 $joinDate = CRM_Utils_Request
::retrieve('join', 'Date',
353 CRM_Core_DAO
::$_nullObject
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',
361 CRM_Core_DAO
::$_nullObject
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', CRM_Core_DAO
::$_nullObject);
375 $this->_formValues
['member_is_primary'] = $this->_defaults
['member_is_primary'] = 2;
380 * Return a descriptive name for the page, used in wizard header.
384 public function getTitle() {
385 return ts('Find Memberships');