Boot
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
Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.
Inject the uri for the specific site to be bootstrapped
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.
Given a site root directory, determine the exact version of the software.
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 an array mapping from bootstrap phase shorthand strings (e.g. "full") to the corresponding bootstrap phase index constant (e.g. DRUSH_BOOTSTRAP_DRUPAL_FULL).
Convert from a phase shorthand or constant to a phase index.
Called by Drush if a command is not found, or if the command was found, but did not meet requirements.
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.
setUri(string $uri)
Inject the uri for the specific site to be bootstrapped
bool
validRoot(string|null $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.
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.
array
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.
The implementation in BaseBoot should be sufficient for most cases, so this method typically will not need to be overridden.
void
terminate()
This method is called during the shutdown of drush.