\app\framework\Component\Console\InputInputArgument

Represents a command line argument.

Summary

Methods
Properties
Constants
__construct()
isRequired()
isOptional()
isArray()
getName()
getDefault()
getDescription()
setDefault()
No public properties found
REQUIRED
OPTIONAL
IS_ARRAY
No protected methods found
No protected properties found
N/A
No private methods found
$name
$mode
$default
$description
N/A

Constants

REQUIRED

REQUIRED

OPTIONAL

OPTIONAL

IS_ARRAY

IS_ARRAY

Properties

$name

$name : 

Type

$mode

$mode : 

Type

$default

$default : 

Type

$description

$description : 

Type

Methods

__construct()

__construct(  $name,   $mode = null,   $description = '',   $default = null) 

InputArgument constructor.

Parameters

$name
$mode
$description
$default

isRequired()

isRequired() : boolean

Returns true if the option requires a value.

Returns

boolean —

true if mode is self::VALUE_REQUIRED, otherwise false

isOptional()

isOptional() : boolean

Returns true if the option takes a optional value.

Returns

boolean —

true if mode is self::VALUE_OPTIONAL, otherwise false

isArray()

isArray() : boolean

Returns true if the option can take multiple values.

Returns

boolean —

true if mode is self::VALUE_IS_ARRAY, false otherwise.

getName()

getName() : mixed

Returns the name.

Returns

mixed

getDefault()

getDefault() : mixed

Returns the default value.

Returns

mixed

getDescription()

getDescription() : string

Returns the description text.

Returns

string

setDefault()

setDefault(mixed  $default = null) 

Sets the default value.

Parameters

mixed $default