Skip to content

Instantly share code, notes, and snippets.

@jonsa
Created August 30, 2017 20:13
Show Gist options
  • Save jonsa/4dc5fa25d44378b54b71f1f54a5b5496 to your computer and use it in GitHub Desktop.
Save jonsa/4dc5fa25d44378b54b71f1f54a5b5496 to your computer and use it in GitHub Desktop.
Xdebug ini doc WIP
[Xdebug]
;zend_extension=
; When this setting is set to on, the tracing of function calls will be enabled
; just before the script is run. This makes it possible to trace code in the
; auto_prepend_file.
;
; Type: boolean
; Default value: 0
;xdebug.auto_trace=
; If this setting is 1, Xdebug will color var_dumps and stack traces output
; when in CLI mode and when the output is a tty. On Windows, the ANSICON tool
; needs to be installed.
; http://adoxa.110mb.com/ansicon/
;
; If the setting is 2, then Xdebug will always color var_dumps and stack trace,
; no matter whether it's connected to a tty or whether ANSICON is installed. In
; this case, you might end up seeing escape codes.
;
; See this article for some more information.
; http://drck.me/clicolor-9cr
;
; Type: integer
; Default value: 0
; Introduced in Xdebug >= 2.2
;xdebug.cli_color=
; This setting, defaulting to 0, controls whether Xdebug should add variable
; assignments to function traces.
;
; Type: boolean
; Default value: 0
; Introduced in Xdebug >= 2.1
;xdebug.collect_assignments=
; This setting, defaulting to 1, controls whether Xdebug should write the
; filename used in include(), include_once(), require() or require_once() to
; the trace files.
;
; Type: boolean
; Default value: 1
;xdebug.collect_includes=
; This setting, defaulting to 0, controls whether Xdebug should collect the
; parameters passed to functions when a function call is recorded in either the
; function trace or the stack trace.
;
; The setting defaults to 0 because for very large scripts it may use huge
; amounts of memory and therefore make it impossible for the huge script to run.
; You can most safely turn this setting on, but you can expect some problems in
; scripts with a lot of function calls and/or huge data structures as
; parameters. Xdebug 2 will not have this problem with increased memory usage,
; as it will never store this information in memory. Instead it will only be
; written to disk. This means that you need to have a look at the disk usage
; though.
;
; This setting can have four different values. For each of the values a
; different amount of information is shown. Below you will see what information
; each of the values provides. See also the introduction of the feature Stack
; Traces for a few screenshots.
; https://xdebug.org/docs/stack_trace
;
; +-------+--------------------------------------------------------------------+
; | Value | Argument Information Shown |
; +-------+--------------------------------------------------------------------+
; | 0 | None. |
; +-------+--------------------------------------------------------------------+
; | 1 | Type and number of elements (f.e. string(6), array(8)). |
; +-------+--------------------------------------------------------------------+
; | 2 | Type and number of elements, with a tool tip for the full |
; | | information (1). |
; +-------+--------------------------------------------------------------------+
; | 3 | Full variable contents (with the limits respected as set by |
; | | xdebug.var_display_max_children, xdebug.var_display_max_data, |
; | | and xdebug.var_display_max_depth. |
; | | https://xdebug.org/docs/all_settings#var_display_max_children |
; | | https://xdebug.org/docs/all_settings#var_display_max_data |
; | | https://xdebug.org/docs/all_settings#var_display_max_depth |
; +-------+--------------------------------------------------------------------+
; | 4 | Full variable contents and variable name. |
; +-------+--------------------------------------------------------------------+
; | 5 | PHP serialized variable contents, without the name. |
; | | (New in Xdebug 2.3) |
; +-------+--------------------------------------------------------------------+
; (1) in the CLI version of PHP it will not have the tool tip, nor in output
; files.
;
; Type: integer
; Default value: 0
;xdebug.collect_params=
; This setting, defaulting to 0, controls whether Xdebug should write the return
; value of function calls to the trace files.
;
; For computerized trace files (xdebug.trace_format=1) this only works from
; Xdebug 2.3 onwards.
; https://xdebug.org/docs/all_settings#trace_format
;
; Type: boolean
; Default value: 0
;xdebug.collect_return=
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment