1. class
  2. Drush
  3. \
  4. Boot
  5. \
  6. BaseBoot

BaseBoot

abstract class BaseBoot implements Boot, LoggerAwareInterface (View source)

Traits

LoggerAwareTrait

Properties

protected string|bool $uri
protected int $phase

Methods

__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.

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.

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

bool
hasRegisteredSymfonyCommand($application, $name)

No description

void
terminate()

This method is called during the shutdown of drush.

Details

at line 17
__construct()

No description

at line 22
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

at line 27
string getUri()

No description

Return Value

string

at line 32
setUri(string $uri)

Inject the uri for the specific site to be bootstrapped

Parameters

string $uri

Site to bootstrap

at line 37
int getPhase()

No description

Return Value

int

at line 42
void setPhase(int $phase)

No description

Parameters

int $phase

Return Value

void

at line 47
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.

Parameters

string|null $path

Return Value

bool

at line 51
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

at line 55
commandDefaults()

No description

at line 59
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

at line 64
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).

Return Value

array

at line 78
lookUpPhaseIndex($phase)

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

Parameters

$phase

at line 94
bootstrapDrush()

No description

at line 98
protected bool hasRegisteredSymfonyCommand($application, $name)

No description

Parameters

$application
$name

Return Value

bool

at line 111
void terminate()

This method is called during the shutdown of drush.

Return Value

void