class ConfigImportCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

IMPORT

Properties

protected CommandData|null $commandData from  DrushCommands
protected StorageInterface|null $configStorageSync
protected ImportStorageTransformer|null $importStorageTransformer

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, CacheBackendInterface $configCache, ModuleHandlerInterface $moduleHandler, EventDispatcherInterface $eventDispatcher, LockBackendInterface $lock, TypedConfigManagerInterface $configTyped, ModuleInstallerInterface $moduleInstaller, ThemeHandlerInterface $themeHandler, TranslationInterface $stringTranslation, ModuleExtensionList $moduleExtensionList)

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

StorageInterface
getConfigStorage()

No description

StorageInterface
getConfigStorageSync()

No description

void
setConfigStorageSync(StorageInterface|null $syncStorage)

No description

CacheBackendInterface
getConfigCache()

No description

ModuleHandlerInterface
getModuleHandler()

No description

EventDispatcherInterface
getEventDispatcher()

No description

LockBackendInterface
getLock()

No description

TypedConfigManagerInterface
getConfigTyped()

No description

ModuleInstallerInterface
getModuleInstaller()

No description

ThemeHandlerInterface
getThemeHandler()

No description

TranslationInterface
getStringTranslation()

No description

void
setImportTransformer(ImportStorageTransformer $importStorageTransformer)

No description

bool
hasImportTransformer()

No description

ImportStorageTransformer|null
getImportTransformer()

No description

ModuleExtensionList
getModuleExtensionList()

No description

create(ContainerInterface $container)

No description

import(array $options = ['source' => self::REQ, 'partial' => false, 'diff' => false])

Import config from the config directory.

void
doImport($storage_comparer)

No description

validate(CommandData $commandData)

Validate partial and source options.

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, CacheBackendInterface $configCache, ModuleHandlerInterface $moduleHandler, EventDispatcherInterface $eventDispatcher, LockBackendInterface $lock, TypedConfigManagerInterface $configTyped, ModuleInstallerInterface $moduleInstaller, ThemeHandlerInterface $themeHandler, TranslationInterface $stringTranslation, ModuleExtensionList $moduleExtensionList)

No description

Parameters

ConfigManagerInterface $configManager
StorageInterface $configStorage
CacheBackendInterface $configCache
ModuleHandlerInterface $moduleHandler
EventDispatcherInterface $eventDispatcher
LockBackendInterface $lock
TypedConfigManagerInterface $configTyped
ModuleInstallerInterface $moduleInstaller
ThemeHandlerInterface $themeHandler
TranslationInterface $stringTranslation
ModuleExtensionList $moduleExtensionList

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

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

CacheBackendInterface getConfigCache()

No description

Return Value

CacheBackendInterface

ModuleHandlerInterface getModuleHandler()

No description

Return Value

ModuleHandlerInterface

EventDispatcherInterface getEventDispatcher()

No description

Return Value

EventDispatcherInterface

LockBackendInterface getLock()

No description

Return Value

LockBackendInterface

TypedConfigManagerInterface getConfigTyped()

No description

Return Value

TypedConfigManagerInterface

ModuleInstallerInterface getModuleInstaller()

No description

Return Value

ModuleInstallerInterface

ThemeHandlerInterface getThemeHandler()

No description

Return Value

ThemeHandlerInterface

TranslationInterface getStringTranslation()

No description

Return Value

TranslationInterface

void setImportTransformer(ImportStorageTransformer $importStorageTransformer)

No description

Parameters

ImportStorageTransformer $importStorageTransformer

Return Value

void

bool hasImportTransformer()

No description

Return Value

bool

ImportStorageTransformer|null getImportTransformer()

No description

Return Value

ImportStorageTransformer|null

ModuleExtensionList getModuleExtensionList()

No description

Return Value

ModuleExtensionList

static ConfigImportCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

ConfigImportCommands

import(array $options = ['source' => self::REQ, 'partial' => false, 'diff' => false])

Import config from the config directory.

Parameters

array $options

void doImport($storage_comparer)

No description

Parameters

$storage_comparer

Return Value

void

validate(CommandData $commandData)

Validate partial and source options.

Parameters

CommandData $commandData