interface Boot (View source)

Defines the interface for a Boot classes. Any CMS that wishes to work with Drush should extend BaseBoot. If the CMS has a Drupal-Compatibility layer, then it should extend DrupalBoot.

Methods

findUri($root, $uri)

Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.

setUri(string $uri)

Inject the uri for the specific site to be bootstrapped

TRUE
validRoot($path)

This function determines if the specified path points to the root directory of a CMS that can be bootstrapped by the specific subclass that implements it.

string|NULL
getVersion(string $root)

Given a site root directory, determine the exact version of the software.

array
bootstrapPhases()

Returns an array that determines what bootstrap phases are necessary to bootstrap this CMS. This array should map from a numeric phase to the name of a method (string) in the Boot class that handles the bootstrap phase.

bootstrapPhaseMap()

Return an array mapping from bootstrap phase shorthand strings (e.g. "full") to the corresponding bootstrap phase index constant (e.g. DRUSH_BOOTSTRAP_DRUPAL_FULL).

lookUpPhaseIndex($phase)

Convert from a phase shorthand or constant to a phase index.

reportCommandError($command)

Called by Drush if a command is not found, or if the command was found, but did not meet requirements.

void
terminate()

This method is called during the shutdown of drush.

Details

findUri($root, $uri)

Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.

Parameters

$root
$uri

setUri(string $uri)

Inject the uri for the specific site to be bootstrapped

Parameters

string $uri Site to bootstrap

TRUE validRoot($path)

This function determines if the specified path points to the root directory of a CMS that can be bootstrapped by the specific subclass that implements it.

These functions should be written such that one and only one class will return TRUE for any given $path.

Parameters

$path to a directory to test

Return Value

TRUE if $path is a valid root directory

string|NULL getVersion(string $root)

Given a site root directory, determine the exact version of the software.

Parameters

string $root The full path to the site installation, with no trailing slash.

Return Value

string|NULL The version string for the current version of the software, e.g. 8.1.3

array bootstrapPhases()

Returns an array that determines what bootstrap phases are necessary to bootstrap this CMS. This array should map from a numeric phase to the name of a method (string) in the Boot class that handles the bootstrap phase.

Return Value

array of PHASE index => method name.

See also

DrupalBoot::bootstrapPhases

bootstrapPhaseMap()

Return an array mapping from bootstrap phase shorthand strings (e.g. "full") to the corresponding bootstrap phase index constant (e.g. DRUSH_BOOTSTRAP_DRUPAL_FULL).

lookUpPhaseIndex($phase)

Convert from a phase shorthand or constant to a phase index.

Parameters

$phase

reportCommandError($command)

Called by Drush if a command is not found, or if the command was found, but did not meet requirements.

The implementation in BaseBoot should be sufficient for most cases, so this method typically will not need to be overridden.

Parameters

$command

void terminate()

This method is called during the shutdown of drush.

Return Value

void