final class ArchiveRestoreCommands extends DrushCommands implements SiteAliasManagerAwareInterface (View source)

Traits

SiteAliasManagerAwareTrait
ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

RESTORE

private COMPONENT_CODE

private COMPONENT_FILES

private COMPONENT_DATABASE

private SQL_DUMP_FILE_NAME

private SITE_SUBDIR

private TEMP_DIR_NAME

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()

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.

void
restore(string $path = null, string|null $site = null, array $options = ['destination-path' => null, 'overwrite' => false, 'site-subdir' => self::SITE_SUBDIR, 'setup-database-connection' => true, 'code' => false, 'code-source-path' => null, 'files' => false, 'files-source-path' => null, 'files-destination-relative-path' => null, 'db' => false, 'db-source-path' => null, 'db-driver' => 'mysql', 'db-port' => null, 'db-host' => null, 'db-name' => null, 'db-user' => null, 'db-password' => null, 'db-prefix' => null])

Restore (import) your code, files, and database.

string|null
getExtractDir(string|null $path)

Extracts the archive.

void
importCode(string $source)

Imports the code to the site.

void
importFiles(string $source, array $options)

Imports Drupal files to the site.

string
fileImportAbsolutePath(string|null $destinationRelative)

Determines the path where files should be extracted.

string|null
getDrupalRootPath()

Returns the absolute path to Drupal root.

string
getDestinationPath()

Returns the destination path.

SiteAlias
getSiteAlias(string|null $site)

Returns SiteAlias object by the site alias name.

void
rsyncFiles(string $source, string $destination)

Copies files from the source to the destination.

void
importDatabase(string $databaseDumpPath, array $options)

Imports the database dump to the site.

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()

No description

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.

void restore(string $path = null, string|null $site = null, array $options = ['destination-path' => null, 'overwrite' => false, 'site-subdir' => self::SITE_SUBDIR, 'setup-database-connection' => true, 'code' => false, 'code-source-path' => null, 'files' => false, 'files-source-path' => null, 'files-destination-relative-path' => null, 'db' => false, 'db-source-path' => null, 'db-driver' => 'mysql', 'db-port' => null, 'db-host' => null, 'db-name' => null, 'db-user' => null, 'db-password' => null, 'db-prefix' => null])

Restore (import) your code, files, and database.

Parameters

string $path
string|null $site
array $options

Return Value

void

protected string|null getExtractDir(string|null $path)

Extracts the archive.

Parameters

string|null $path

The path to the archive file.

Return Value

string|null

Exceptions

Exception

protected void importCode(string $source)

Imports the code to the site.

Parameters

string $source

The path to the code files directory.

Return Value

void

Exceptions

Exception

protected void importFiles(string $source, array $options)

Imports Drupal files to the site.

Parameters

string $source

The path to the source directory.

array $options

The options.

Return Value

void

Exceptions

Exception

protected string fileImportAbsolutePath(string|null $destinationRelative)

Determines the path where files should be extracted.

Parameters

string|null $destinationRelative

The relative path to the Drupal files directory.

Return Value

string

The absolute path to the Drupal files directory.

Exceptions

Exception

protected string|null getDrupalRootPath()

Returns the absolute path to Drupal root.

Return Value

string|null

protected string getDestinationPath()

Returns the destination path.

Return Value

string

protected SiteAlias getSiteAlias(string|null $site)

Returns SiteAlias object by the site alias name.

Parameters

string|null $site

The site alias.

Return Value

SiteAlias

Exceptions

Exception

protected void rsyncFiles(string $source, string $destination)

Copies files from the source to the destination.

Parameters

string $source

The source path.

string $destination

The destination path.

Return Value

void

Exceptions

Exception

protected void importDatabase(string $databaseDumpPath, array $options)

Imports the database dump to the site.

Parameters

string $databaseDumpPath

The path to the database dump file.

array $options

The command options.

Return Value

void

Exceptions

UserAbortException
Exception