interface TestSetupInterface

Same name in other branches
  1. 8.9.x core/tests/Drupal/TestSite/TestSetupInterface.php \Drupal\TestSite\TestSetupInterface
  2. 10 core/tests/Drupal/TestSite/TestSetupInterface.php \Drupal\TestSite\TestSetupInterface
  3. 11.x core/tests/Drupal/TestSite/TestSetupInterface.php \Drupal\TestSite\TestSetupInterface

Allows setting up an environment as part of a test site install.

Hierarchy

Expanded class hierarchy of TestSetupInterface

All classes that implement TestSetupInterface

See also

\Drupal\TestSite\Commands\TestSiteInstallCommand

1 file declares its use of TestSetupInterface
TestSiteInstallCommand.php in core/tests/Drupal/TestSite/Commands/TestSiteInstallCommand.php

File

core/tests/Drupal/TestSite/TestSetupInterface.php, line 10

Namespace

Drupal\TestSite
View source 
interface TestSetupInterface {
    
    /**
     * Run the code to setup the test environment.
     *
     * You have access to any API provided by any installed module. For example,
     * to install modules use:
     * @code
     * \Drupal::service('module_installer')->install(['my_module'])
     * @endcode
     *
     * Check out TestSiteInstallTestScript for an example.
     *
     * @see \Drupal\TestSite\TestSiteInstallTestScript
     */
    public function setup();

}

Members

Title Modifiers Object type Summary Overrides
TestSetupInterface::setup public function Run the code to setup the test environment. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.