EmptyBoot
class EmptyBoot extends BaseBoot (View source)
This is a do-nothing 'Boot' class that is used when there is no site at Drupal root, or when no root is specified.
The 'empty' boot must be careful to never change state, in case bootstrap code might later come along and set a site (e.g. in command completion).
Traits
Properties
| protected string|bool | $uri | from BaseBoot | |
| protected int | $phase | from BaseBoot |
Methods
Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.
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.
Called by Drush if a command is not found, or if the command was found, but did not meet requirements.
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).
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.
No description
Details
__construct()
No description
findUri($root, $uri)
Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.
string
getUri()
No description
setUri(string $uri)
Inject the uri for the specific site to be bootstrapped
int
getPhase()
No description
void
setPhase(int $phase)
No description
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.
commandDefaults()
No description
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.
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.
bootstrapDrush()
No description
protected bool
hasRegisteredSymfonyCommand($application, $name)
No description
void
terminate()
This method is called during the shutdown of drush.
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
bootstrapInitPhases()
No description