@@ -208,25 +208,21 @@ ide
208
208
209
209
**type **: ``string `` **default **: ``null ``
210
210
211
- Symfony can turn file paths seen in dumps and exception messages into links
212
- that will open in your preferred text editor or IDE.
211
+ Symfony turns file paths seen in variable dumps and exception messages into
212
+ links that open those files right inside your browser. If you prefer, you can
213
+ open those files in your favorite IDE or text editor.
213
214
214
- Since every developer uses a different IDE, the recommended way to enable this
215
- feature is to configure it on a system level. This can be done by setting the
216
- ``xdebug.file_link_format `` option in your `` php.ini `` configuration file .
215
+ Set this option to any of these values preconfigured for the most popular editors:
216
+ `` phpstorm `` (requires ` PhpStormProtocol `_), `` sublime ``, `` textmate ``,
217
+ ``macvim `` and `` emacs `` .
217
218
218
- .. tip ::
219
+ If you use another editor, the expected configuration value is a URL template
220
+ that contains an ``%f `` placeholder where the file path is expected and ``%l ``
221
+ placeholder for the line number (percentages signs (``% ``) must be escaped by
222
+ doubling them to prevent Symfony from interpreting them as container parameters).
219
223
220
- Setting the ``xdebug.file_link_format `` ini option works even if the Xdebug
221
- extension is not enabled.
222
-
223
- Alternatively, you can use this ``ide `` configuration key.
224
-
225
- In both cases, the expected configuration value is a URL template that contains an
226
- ``%f `` where the file path is expected and ``%l `` for the line number. When using
227
- the ``ide `` configuration key, percentages signs (``% ``) must be escaped by
228
- doubling them. For example, if you use PHPstorm on the Mac OS platform, you will
229
- do something like:
224
+ For example, if you use PHPstorm on the Mac OS platform, you can use this
225
+ configuration:
230
226
231
227
.. configuration-block ::
232
228
@@ -256,6 +252,17 @@ do something like:
256
252
'ide' => 'phpstorm://open?file=%%f&line=%%l',
257
253
));
258
254
255
+ Since every developer uses a different IDE, the recommended way to enable this
256
+ feature is to configure it on a system level. This can be done by setting the
257
+ ``xdebug.file_link_format `` option in your ``php.ini `` configuration file. The
258
+ format to use is the same as for the ``framework.ide `` option, but without the
259
+ need to escape the percent signs (``% ``) by doubling them.
260
+
261
+ .. tip ::
262
+
263
+ Setting the ``xdebug.file_link_format `` ini option works even if the Xdebug
264
+ extension is not enabled.
265
+
259
266
.. tip ::
260
267
261
268
When running your app in a container or in a virtual machine, you can tell
@@ -271,12 +278,6 @@ do something like:
271
278
.. versionadded :: 3.2
272
279
Guest to host mappings were introduced in Symfony 3.2.
273
280
274
- .. tip ::
275
-
276
- Symfony contains preconfigured URLs for some popular IDEs, you can set them
277
- using the following values: ``phpstorm `` (requires `PhpStormProtocol `_),
278
- ``sublime ``, ``textmate ``, ``macvim `` or ``emacs ``.
279
-
280
281
.. _reference-framework-test :
281
282
282
283
test
0 commit comments