CRM/Core/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Base class for most search forms
  30  */
  31 class CRM_Core_Form_Search extends CRM_Core_Form {
  32
  33   /**
  34    * Are we forced to run a search
  35    *
  36    * @var int
  37    */
  38   protected $_force;
  39
  40   /**
  41    * Name of search button
  42    *
  43    * @var string
  44    */
  45   protected $_searchButtonName;
  46
  47   /**
  48    * Name of action button
  49    *
  50    * @var string
  51    */
  52   protected $_actionButtonName;
  53
  54   /**
  55    * Form values that we will be using
  56    *
  57    * @var array
  58    */
  59   public $_formValues;
  60
  61   /**
  62    * Have we already done this search
  63    *
  64    * @var boolean
  65    */
  66   protected $_done;
  67
  68   /**
  69    * What context are we being invoked from
  70    *
  71    * @var string
  72    */
  73   protected $_context = NULL;
  74
  75   /**
  76    * The list of tasks or actions that a searcher can perform on a result set.
  77    *
  78    * @var array
  79    */
  80   protected $_taskList = array();
  81
  82   /**
  83    * Declare entity reference fields as they will need to be converted.
  84    *
  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.
  87    *
  88    * @var array
  89    */
  90   protected $entityReferenceFields = array();
  91
  92   /**
  93    * Builds the list of tasks or actions that a searcher can perform on a result set.
  94    *
  95    * To modify the task list, child classes should alter $this->_taskList,
  96    * preferably by extending this method.
  97    *
  98    * @return array
  99    */
 100   protected function buildTaskList() {
 101     return $this->_taskList;
 102   }
 103
 104   /**
 105    * Metadata for fields on the search form.
 106    *
 107    * @var array
 108    */
 109   protected $searchFieldMetadata = [];
 110
 111   /**
 112    * @return array
 113    */
 114   public function getSearchFieldMetadata() {
 115     return $this->searchFieldMetadata;
 116   }
 117
 118   /**
 119    * @param array $searchFieldMetadata
 120    */
 121   public function addSearchFieldMetadata($searchFieldMetadata) {
 122     $this->searchFieldMetadata = array_merge($this->searchFieldMetadata, $searchFieldMetadata);
 123   }
 124
 125   /**
 126    * Common buildForm tasks required by all searches.
 127    */
 128   public function buildQuickform() {
 129     CRM_Core_Resources::singleton()
 130       ->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header')
 131       ->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
 132
 133     $this->addButtons(array(
 134       array(
 135         'type' => 'refresh',
 136         'name' => ts('Search'),
 137         'isDefault' => TRUE,
 138       ),
 139     ));
 140
 141     $this->addClass('crm-search-form');
 142
 143     $tasks = $this->buildTaskList();
 144     $this->addTaskMenu($tasks);
 145   }
 146
 147   /**
 148    * Add any fields described in metadata to the form.
 149    *
 150    * The goal is to describe all fields in metadata and handle from metadata rather
 151    * than existing ad hoc handling.
 152    */
 153   public function addFormFieldsFromMetadata() {
 154     $this->_action = CRM_Core_Action::ADVANCED;
 155     foreach ($this->getSearchFieldMetadata() as $entity => $fields) {
 156       foreach ($fields as $fieldName => $fieldSpec) {
 157         if ($fieldSpec['type'] === CRM_Utils_Type::T_DATE) {
 158           // Assuming time is false for now as we are not checking for date-time fields as yet.
 159           $this->addDatePickerRange($fieldName, $fieldSpec['title'], FALSE);
 160         }
 161         else {
 162           $this->addField($fieldName, ['entity' => $entity]);
 163         }
 164       }
 165     }
 166   }
 167
 168   /**
 169    * Get the validation rule to apply to a function.
 170    *
 171    * Alphanumeric is designed to always be safe & for now we just return
 172    * that but in future we can use tighter rules for types like int, bool etc.
 173    *
 174    * @param string $entity
 175    * @param string $fieldName
 176    *
 177    * @return string
 178    */
 179   protected function getValidationTypeForField($entity, $fieldName) {
 180     switch ($this->getSearchFieldMetadata()[$entity][$fieldName]['type']) {
 181       case CRM_Utils_Type::T_BOOLEAN:
 182         return 'Boolean';
 183
 184       case CRM_Utils_Type::T_INT:
 185         return 'CommaSeparatedIntegers';
 186
 187       default:
 188         return 'Alphanumeric';
 189     }
 190   }
 191
 192   /**
 193    * Get the defaults for the entity for any fields described in metadata.
 194    *
 195    * @param string $entity
 196    *
 197    * @return array
 198    */
 199   protected function getEntityDefaults($entity) {
 200     $defaults = [];
 201     foreach ($this->getSearchFieldMetadata()[$entity] as $fieldSpec) {
 202       if (empty($_POST[$fieldSpec['name']])) {
 203         $value = CRM_Utils_Request::retrieveValue($fieldSpec['name'], $this->getValidationTypeForField($entity, $fieldSpec['name']), FALSE, NULL, 'GET');
 204         if ($value !== FALSE) {
 205           $defaults[$fieldSpec['name']] = $value;
 206         }
 207       }
 208     }
 209     return $defaults;
 210   }
 211
 212   /**
 213    * Add checkboxes for each row plus a master checkbox.
 214    *
 215    * @param array $rows
 216    */
 217   public function addRowSelectors($rows) {
 218     $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
 219     if (!empty($rows)) {
 220       foreach ($rows as $row) {
 221         if (CRM_Utils_Array::value('checkbox', $row)) {
 222           $this->addElement('checkbox', $row['checkbox'], NULL, NULL, array('class' => 'select-row'));
 223         }
 224       }
 225     }
 226   }
 227
 228   /**
 229    * Add actions menu to search results form.
 230    *
 231    * @param array $tasks
 232    */
 233   public function addTaskMenu($tasks) {
 234     $taskMetaData = array();
 235     foreach ($tasks as $key => $task) {
 236       $taskMetaData[$key] = array('title' => $task);
 237     }
 238     parent::addTaskMenu($taskMetaData);
 239   }
 240
 241   /**
 242    * Add the sort-name field to the form.
 243    *
 244    * There is a setting to determine whether email is included in the search & we look this up to determine
 245    * which text to choose.
 246    *
 247    * Note that for translation purposes the full string works better than using 'prefix' hence we use override-able functions
 248    * to define the string.
 249    */
 250   protected function addSortNameField() {
 251     $this->addElement(
 252       'text',
 253       'sort_name',
 254       civicrm_api3('setting', 'getvalue', array('name' => 'includeEmailInName', 'group' => 'Search Preferences')) ? $this->getSortNameLabelWithEmail() : $this->getSortNameLabelWithOutEmail(),
 255       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
 256     );
 257   }
 258
 259   /**
 260    * Get the label for the sortName field if email searching is on.
 261    *
 262    * (email searching is a setting under search preferences).
 263    *
 264    * @return string
 265    */
 266   protected function getSortNameLabelWithEmail() {
 267     return ts('Name or Email');
 268   }
 269
 270   /**
 271    * Get the label for the sortName field if email searching is off.
 272    *
 273    * (email searching is a setting under search preferences).
 274    *
 275    * @return string
 276    */
 277   protected function getSortNameLabelWithOutEmail() {
 278     return ts('Name');
 279   }
 280
 281   /**
 282    * Explicitly declare the form context for addField().
 283    */
 284   public function getDefaultContext() {
 285     return 'search';
 286   }
 287
 288   /**
 289    * Add generic fields that specify the contact.
 290    */
 291   protected function addContactSearchFields() {
 292     if (!$this->isFormInViewOrEditMode()) {
 293       return;
 294     }
 295     $this->addSortNameField();
 296
 297     $this->_group = CRM_Core_PseudoConstant::nestedGroup();
 298     if ($this->_group) {
 299       $this->add('select', 'group', $this->getGroupLabel(), $this->_group, FALSE,
 300         array(
 301           'id' => 'group',
 302           'multiple' => 'multiple',
 303           'class' => 'crm-select2',
 304         )
 305       );
 306     }
 307
 308     $contactTags = CRM_Core_BAO_Tag::getTags();
 309     if ($contactTags) {
 310       $this->add('select', 'contact_tags', $this->getTagLabel(), $contactTags, FALSE,
 311         array(
 312           'id' => 'contact_tags',
 313           'multiple' => 'multiple',
 314           'class' => 'crm-select2',
 315         )
 316       );
 317     }
 318     $this->addField('contact_type', array('entity' => 'Contact'));
 319
 320     if (CRM_Core_Permission::check('access deleted contacts') && Civi::settings()->get('contact_undelete')) {
 321       $this->addElement('checkbox', 'deleted_contacts', ts('Search in Trash') . '<br />' . ts('(deleted contacts)'));
 322     }
 323
 324   }
 325
 326   /**
 327    * we allow the controller to set force/reset externally, useful when we are being
 328    * driven by the wizard framework
 329    */
 330   protected function loadStandardSearchOptionsFromUrl() {
 331     $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean');
 332     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
 333     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
 334     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'search');
 335     $this->_ssID = CRM_Utils_Request::retrieve('ssID', 'Positive', $this);
 336     $this->assign("context", $this->_context);
 337   }
 338
 339   /**
 340    * Get user submitted values.
 341    *
 342    * Get it from controller only if form has been submitted, else preProcess has set this
 343    */
 344   protected function loadFormValues() {
 345     if (!empty($_POST)  && !$this->controller->isModal()) {
 346       $this->_formValues = $this->controller->exportValues($this->_name);
 347     }
 348     else {
 349       $this->_formValues = $this->get('formValues');
 350     }
 351
 352     if (empty($this->_formValues)) {
 353       if (isset($this->_ssID)) {
 354         $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 355       }
 356     }
 357   }
 358
 359 }