forked from xdebug/xdebug
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xdebug.ini
1102 lines (1045 loc) · 40.8 KB
/
xdebug.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
; This file is generated by the 'xdebug.org:html/docs/convert.php' robot
; for Xdebug 3.0.0-dev — do not modify by hand
; -----------------------------------------------------------------------------
; xdebug.auto_trace
;
; Type: boolean, Default value: false
;
; 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 [1].
;
; [1] https://www.php.net/manual/ini.core.php#ini.auto-prepend-file
;
;
;xdebug.auto_trace = false
; -----------------------------------------------------------------------------
; xdebug.cli_color
;
; Introduced in version 2.2
;
; Type: integer, Default value: 0
;
; 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 [1] tool
; needs to be installed.
;
; [1] http://adoxa.altervista.org/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 [1] for some more information.
;
; [1] https://derickrethans.nl/cli-color.html
;
;
;xdebug.cli_color = 0
; -----------------------------------------------------------------------------
; xdebug.collect_assignments
;
; Introduced in version 2.1
;
; Type: boolean, Default value: false
;
; This setting, defaulting to 0, controls whether Xdebug should add variable
; assignments to function traces.
;
; From Xdebug 2.6, assign-by-var ( ``=&``) assignments are included too.
;
;
;xdebug.collect_assignments = false
; -----------------------------------------------------------------------------
; xdebug.collect_includes
;
; Type: boolean, Default value: true
;
; 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.
;
;
;xdebug.collect_includes = true
; -----------------------------------------------------------------------------
; xdebug.collect_params
;
; Type: integer, Default value: 0
;
; 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.
;
; ===== ========================================================================
; 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.
; ----- ------------------------------------------------------------------------
; 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.
;
;
;xdebug.collect_params = 0
; -----------------------------------------------------------------------------
; xdebug.collect_return
;
; Type: boolean, Default value: false
;
; 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.
;
;
;xdebug.collect_return = false
; -----------------------------------------------------------------------------
; xdebug.collect_vars
;
; Type: boolean, Default value: false
;
; This setting tells Xdebug to gather information about which variables are used
; in a certain scope. This analysis can be quite slow as Xdebug has to reverse
; engineer PHP's opcode arrays. This setting will not record which values the
; different variables have, for that use xdebug.collect_params. This setting
; needs to be enabled only if you wish to use xdebug_get_declared_vars().
;
;
;xdebug.collect_vars = false
; -----------------------------------------------------------------------------
; xdebug.coverage_enable
;
; Introduced in version 2.2
;
; Type: boolean, Default value: true
;
; If this setting is set to ``false``, then Xdebug will not set-up internal
; structures to allow code coverage. This speeds up Xdebug quite a bit, but of
; course, Code Coverage Analysis won't work.
;
;
;xdebug.coverage_enable = true
; -----------------------------------------------------------------------------
; xdebug.default_enable
;
; Type: boolean, Default value: true
;
; If this setting is 1, then stacktraces will be shown by default on an error
; event. You can disable showing stacktraces from your code with
; xdebug_disable(). As this is one of the basic functions of Xdebug, it is
; advisable to leave this setting set to 1.
;
;
;xdebug.default_enable = true
; -----------------------------------------------------------------------------
; xdebug.dump.*
;
; Type: string, Default value: Empty
;
; * can be any of COOKIE, FILES, GET, POST, REQUEST, SERVER, SESSION. These
; seven settings control which data from the superglobals is shown when an error
; situation occurs.
;
; Each of those php.ini setting can consist of a comma seperated list of
; variables from this superglobal to dump, or ``*`` for all of them. Make sure
; you do not add spaces in this setting.
;
; In order to dump the REMOTE_ADDR and the REQUEST_METHOD when an error occurs,
; and all GET parameters, add these settings:
;
; xdebug.dump.SERVER = REMOTE_ADDR,REQUEST_METHOD
; xdebug.dump.GET = *
;
;
;xdebug.dump.* = Empty
; -----------------------------------------------------------------------------
; xdebug.dump_globals
;
; Type: boolean, Default value: true
;
; When this setting is set to ``true``, Xdebug adds the values of the super
; globals as configured through the xdebug.dump.* to on-screen stack traces and
; the error log (if enabled).
;
;
;xdebug.dump_globals = true
; -----------------------------------------------------------------------------
; xdebug.dump_once
;
; Type: boolean, Default value: true
;
; Controls whether the values of the superglobals should be dumped on all error
; situations (set to 0) or only on the first (set to 1).
;
;
;xdebug.dump_once = true
; -----------------------------------------------------------------------------
; xdebug.dump_undefined
;
; Type: boolean, Default value: false
;
; If you want to dump undefined values from the superglobals you should set this
; setting to 1, otherwise leave it set to 0.
;
;
;xdebug.dump_undefined = false
; -----------------------------------------------------------------------------
; xdebug.file_link_format
;
; Introduced in version 2.1
;
; Type: string, Default value:
;
; This setting determines the format of the links that are made in the display
; of stack traces where file names are used. This allows IDEs to set up a
; link-protocol that makes it possible to go directly to a line and file by
; clicking on the filenames that Xdebug shows in stack traces. An example format
; might look like:
;
; myide://%f@%l
;
; The possible format specifiers are:
;
; ========= ===============
; Specifier Meaning
; ========= ===============
; %f the filename
; --------- ---------------
; %l the line number
; ========= ===============
;
; For various IDEs/OSses there are some instructions listed on how to make this
; work:
;
; ----------------
; Firefox on Linux
; ----------------
;
; - Open
;
; about:config
;
; - Add a new boolean setting "network.protocol-handler.expose.xdebug" and set
; it to "false"
;
; - Add the following into a shell script
;
; ``~/bin/ff-xdebug.sh``:
;
; #! /bin/sh
;
; f=`echo $1 | cut -d @ -f 1 | sed 's/xdebug:\/\///'`
; l=`echo $1 | cut -d @ -f 2`
;
; Add to that one of (depending whether you have komodo, gvim or netbeans):
;
; - komodo $f -l $l
;
; - gvim --remote-tab +$l $f
;
; - netbeans "$f:$l"
;
; - Make the script executable with
;
; chmod +x ~/bin/ff-xdebug.sh
;
; - Set the xdebug.file_link_format setting to
;
; xdebug://%f@%l
;
; --------------------
; Windows and netbeans
; --------------------
;
; - Create the file
;
; ``netbeans.bat`` and save it in your path ( ``C:\Windows`` will work):
;
; @echo off
; setlocal enableextensions enabledelayedexpansion
; set NETBEANS=%1
; set FILE=%~2
; %NETBEANS% --nosplash --console suppress --open "%FILE:~19%"
; nircmd win activate process netbeans.exe
;
; **Note:** Remove the last line if you don't have ``nircmd``.
;
; - Save the following code as
;
; ``netbeans_protocol.reg``:
;
; Windows Registry Editor Version 5.00
;
; [HKEY_CLASSES_ROOT\netbeans]
; "URL Protocol"=""
; @="URL:Netbeans Protocol"
;
; [HKEY_CLASSES_ROOT\netbeans\DefaultIcon]
; @="\"C:\\Program Files\\NetBeans 7.1.1\\bin\\netbeans.exe,1\""
;
; [HKEY_CLASSES_ROOT\netbeans\shell]
;
; [HKEY_CLASSES_ROOT\netbeans\shell\open]
;
; [HKEY_CLASSES_ROOT\netbeans\shell\open\command]
; @="\"C:\\Windows\\netbeans.bat\" \"C:\\Program Files\\NetBeans 7.1.1\\bin\\netbeans.exe\" \"%1\""
;
; **Note:** Make sure to change the path to Netbeans (twice), as well as the
; ``netbeans.bat`` batch file if you saved it somewhere else than
; ``C:\Windows\``.
;
; - Double click on the
;
; ``netbeans_protocol.reg`` file to import it into the registry.
;
; - Set the xdebug.file_link_format setting to
;
; xdebug.file_link_format =
; "netbeans://open/?f=%f:%l"
;
;
;xdebug.file_link_format =
; -----------------------------------------------------------------------------
; xdebug.filename_format
;
; Introduced in version 2.6
;
; Type: string, Default value: ...%s%n
;
; This setting determines the format with which Xdebug renders filenames in HTML
; stack traces (default: ``...%s%n``) and location information through the
; overloaded xdebug_var_dump() (default: ``%f``).
;
; The possible format specifiers are listed in this table. The example output is
; rendered according to the full path
; ``/var/www/vendor/mail/transport/mta.php``.
;
; ========= ============================================== ===========================================================
; Specifier Meaning Example Output
; ========= ============================================== ===========================================================
; %a Ancester: Two directory elements and filename mail/transport/mta.php
; --------- ---------------------------------------------- -----------------------------------------------------------
; %f Full path /var/www/vendor/mail/transport/mta.php
; --------- ---------------------------------------------- -----------------------------------------------------------
; %n Name: Only the file name mta.php
; --------- ---------------------------------------------- -----------------------------------------------------------
; %p Parent: One directory element and the filename transport/mta.php
; --------- ---------------------------------------------- -----------------------------------------------------------
; %s Directory separator /
; on Linux, OSX and other Unix-like systems, ``\`` on Windows
; ========= ============================================== ===========================================================
;
;
;xdebug.filename_format = ...%s%n
; -----------------------------------------------------------------------------
; xdebug.force_display_errors
;
; Introduced in version 2.3
;
; Type: integer, Default value: 0
;
; If this setting is set to ``1`` then errors will **always** be displayed, no
; matter what the setting of PHP's display_errors [1] is.
;
; [1] https://www.php.net/manual/errorfunc.configuration.php#ini.display-errors
;
;
;xdebug.force_display_errors = 0
; -----------------------------------------------------------------------------
; xdebug.force_error_reporting
;
; Introduced in version 2.3
;
; Type: integer, Default value: 0
;
; This setting is a bitmask, like error_reporting [1]. This bitmask will be
; logically ORed with the bitmask represented by error_reporting [2] to dermine
; which errors should be displayed. This setting can only be made in php.ini and
; allows you to force certain errors from being shown no matter what an
; application does with ini_set() [3].
;
; [1] https://www.php.net/manual/errorfunc.configuration.php#ini.error-reporting
; [2] https://www.php.net/manual/errorfunc.configuration.php#ini.error-reporting
; [3] https://www.php.net/manual/function.ini-set.php
;
;
;xdebug.force_error_reporting = 0
; -----------------------------------------------------------------------------
; xdebug.gc_stats_enable
;
; Introduced in version 2.6
;
; Type: bool, Default value: false
;
; If this setting is enabled, then statistics for garbage collection runs are
; automatically collected into the given directory set with
; xdebug.gc_stats_output_dir and with an automatically generated name configured
; by xdebug.gc_stats_output_name.
;
;
;xdebug.gc_stats_enable = false
; -----------------------------------------------------------------------------
; xdebug.gc_stats_output_dir
;
; Introduced in version 2.6
;
; Type: string, Default value: /tmp
;
; The directory where the garbage collection statistics output will be written
; to, make sure that the user who the PHP will be running as has write
; permissions to that directory. This setting can not be set in your script with
; ini_set().
;
;
;xdebug.gc_stats_output_dir = /tmp
; -----------------------------------------------------------------------------
; xdebug.gc_stats_output_name
;
; Introduced in version 2.6
;
; Type: string, Default value: gcstats.%p
;
; This setting determines the name of the file that is used to dump garbage
; collection statistics into. The setting specifies the format with format
; specifiers, very similar to sprintf() and strftime(). There are several format
; specifiers that can be used to format the file name.
;
; See the xdebug.trace_output_name documentation for the supported specifiers.
;
;
;xdebug.gc_stats_output_name = gcstats.%p
; -----------------------------------------------------------------------------
; xdebug.halt_level
;
; Introduced in version 2.3
;
; Type: integer, Default value: 0
;
; This setting allows you to configure a mask that determines whether, and
; which, notices and/or warnings get converted to errors. You can configure
; notices and warnings that are generated by PHP, and notices and warnings that
; you generate yourself (by means of trigger_error()). For example, to convert
; the warning of strlen() (without arguments) to an error, you would do:
;
; ini_set('xdebug.halt_level', E_WARNING);
; strlen();
; echo "Hi!\n";
;
; Which will then result in the showing of the error message, and the abortion
; of the script. ``echo "Hi!\n";`` will not be executed.
;
; The setting is a bit mask, so to convert all notices and warnings into errors
; for all applications, you can set this in php.ini:
;
; xdebug.halt_level=E_WARNING|E_NOTICE|E_USER_WARNING|E_USER_NOTICE
;
; The bitmask only supports the four level that are mentioned above.
;
;
;xdebug.halt_level = 0
; -----------------------------------------------------------------------------
; xdebug.idekey
;
; Type: string, Default value: *complex*
;
; Controls which IDE Key Xdebug should pass on to the DBGp debugger handler. The
; default is based on environment settings. First the environment setting
; DBGP_IDEKEY is consulted, then USER and as last USERNAME. The default is set
; to the first environment variable that is found. If none could be found the
; setting has as default ''. If this setting is set, it always overrides the
; environment variables.
;
;
;xdebug.idekey = *complex*
; -----------------------------------------------------------------------------
; xdebug.max_nesting_level
;
; Type: integer, Default value: 256
;
; Controls the protection mechanism for infinite recursion protection. The value
; of this setting is the maximum level of nested functions that are allowed
; before the script will be aborted.
;
; Before Xdebug 2.6, this would create a fatal exception if exceeded. From
; Xdebug 2.6 and later, an "Error [1]" exception is thrown instead.
;
; [1] https://www.php.net/manual/class.error.php
;
; Before Xdebug 2.3, the default value was ``100``.
;
;
;xdebug.max_nesting_level = 256
; -----------------------------------------------------------------------------
; xdebug.max_stack_frames
;
; Introduced in version 2.3
;
; Type: integer, Default value: -1
;
; Controls how many stack frames are shown in stack traces, both on the command
; line during PHP error stack traces, as well as in the browser for HTML traces.
;
;
;xdebug.max_stack_frames = -1
; -----------------------------------------------------------------------------
; xdebug.overload_var_dump
;
; Introduced in version 2.1
;
; Type: integer, Default value: 2
;
; By default Xdebug overloads var_dump() with its own improved version for
; displaying variables when the html_errors [1] php.ini setting is set to
; ``true``. In case you do not want that, you can set this setting to ``0``, but
; check first if it's not smarter to turn off ``html_errors``.
;
; [1] https://www.php.net/manual/en/errorfunc.configuration.php#ini.html-errors
;
; *New in Xdebug 2.3*: You can also use ``2`` as value for this setting. Besides
; formatting the var_dump() output nicely, it will also add filename and line
; number to the output. The xdebug.file_link_format setting is also respected.
;
; *Before Xdebug 2.4*: the default value of this setting was ``1``.
;
;
;xdebug.overload_var_dump = 2
; -----------------------------------------------------------------------------
; xdebug.profiler_append
;
; Type: integer, Default value: 0
;
; When this setting is set to 1, profiler files will not be overwritten when a
; new request would map to the same file (depending on the
; xdebug.profiler_output_name setting. Instead the file will be appended to with
; the new profile.
;
;
;xdebug.profiler_append = 0
; -----------------------------------------------------------------------------
; xdebug.profiler_enable
;
; Type: integer, Default value: 0
;
; Enables Xdebug's profiler which creates files in the profile output directory.
; Those files can be read by KCacheGrind to visualize your data. This setting
; can not be set in your script with ini_set(). If you want to selectively
; enable the profiler, please set xdebug.profiler_enable_trigger to 1
; **instead** of using this setting.
;
;
;xdebug.profiler_enable = 0
; -----------------------------------------------------------------------------
; xdebug.profiler_enable_trigger
;
; Type: integer, Default value: 0
;
; When this setting is set to 1, you can trigger the generation of profiler
; files by using the XDEBUG_PROFILE GET/POST parameter, or set a cookie with the
; name XDEBUG_PROFILE. This will then write the profiler data to defined
; directory. In order to prevent the profiler to generate profile files for each
; request, you need to set xdebug.profiler_enable to 0. Access to the trigger
; itself can be configured through xdebug.profiler_enable_trigger_value.
;
;
;xdebug.profiler_enable_trigger = 0
; -----------------------------------------------------------------------------
; xdebug.profiler_enable_trigger_value
;
; Introduced in version 2.3
;
; Type: string, Default value: ""
;
; This setting can be used to restrict who can make use of the XDEBUG_PROFILE
; functionality as outlined in xdebug.profiler_enable_trigger. When changed from
; its default value of an empty string, the value of the cookie, GET or POST
; argument needs to match the shared secret set with this setting in order for
; the profiler to start.
;
;
;xdebug.profiler_enable_trigger_value = ""
; -----------------------------------------------------------------------------
; xdebug.profiler_output_dir
;
; Type: string, Default value: /tmp
;
; The directory where the profiler output will be written to, make sure that the
; user who the PHP will be running as has write permissions to that directory.
; This setting can not be set in your script with ini_set().
;
;
;xdebug.profiler_output_dir = /tmp
; -----------------------------------------------------------------------------
; xdebug.profiler_output_name
;
; Type: string, Default value: cachegrind.out.%p
;
; This setting determines the name of the file that is used to dump traces into.
; The setting specifies the format with format specifiers, very similar to
; sprintf() and strftime(). There are several format specifiers that can be used
; to format the file name.
;
; See the xdebug.trace_output_name documentation for the supported specifiers.
;
;
;xdebug.profiler_output_name = cachegrind.out.%p
; -----------------------------------------------------------------------------
; xdebug.remote_addr_header
;
; Introduced in version 2.4
;
; Type: string, Default value: ""
;
; If xdebug.remote_addr_header is configured to be a non-empty string, then the
; value is used as key in the $SERVER superglobal array to determine which
; header to use to find the IP address or hostname to use for 'connecting back
; to'. This setting is only used in combination with xdebug.remote_connect_back
; and is otherwise ignored.
;
;
;xdebug.remote_addr_header = ""
; -----------------------------------------------------------------------------
; xdebug.remote_autostart
;
; Type: boolean, Default value: false
;
; Normally you need to use a specific HTTP GET/POST variable to start remote
; debugging (see Step Debugging). When this setting is set to 1, Xdebug will
; always attempt to start a remote debugging session and try to connect to a
; client, even if the GET/POST/COOKIE variable was not present.
;
;
;xdebug.remote_autostart = false
; -----------------------------------------------------------------------------
; xdebug.remote_connect_back
;
; Introduced in version 2.1
;
; Type: boolean, Default value: false
;
; If enabled, the xdebug.remote_host setting is ignored and Xdebug will try to
; connect to the client that made the HTTP request. It checks the
; $_SERVER['HTTP_X_FORWARDED_FOR'] and $_SERVER['REMOTE_ADDR'] variables to find
; out which IP address to use.
;
; If xdebug.remote_addr_header is configured, then the $SERVER variable with the
; configured name will be checked before the $_SERVER['HTTP_X_FORWARDED_FOR']
; and $_SERVER['REMOTE_ADDR'] variables.
;
; This setting does not apply for debugging through the CLI, as the $SERVER
; header variables are not available there.
;
; Please note that there is **no** filter available, and anybody who can connect
; to the webserver will then be able to start a debugging session, even if their
; address does not match xdebug.remote_host.
;
;
;xdebug.remote_connect_back = false
; -----------------------------------------------------------------------------
; xdebug.remote_cookie_expire_time
;
; Introduced in version 2.1
;
; Type: integer, Default value: 3600
;
; This setting can be used to increase (or decrease) the time that the remote
; debugging session stays alive via the session cookie.
;
;
;xdebug.remote_cookie_expire_time = 3600
; -----------------------------------------------------------------------------
; xdebug.remote_enable
;
; Type: boolean, Default value: false
;
; This switch controls whether Xdebug should try to contact a debug client which
; is listening on the host and port as set with the settings xdebug.remote_host
; and xdebug.remote_port. If a connection can not be established the script will
; just continue as if this setting was 0.
;
;
;xdebug.remote_enable = false
; -----------------------------------------------------------------------------
; xdebug.remote_host
;
; Type: string, Default value: localhost
;
; Selects the host where the debug client is running, you can either use a host
; name, IP address, or 'unix:///path/to/sock' for a Unix domain socket. This
; setting is ignored if xdebug.remote_connect_back is enabled.
;
; Support for Unix domain sockets was introduced in Xdebug 2.6.
;
;
;xdebug.remote_host = localhost
; -----------------------------------------------------------------------------
; xdebug.remote_log
;
; Type: string, Default value:
;
; If set to a value, it is used as filename to a file to which all remote
; debugger communications are logged. The file is always opened in append-mode,
; and will therefore not be overwritten by default. There is no concurrency
; protection available. The format of the file looks something like:
;
; Log opened at 2007-05-27 14:28:15
; -> <init xmlns="urn:debugger_protocol_v1" xmlns:xdebug="https://xdebug.org/dbgp/x ... ight></init>
;
; <- step_into -i 1
; -> <response xmlns="urn:debugger_protocol_v1" xmlns:xdebug="https://xdebug.org/db ... ></response>
;
;
;xdebug.remote_log =
; -----------------------------------------------------------------------------
; xdebug.remote_log_level
;
; Introduced in version 2.8
;
; Type: integer, Default value: 7
;
; Configures which logging messages should be emitted by the Step Debugging.
;
; The following levels are supported:
;
; ===== ============= ================================
; Level Name Example
; ===== ============= ================================
; 1 Errors Connection errors
; ----- ------------- --------------------------------
; 3 Warnings Connection warnings
; ----- ------------- --------------------------------
; 5 Communication Protocol messages
; ----- ------------- --------------------------------
; **7** Information Information while connecting
; ----- ------------- --------------------------------
; 10 Debug Breakpoint resolving information
; ===== ============= ================================
;
;
;xdebug.remote_log_level = 7
; -----------------------------------------------------------------------------
; xdebug.remote_mode
;
; Type: string, Default value: req
;
; Selects when a debug connection is initiated. This setting can have two
; different values:
;
; req
; Xdebug will try to connect to the debug client as soon as the script
; starts.
;
; jit
; Xdebug will only try to connect to the debug client as soon as an error
; condition occurs.
;
;
;xdebug.remote_mode = req
; -----------------------------------------------------------------------------
; xdebug.remote_port
;
; Type: integer, Default value: 9000
;
; The port to which Xdebug tries to connect on the remote host. Port 9000 is the
; default for both the client and the bundled debugclient. As many clients use
; this port number, it is best to leave this setting unchanged.
;
;
;xdebug.remote_port = 9000
; -----------------------------------------------------------------------------
; xdebug.remote_timeout
;
; Introduced in version 2.6
;
; Type: integer, Default value: 200
;
; The amount of time in milliseconds that Xdebug will wait for on an IDE to
; acknowledge an incoming debugging connection. The default value of 200 ms
; should in most cases be enough. In case you often get dropped debugging
; requests, perhaps because you have a high latency network, or a development
; box far away from your IDE, or have a slow firewall, then you can should
; increase this value.
;
; Please note that increasing this value might mean that your requests seem to
; 'hang' in case Xdebug tries to establish a connection, but your IDE is not
; listening.
;
;
;xdebug.remote_timeout = 200
; -----------------------------------------------------------------------------
; xdebug.scream
;
; Introduced in version 2.1
;
; Type: boolean, Default value: false
;
; If this setting is 1, then Xdebug will disable the @ (shut-up) operator so
; that notices, warnings and errors are no longer hidden.
;
;
;xdebug.scream = false
; -----------------------------------------------------------------------------
; xdebug.show_error_trace
;
; Introduced in version 2.4
;
; Type: integer, Default value: 0
;
; When this setting is set to 1, Xdebug will show a stack trace whenever an
; Error is raised - even if this Error is actually caught.
;
;
;xdebug.show_error_trace = 0
; -----------------------------------------------------------------------------
; xdebug.show_exception_trace
;
; Type: integer, Default value: 0
;
; When this setting is set to 1, Xdebug will show a stack trace whenever an
; Exception or Error is raised - even if this Exception or Error is actually
; caught.
;
; Error 'exceptions' were introduced in PHP 7.
;
;
;xdebug.show_exception_trace = 0
; -----------------------------------------------------------------------------
; xdebug.show_local_vars
;
; Type: integer, Default value: 0
;
; When this setting is set to something != 0 Xdebug's generated stack dumps in
; error situations will also show all variables in the top-most scope. Beware
; that this might generate a lot of information, and is therefore turned off by
; default.
;
;
;xdebug.show_local_vars = 0
; -----------------------------------------------------------------------------
; xdebug.show_mem_delta
;
; Type: integer, Default value: 0
;
; When this setting is set to something != 0 Xdebug's human-readable generated
; trace files will show the difference in memory usage between function calls.
; If Xdebug is configured to generate computer-readable trace files then they
; will always show this information.
;
;
;xdebug.show_mem_delta = 0
; -----------------------------------------------------------------------------
; xdebug.trace_enable_trigger
;
; Introduced in version 2.2
;
; Type: boolean, Default value: false
;
; When this setting is set to 1, you can trigger the generation of trace files
; by using the XDEBUG_TRACE GET/POST parameter, or set a cookie with the name
; XDEBUG_TRACE. This will then write the trace data to defined directory. In
; order to prevent Xdebug to generate trace files for each request, you need to
; set xdebug.auto_trace to 0. Access to the trigger itself can be configured
; through xdebug.trace_enable_trigger_value.
;
;
;xdebug.trace_enable_trigger = false
; -----------------------------------------------------------------------------
; xdebug.trace_enable_trigger_value
;
; Introduced in version 2.3
;
; Type: string, Default value: ""
;
; This setting can be used to restrict who can make use of the XDEBUG_TRACE
; functionality as outlined in xdebug.trace_enable_trigger. When changed from
; its default value of an empty string, the value of the cookie, GET or POST
; argument needs to match the shared secret set with this setting in order for
; the trace file to be generated.
;
;
;xdebug.trace_enable_trigger_value = ""
; -----------------------------------------------------------------------------
; xdebug.trace_format
;
; Type: integer, Default value: 0
;
; The format of the trace file.
;
; ===== ==============================================================================
; Value Description
; ===== ==============================================================================
; 0 shows a human readable indented trace file with:
;
; *time index*, *memory usage*, *memory delta* (if the setting
; xdebug.show_mem_delta is enabled), *level*, *function name*, *function
; parameters* (if the setting xdebug.collect_params is enabled), *filename* and
; *line number*.
; ----- ------------------------------------------------------------------------------
; 1 writes a computer readable format which has two different records. There are
; different records for entering a stack frame, and leaving a stack frame. The
; table below lists the fields in each type of record. Fields are tab separated.
; ----- ------------------------------------------------------------------------------
; 2 writes a trace formatted in (simple) HTML.
; ===== ==============================================================================
;
; Fields for the computerized format:
;
; =========== ===== ========== ========== ========== ============ ============= ========================================= =================================== ======== =========== ================ ============================================================
; Record type 1 2 3 4 5 6 7 8 9 10 11 12 - ...
; =========== ===== ========== ========== ========== ============ ============= ========================================= =================================== ======== =========== ================ ============================================================
; Entry level function # always '0' time index memory usage function name user-defined (1) or internal function (0) name of the include or require file filename line number no. of arguments arguments (as many as specified in field 11) - tab separated
; ----------- ----- ---------- ---------- ---------- ------------ ------------- ----------------------------------------- ----------------------------------- -------- ----------- ---------------- ------------------------------------------------------------
; Exit level function # always '1' time index memory usage empty
; ----------- ----- ---------- ---------- ---------- ------------ ------------- ----------------------------------------- ----------------------------------- -------- ----------- ---------------- ------------------------------------------------------------
; Return level function # always 'R' empty return value empty
; =========== ===== ========== ========== ========== ============ ============= ========================================= =================================== ======== =========== ================ ============================================================
;
; See the introduction of Function Traces for a few examples.
;
;
;xdebug.trace_format = 0
; -----------------------------------------------------------------------------
; xdebug.trace_options
;
; Type: integer, Default value: 0
;
; When set to '1' the trace files will be appended to, instead of being
; overwritten in subsequent requests.
;
;
;xdebug.trace_options = 0
; -----------------------------------------------------------------------------
; xdebug.trace_output_dir
;
; Type: string, Default value: /tmp
;
; The directory where the tracing files will be written to, make sure that the
; user who the PHP will be running as has write permissions to that directory.
;
;
;xdebug.trace_output_dir = /tmp