final class ConfigExportCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

EXPORT

Properties

protected CommandData|null $commandData from  DrushCommands
protected StorageInterface|null $configStorageSync
protected StorageInterface|null $configStorageExport

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(ConfigManagerInterface $configManager, StorageInterface $configStorage)

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.

ConfigManagerInterface
getConfigManager()

No description

void
setExportStorage(StorageInterface $exportStorage)

No description

StorageInterface
getConfigStorageExport()

No description

StorageInterface
getConfigStorage()

No description

StorageInterface
getConfigStorageSync()

No description

void
setConfigStorageSync(StorageInterface|null $syncStorage)

No description

create(ContainerInterface $container)

No description

array
export($options = ['add' => false, 'commit' => false, 'message' => self::REQ, 'destination' => self::OPT, 'diff' => false, 'format' => null])

Export Drupal configuration to a directory.

doExport($options, $destination_dir)

No description

void
doAddCommit($options, $destination_dir, $preview)

No description

void
validate($commandData)

No description

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(ConfigManagerInterface $configManager, StorageInterface $configStorage)

No description

Parameters

ConfigManagerInterface $configManager
StorageInterface $configStorage

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.

ConfigManagerInterface getConfigManager()

No description

Return Value

ConfigManagerInterface

void setExportStorage(StorageInterface $exportStorage)

No description

Parameters

StorageInterface $exportStorage

Return Value

void

StorageInterface getConfigStorageExport()

No description

Return Value

StorageInterface

StorageInterface getConfigStorage()

No description

Return Value

StorageInterface

StorageInterface getConfigStorageSync()

No description

Return Value

StorageInterface

void setConfigStorageSync(StorageInterface|null $syncStorage)

No description

Parameters

StorageInterface|null $syncStorage

Return Value

void

static ConfigExportCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

ConfigExportCommands

array export($options = ['add' => false, 'commit' => false, 'message' => self::REQ, 'destination' => self::OPT, 'diff' => false, 'format' => null])

Export Drupal configuration to a directory.

Parameters

$options

Return Value

array

doExport($options, $destination_dir)

No description

Parameters

$options
$destination_dir

void doAddCommit($options, $destination_dir, $preview)

No description

Parameters

$options
$destination_dir
$preview

Return Value

void

void validate($commandData)

No description

Parameters

$commandData

Return Value

void