Class Arguments

Provides an interface for interacting with a command's options and arguments.

Namespace: Cake\Console
Location: Console/Arguments.php

Properties summary

$argNames protected

string[]
Positional argument name map
$args protected

string[]
Positional arguments.
$options protected

array
Named options

Method Summary

__construct() public
Constructor
getArgument() public
Check if a positional argument exists by name
getArgumentAt() public
Get positional arguments by index.
getArguments() public
Get all positional arguments.
getOption() public
Get an option's value or null
getOptions() public
Get an array of all the options
hasArgument() public
Check if a positional argument exists by name
hasArgumentAt() public
Check if a positional argument exists
hasOption() public
Check if an option is defined and not null.

Method Detail

__construct()source public

__construct( array $args , array $options , array $argNames )

Constructor

Parameters

array $args: Positional arguments
array $options: Named arguments
array $argNames: List of argument names. Order is expected to be the same as $args.

getArgument()source public

getArgument( string $name )

Check if a positional argument exists by name

Parameters

string $name: The argument name to check.

Returns

string|null

getArgumentAt()source public

getArgumentAt( integer $index )

Get positional arguments by index.

Parameters

integer $index: The argument index to access.

Returns

string|null
The argument value or null

getArguments()source public

getArguments( )

Get all positional arguments.

Returns

string[]

getOption()source public

getOption( string $name )

Get an option's value or null

Parameters

string $name: The name of the option to check.

Returns

string|integer|boolean|null
The option value or null.

getOptions()source public

getOptions( )

Get an array of all the options

Returns

array

hasArgument()source public

hasArgument( string $name )

Check if a positional argument exists by name

Parameters

string $name: The argument name to check.

Returns

boolean

hasArgumentAt()source public

hasArgumentAt( integer $index )

Check if a positional argument exists

Parameters

integer $index: The argument index to check.

Returns

boolean

hasOption()source public

hasOption( string $name )

Check if an option is defined and not null.

Parameters

string $name: The name of the option to check.

Returns

boolean

Properties detail

$argNamessource

protected string[]

Positional argument name map

$argssource

protected string[]

Positional arguments.

$optionssource

protected array

Named options

© 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/3.7/class-Cake.Console.Arguments.html