Class Argument

An input argument.

Args arguments are passed after the command name and its options. In the example below, "localhost" is the argument to the "server -d" command.

$ console server -d localhost

Arguments can be either optional or required. By default, all arguments are optional, but you can explicitly make an argument optional or required by passing one of the flags Webmozart\Console\Api\Args\Format\Argument::OPTIONAL and Webmozart\Console\Api\Args\Format\Argument::REQUIRED to the constructor:

$argument = new Argument('server', Argument::REQUIRED);

Arguments can also be multi-valued. Multi-valued arguments can be passed any number of times:

$ console server -d localhost google.com

To create a multi-valued argument, pass the flag Webmozart\Console\Api\Args\Format\Argument::MULTI_VALUED to the constructor:

$argument = new Argument('server', Argument::MULTI_VALUED);

You can combine the Webmozart\Console\Api\Args\Format\Argument::MULTI_VALUED flag with either Webmozart\Console\Api\Args\Format\Argument::OPTIONAL or Webmozart\Console\Api\Args\Format\Argument::REQUIRED using the bitwise operator "|":

$argument = new Argument('server', Argument::REQUIRED | Argument::MULTI_VALUED);