settings/Search.setting.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35 /*
  36  * Settings metadata file
  37  */
  38 return array(
  39   'search_autocomplete_count' => array(
  40     'group_name' => 'Search Preferences',
  41     'group' => 'Search Preferences',
  42     'name' => 'search_autocomplete_count',
  43     'prefetch' => 0,
  44     'type' => 'Integer',
  45     'quick_form_type' => 'Element',
  46     'html_type' => 'text',
  47     'html_attributes' => array(
  48       'size' => 2,
  49       'maxlength' => 2,
  50     ),
  51     'default' => 10,
  52     'add' => '4.3',
  53     'title' => 'Autocomplete Results',
  54     'is_domain' => 1,
  55     'is_contact' => 0,
  56     'description' => 'The maximum number of contacts to show at a time when typing in an autocomplete field.',
  57     'help_text' => NULL,
  58   ),
  59   'enable_innodb_fts' => array(
  60     'group_name' => 'Search Preferences',
  61     'group' => 'Search Preferences',
  62     'name' => 'enable_innodb_fts',
  63     'prefetch' => 0,
  64     'type' => 'Boolean',
  65     'quick_form_type' => 'YesNo',
  66     'default' => 0,
  67     'add' => '4.4',
  68     'title' => 'InnoDB Full Text Search',
  69     'is_domain' => 1,
  70     'is_contact' => 0,
  71     'description' => "Enable InnoDB full-text search optimizations. (Requires MySQL 5.6+)",
  72     'help_text' => NULL,
  73     'on_change' => array(
  74       array('CRM_Core_InnoDBIndexer', 'onToggleFts'),
  75     ),
  76   ),
  77   'fts_query_mode' => array(
  78     'group_name' => 'Search Preferences',
  79     'group' => 'Search Preferences',
  80     'name' => 'fts_query_mode',
  81     'prefetch' => 0,
  82     'type' => 'String',
  83     'quick_form_type' => 'Element',
  84     'html_attributes' => array(
  85       'size' => 64,
  86       'maxlength' => 64,
  87     ),
  88     'html_type' => 'Text',
  89     'default' => 'simple',
  90     'add' => '4.5',
  91     'title' => 'How to handle full-tet queries',
  92     'is_domain' => 1,
  93     'is_contact' => 0,
  94     'description' => NULL,
  95     'help_text' => NULL,
  96   ),
  97   'includeOrderByClause' => array(
  98     'group_name' => 'Search Preferences',
  99     'group' => 'Search Preferences',
 100     'name' => 'includeOrderByClause',
 101     'prefetch' => 1,
 102     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 103     'config_only' => 1,
 104     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 105     'type' => 'Boolean',
 106     'quick_form_type' => 'YesNo',
 107     'default' => 1,
 108     'add' => '4.6',
 109     'title' => 'Include Order By Clause',
 110     'is_domain' => 1,
 111     'is_contact' => 0,
 112     'description' => 'If disabled, the search results will not be ordered. This may improve response time on search results on large datasets',
 113     'help_text' => NULL,
 114   ),
 115   'includeWildCardInName' => array(
 116     'group_name' => 'Search Preferences',
 117     'group' => 'Search Preferences',
 118     'name' => 'includeWildCardInName',
 119     'prefetch' => 1,
 120     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 121     'config_only' => 1,
 122     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 123     'type' => 'Boolean',
 124     'quick_form_type' => 'YesNo',
 125     'default' => 1,
 126     'add' => '4.6',
 127     'title' => 'Automatic Wildcard',
 128     'is_domain' => 1,
 129     'is_contact' => 0,
 130     'description' => "If enabled, wildcards are automatically added to the beginning AND end of the search term when users search for contacts by Name. EXAMPLE: Searching for 'ada' will return any contact whose name includes those letters - e.g. 'Adams, Janet', 'Nadal, Jorge', etc. If disabled, a wildcard is added to the end of the search term only. EXAMPLE: Searching for 'ada' will return any contact whose last name begins with those letters - e.g. 'Adams, Janet' but NOT 'Nadal, Jorge'. Disabling this feature will speed up search significantly for larger databases, but users must manually enter wildcards ('%' or '_') to the beginning of the search term if they want to find all records which contain those letters. EXAMPLE: '%ada' will return 'Nadal, Jorge'.",
 131     'help_text' => NULL,
 132   ),
 133   'includeEmailInName' => array(
 134     'group_name' => 'Search Preferences',
 135     'group' => 'Search Preferences',
 136     'name' => 'includeEmailInName',
 137     'prefetch' => 1,
 138     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 139     'config_only' => 1,
 140     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 141     'type' => 'Boolean',
 142     'quick_form_type' => 'YesNo',
 143     'default' => 1,
 144     'add' => '4.6',
 145     'title' => 'Include Email',
 146     'is_domain' => 1,
 147     'is_contact' => 0,
 148     'description' => 'If enabled, email addresses are automatically included when users search by Name. Disabling this feature will speed up search significantly for larger databases, but users will need to use the Email search fields (from Advanced Search, Search Builder, or Profiles) to find contacts by email address.',
 149     'help_text' => NULL,
 150   ),
 151   'includeNickNameInName' => array(
 152     'group_name' => 'Search Preferences',
 153     'group' => 'Search Preferences',
 154     'name' => 'includeNickNameInName',
 155     'prefetch' => 1,
 156     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 157     'config_only' => 1,
 158     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 159     'type' => 'Boolean',
 160     'quick_form_type' => 'YesNo',
 161     'default' => 1,
 162     'add' => '4.6',
 163     'title' => 'Include Nickname',
 164     'is_domain' => 1,
 165     'is_contact' => 0,
 166     'description' => 'If enabled, nicknames are automatically included when users search by Name.',
 167     'help_text' => NULL,
 168   ),
 169   'includeAlphabeticalPager' => array(
 170     'group_name' => 'Search Preferences',
 171     'group' => 'Search Preferences',
 172     'name' => 'includeAlphabeticalPager',
 173     'prefetch' => 1,
 174     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 175     'config_only' => 1,
 176     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 177     'type' => 'Boolean',
 178     'quick_form_type' => 'YesNo',
 179     'default' => 1,
 180     'add' => '4.6',
 181     'title' => 'Include Alphabetical Pager',
 182     'is_domain' => 1,
 183     'is_contact' => 0,
 184     'description' => 'If disabled, the alphabetical pager will not be displayed on the search screens. This will improve response time on search results on large datasets.',
 185     'help_text' => NULL,
 186   ),
 187   'smartGroupCacheTimeout' => array(
 188     'group_name' => 'Search Preferences',
 189     'group' => 'Search Preferences',
 190     'name' => 'smartGroupCacheTimeout',
 191     'prefetch' => 1,
 192     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 193     'config_only' => 1,
 194     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 195     'type' => 'Integer',
 196     'quick_form_type' => 'Text',
 197     'default' => 1,
 198     'add' => '4.6',
 199     'title' => 'Smart group cache timeout',
 200     'is_domain' => 1,
 201     'is_contact' => 0,
 202     'description' => 'The number of minutes to cache smart group contacts. We strongly recommend that this value be greater than zero, since a value of zero means no caching at all. If your contact data changes frequently, you should set this value to at least 5 minutes.',
 203     'help_text' => NULL,
 204   ),
 205   'defaultSearchProfileID' => array(
 206     'group_name' => 'Search Preferences',
 207     'group' => 'Search Preferences',
 208     'name' => 'defaultSearchProfileID',
 209     'prefetch' => 1,
 210     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 211     'config_only' => 1,
 212     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 213     'type' => 'Integer',
 214     'quick_form_type' => 'Text',
 215     'default' => 1,
 216     'add' => '4.6',
 217     'title' => 'Default Contact Search Profile',
 218     'is_domain' => 1,
 219     'is_contact' => 0,
 220     'description' => 'If set, this will be the default profile used for contact search.',
 221     'help_text' => NULL,
 222   ),
 223   'autocompleteContactSearch' => array(
 224     'group_name' => 'Search Preferences',
 225     'group' => 'Search Preferences',
 226     'name' => 'autocompleteContactSearch',
 227     'prefetch' => 1,
 228     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 229     'config_only' => 1,
 230     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 231     'type' => 'Integer',
 232     'quick_form_type' => 'CheckBox',
 233     'default' => 1,
 234     'add' => '4.6',
 235     'title' => 'Autocomplete Contact Search',
 236     'pseudoconstant' => array('optionGroupName' => 'contact_autocomplete_options'),
 237     'is_domain' => 1,
 238     'is_contact' => 0,
 239     'description' => "Selected fields will be displayed in back-office autocomplete dropdown search results (Quick Search, etc.). Contact Name is always included.",
 240     'help_text' => NULL,
 241   ),
 242   'autocompleteContactReference' => array(
 243     'group_name' => 'Search Preferences',
 244     'group' => 'Search Preferences',
 245     'name' => 'autocompleteContactReference',
 246     'prefetch' => 1,
 247     // prefetch causes it to be cached in config settings. Usually this is a transitional setting. Some things like urls are permanent. Remove this comment if you have assessed & it should be permanent
 248     'config_only' => 1,
 249     //@todo - see https://wiki.civicrm.org/confluence/display/CRMDOC/Settings+Reference#SettingsReference-Convertingaconfigobjecttoasetting on removing this deprecated value
 250     'type' => 'Integer',
 251     'quick_form_type' => 'CheckBox',
 252     'default' => 1,
 253     'add' => '4.6',
 254     'title' => 'Contact Reference Options',
 255     'pseudoconstant' => array('optionGroupName' => 'contact_reference_options'),
 256     'is_domain' => 1,
 257     'is_contact' => 0,
 258     'description' => "Selected fields will be displayed in autocomplete dropdown search results for 'Contact Reference' custom fields. Contact Name is always included. NOTE: You must assign 'access contact reference fields' permission to the anonymous role if you want to use custom contact reference fields in profiles on public pages. For most situations, you should use the 'Limit List to Group' setting when configuring a contact reference field which will be used in public forms to prevent exposing your entire contact list.",
 259     'help_text' => NULL,
 260   ),
 261 );