Class Arguments
Provides an interface for interacting with a command's options and arguments.
Properties summary
Method Summary
Method Detail
__construct() public
__construct(array $args, array $options, array $argNames)
Constructor
Parameters
-
string[]$args Positional arguments
-
array$options Named arguments
-
string[]$argNames List of argument names. Order is expected to be the same as $args.
getArgument() public
getArgument(string $name)
Check if a positional argument exists by name
Parameters
-
string$name The argument name to check.
Returns
string|nullgetArgumentAt() public
getArgumentAt(int $index)
Get positional arguments by index.
Parameters
-
int$index The argument index to access.
Returns
string|nullThe argument value or null
getArguments() public
getArguments()
Get all positional arguments.
Returns
string[]getOption() public
getOption(string $name)
Get an option's value or null
Parameters
-
string$name The name of the option to check.
Returns
string|int|bool|nullThe option value or null.
getOptions() public
getOptions()
Get an array of all the options
Returns
arrayhasArgument() public
hasArgument(string $name)
Check if a positional argument exists by name
Parameters
-
string$name The argument name to check.
Returns
boolhasArgumentAt() public
hasArgumentAt(int $index)
Check if a positional argument exists
Parameters
-
int$index The argument index to check.
Returns
boolhasOption() public
hasOption(string $name)
Check if an option is defined and not null.
Parameters
-
string$name The name of the option to check.
Returns
boolProperty Detail
$argNames protected
Positional argument name map
Type
string[]$args protected
Positional arguments.
Type
string[]$options protected
Named options
Type
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Console.Arguments.html