ConfigCommands
final class ConfigCommands extends DrushCommands implements StdinAwareInterface, SiteAliasManagerAwareInterface (View source)
Traits
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
| INTERACT_CONFIG_NAME |
|
| VALIDATE_CONFIG_NAME |
|
| GET |
|
| SET |
|
| EDIT |
|
| DELETE |
|
| STATUS |
|
Properties
| protected CommandData|null | $commandData | from DrushCommands | |
| protected StorageInterface|null | $configStorageExport | ||
| protected ImportStorageTransformer|null | $importStorageTransformer |
Methods
Starts a background browser/tab for the current site or a specified URL.
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
No description
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
No description
No description
No description
No description
No description
No description
No description
Display a config value, or a whole configuration object.
Save a config value directly. Does not perform a config import.
Open a config file in a text editor. Edits are imported after closing editor.
Delete a configuration key, or a whole object(s).
Display status of configuration (differences between the filesystem and database).
Determine which configuration directory to use and return directory path.
Returns the difference in configuration between active storage and target storage.
Get storage corresponding to a configuration directory.
Build a table of config changes.
No description
No description
Validate that a config name is valid.
Copies configuration objects from source storage to target storage.
Get diff between two config sets.
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.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
DrushConfig
getConfig()
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
protected
__construct(ConfigFactoryInterface $configFactory, StorageInterface $configStorage)
No description
protected SymfonyStyle
io()
Override Robo's IO function with our custom style.
protected DrushLoggerManager|null
logger()
Returns a logger object.
protected 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.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
ConfigFactoryInterface
getConfigFactory()
No description
static ConfigCommands
create(ContainerInterface $container)
No description
void
setExportStorage(StorageInterface $exportStorage)
No description
StorageInterface
getConfigStorageExport()
No description
void
setImportTransformer(ImportStorageTransformer $importStorageTransformer)
No description
bool
hasImportTransformer()
No description
ImportStorageTransformer
getImportTransformer()
No description
get($config_name, $key = '', $options = ['format' => 'yaml', 'source' => 'active', 'include-overridden' => false])
Display a config value, or a whole configuration object.
set($config_name, $key, $value, $options = ['input-format' => 'string'])
Save a config value directly. Does not perform a config import.
void
edit($config_name, $options = [])
Open a config file in a text editor. Edits are imported after closing editor.
void
delete($config_name, $key = null)
Delete a configuration key, or a whole object(s).
RowsOfFields|null
status($options = ['state' => 'Only in DB,Only in sync dir,Different', 'prefix' => self::REQ])
Display status of configuration (differences between the filesystem and database).
static string
getDirectory(mixed $directory = null)
Determine which configuration directory to use and return directory path.
Directory path is determined based on the following precedence:
- User-provided $directory.
- Default sync directory
array
getChanges($target_storage)
Returns the difference in configuration between active storage and target storage.
getStorage($directory)
Get storage corresponding to a configuration directory.
static Table
configChangesTable(array $config_changes, OutputInterface $output, $use_color = true)
Build a table of config changes.
void
configComplete(CompletionInput $input, CompletionSuggestions $suggestions)
No description
void
interactConfigName($input, $output)
No description
CommandError|null
validateConfigName(CommandData $commandData)
Validate that a config name is valid.
static void
copyConfig(StorageInterface $source, StorageInterface $destination)
Copies configuration objects from source storage to target storage.
static string
getDiff(StorageInterface $destination_storage, StorageInterface $source_storage, OutputInterface $output)
Get diff between two config sets.