site.ini [DebugSettings] #

The block [DebugSettings] of settings/site.ini, with 17 setting(s).

Never edit settings/site.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/site.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/site.ini.append.php for one siteaccess,
• extension/<extension>/settings/site.ini.append.php in an extension (read when the extension is active).

DebugOutput #

Master switch for debug, if disabled no debug will be shown
If enabled it's up to the DebugByIP and DebugIPList to decide what to do.
Use either enabled or disabled

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DebugOutput=disabled
*/ ?>

AlwaysLog #

Controls which debug types to always log.
This ensures logging even if debug output is off

Available debug types are:
error - For major errors, very important to log
warning - Smaller errors, important for development but not for live site
debug - Temporary debug, usually only important to see in the web browser
notice - General notices, enabling this can fill up the log files quickly
strict - Strict notices, suggests changes to your code which will ensure the best interoperability and forward compatibility
deprecated - PHP deprecations (with DeprecatedLog=enabled), each distinct message once per request

Default: a list of 1: error.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
# an empty "AlwaysLog[]" first replaces the shipped list; without it the items are added
AlwaysLog[]
AlwaysLog[]=error
*/ ?>

DeprecatedLog #

PHP deprecations (E_DEPRECATED, E_USER_DEPRECATED, eZDebug::writeDeprecated()).
enabled: written to var/log/deprecated.log, each distinct message once per
request, and only counted in the debug output (the debug bar's summary and
the warning count); none is kept in memory or listed with the messages.
disabled: warnings in warning.log and the debug output, as before.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DeprecatedLog=enabled
*/ ?>

ScriptDebugOutput #

Debug switch for scripts, will only take place if DebugOutput is set to enabled
By default it is off to not give debug for scripts.
Use either enabled or disabled

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
ScriptDebugOutput=disabled
*/ ?>

DebugByIP #

Whether debug is set per IP address. If set to enabled it will user
DebugIPList for valid ips otherwise all ips get debug.
Use either enabled or disabled

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DebugByIP=disabled
*/ ?>

DebugIPList #

A array with IP addresses or networks which will get debug information

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
# an empty "DebugIPList[]" first replaces the shipped list; without it the items are added
DebugIPList[]
*/ ?>

DebugByUser #

Examples
DebugIPList[]=1.2.3.4
DebugIPList[]=192.0.0.42
DebugIPList[]=192.0.0.0/27
Whether debug is set per UserID. If set to enabled only users with
IDs (in DebugUserIDList) can get debug.
Use either enabled or disabled

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DebugByUser=disabled
*/ ?>

DebugUserIDList #

An array with UserIDs which will get debug information

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
# an empty "DebugUserIDList[]" first replaces the shipped list; without it the items are added
DebugUserIDList[]
*/ ?>

CollectStatsPolicyList #

Examples
DebugUserIDList[]=14
Signed-in users who hold one of these policies (module/function) get each
request's statistics collected without any debug output: page time, SQL
statements, the content view cache, cache-blocks and the template tree, as
the debug bar shows them. Nothing is printed and no debug message is kept;
a tool of theirs shows the figures (the website sidebar's Performance panel
adds expwt/performance here). Empty: only with debug output on.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
# an empty "CollectStatsPolicyList[]" first replaces the shipped list; without it the items are added
CollectStatsPolicyList[]
*/ ?>

Debug #

Examples
CollectStatsPolicyList[]=expwt/performance
Controls how debug is displayed, inline means that the debug is displayed in
page itself while popup will create a new popup window with the debug.
Popup window might not work in all browsers.
Use either disabled, inline or popup
If you use popup you must make sure that a rewrite rules exists for .html files
or that your site is running in non-virtual host mode. Also some browsers
have problems with this feature.

Default: inline.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
Debug=inline
*/ ?>

DebugRedirection #

Controls if redirects should be debuggable, set to enable to get a redirect
page with debug info.
This is useful for development while production sites should have it off

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DebugRedirection=disabled
*/ ?>

DisplayDebugWarnings #

Whether debug warnings/errors should be displayed on the page or not.
If not they will appear in debug log only.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DisplayDebugWarnings=disabled
*/ ?>

DebugLogOnly #

Whether to skip showing debug strings in the debug output.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DebugLogOnly=disabled
*/ ?>

DebugToolbar #

Developer toolbar with clear cache and quick settings features

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DebugToolbar=enabled
*/ ?>

DisplayIncludedFiles #

Display list of php included files used to render the current page

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
DisplayIncludedFiles=disabled
*/ ?>

QuickSettingsList #

Quick settings list for the developer toolbar
You can use any enabled/disabled setting

Default: a list of 6: DebugSettings;DebugOutput;site.ini;Debug output, DebugSettings;DebugRedirection;site.ini;Debug redirection, TemplateSettings;Debug;site.ini;Template debug, TemplateSettings;ShowXHTMLCode;site.ini;Inline template debug, TemplateSettings;ShowUsedTemplates;site.ini;List of used templates, DatabaseSettings;SQLOutput;site.ini;SQL debug output.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
# an empty "QuickSettingsList[]" first replaces the shipped list; without it the items are added
QuickSettingsList[]
QuickSettingsList[]=DebugSettings;DebugOutput;site.ini;Debug output
QuickSettingsList[]=DebugSettings;DebugRedirection;site.ini;Debug redirection
QuickSettingsList[]=TemplateSettings;Debug;site.ini;Template debug
QuickSettingsList[]=TemplateSettings;ShowXHTMLCode;site.ini;Inline template debug
QuickSettingsList[]=TemplateSettings;ShowUsedTemplates;site.ini;List of used templates
QuickSettingsList[]=DatabaseSettings;SQLOutput;site.ini;SQL debug output
*/ ?>

UsedTemplateEditUrl #

The link of each template's "Edit" icon in the debug output's list of used
templates (TemplateSettings ShowUsedTemplates), as a sprintf() format:
%1$s the address of visual/templateedit in the current siteaccess followed
by the template file, e.g. /visual/templateedit/design/standard/templates/page.tpl
%2$s the current siteaccess
%3$s the template file, for example design/standard/templates/page.tpl
Empty (the default): %1$s/(siteAccess)/%2$s, the link the list always had.
Example, the editor of the admin siteaccess from a public siteaccess:
UsedTemplateEditUrl=/admin/visual/templateedit/%3$s/(siteAccess)/%2$s

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DebugSettings]
UsedTemplateEditUrl=
*/ ?>

Related #

• All blocks of site.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/site.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.