From 15882420faa8c8333b797beb017a6921c6c7a630 Mon Sep 17 00:00:00 2001 From: harcod Date: Sun, 19 Feb 2017 12:04:25 -0500 Subject: [PATCH 1/7] 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 --- reference/configuration/framework.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 3291785f545..8763c8094ed 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -228,7 +228,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: 'phpstorm://open?url=file://%%f&line=%%l' .. code-block:: xml @@ -240,14 +240,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"> - + .. code-block:: php // app/config/config.php $container->loadFromExtension('framework', array( - 'ide' => 'phpstorm://open?file=%%f&line=%%l', + 'ide' => 'phpstorm://open?url=file://%%f&line=%%l', )); Since every developer uses a different IDE, the recommended way to enable this From b5db60db918be0dff97318f2dfe1b68f2df34725 Mon Sep 17 00:00:00 2001 From: Rob Harris Date: Wed, 22 Feb 2017 13:02:38 -0500 Subject: [PATCH 2/7] Provide specific instructions for using the 'phpstorm' ide setting on various platforms. --- reference/configuration/framework.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 8763c8094ed..ca3c845ea4a 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -214,9 +214,14 @@ 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``, +following values: ``phpstorm``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``. +.. note:: + + PhpStorm for the Mac provides built-in support for the ``phpstorm`` protocol. + Windows requires `PhpStormProtocol`_. 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`` placeholder for the line number (percentage signs (``%``) must be escaped by @@ -228,7 +233,7 @@ doubling them to prevent Symfony from interpreting them as container parameters) # app/config/config.yml framework: - ide: 'phpstorm://open?url=file://%%f&line=%%l' + ide: 'myide://open?url=file://%%f&line=%%l' .. code-block:: xml @@ -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"> - + .. code-block:: php // app/config/config.php $container->loadFromExtension('framework', array( - 'ide' => 'phpstorm://open?url=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 @@ -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 From f25a4e9eb46513dad980263425fc46c46917b867 Mon Sep 17 00:00:00 2001 From: Rob Harris Date: Thu, 23 Feb 2017 09:08:22 -0500 Subject: [PATCH 3/7] Reflects changes made for phpstorm-mac by symfony/symfony#21712 --- reference/configuration/framework.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index ca3c845ea4a..9c80ad29619 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -214,13 +214,14 @@ 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``, ``sublime``, +following values: ``phpstorm``, ``phpstorm-mac``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``. .. note:: - PhpStorm for the Mac provides built-in support for the ``phpstorm`` protocol. - Windows requires `PhpStormProtocol`_. Linux requires `phpstorm-url-handler`_. + The ``phpstorm`` option requires `PhpStormProtocol`_ for Windows, + or `phpstorm-url-handler`_ for Linux. PhpStorm for the Mac provides + built-in support for the ``phpstorm-mac`` option. 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`` From 60b603dfdf82a97c0ef320e141f5c992bbc9a61a Mon Sep 17 00:00:00 2001 From: Rob Harris Date: Fri, 24 Feb 2017 08:03:53 -0500 Subject: [PATCH 4/7] Changed phpstorm-mac to phpstorm-core by symfony/symfony#21712 --- reference/configuration/framework.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 9c80ad29619..733591ab9cd 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -214,14 +214,14 @@ 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``, ``phpstorm-mac``, ``sublime``, +following values: ``phpstorm``, ``phpstorm-core``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``. .. note:: The ``phpstorm`` option requires `PhpStormProtocol`_ for Windows, or `phpstorm-url-handler`_ for Linux. PhpStorm for the Mac provides - built-in support for the ``phpstorm-mac`` option. + built-in support for the ``phpstorm-core`` option. 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`` From 0ce8ef03561bf8aa554a26bc444cf5ceb5986368 Mon Sep 17 00:00:00 2001 From: Rob Harris Date: Mon, 27 Feb 2017 10:18:01 -0500 Subject: [PATCH 5/7] Updated to phpstorm-protocol as changed by symfony/symfony#21712 --- reference/configuration/framework.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 733591ab9cd..6566fabcbbf 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -214,14 +214,14 @@ 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``, ``phpstorm-core``, ``sublime``, +following values: ``phpstorm``, ``phpstorm-protocol``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``. .. note:: - The ``phpstorm`` option requires `PhpStormProtocol`_ for Windows, - or `phpstorm-url-handler`_ for Linux. PhpStorm for the Mac provides - built-in support for the ``phpstorm-core`` option. + PhpStorm for the Mac provides built-in support for the ``phpstorm`` option. + The ``phpstorm-protocol`` option requires `PhpStormProtocol`_ for Windows, + or `phpstorm-url-handler`_ for Linux. 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`` From 6e8e0be193b3f4d06710c30c3725944a77d11655 Mon Sep 17 00:00:00 2001 From: Rob Harris Date: Wed, 1 Mar 2017 09:50:10 -0500 Subject: [PATCH 6/7] phpstorm-protocol was eliminated since the Windows and Linux handlers now support the same format scheme as MacOS. --- reference/configuration/framework.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 6566fabcbbf..6712618f204 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -214,14 +214,14 @@ 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``, ``phpstorm-protocol``, ``sublime``, +following values: ``phpstorm``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``. .. note:: - PhpStorm for the Mac provides built-in support for the ``phpstorm`` option. - The ``phpstorm-protocol`` option requires `PhpStormProtocol`_ for Windows, - or `phpstorm-url-handler`_ for Linux. + 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`` From 2cbec8c8fa9182bf40ca8d4f0db1432021e8db7e Mon Sep 17 00:00:00 2001 From: Rob Harris Date: Wed, 1 Mar 2017 15:11:52 -0500 Subject: [PATCH 7/7] made line longer as requested --- reference/configuration/framework.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 6712618f204..ed71bc3b22d 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -214,8 +214,7 @@ 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``, ``sublime``, -``textmate``, ``macvim`` and ``emacs``. +following values: ``phpstorm``, ``sublime``, ``textmate``, ``macvim`` and ``emacs``. .. note::