ConfigCommands
final class ConfigCommands extends DrushCommands implements StdinAwareInterface (View source)
Traits
A copy of \Drupal\Core\DependencyInjection\AutowireTrait with first params' type hint changed.
StdinAwareTrait provides the implementation for StdinAwareInterface.
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
| INTERACT_CONFIG_NAME |
|
| VALIDATE_CONFIG_NAME |
|
| GET |
|
| SET |
|
| EDIT |
|
| DELETE |
|
| STATUS |
|
Properties
| protected | $uri | from ExecTrait | |
| protected ConfigInterface | $config | from ConfigAwareTrait | |
| protected InputInterface | $input | from InputAwareTrait | |
| protected OutputInterface | $output | from OutputAwareTrait | |
| protected | $io | from IO | |
| protected | $obj | from IO | |
| protected CommandData|null | $commandData | from DrushCommands | |
| protected | $stdinHandler | from StdinAwareTrait |
Methods
Starts a background browser/tab for the current site or a specified URL.
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
No description
No description
No description
Prompt the user until the given validation callback passes.
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.
This method overrides the trait in order to provide a more specific return type.
Instantiates a new instance of the implementing class using autowiring.
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
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
$this
setConfig(ConfigInterface $config)
Set the config management object.
ConfigInterface
getConfig()
Get the config management object.
static protected string
configPrefix()
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
static protected
configClassIdentifier($classname)
No description
static protected
configPostfix()
No description
static
configure(string $key, mixed $value, ConfigInterface|null $config = null)
No description
protected mixed|null
getConfigValue(string $key, mixed|null $default = null)
No description
$this
setInput(InputInterface $input)
No description
protected InputInterface
input()
No description
protected InputInterface
getInput()
deprecated
deprecated
Backwards compatibility.
$this
setOutput(OutputInterface $output)
No description
protected OutputInterface
output()
No description
protected OutputInterface
stderr()
No description
protected OutputInterface
getOutput()
deprecated
deprecated
Backwards compatibility
in
IO at line 24
currentState()
No description
__construct(ConfigFactoryInterface $configFactory, StorageInterface $configStorage, SiteAliasManagerInterface $siteAliasManager, StorageManagerInterface $configStorageExport, ImportStorageTransformer $importStorageTransformer)
No description
in
IO at line 40
restore()
No description
protected void
configurePrompts(InputInterface $input)
Configure the prompt fallbacks.
protected mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Prompt the user until the given validation callback passes.
protected void
restorePrompts()
Restore the prompts output.
protected bool
runningUnitTests()
No description
protected DrushStyle
io()
Override Robo's IO function with our custom style.
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.
initHook($input, AnnotationData $annotationData)
Configure Laravel prompts package.
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.
ProcessManager
processManager()
This method overrides the trait in order to provide a more specific return type.
static AutowireTrait
create(ContainerInterface $container)
Instantiates a new instance of the implementing class using autowiring.
setStdinHandler(StdinHandler $stdin)
No description
stdin()
No description
ConfigFactoryInterface
getConfigFactory()
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.