Skip to content

Commit 76e216f

Browse files
Add docs about the editor option
1 parent 8e6ab5c commit 76e216f

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Intro: Sets the editor for the debugger
2+
3+
----
4+
5+
Text:
6+
7+
When your debug mode is enabled, you can set your editor to quickly open the file in which the error appeared.
8+
9+
(video: error.mp4)
10+
11+
```php
12+
return [
13+
'debug' => true,
14+
'editor' => 'vscode'
15+
];
16+
```
17+
18+
The following editors are supported:
19+
20+
| shortcut | Editor |
21+
| - | - |
22+
| `emacs`| Emacs |
23+
| `idea`| IDEA |
24+
| `macvim`| MacVim |
25+
| `phpstorm`| PhpStorm |
26+
| `sublime`| Sublime Text |
27+
| `textmate`| Textmate |
28+
| `xdebug`| xdebug |
29+
| `vscode`| VSCode |
30+
| `atom`| Atom |
31+
| `espresso`| Espresso |
32+
| `netbeans`| Netbeans |
33+
34+
<alert>
35+
Make sure to disable `debug` mode in production! Displaying PHP errors on a public server can be a serious security risk:
36+
37+
- Error messages are displayed with detailed information about the code structure (e.g. file path, class, method)
38+
- With Whoops enabled, there will be even more detailed information about the code structure
39+
40+
In a production environment, always log errors to your PHP error logs.
41+
</alert>
42+
43+
(link: docs/reference/system/options/debug text: Learn more about the debug mode …)
44+

0 commit comments

Comments
 (0)