PHP Interface Phalcon\Cli\Input\ParameterInterface

Represents an abstract command line Parameter. This interface must be used as a base interface for any parameters - Options and Arguments (so-called Operands). This interface includes properties for each of the following: - Parameter name - Parameter description - Parameter default value
Show file Open project: phalcon/incubator

Public Methods

Method Description
getDefault ( ) : mixed Gets the default value of the Parameter.
getDescription ( ) : string Gets the description text of the Parameter.
getName ( ) : string Gets the Parameter name.
hasDefault ( ) : boolean Checks if Parameter has default value
setDefault ( mixed $default ) : Phalcon\Cli\Input\ParameterInterface Sets the default value of the Parameter.
setDescription ( string $description ) : Phalcon\Cli\Input\ParameterInterface Sets the description text of the Parameter.
setName ( string $name ) : Phalcon\Cli\Input\ParameterInterface Sets the Parameter name.

Method Details

getDefault() public method

Gets the default value of the Parameter.
public getDefault ( ) : mixed
return mixed

getDescription() public method

Gets the description text of the Parameter.
public getDescription ( ) : string
return string

getName() public method

Gets the Parameter name.
public getName ( ) : string
return string

hasDefault() public method

Checks if Parameter has default value
public hasDefault ( ) : boolean
return boolean

setDefault() public method

Sets the default value of the Parameter.
public setDefault ( mixed $default ) : Phalcon\Cli\Input\ParameterInterface
$default mixed The default value of the Parameter.
return Phalcon\Cli\Input\ParameterInterface

setDescription() public method

Sets the description text of the Parameter.
public setDescription ( string $description ) : Phalcon\Cli\Input\ParameterInterface
$description string The description text of the Parameter.
return Phalcon\Cli\Input\ParameterInterface

setName() public method

Sets the Parameter name.
public setName ( string $name ) : Phalcon\Cli\Input\ParameterInterface
$name string The Parameter name.
return Phalcon\Cli\Input\ParameterInterface