1. interface
  2. Consolidation
  3. \
  4. SiteAlias
  5. \
  6. SiteAliasManagerInitializationInterface

SiteAliasManagerInitializationInterface

interface SiteAliasManagerInitializationInterface (View source)

Site Alias manager methods used to set up the object.

Methods

setReferenceData($data)

Allow configuration data to be used in replacements in the alias file.

$this
setRoot(string $root)

Inject the root of the selected site

$this
addSearchLocation(string $path)

Add a search location to our site alias discovery object.

$this
addSearchLocations(array $paths)

Add search locations to our site alias discovery object.

$this
setSelf(SiteAlias $selfSiteAlias)

Force-set the current @self alias.

Details

at line 12
setReferenceData($data)

Allow configuration data to be used in replacements in the alias file.

Parameters

$data

at line 20
$this setRoot(string $root)

Inject the root of the selected site

Parameters

string $root

Return Value

$this

at line 29
$this addSearchLocation(string $path)

Add a search location to our site alias discovery object.

Parameters

string $path

Return Value

$this

at line 39
$this addSearchLocations(array $paths)

Add search locations to our site alias discovery object.

Parameters

array $paths

Any path provided in --alias-path option or drush.path.alias-path configuration item.

Return Value

$this

at line 47
$this setSelf(SiteAlias $selfSiteAlias)

Force-set the current @self alias.

Parameters

SiteAlias $selfSiteAlias

Return Value

$this