Skip to content

Commit

Permalink
feature #3835 Updated framework.ide configuration (WouterJ)
Browse files Browse the repository at this point in the history
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #3835).

Discussion
----------

Updated framework.ide configuration

| Q   | A
| --- | ---
| Doc fix? | yes
| New docs? | yes (symfony/symfony#10856)
| Applies to | 2.5/2.6
| Fixed tickets | -

I'll add a versionadded directive when I now the release version.

Commits
-------

15e3ff9 Updated framework.ide configuration
  • Loading branch information
weaverryan committed May 10, 2014
2 parents e58e39f + 91452bc commit d8aaac3
Showing 1 changed file with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,25 +82,48 @@ If you're using an IDE like TextMate or Mac Vim, then Symfony can turn all
of the file paths in an exception message into a link, which will open that
file in your IDE.

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

* ``textmate``
* ``macvim``
* ``emacs``
* ``sublime``

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

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

framework:
ide: "txmt://open?url=file://%%f&line=%%l"
.. configuration-block::

.. code-block:: yaml
framework:
ide: "pstorm://%%f:%%l"
.. code-block:: xml
<?xml version="1.0" charset="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/service"
xmlns:framework="http://symfony.com/schema/dic/symfony">
<framework:config ide="pstorm://%%f:%%l" />
</container>
.. code-block:: php
$container->loadFromExtension('framework', array(
'ide' => 'pstorm://%%f:%%l',
));
Of course, since every developer uses a different IDE, it's better to set
this on a system level. This can be done by setting the ``xdebug.file_link_format``
``php.ini`` value to the file link string. If this configuration value is set, then
the ``ide`` option does not need to be specified.
in the ``php.ini`` configuration to the url string. If this configuration value
is set, then the ``ide`` option will be ignored.

.. _reference-framework-test:

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

0 comments on commit d8aaac3

Please sign in to comment.