Argument

Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The first index is 0 (because we are in the computer world).

package

Default

Methods

Argument constructor

__construct( $argument = null) 

Arguments

$argument

mixed | null

getArgName

getArgName() : string

Response

string

getDefaultValue

getDefaultValue() : string

Response

string

getDescription

getDescription() : string

Response

string

getIndex

getIndex() : integer

Response

integer

isHidden

isHidden() : boolean

Response

boolean

isMultiValued

isMultiValued() : boolean

Response

boolean

isRequired

isRequired() : boolean

Response

boolean

setArgName

setArgName( $argName) : $this

Arguments

$argName

string

Response

$this

setDefaultValue

setDefaultValue( $defaultValue) : $this

Arguments

$defaultValue

string

Response

$this

setDescription

setDescription( $description) : $this

Arguments

$description

string

Response

$this

setHidden

setHidden( $hidden) : $this

Arguments

$hidden

boolean

Response

$this

setIndex

setIndex( $index) : $this

Arguments

$index

integer

Response

$this

setMultiValued

setMultiValued( $multiValued) : $this

Arguments

$multiValued

boolean

Response

$this

setRequired

setRequired( $required) : $this

Arguments

$required

boolean

Response

$this