CRM/Admin/Form/Setting/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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class generates form components for Search Parameters
  36  *
  37  */
  38 class CRM_Admin_Form_Setting_Search extends CRM_Admin_Form_Setting {
  39
  40   protected $_settings = array(
  41     'contact_reference_options' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  42     'contact_autocomplete_options' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  43     'search_autocomplete_count' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  44     'enable_innodb_fts' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  45     'includeWildCardInName' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  46     'includeEmailInName' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  47     'includeNickNameInName' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  48     'includeAlphabeticalPager' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  49     'includeOrderByClause' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  50     'smartGroupCacheTimeout' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  51     'defaultSearchProfileID' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  52     'searchPrimaryDetailsOnly' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  53     'quicksearch_options' => CRM_Core_BAO_Setting::SEARCH_PREFERENCES_NAME,
  54   );
  55
  56   /**
  57    * Build the form object.
  58    */
  59   public function buildQuickForm() {
  60     CRM_Utils_System::setTitle(ts('Settings - Search Preferences'));
  61
  62     parent::buildQuickForm();
  63
  64     // @todo remove the following adds in favour of setting via the settings array (above).
  65
  66     // Autocomplete for Contact Search (quick search etc.)
  67     $element = $this->getElement('contact_autocomplete_options');
  68     $element->_elements[0]->_flagFrozen = TRUE;
  69
  70     // Autocomplete for Contact Reference (custom fields)
  71     $element = $this->getElement('contact_reference_options');
  72     $element->_elements[0]->_flagFrozen = TRUE;
  73
  74     // Freeze first element of quicksearch options
  75     $element = $this->getElement('quicksearch_options');
  76     $element->_elements[0]->_flagFrozen = TRUE;
  77   }
  78
  79   /**
  80    * @return array
  81    */
  82   public static function getContactAutocompleteOptions() {
  83     return [1 => ts('Contact Name')] + CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, TRUE);
  84   }
  85
  86   /**
  87    * @return array
  88    */
  89   public static function getAvailableProfiles() {
  90     return array('' => ts('- none -')) + CRM_Core_BAO_UFGroup::getProfiles(array(
  91       'Contact',
  92       'Individual',
  93       'Organization',
  94       'Household',
  95     ));
  96   }
  97
  98   /**
  99    * @return array
 100    */
 101   public static function getContactReferenceOptions() {
 102     return [1 => ts('Contact Name')] + CRM_Core_OptionGroup::values('contact_reference_options', FALSE, FALSE, TRUE);
 103   }
 104
 105 }