Skip to content

Commit 91452bc

Browse files
wouterjweaverryan
authored andcommitted
Updated framework.ide configuration
1 parent e58e39f commit 91452bc

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
@@ -82,25 +82,48 @@ If you're using an IDE like TextMate or Mac Vim, then Symfony can turn all
8282
of the file paths in an exception message into a link, which will open that
8383
file in your IDE.
8484

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

8888
* ``textmate``
8989
* ``macvim``
90+
* ``emacs``
91+
* ``sublime``
9092

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

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

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

105128
.. _reference-framework-test:
106129

@@ -567,3 +590,4 @@ Full default Configuration
567590
debug: %kernel.debug%
568591
569592
.. _`protocol-relative`: http://tools.ietf.org/html/rfc3986#section-4.2
593+
.. _`PhpStormOpener`: https://github.com/pinepain/PhpStormOpener

0 commit comments

Comments
 (0)