Skip to content

Commit 6940a12

Browse files
committed
minor symfony#7513 Update 'ide' example in framework.rst (harcod)
This PR was squashed before being merged into the 3.2 branch (closes symfony#7513). Discussion ---------- Update 'ide' example in framework.rst The example 'ide' configuration was different from the actual format required for PhpStorm. See README at https://github.com/aik099/PhpStormProtocol to verify the correct format as > phpstorm://open?url=file://%f&line=%l Commits ------- 606bfb1 Update 'ide' example in framework.rst
2 parents 6ac3cb4 + 606bfb1 commit 6940a12

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

reference/configuration/framework.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,13 @@ ide
214214
Symfony turns file paths seen in variable dumps and exception messages into
215215
links that open those files right inside your browser. If you prefer to open
216216
those files in your favorite IDE or text editor, set this option to any of the
217-
following values: ``phpstorm`` (requires `PhpStormProtocol`_), ``sublime``,
218-
``textmate``, ``macvim`` and ``emacs``.
217+
following values: ``phpstorm``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``.
218+
219+
.. note::
220+
221+
The ``phpstorm`` option is supported natively by PhpStorm on MacOS,
222+
Windows requires `PhpStormProtocol`_,
223+
and Linux requires `phpstorm-url-handler`_.
219224

220225
If you use another editor, the expected configuration value is a URL template
221226
that contains an ``%f`` placeholder where the file path is expected and ``%l``
@@ -228,7 +233,7 @@ doubling them to prevent Symfony from interpreting them as container parameters)
228233
229234
# app/config/config.yml
230235
framework:
231-
ide: 'phpstorm://open?file=%%f&line=%%l'
236+
ide: 'myide://open?url=file://%%f&line=%%l'
232237
233238
.. code-block:: xml
234239
@@ -240,14 +245,14 @@ doubling them to prevent Symfony from interpreting them as container parameters)
240245
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
241246
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
242247
243-
<framework:config ide="phpstorm://open?file=%%f&line=%%l" />
248+
<framework:config ide="myide://open?url=file://%%f&line=%%l" />
244249
</container>
245250
246251
.. code-block:: php
247252
248253
// app/config/config.php
249254
$container->loadFromExtension('framework', array(
250-
'ide' => 'phpstorm://open?file=%%f&line=%%l',
255+
'ide' => 'myide://open?url=file://%%f&line=%%l',
251256
));
252257
253258
Since every developer uses a different IDE, the recommended way to enable this
@@ -1653,4 +1658,5 @@ Full Default Configuration
16531658
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html
16541659
.. _`egulias/email-validator`: https://github.com/egulias/EmailValidator
16551660
.. _`PhpStormProtocol`: https://github.com/aik099/PhpStormProtocol
1661+
.. _`phpstorm-url-handler`: https://github.com/sanduhrs/phpstorm-url-handler
16561662
.. _`blue/green deployment`: http://martinfowler.com/bliki/BlueGreenDeployment.html

0 commit comments

Comments
 (0)