1. class
  2. Drush
  3. \
  4. Commands
  5. \
  6. core
  7. \
  8. ArchiveDumpCommands

ArchiveDumpCommands

final class ArchiveDumpCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
ExecTrait
ConfigAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

DUMP

private COMPONENT_CODE

private COMPONENT_FILES

private COMPONENT_DATABASE

private SQL_DUMP_FILE_NAME

private ARCHIVES_DIR_NAME

private ARCHIVE_FILE_NAME

private MANIFEST_FORMAT_VERSION

private MANIFEST_FILE_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.

from  ExecTrait
static bool
programExists($program)

No description

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

No description

from  ExecTrait
DrushConfig
getConfig()

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

from  ConfigAwareTrait
__construct()

No description

from  DrushCommands
SymfonyStyle
io()

Override Robo's IO function with our custom style.

from  DrushCommands
DrushLoggerManager|null
logger()

Returns a logger object.

from  DrushCommands
void
printFile(string $file)

Print the contents of a file.

from  DrushCommands
preHook(CommandData $commandData)

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

from  DrushCommands
printFileTopic(CommandData $commandData)

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

from  DrushCommands
HandlerStack
getStack()

Get a Guzzle handler stack that uses the Drush logger.

from  DrushCommands
string
dump(array $options = ['code' => false, 'files' => false, 'db' => false, 'destination' => InputOption::VALUE_REQUIRED, 'overwrite' => false, 'description' => InputOption::VALUE_REQUIRED, 'tags' => InputOption::VALUE_REQUIRED, 'generator' => InputOption::VALUE_REQUIRED, 'generatorversion' => InputOption::VALUE_REQUIRED, 'exclude-code-paths' => InputOption::VALUE_REQUIRED, 'extra-dump' => self::REQ])

Backup your code, files, and database into a single file.

void
prepareArchiveDir()

Creates a temporary directory for the archive.

Details

in ExecTrait at line 26
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.

in ExecTrait at line 87
static bool programExists($program)

No description

Parameters

$program

Return Value

bool

in ExecTrait at line 99
static string getEditor(string|null $editor = null)

No description

Parameters

string|null $editor

Return Value

string

in ConfigAwareTrait at line 21
DrushConfig getConfig()

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

Return Value

DrushConfig

See also

https://stackoverflow.com/a/37687295.

in DrushCommands at line 51
__construct()

No description

in DrushCommands at line 58
protected SymfonyStyle io()

Override Robo's IO function with our custom style.

Return Value

SymfonyStyle

in DrushCommands at line 70
protected DrushLoggerManager|null logger()

Returns a logger object.

Return Value

DrushLoggerManager|null

in DrushCommands at line 81
protected void printFile(string $file)

Print the contents of a file.

Parameters

string $file

Full path to a file.

Return Value

void

in DrushCommands at line 103
preHook(CommandData $commandData)

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

Parameters

CommandData $commandData

in DrushCommands at line 115
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.

in DrushCommands at line 126
protected HandlerStack getStack()

Get a Guzzle handler stack that uses the Drush logger.

Return Value

HandlerStack

See also

https://stackoverflow.com/questions/32681165/how-do-you-log-all-api-calls-using-guzzle-6.

at line 65
string dump(array $options = ['code' => false, 'files' => false, 'db' => false, 'destination' => InputOption::VALUE_REQUIRED, 'overwrite' => false, 'description' => InputOption::VALUE_REQUIRED, 'tags' => InputOption::VALUE_REQUIRED, 'generator' => InputOption::VALUE_REQUIRED, 'generatorversion' => InputOption::VALUE_REQUIRED, 'exclude-code-paths' => InputOption::VALUE_REQUIRED, 'extra-dump' => self::REQ])

Backup your code, files, and database into a single file.

The following paths would be excluded from a code archive:

  • .git
  • vendor
  • [docroot]/sites/@/settings.@.php
  • Drupal files directory
  • Composer packages installed paths (composer info --path --format=json)

The following directories would be excluded from a file archive:

  • css
  • js
  • styles
  • php

Parameters

array $options

Return Value

string

at line 140
protected void prepareArchiveDir()

Creates a temporary directory for the archive.

Return Value

void

Exceptions

Exception