Class Arguments
Provides an interface for interacting with a command's options and arguments.
Properties summary
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() 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() public ¶
getArgument( string $name )
Check if a positional argument exists by name
Parameters
- string $name
- The argument name to check.
Returns
string|null
getArgumentAt() 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
The argument value or null
getOption() 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.
The option value or null.
hasArgument() public ¶
hasArgument( string $name )
Check if a positional argument exists by name
Parameters
- string $name
- The argument name to check.
Returns
boolean
hasArgumentAt() public ¶
hasArgumentAt( integer $index )
Check if a positional argument exists
Parameters
- integer $index
- The argument index to check.
Returns
boolean
hasOption() 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