PHPSpec

This page is available only when the PHP and PHPSpec plugins are installed and enabled. The plugins are bundled with PhpStorm and activated by default. If the plugins are not activated, enable them on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Before you start, make sure the PHP interpreter is configured in PhpStorm on the PHP page, as described in Configuring Local PHP Interpreters and Configuring Remote PHP Interpreters.

On this page, configure installations of the PHPSpec toolset available through configured local and remote PHP interpreters and thus enable behaviour-driven development in PhpStorm. The page consists of two panes:

PHP interpreters
PHPSpec configuration

PHP interpreters

The central pane of the page shows a list of configured PHP interpreters that are associated with PHPSpec installations. The list contains at least one item (Local) which cannot be removed. The contents of the right-hand pane depend on the type of the selected interpreter.

To add a remote interpreter to the list, click on the toolbar of the pane and choose the relevant interpreter in the PHPSpec by remote interpreter dialog that opens. Then specify the details of the PHPSpec installation to use with this interpreter.
To remove a remote interpreter from the list, select the relevant interpreter and click . The PHPSpec configuration associated with the interpreter is also removed.

See Configuring Remote PHP Interpreters for details.

PHPSpec configuration

Item Description

Item	Description
CLI Interpreter	This area shows: The remote PHP CLI Interpreter to use PHPSpec with. The field is read-only, to update the chosen interpreter configuration or create a new one, click the whereupon PhpStorm brings you to the Interpreters dialog box. The Path Mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host. The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed port, the network, etc. In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click the next to the field in question and specify the settings manually. See Configuring Remote PHP Interpreters for details. The field is read-only, to update the chosen interpreter configuration or create a new one, click the whereupon PhpStorm brings you to the Interpreters dialog box.
PHPSpec Library	In this area, specify the PHPSpec installation to use. In the Path to PHPSpec executable text box, specify the location of `phpspec`. PHPSpec does not necessarily have to be installed under the current project root. If no path to PHPSpec is specified for a Local interpreter, PhpStorm does not provide full support of PHPSpec, for example, it does not show suggestion for code completion and does not resolve references. The Prefix ('spec_prefix'): read-only field shows the namespace prefix for specifications. PhpStorm detects `spec_prefix` from the configuration file specified in the Default Configuration File field. The default value is `spec`. See PHPSpec Configuration: PSR-4 and PHPSpec Configuration: Spec and Source Location for details. The field is shown for Local configurations only.
Test Runner	In this area, appoint the configuration `.yml` file to use for launching and executing specifications. By default, PHPSpec looks for a `phpspec.yml` or a `phpspec.yml.dist` configuration file in the project root folder. You can appoint a custom configuration file. Default configuration file: select this check box to specify your own `.yml` configuration file. This file will be later used as default in all PHPSpec run/debug configurations. In the text box, specify the location of the configuration file to use. Type the path manually or click the button and choose the file in the dialog box that opens. Clear the check box to have PHPSpec use the `phpspec.yml` or `phpspec.yml.dist` configuration file from the project root folder. If no such file is found, test execution fails, therefore it may be more reliable to specify the configuration file explicitly.

CLI Interpreter

This area shows:

The remote PHP CLI Interpreter to use PHPSpec with. The field is read-only, to update the chosen interpreter configuration or create a new one, click the whereupon PhpStorm brings you to the Interpreters dialog box.
The Path Mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host.
The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed port, the network, etc.

In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click the

next to the field in question and specify the settings manually. See Configuring Remote PHP Interpreters for details.

The field is read-only, to update the chosen interpreter configuration or create a new one, click the whereupon PhpStorm brings you to the Interpreters dialog box.

PHPSpec Library

In this area, specify the PHPSpec installation to use.

In the Path to PHPSpec executable text box, specify the location of phpspec. PHPSpec does not necessarily have to be installed under the current project root.
If no path to PHPSpec is specified for a Local interpreter, PhpStorm does not provide full support of PHPSpec, for example, it does not show suggestion for code completion and does not resolve references.
The Prefix ('spec_prefix'): read-only field shows the namespace prefix for specifications. PhpStorm detects spec_prefix from the configuration file specified in the Default Configuration File field. The default value is spec. See PHPSpec Configuration: PSR-4 and PHPSpec Configuration: Spec and Source Location for details.
The field is shown for Local configurations only.

Test Runner

In this area, appoint the configuration .yml file to use for launching and executing specifications.

By default, PHPSpec looks for a phpspec.yml or a phpspec.yml.dist configuration file in the project root folder. You can appoint a custom configuration file.

Default configuration file: select this check box to specify your own .yml configuration file. This file will be later used as default in all PHPSpec run/debug configurations.
In the text box, specify the location of the configuration file to use. Type the path manually or click the button and choose the file in the dialog box that opens.

Clear the check box to have PHPSpec use the phpspec.yml or phpspec.yml.dist configuration file from the project root folder. If no such file is found, test execution fails, therefore it may be more reliable to specify the configuration file explicitly.

Procedures:

Testing with PHPSpec

Reference:

Run/Debug Configuration: PHPSpec

Last modified: 19 July 2017

PhpStorm 2017.1 Help

PHPSpec

PHP interpreters

PHPSpec configuration

See Also

Procedures:

Reference: