final class SiteInstallCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

INSTALL

Properties

protected CommandData|null $commandData from  DrushCommands

Methods

bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)

Starts a background browser/tab for the current site or a specified URL.

static bool
programExists($program)

No description

static string
getEditor(string|null $editor = null)

No description

getConfig()

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

__construct(BootstrapManager $bootstrapManager, SiteAliasManager $siteAliasManager, ClassLoader $autoloader)

No description

SymfonyStyle
io()

Override Robo's IO function with our custom style.

DrushLoggerManager|null
logger()

Returns a logger object.

void
printFile(string $file)

Print the contents of a file.

preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

HandlerStack
getStack()

Get a Guzzle handler stack that uses the Drush logger.

createEarly(ContainerInterface $drush_container)

No description

void
install(array $profile, $options = ['db-url' => self::REQ, 'db-prefix' => self::REQ, 'db-su' => self::REQ, 'db-su-pw' => self::REQ, 'account-name' => 'admin', 'account-mail' => 'admin@example.com', 'site-mail' => 'admin@example.com', 'account-pass' => self::REQ, 'locale' => 'en', 'site-name' => 'Drush Site-Install', 'site-pass' => self::REQ, 'sites-subdir' => self::REQ, 'config-dir' => self::REQ, 'existing-config' => false])

Install Drupal along with modules/themes/configuration/profile.

void
taskCallback($install_state)

No description

string|bool
determineProfile($profile, $options)

No description

bool
hasConfigFiles($config)

Check to see if there are any .yml files in the provided config directory.

void
validate(CommandData $commandData)

No description

void
pre(CommandData $commandData)

Perform setup tasks before installation.

getSitesSubdirFromUri($root, $uri)

Determine an appropriate site subdir name to use for the provided uri.

void
serverGlobals($drupal_base_url)

Fake the necessary HTTP headers that the Drupal installer still needs:

void
validateConfigDir(CommandData $commandData, $directory)

Assure that a config directory exists and is populated.

Details

bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)

Starts a background browser/tab for the current site or a specified URL.

Uses a non-blocking Process call, so Drush execution will continue.

Parameters

string|null $uri

Optional URI or site path to open in browser. If omitted, or if a site path is specified, the current site home page uri will be prepended if the site's hostname resolves.

int $sleep
int|null $port
string|bool $browser

Return Value

bool

if browser was opened. FALSE if browser was disabled by the user or a default browser could not be found.

static bool programExists($program)

No description

Parameters

$program

Return Value

bool

static string getEditor(string|null $editor = null)

No description

Parameters

string|null $editor

Return Value

string

DrushConfig getConfig()

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

__construct(BootstrapManager $bootstrapManager, SiteAliasManager $siteAliasManager, ClassLoader $autoloader)

No description

Parameters

BootstrapManager $bootstrapManager
SiteAliasManager $siteAliasManager
ClassLoader $autoloader

protected SymfonyStyle io()

Override Robo's IO function with our custom style.

Return Value

SymfonyStyle

protected DrushLoggerManager|null logger()

Returns a logger object.

Return Value

DrushLoggerManager|null

protected void printFile(string $file)

Print the contents of a file.

Parameters

string $file

Full path to a file.

Return Value

void

preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

Parameters

CommandData $commandData

protected printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

Parameters

CommandData $commandData

Full path to a file.

protected HandlerStack getStack()

Get a Guzzle handler stack that uses the Drush logger.

static SiteInstallCommands createEarly(ContainerInterface $drush_container)

No description

Parameters

ContainerInterface $drush_container

Return Value

SiteInstallCommands

void install(array $profile, $options = ['db-url' => self::REQ, 'db-prefix' => self::REQ, 'db-su' => self::REQ, 'db-su-pw' => self::REQ, 'account-name' => 'admin', 'account-mail' => 'admin@example.com', 'site-mail' => 'admin@example.com', 'account-pass' => self::REQ, 'locale' => 'en', 'site-name' => 'Drush Site-Install', 'site-pass' => self::REQ, 'sites-subdir' => self::REQ, 'config-dir' => self::REQ, 'existing-config' => false])

Install Drupal along with modules/themes/configuration/profile.

Parameters

array $profile
$options

Return Value

void

void taskCallback($install_state)

No description

Parameters

$install_state

Return Value

void

protected string|bool determineProfile($profile, $options)

No description

Parameters

$profile
$options

Return Value

string|bool

protected bool hasConfigFiles($config)

Check to see if there are any .yml files in the provided config directory.

Parameters

$config

Return Value

bool

void validate(CommandData $commandData)

No description

Parameters

CommandData $commandData

Return Value

void

void pre(CommandData $commandData)

Perform setup tasks before installation.

Parameters

CommandData $commandData

Return Value

void

protected getSitesSubdirFromUri($root, $uri)

Determine an appropriate site subdir name to use for the provided uri.

Parameters

$root
$uri

void serverGlobals($drupal_base_url)

Fake the necessary HTTP headers that the Drupal installer still needs:

protected void validateConfigDir(CommandData $commandData, $directory)

Assure that a config directory exists and is populated.

Parameters

CommandData $commandData
$directory

Return Value

void

Exceptions

Exception