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 +--------------------------------------------------------------------+
29 * Base class for most search forms
31 class CRM_Core_Form_Search
extends CRM_Core_Form
{
34 * Are we forced to run a search
41 * Name of search button
45 protected $_searchButtonName;
48 * Name of action button
52 protected $_actionButtonName;
55 * Form values that we will be using
62 * Have we already done this search
69 * What context are we being invoked from
73 protected $_context = NULL;
76 * The list of tasks or actions that a searcher can perform on a result set.
80 protected $_taskList = [];
83 * Declare entity reference fields as they will need to be converted.
85 * The entity reference format looks like '2,3' whereas the Query object expects array(2, 3)
86 * or array('IN' => array(2, 3). The latter is the one we are moving towards standardising on.
90 protected $entityReferenceFields = [];
93 * Builds the list of tasks or actions that a searcher can perform on a result set.
95 * To modify the task list, child classes should alter $this->_taskList,
96 * preferably by extending this method.
100 protected function buildTaskList() {
101 return $this->_taskList
;
105 * Metadata for fields on the search form.
107 * Instantiate with empty array for contact to prevent e-notices.
111 protected $searchFieldMetadata = ['Contact' => []];
116 public function getSearchFieldMetadata() {
117 return $this->searchFieldMetadata
;
121 * @param array $searchFieldMetadata
123 public function addSearchFieldMetadata($searchFieldMetadata) {
124 $this->searchFieldMetadata
= array_merge($this->searchFieldMetadata
, $searchFieldMetadata);
128 * This virtual function is used to set the default values of various form elements.
131 * reference to the array of default values
132 * @throws \CRM_Core_Exception
134 public function setDefaultValues() {
135 $defaults = (array) $this->_formValues
;
136 foreach (array_keys($this->getSearchFieldMetadata()) as $entity) {
137 $defaults = array_merge($this->getEntityDefaults($entity), $defaults);
143 * Set the form values based on input and preliminary processing.
147 protected function setFormValues() {
148 $this->_formValues
= $this->getFormValues();
149 $this->convertTextStringsToUseLikeOperator();
153 * Common buildForm tasks required by all searches.
155 public function buildQuickForm() {
156 CRM_Core_Resources
::singleton()
157 ->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header')
158 ->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
163 'name' => ts('Search'),
168 $this->addClass('crm-search-form');
170 $tasks = $this->buildTaskList();
171 $this->addTaskMenu($tasks);
175 * Add any fields described in metadata to the form.
177 * The goal is to describe all fields in metadata and handle from metadata rather
178 * than existing ad hoc handling.
180 public function addFormFieldsFromMetadata() {
181 $this->addFormRule(['CRM_Core_Form_Search', 'formRule'], $this);
182 $this->_action
= CRM_Core_Action
::ADVANCED
;
183 foreach ($this->getSearchFieldMetadata() as $entity => $fields) {
184 foreach ($fields as $fieldName => $fieldSpec) {
185 $fieldType = $fieldSpec['type'] ??
'';
186 if ($fieldType === CRM_Utils_Type
::T_DATE ||
$fieldType === (CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
)) {
187 $title = empty($fieldSpec['unique_title']) ?
$fieldSpec['title'] : $fieldSpec['unique_title'];
188 $this->addDatePickerRange($fieldName, $title, ($fieldType === (CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
)));
191 // Not quite sure about moving to a mix of keying by entity vs permitting entity to
192 // be passed in. The challenge of the former is that it doesn't permit ordering.
193 // Perhaps keying was the wrong starting point & we should do a flat array as all
194 // fields eventually need to be unique.
195 $props = ['entity' => $fieldSpec['entity'] ??
$entity];
196 if (isset($fields[$fieldName]['unique_title'])) {
197 $props['label'] = $fields[$fieldName]['unique_title'];
199 elseif (isset($fields[$fieldName]['title'])) {
200 $props['label'] = $fields[$fieldName]['title'];
202 if (empty($fieldSpec['is_pseudofield'])) {
203 $this->addField($fieldName, $props);
211 * Global validation rules for the form.
213 * @param array $fields
214 * Posted values of the form.
215 * @param array $files
216 * @param object $form
219 * list of errors to be posted back to the form
221 public static function formRule($fields, $files, $form) {
223 if (!is_a($form, 'CRM_Core_Form_Search')) {
224 // So this gets hit with a form object when doing an activity date search from
225 // advanced search, but a NULL object when doing a pledge search.
228 foreach ($form->getSearchFieldMetadata() as $entity => $spec) {
229 foreach ($spec as $fieldName => $fieldSpec) {
230 if ($fieldSpec['type'] === CRM_Utils_Type
::T_DATE ||
$fieldSpec['type'] === (CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
)) {
231 if (!empty($fields[$fieldName . '_high']) && !empty($fields[$fieldName . '_low']) && empty($fields[$fieldName . '_relative'])) {
232 if (strtotime($fields[$fieldName . '_low']) > strtotime($fields[$fieldName . '_high'])) {
233 $errors[$fieldName . '_low'] = ts('%1: Please check that your date range is in correct chronological order.', [1 => $fieldSpec['title']]);
243 * Get the validation rule to apply to a function.
245 * Alphanumeric is designed to always be safe & for now we just return
246 * that but in future we can use tighter rules for types like int, bool etc.
248 * @param string $entity
249 * @param string $fieldName
253 protected function getValidationTypeForField($entity, $fieldName) {
254 switch ($this->getSearchFieldMetadata()[$entity][$fieldName]['type']) {
255 case CRM_Utils_Type
::T_BOOLEAN
:
258 case CRM_Utils_Type
::T_INT
:
259 return 'CommaSeparatedIntegers';
261 case CRM_Utils_Type
::T_DATE
:
262 case CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
:
266 return 'Alphanumeric';
271 * Get the defaults for the entity for any fields described in metadata.
273 * @param string $entity
277 * @throws \CRM_Core_Exception
279 protected function getEntityDefaults($entity) {
281 foreach (CRM_Utils_Array
::value($entity, $this->getSearchFieldMetadata(), []) as $fieldName => $fieldSpec) {
282 if (empty($_POST[$fieldName])) {
283 $value = CRM_Utils_Request
::retrieveValue($fieldName, $this->getValidationTypeForField($entity, $fieldName), NULL, NULL, 'GET');
284 if ($value !== NULL) {
285 $defaults[$fieldName] = $value;
287 if ($fieldSpec['type'] === CRM_Utils_Type
::T_DATE ||
($fieldSpec['type'] === CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
)) {
288 $low = CRM_Utils_Request
::retrieveValue($fieldName . '_low', 'Timestamp', NULL, NULL, 'GET');
289 $high = CRM_Utils_Request
::retrieveValue($fieldName . '_high', 'Timestamp', NULL, NULL, 'GET');
290 if ($low !== NULL ||
$high !== NULL) {
291 $defaults[$fieldName . '_relative'] = 0;
292 $defaults[$fieldName . '_low'] = $low ?
date('Y-m-d H:i:s', strtotime($low)) : NULL;
293 $defaults[$fieldName . '_high'] = $high ?
date('Y-m-d H:i:s', strtotime($high)) : NULL;
296 $relative = CRM_Utils_Request
::retrieveValue($fieldName . '_relative', 'String', NULL, NULL, 'GET');
297 if (!empty($relative) && isset(CRM_Core_OptionGroup
::values('relative_date_filters')[$relative])) {
298 $defaults[$fieldName . '_relative'] = $relative;
308 * Convert any submitted text fields to use 'like' rather than '=' as the operator.
310 * This excludes any with options.
312 * Note this will only pick up fields declared via metadata.
314 protected function convertTextStringsToUseLikeOperator() {
315 foreach ($this->getSearchFieldMetadata() as $entity => $fields) {
316 foreach ($fields as $fieldName => $field) {
317 if (!empty($this->_formValues
[$fieldName]) && empty($field['options']) && empty($field['pseudoconstant'])) {
318 if (in_array($field['type'], [CRM_Utils_Type
::T_STRING
, CRM_Utils_Type
::T_TEXT
])) {
319 $this->_formValues
[$fieldName] = ['LIKE' => CRM_Contact_BAO_Query
::getWildCardedValue(TRUE, 'LIKE', trim($this->_formValues
[$fieldName]))];
327 * Add checkboxes for each row plus a master checkbox.
331 public function addRowSelectors($rows) {
332 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, ['class' => 'select-rows']);
334 foreach ($rows as $row) {
335 if (!empty($row['checkbox'])) {
336 $this->addElement('checkbox', $row['checkbox'], NULL, NULL, ['class' => 'select-row']);
343 * Add actions menu to search results form.
345 * @param array $tasks
347 public function addTaskMenu($tasks) {
349 foreach ($tasks as $key => $task) {
350 $taskMetaData[$key] = ['title' => $task];
352 parent
::addTaskMenu($taskMetaData);
356 * Add the sort-name field to the form.
358 * There is a setting to determine whether email is included in the search & we look this up to determine
359 * which text to choose.
361 * Note that for translation purposes the full string works better than using 'prefix' hence we use override-able functions
362 * to define the string.
364 protected function addSortNameField() {
365 $title = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']) ?
$this->getSortNameLabelWithEmail() : $this->getSortNameLabelWithOutEmail();
370 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
372 $this->searchFieldMetadata
['Contact']['sort_name'] = ['name' => 'sort_name', 'title' => $title, 'type' => CRM_Utils_Type
::T_STRING
];
376 * Get the label for the sortName field if email searching is on.
378 * (email searching is a setting under search preferences).
382 protected function getSortNameLabelWithEmail() {
383 return ts('Name or Email');
387 * Get the label for the sortName field if email searching is off.
389 * (email searching is a setting under search preferences).
393 protected function getSortNameLabelWithOutEmail() {
398 * Explicitly declare the form context for addField().
400 public function getDefaultContext() {
405 * Add generic fields that specify the contact.
407 protected function addContactSearchFields() {
408 if (!$this->isFormInViewOrEditMode()) {
411 $this->addSortNameField();
413 $this->_group
= CRM_Core_PseudoConstant
::nestedGroup();
415 $this->add('select', 'group', $this->getGroupLabel(), $this->_group
, FALSE,
418 'multiple' => 'multiple',
419 'class' => 'crm-select2',
424 $contactTags = CRM_Core_BAO_Tag
::getTags();
426 $this->add('select', 'contact_tags', $this->getTagLabel(), $contactTags, FALSE,
428 'id' => 'contact_tags',
429 'multiple' => 'multiple',
430 'class' => 'crm-select2',
434 $this->addField('contact_type', ['entity' => 'Contact']);
436 if (CRM_Core_Permission
::check('access deleted contacts') && Civi
::settings()->get('contact_undelete')) {
437 $this->addElement('checkbox', 'deleted_contacts', ts('Search in Trash') . '<br />' . ts('(deleted contacts)'));
443 * we allow the controller to set force/reset externally, useful when we are being
444 * driven by the wizard framework
446 protected function loadStandardSearchOptionsFromUrl() {
447 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean');
448 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
449 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
450 $this->_context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this, FALSE, 'search');
451 $this->_ssID
= CRM_Utils_Request
::retrieve('ssID', 'Positive', $this);
452 $this->assign("context", $this->_context
);
456 * Get user submitted values.
458 * Get it from controller only if form has been submitted, else preProcess has set this
460 protected function loadFormValues() {
461 if (!empty($_POST) && !$this->controller
->isModal()) {
462 $this->_formValues
= $this->controller
->exportValues($this->_name
);
465 $this->_formValues
= $this->get('formValues');
468 if (empty($this->_formValues
)) {
469 if (isset($this->_ssID
)) {
470 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
476 * Get the form values.
478 * @todo consolidate with loadFormValues()
482 * @throws \CRM_Core_Exception
484 protected function getFormValues() {
485 if (!empty($_POST) && !$this->_force
) {
486 return $this->controller
->exportValues($this->_name
);
489 return $this->setDefaultValues();
491 return (array) $this->get('formValues');
495 * Set the metadata for the form.
497 * @throws \CiviCRM_API3_Exception
499 protected function setSearchMetadata() {}
502 * Handle force=1 in the url.
504 * Search field metadata is normally added in buildForm but we are bypassing that in this flow
505 * (I've always found the flow kinda confusing & perhaps that is the problem but this mitigates)
507 * @throws \CiviCRM_API3_Exception
509 protected function handleForcedSearch() {
510 $this->setSearchMetadata();
511 $this->postProcess();
512 $this->set('force', 0);