Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated old Project Settings data with new one

...

Redirect

...

alignright

...

locationhttps://

...

www.jetbrains.com/help/phpstorm/configuring-remote-interpreters.html
delay2

Include Page
Social Buttons PhpStorm
Social Buttons PhpStorm

 

Note
iconfalse

Using a remote PHP interpreter instead of a local one lets us run our application and PHP-based tools on a production-like environment, be it the real production server or a virtualized one that uses a tool like Vagrant. Speaking of Vagrant, with remote PHP interpreters we can install only PhpStorm on our development machine, and run, debug and unit test our application on the Vagrant machine. In this tutorial, we'll see how we can work with remote PHP interpreters in PhpStorm.

Table of Contents

1. Registering a new PHP interpreter

A remote interpreter can be configured in a similar way as a local one. We can specify the PHP interpreter we want to use in Project File | Settings (or PhpStorm | Preferences for Mac) | Languages & Frameworks | PHP. This can be a local PHP installation or a remote PHP executable. Clicking ... next to the selected interpreter will open a list of registered PHP interpreters. Click the green + to add a new Remote....

...

Expand
Adding a remote PHP interpreter from deployment configuration...
Adding a remote PHP interpreter from deployment configuration...

When one or more SFTP deployment configurations are configurations are present, for example when using Deployments in PhpStorm, the IDE will offer a third option: we can select the Deployment configuration option to use an existing configuration to connect to a remote PHP interpreter.

...

Once a remote PHP interpreter is registered and configured, we can set up our project to use it during development. Simply select it in the dropdown list in Project Settings | in File | Settings (or PhpStorm | Preferences for Mac) | Languages & Frameworks | PHP.

Once configured, all our Run/Debug configurations will make use of the configured PHP interpreter. Since we just configured a remote PHP interpreter as the one that should be used for our project, the following run configuration will always run on the remote server or Vagrant machine. All paths in Run/Debug Configuration should be local, they'll be automatically mapped to remote server local paths by the IDE.

3. Using the remote PHP interpreter

Once configured, we can start using our remote PHP interpreter, for example for unit testing. Check the tutorial Running PHPUnit tests over SSH on a remote server with PhpStorm for more information.

(optional) Composer and Remote PHP Interpreters

PHP interpreter is a project setting in PhpStorm: it will be used for all actions that require the PHP executable, for example for running the various Composer commands. When a remote PHP interpreter is configured, the Composer Support in PhpStorm may break because the remote PHP interpreter will potentially not have access to the project path on our development machine.

Through Project Settings | PHP | Composer, we can specify the PHP interpreter to use for running Composer commands.

Image Removed

Once configured, PhpStorm will use the remote PHP interpreter for commands that can be run remote, for example running PHPUnit tests, and a local interpreter for Composer.

Debugging and Remote PHP Interpreters

Remote debugging of PHP CLI scripts is possible when the remote PHP interpreter and SFTP deployment server with proper mappings are configured. Mappings can be also fetched from valid .Vagrantfile.

In order to take advantage of debugging with remote PHP interpreters, follow this workflow:

1. Make sure that remote PHP interpreter is configured and selected for current project in File | Settings (or PhpStorm | Preferences for Mac) | Languages & Frameworks | PHP, and Xdebug extension is installed (read more on Xdebug installation).

2. Configure SFTP deployment server that matches Remote Interpreter settings in File | Settings (or PhpStorm | Preferences for Mac) | Build, Execution, Deployment | Deployment with proper mappings (if you don't have it configured yet).

Image Added

3. Put the breakpoint and start the debugging session.

4. Create a PHP Script run/debug configuration or auto-generate run/debug configuration from the context menu of the file in Project View tool window.

Image Added

Info

Please note that remote debugging with remote PHP interpreters is currently available for Xdebug only (not for Zend Debugger).

Wiki Markup
{hidden-data}


h3. Composer and Remote PHP Interpreters

{color:#333333}PHP interpreter is a project setting in PhpStorm: it will be used for all actions that require the PHP executable, for example for running the various{color} [Composer|http://getcomposer.org] {color:#333333}commands. When a remote PHP interpreter is configured, the{color} [PhpStorm:Composer Support in PhpStorm] {color:#333333}may break because the remote PHP interpreter will potentially not have access to the project path on our development machine.{color}

Through *{_}Project Settings \| PHP \| Composer{_}*, we can specify the PHP interpreter to use for running Composer commands.

!composer-remote-interpreter.png!

Once configured, PhpStorm will use the remote PHP interpreter for commands that can be run remote, for example running PHPUnit tests, and a local interpreter for Composer.
{hidden-data}

PHPUnit and Remote PHP Interpreters

We can also run PHPUnit tests using remote PHP interpreters. To do so, configure a remote PHP interpreter first. Next, click the green + button in File | Settings (or PhpStorm | Preferences for Mac) | Languages & Frameworks | PHP | Test Frameworks and add PHPUnit settings By Remote Interpreter.

Image Added

Note

PhpStorm will need the remote path to the PHPUnit configuration file and/or autoloader.

Once done, create a new PHPUnit Run/Debug configuration as we would do normally. We can then run, debug and profile PHPUnit using the remote PHP interpreter.

See Running PHPUnit tests over SSH on a remote server with PhpStorm for a complete tutorial.

Troubleshooting Remote PHP Interpreters

...

In some cases, for example when additional shared folders have been configured, it may be required to add the remote PHP interpreter from a SFTP deployment configuration (e.g. SFTP) and configure mappings manually. A mapping is the relation between the project folders, the folders on the remote server, and the URLs to access the data on the server over HTTP. These mappings are used to help PhpStorm find a file or folder in our project or on the remote server.

...

Local path

Path on the remote server

Web path (URL)

Pre
Wiki Markup
{pre}C:\Projects\wordpress-networkmarketing{pre}

Pre

Wiki Markup
{pre}/site/wwwroot/wp-content/plugins/jetbrains-networkmarketing{pre}

Pre

Wiki Markup
{pre}/wp-content/plugins/jetbrains-networkmarketing{pre}

In the case where multiple folders should be mapped, which is common for frameworks like Symfony2, Zend Framework, Laravel or CakePHP that typically make use of two main folders, we can configure additional mappings:

Local path

Path on the remote server

Web path (URL)

Pre
Wiki Markup
{pre}C:\Projects\MyProject\application{pre}

Pre

Wiki Markup
{pre}/site/application{pre}

 

Pre

Wiki Markup
{pre}C:\Projects\MyProject\public{pre}

Pre

Wiki Markup
{pre}/site/wwwroot{pre}

Pre/

Wiki Markup
{pre}/{pre}

Note the warning shown is because the /application path has no web path specified, which in this setup is perfectly fine.

align
Note

Note that when folders match multiple relevant mappings, the nearest one is applied.

Include Page

...

alignright

...

HTML

<a href="https://twitter.com/share" class="twitter-share-button" data-via="phpstorm">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<span id="fb-root"></span>
<script>(function(d, s, id) {
  var js, fjs = d.getElementsByTagName(s)[0];
  if (d.getElementById(id)) return;
  js = d.createElement(s); js.id = id;
  js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.0";
  fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>
<span class="fb-like" data-layout="button_count" data-action="like" data-show-faces="true" data-share="false" style="position:relative;margin-left:-20px;top:-5px;"></span>
<script type="text/javascript" src="http://apis.google.com/js/plusone.js"></script>
<g:plusone size="medium"></g:plusone>

Social Buttons PhpStorm
Social Buttons PhpStorm