MkCommands
final class MkCommands extends DrushCommands (View source)
Traits
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
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 |
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
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.
Build a Markdown document for each available Drush command/generator.
Convert generators into Annotated commands (for Help).
No description
No description
No description
No description
No description
No description
No description
No description
Empty target directories.
Build an array since that's what HelpCLIFormatter expects.
Build an array since that's what HelpCLIFormatter expects.
Convert text like
Write content files, add to nav, build a redirect map.
No description
Get a filename from a command.
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
in
IO at line 32
__construct($obj, $input, $output, $io)
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.
void
docs()
Build a Markdown document for each available Drush command/generator.
This command is an early step when building the www.drush.org static site. Adapt it to build a similar site listing the commands that are available on your site. Also see Drush's Github Actions workflow.
array
createAnnotatedCommands(Application $application_generate, Application $application_drush)
Convert generators into Annotated commands (for Help).
static protected string
appendPostAmble()
No description
static protected string
appendAliases($command)
No description
static protected string
appendTopics(AnnotatedCommand $command, string $dir_commands)
No description
static protected string
appendOptions($command)
No description
static protected string
appendOptionsGlobal($application)
No description
static protected string
appendArguments($command)
No description
static protected string
appendUsages(AnnotatedCommand $command)
No description
static protected string
appendPreamble($command, $root)
No description
protected void
writeYml(array $nav_commands, array $nav_generators, array $map_commands, array $map_generators, string $dest)
No description
protected void
writeAllMd(array $pages_all, string $destination_path, string $title)
No description
protected void
prepare($destination)
Empty target directories.
static iterable
argToArray(InputArgument $arg)
Build an array since that's what HelpCLIFormatter expects.
static iterable
optionToArray(InputOption $opt)
Build an array since that's what HelpCLIFormatter expects.
static string
cliTextToMarkdown(string $text)
Convert text like
array
writeContentFilesAndBuildNavAndBuildRedirectMap(array $namespaced, string $destination, string $dir_root, string $destination_path)
Write content files, add to nav, build a redirect map.
protected array
getRedirectMap(Command $command, string $destination)
No description
string
getFilename(string $name)
Get a filename from a command.