class SiteCommands extends DrushCommands implements SiteAliasManagerAwareInterface (View source)

Traits

SiteAliasManagerAwareTrait
ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

Methods

getConfig()

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

__construct()

No description

LoggerInterface
logger()

Returns a logger object.

io()

Override Robo's IO function with our custom style.

printFile(string $file)

Print the contents of a file.

siteSet(string $site = '@none')

Set a site alias that will persist for the current session.

UnstructuredListData
siteAlias(string $site = null, array $options = ['format' => 'yaml'])

Show site alias details, or a list of available site aliases.

array
siteAliasConvert($destination, $options = ['format' => 'yaml', 'sources' => self::REQ])

Convert legacy site alias files to the new yml format.

interactSiteAliasConvert(Input $input, Output $output)

No description

array
siteAliasExportList(array $aliasList, $options)

No description

Details

DrushConfig getConfig()

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

__construct()

protected LoggerInterface logger()

Returns a logger object.

Return Value

LoggerInterface

protected io()

Override Robo's IO function with our custom style.

protected printFile(string $file)

Print the contents of a file.

Parameters

string $file Full path to a file.

siteSet(string $site = '@none')

Set a site alias that will persist for the current session.

Stores the site alias being used in the current session in a temporary file.

Parameters

string $site Site specification to use, or "-" for previous site. Omit this argument to unset.

Exceptions

Exception

UnstructuredListData siteAlias(string $site = null, array $options = ['format' => 'yaml'])

Show site alias details, or a list of available site aliases.

Parameters

string $site Site alias or site specification.
array $options

Return Value

UnstructuredListData

Exceptions

Exception

array siteAliasConvert($destination, $options = ['format' => 'yaml', 'sources' => self::REQ])

Convert legacy site alias files to the new yml format.

Parameters

$destination
$options

Return Value

array

interactSiteAliasConvert(Input $input, Output $output)

Parameters

Input $input
Output $output

protected array siteAliasExportList(array $aliasList, $options)

Parameters

array $aliasList
$options

Return Value

array