Command argument is required.
A command to handle display of help information for other commands or list available commands if none was selected by the command line arguments.
When the CLI runner can't find a valid command, this command is executed to help the user fix their input.
$runner : \Dewdrop\Cli\Run
The \Dewdrop\Cli\Run instance that is managing this and other CLI commands.
$renderer : \Dewdrop\Cli\Renderer\RendererInterface
The renderer that should be used for all command output. No output should be rendered directly (i.e. with echo, print, printf, etc.), so that it is easier to capture and examine output during testing.
$paths : \Dewdrop\Paths
Paths utility to assist CLI commands in getting around the WP environment.
$command : string
The command name that should be used on the CLI to select this command class for execution. For example, when running the dewdrop CLI tool like this:
\Dewdrop\Cli\Run will select the command class that has a command class that has a $command property value of "command-name"
$primaryArg : string
The name of the command's primary argument. The primary argument's value can be specified without naming the argument explicitly on the command line. Using popular version control system Subversion as an example, you can do a code checkout without specifying the name of the path argument like this:
svn checkout http://example.org/path
In that case, the path argument is the primary argument of SVN's checkout command.
In Dewdrop, if your command had a primary argument of "name" and the user supplied this input:
./vendor/bin/dewdrop my-command --folder=example "Example Name Value"
The argument parser would set the name argument's value to "Example Name Value" because that is the value expression not explicitly assigned to another argument name.
Users can still explicitly set the argument name for the primary argument, too, if they prefer:
./vendor/bin/dewdrop --name="Example Name Value"
$supportFallbackArgs : boolean
Whether this command supports passing along any unrecognized arguments to another command. For example, if your CLI command is a thin wrapper around phpunit, you could pass all unrecognized arguments to phpunit so that the Dewdrop user has the full capabilities of phpunit available to them.
__construct(\Dewdrop\Cli\Run $runner, \Dewdrop\Cli\Renderer\RendererInterface $renderer)
Instantiate command with a runner and renderer. After the command sub-class runs its init() method, check to ensure the required basic properties were set.
parseArgs(array $args) : boolean
Parse the arguments passed to this command.
If the "--help" argument is present anywhere in the argument input, all further parsing will be aborted and the command's help content will be displayed.
For all argument names and their aliases, there are multiple acceptable formats of argument and value. For example, all of these inputs are equivalent:
./vendor/bin/dewdrop my-command --argument-name=value ./vendor/bin/dewdrop my-command --argument-name value ./vendor/bin/dewdrop my-command --argument-alias=value ./vendor/bin/dewdrop my-command -argument-alias=value ./vendor/bin/dewdrop my-command -argument-alias value
In short, you can use one or two dashes at the beginning of the argument name and you can separate the value from the name with either a space or an equals sign.
For every argument your command supports, you need to implement a setter method. For example, if you have an argument with the name "my-argument" then your command class needs a method called "setMyArgument()".
Also note that the command API supports the concept of a "primary argument". See the documentation for the $primaryArgument property for more information about that feature.
Whether args were fully parsed and command can be executed.
setDescription(string $description) : \Dewdrop\Cli\Command\CommandAbstract
Set a human-friendly description of this command's role
setCommand(string $command) : \Dewdrop\Cli\Command\CommandAbstract
Set the primary command that will be used to run this command. This value differs from aliases because it is displayed in the default help listings.
addAlias(string $alias) : \Dewdrop\Cli\Command\CommandAbstract
Register an alias for this command. This can be useful to provide the user other ways to execute the command. For example, you might provide a shortened version of the command name so that experienced users can avoid typing the full name once their comfortable with the command.
addPrimaryArg(string $name, string $description, boolean $required, array $aliases = array()) : \Dewdrop\Cli\Command\CommandAbstract
Add an argument while also setting it as the primary arg for this command. For more information about the primary arg feature, read the docs on the $primaryArg property.
addArg(string $name, string $description, boolean $required, array $aliases = array(), string $mode = self::VALUE_REQUIRED) : \Dewdrop\Cli\Command\CommandAbstract
Register a new argument allowed to be used with this command.
setSupportFallbackArgs(boolean $supportFallbackArgs) : \Dewdrop\Cli\Command\CommandAbstract
Set whether this command supports fallback args.
addExample(string $description, string $command) : \Dewdrop\Cli\Command\CommandAbstract
Add an example usage for this command. These are displayed in the command's help content.
help() : $this
Display help content for this command.
The basic command name and description, any avaialble aliases, and any avaialble examples are all included in the help display.
This content can be accessed by called "--help" on this command directly:
./vendor/bin/dewdrop my-command --help
Or, you can use the built-in help command to access it:
./vendor/bin/dewdrop help my-command
setSubcommand(string $subcommand) : \Dewdrop\Cli\Command\Help
Set the sub-command (the command for which you want to display help content)
exec(string $command, array $output, integer $exitStatus) : void
Run a shell command using PHP's exec fucntion, which may be preferable to passthru() when you need to capture output. This is primarily present to make it easy to mock exec() during testing.
evalPathArgument(string $path) : string
Change "~" prefix to the user's home folder.
Bash doesn't do "~" evaluation automatically for command arguments, so we do it here to avoid confusing developers by creating a "~" folder in their WP install instead.
autoDetectExecutable(string $name) : string
First, we check to see if the executable is present in Composer's "./vendor/bin/" folder. Then, we attempt to locate the named executable using "which", if it is available. Otherwise, just return the name and hope it is in the user's $PATH.
setArgValue(string $name, string $value) : \Dewdrop\Cli\Command\CommandAbstract
Set the valid of the specified argument.
The argument's name is inflected to form a setter name that will be called to set the value. If no setter is available, execution will be aborted.