PHP Interface Phalcon\Cli\Input\ArgumentInterface

This interface is meant to represent a command line argument according to IEEE Std 1003.1, 2013 Edition and to provide methods for most common operations. The ArgumentInterface uses a convention stating that the argument is a synonym of the operand. Additional functionality for working with arguments can be provided on top of the interface (ParameterInterface) or externally. This interface includes properties for each of the following: - Argument type (optional, required, array)

See link: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html

Inheritance: extends Phalcon\Cli\Input\ParameterInterface

Show file Open project: phalcon/incubator

Public Methods

Method	Description
getMode ( ) : integer	Gets the Argument mode (one of the IS_* constants).
isArray ( ) : boolean	Checks if the Argument can take multiple values.
isOptional ( ) : boolean	Checks if the Argument is optional.
isRequired ( ) : boolean	Checks if the Argument is required.
setMode ( integer $mode ) : Phalcon\Cli\Input\ArgumentInterface	Sets the Argument mode (one of the IS_* constants).

Method Details

getMode() public method

Gets the Argument mode (one of the IS_* constants).

public getMode ( ) : integer
return	integer

isArray() public method

Checks if the Argument can take multiple values.

public isArray ( ) : boolean
return	boolean

isOptional() public method

Checks if the Argument is optional.

public isOptional ( ) : boolean
return	boolean

isRequired() public method

Checks if the Argument is required.

public isRequired ( ) : boolean
return	boolean

setMode() public method

Sets the Argument mode (one of the IS_* constants).

public setMode ( integer $mode ) : Phalcon\Cli\Input\ArgumentInterface
$mode	integer	The Argument mode.
return	Phalcon\Cli\Input\ArgumentInterface