Skip to content

Update 'ide' example in framework.rst #7513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Update 'ide' example in framework.rst #7513

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1588242
Update 'ide' example in framework.rst
harcod Feb 19, 2017
b5db60d
Provide specific instructions for using the 'phpstorm' ide setting on…
harcod Feb 22, 2017
f25a4e9
Reflects changes made for phpstorm-mac by symfony/symfony#21712
harcod Feb 23, 2017
60b603d
Changed phpstorm-mac to phpstorm-core by symfony/symfony#21712
harcod Feb 24, 2017
0ce8ef0
Updated to phpstorm-protocol as changed by symfony/symfony#21712
harcod Feb 27, 2017
6e8e0be
phpstorm-protocol was eliminated since the Windows and Linux handlers…
harcod Mar 1, 2017
2cbec8c
made line longer as requested
harcod Mar 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,13 @@ ide
Symfony turns file paths seen in variable dumps and exception messages into
links that open those files right inside your browser. If you prefer to open
those files in your favorite IDE or text editor, set this option to any of the
following values: ``phpstorm`` (requires `PhpStormProtocol`_), ``sublime``,
``textmate``, ``macvim`` and ``emacs``.
following values: ``phpstorm``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``.

.. note::

The ``phpstorm`` option is supported natively by PhpStorm on MacOS,
Windows requires `PhpStormProtocol`_,
and Linux requires `phpstorm-url-handler`_.

If you use another editor, the expected configuration value is a URL template
that contains an ``%f`` placeholder where the file path is expected and ``%l``
Expand All @@ -228,7 +233,7 @@ doubling them to prevent Symfony from interpreting them as container parameters)

# app/config/config.yml
framework:
ide: 'phpstorm://open?file=%%f&line=%%l'
ide: 'myide://open?url=file://%%f&line=%%l'

.. code-block:: xml

Expand All @@ -240,14 +245,14 @@ doubling them to prevent Symfony from interpreting them as container parameters)
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config ide="phpstorm://open?file=%%f&line=%%l" />
<framework:config ide="myide://open?url=file://%%f&line=%%l" />
</container>

.. code-block:: php

// app/config/config.php
$container->loadFromExtension('framework', array(
'ide' => 'phpstorm://open?file=%%f&line=%%l',
'ide' => 'myide://open?url=file://%%f&line=%%l',
));

Since every developer uses a different IDE, the recommended way to enable this
Expand Down Expand Up @@ -1656,4 +1661,5 @@ Full Default Configuration
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html
.. _`egulias/email-validator`: https://github.com/egulias/EmailValidator
.. _`PhpStormProtocol`: https://github.com/aik099/PhpStormProtocol
.. _`phpstorm-url-handler`: https://github.com/sanduhrs/phpstorm-url-handler
.. _`blue/green deployment`: http://martinfowler.com/bliki/BlueGreenDeployment.html