8000 Updated the explanation about framework.ide by javiereguiluz · Pull Request #7197 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Updated the explanation about framework.ide #7197

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 3 commits into from
Closed

Updated the explanation about framework.ide #7197

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2888eda
Updated the explanation about framework.ide
javiereguiluz Nov 29, 2016
8d9ecc2
Fixed typo
javiereguiluz Nov 29, 2016
8de1ef3
Minor reword and explained what happens when you define both paramters
javiereguiluz Dec 9, 2016
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 vi 8000 ew
Diff view
49 changes: 25 additions & 24 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,25 +208,16 @@ ide

**type**: ``string`` **default**: ``null``

Symfony can turn file paths seen in dumps and exception messages into links
that will open in your preferred text editor or 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``.

Since every developer uses a different IDE, the recommended way to enable this
feature is to configure it on a system level. This can be done by setting the
``xdebug.file_link_format`` option in your ``php.ini`` configuration file.

.. tip::

Setting the ``xdebug.file_link_format`` ini option works even if the Xdebug
extension is not enabled.

Alternatively, you can use this ``ide`` configuration key.

In both cases, the expected configuration value is a URL template that contains an
``%f`` where the file path is expected and ``%l`` for the line number. When using
the ``ide`` configuration key, percentages signs (``%``) must be escaped by
doubling them. For example, if you use PHPstorm on the Mac OS platform, you will
do something like:
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``
placeholder for the line number (percentage signs (``%``) must be escaped by
doubling them to prevent Symfony from interpreting them as container parameters).

.. configuration-block::

Expand Down Expand Up @@ -256,6 +247,22 @@ do something like:
'ide' => 'phpstorm://open?file=%%f&line=%%l',
));

Since every developer uses a different IDE, the recommended way to enable this
feature is to configure it on a system level. This can be done by setting the
``xdebug.file_link_format`` option in your ``php.ini`` configuration file. The
format to use is the same as for the ``framework.ide`` option, but without the
need to escape the percent signs (``%``) by doubling them.

.. note::

If both ``framework.ide`` and ``xdebug.file_link_format`` are defined,
Symfony uses the value of the ``framework.ide`` option.

.. tip::

Setting the ``xdebug.file_link_format`` ini option works even if the Xdebug
extension is not enabled.

.. tip::

When running your app in a container or in a virtual machine, you can tell
Expand All @@ -271,12 +278,6 @@ do something like:
.. versionadded:: 3.2
Guest to host mappings were introduced in Symfony 3.2.

.. tip::

Symfony contains preconfigured URLs for some popular IDEs, you can set them
using the following values: ``phpstorm`` (requires `PhpStormProtocol`_),
``sublime``, ``textmate``, ``macvim`` or ``emacs``.

.. _reference-framework-test:

test
Expand Down
0