Developer.setting.php 5.32 KB
Newer Older
totten's avatar
totten committed
1 2 3
<?php
/*
 +--------------------------------------------------------------------+
totten's avatar
totten committed
4
 | CiviCRM version 5                                                  |
totten's avatar
totten committed
5
 +--------------------------------------------------------------------+
6
 | Copyright CiviCRM LLC (c) 2004-2019                                |
totten's avatar
totten committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
26
 */
totten's avatar
totten committed
27 28 29 30

/**
 *
 * @package CRM
31
 * @copyright CiviCRM LLC (c) 2004-2019
totten's avatar
totten committed
32 33 34 35 36 37 38
 * $Id$
 *
 */
/*
 * Settings metadata file
 */

39 40
return [
  'assetCache' => [
41 42 43 44 45 46
    'group_name' => 'Developer Preferences',
    'group' => 'developer',
    'name' => 'assetCache',
    'type' => 'String',
    'quick_form_type' => 'Select',
    'html_type' => 'Select',
47
    'html_attributes' => [
48
      //'class' => 'crm-select2',
49
    ],
50 51 52 53 54 55 56
    'default' => 'auto',
    'add' => '4.7',
    'title' => 'Asset Caching',
    'is_domain' => 1,
    'is_contact' => 0,
    'description' => 'Store computed JS/CSS content in cache files? (Note: In "Auto" mode, the "Debug" setting will determine whether to activate the cache.)',
    'help_text' => NULL,
57
    'pseudoconstant' => [
58
      'callback' => '\Civi\Core\AssetBuilder::getCacheModes',
59 60 61
    ],
  ],
  'userFrameworkLogging' => [
totten's avatar
totten committed
62 63
    'group_name' => 'Developer Preferences',
    'group' => 'developer',
JKingsnorth's avatar
JKingsnorth committed
64
    'name' => 'userFrameworkLogging',
totten's avatar
totten committed
65 66 67 68
    'type' => 'Boolean',
    'quick_form_type' => 'YesNo',
    'default' => '0',
    'add' => '4.3',
JKingsnorth's avatar
JKingsnorth committed
69
    'title' => 'Enable Drupal Watchdog Logging',
totten's avatar
totten committed
70 71
    'is_domain' => 1,
    'is_contact' => 0,
JKingsnorth's avatar
JKingsnorth committed
72 73
    'description' => "Set this value to Yes if you want CiviCRM error/debugging messages to appear in the Drupal error logs",
    'help_text' => "Set this value to Yes if you want CiviCRM error/debugging messages the appear in your CMS' error log. In the case of Drupal, this will cause all CiviCRM error messages to appear in the watchdog (assuming you have Drupal's watchdog enabled)",
74 75
  ],
  'debug_enabled' => [
totten's avatar
totten committed
76 77
    'group_name' => 'Developer Preferences',
    'group' => 'developer',
JKingsnorth's avatar
JKingsnorth committed
78
    'name' => 'debug_enabled',
79 80
    // we can't call the setting debug as that has other meanings in api
    'config_key' => 'debug',
totten's avatar
totten committed
81 82 83 84
    'type' => 'Boolean',
    'quick_form_type' => 'YesNo',
    'default' => '0',
    'add' => '4.3',
JKingsnorth's avatar
JKingsnorth committed
85
    'title' => 'Enable Debugging',
totten's avatar
totten committed
86 87
    'is_domain' => 1,
    'is_contact' => 0,
JKingsnorth's avatar
JKingsnorth committed
88 89
    'description' => "Set this value to Yes if you want to use one of CiviCRM's debugging tools. This feature should NOT be enabled for production sites",
    'help_text' => 'Do not turn this on on production sites',
90 91
  ],
  'backtrace' => [
totten's avatar
totten committed
92 93 94 95 96 97 98 99 100 101 102
    'group_name' => 'Developer Preferences',
    'group' => 'developer',
    'name' => 'backtrace',
    'type' => 'Boolean',
    'quick_form_type' => 'YesNo',
    'default' => '0',
    'add' => '4.3',
    'title' => 'Display Backtrace',
    'is_domain' => 1,
    'is_contact' => 0,
    'description' => "Set this value to Yes if you want to display a backtrace listing when a fatal error is encountered. This feature should NOT be enabled for production sites",
103 104
  ],
  'environment' => [
105 106 107 108 109 110 111
    'group_name' => 'Developer Preferences',
    'group' => 'developer',
    'name' => 'environment',
    'type' => 'String',
    'html_type' => 'Select',
    'quick_form_type' => 'Select',
    'default' => 'Production',
112
    'pseudoconstant' => [
113
      'optionGroupName' => 'environment',
114
    ],
115 116 117 118 119
    'add' => '4.7',
    'title' => 'Environment',
    'is_domain' => 1,
    'is_contact' => 0,
    'description' => "Setting to define the environment in which this CiviCRM instance is running.",
120
    'on_change' => [
deb.monish's avatar
deb.monish committed
121
      'CRM_Core_BAO_Setting::onChangeEnvironmentSetting',
122 123 124
    ],
  ],
  'fatalErrorHandler' => [
totten's avatar
totten committed
125 126 127 128
    'group_name' => 'Developer Preferences',
    'group' => 'developer',
    'name' => 'fatalErrorHandler',
    'type' => 'String',
129 130
    'quick_form_type' => 'Element',
    'html_type' => 'text',
totten's avatar
totten committed
131
    'default' => NULL,
totten's avatar
totten committed
132 133 134 135 136
    'add' => '4.3',
    'title' => 'Fatal Error Handler',
    'is_domain' => 1,
    'is_contact' => 0,
    'description' => "Enter the path and class for a custom PHP error-handling function if you want to override built-in CiviCRM error handling for your site.",
137 138
  ],
];