Skip to content

[Framework] Update link-to-source mapping definition #7019

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

Merged
merged 1 commit into from
Oct 14, 2016
Merged

[Framework] Update link-to-source mapping definition #7019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 8 additions & 3 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,11 @@ 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know that. Great tip! Thanks @nicolas-grekas

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
Expand Down Expand Up @@ -252,13 +257,13 @@ do something like:

When running your app in a container or in a virtual machine, you can tell
Symfony to map files from the guest to the host by changing their prefix.
This map should be specified at the end of the URL template after a ``#``
using JSON-like key/values::
This map should be specified at the end of the URL template, using ``&`` and
``>`` as guest-to-host separators::

// /path/to/guest/.../file will be opened
// as /path/to/host/.../file on the host
// and /foo/.../file as /bar/.../file also
'myide://%f:%l#"/path/to/guest/":"/path/to/host/","/foo/":"/bar/"...'
'myide://%f:%l&/path/to/guest/>/path/to/host/&/foo/>/bar/&...'

.. versionadded:: 3.2
Guest to host mappings were introduced in Symfony 3.2.
Expand Down