Skip to content

Commit 15e3ff9

Browse files
committed
Updated framework.ide configuration
1 parent be6c79d commit 15e3ff9

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

reference/configuration/framework.rst

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,25 +85,48 @@ If you're using an IDE like TextMate or Mac Vim, then Symfony can turn all
8585
of the file paths in an exception message into a link, which will open that
8686
file in your IDE.
8787

88-
If you use TextMate or Mac Vim, you can simply use one of the following built-in
89-
values:
88+
Symfony contains preconfigured urls for some popular IDEs, you can set them
89+
using the following keys:
9090

9191
* ``textmate``
9292
* ``macvim``
93+
* ``emacs``
94+
* ``sublime``
9395

94-
You can also specify a custom file link string. If you do this, all percentage
95-
signs (``%``) must be doubled to escape that character. For example, the
96-
full TextMate string would look like this:
96+
.. versionadded:: 2.3.14
97+
The ``emacs`` and ``sublime`` editors were introduced in Symfony 2.3.14.
9798

98-
.. code-block:: yaml
99+
You can also specify a custom url string. If you do this, all percentage
100+
signs (``%``) must be doubled to escape that character. For example, if you
101+
have installed `PhpStormOpener`_ and use PHPstorm, you will do something like:
99102

100-
framework:
101-
ide: "txmt://open?url=file://%%f&line=%%l"
103+
.. configuration-block::
104+
105+
.. code-block:: yaml
106+
107+
framework:
108+
ide: "pstorm://%%f:%%l"
109+
110+
.. code-block:: xml
111+
112+
<?xml version="1.0" charset="UTF-8" ?>
113+
<container xmlns="http://symfony.com/schema/dic/service"
114+
xmlns:framework="http://symfony.com/schema/dic/symfony">
115+
116+
<framework:config ide="pstorm://%%f:%%l" />
117+
118+
</container>
119+
120+
.. code-block:: php
121+
122+
$container->loadFromExtension('framework', array(
123+
'ide' => 'pstorm://%%f:%%l',
124+
));
102125
103126
Of course, since every developer uses a different IDE, it's better to set
104127
this on a system level. This can be done by setting the ``xdebug.file_link_format``
105-
``php.ini`` value to the file link string. If this configuration value is set, then
106-
the ``ide`` option does not need to be specified.
128+
in the ``php.ini`` configuration to the url string. If this configuration value
129+
is set, then the ``ide`` option will be ignored.
107130

108131
.. _reference-framework-test:
109132

@@ -569,3 +592,4 @@ Full default Configuration
569592
debug: %kernel.debug%
570593
571594
.. _`protocol-relative`: http://tools.ietf.org/html/rfc3986#section-4.2
595+
.. _`PhpStormOpener`: https://github.com/pinepain/PhpStormOpener

0 commit comments

Comments
 (0)