Orpheus Framework
\
Orpheus
Cache
Config
YAML
Controller
Core
DataType
Email
EntityDescriptor
SQLGenerator
User
Exception
File
Form
Hook
InputController
CLIController
HTTPController
Publisher
Exception
Fixture
PermanentObject
Transaction
Rendering
SQLAdapter
Exception
SQLRequest

\Orpheus\InputController\CLIControllerCLIArgument

The CLIArgument class

Summary

Methods
Properties
Constants
__construct()
make()
getUsageCommand()
getLongCommand()
isRequiringValue()
getValueFrom()
verify()
getLongName()
getShortName()
hasShortName()
getType()
getTypeValidator()
isRequired()
setRequired()
getValidatorByType()
registerTypeValidator()
validateParameter()
No public properties found
No constants found
No protected methods found
$longName
$shortName
$type
$required
$typeValidators
N/A
No private methods found
No private properties found
N/A

Properties

$longName

$longName : string

The long name

Type

string

$shortName

$shortName : string

The short name

Type

string

$type

$type : string

The type

Type

string

$required

$required : boolean

Is the argument required ?

Type

boolean

$typeValidators

$typeValidators : array

Registered regex for a type

Type

array

Methods

__construct()

__construct(string  $longName, string  $shortName, string  $type,   $required)

Constructor

Parameters

string $longName
string $shortName
string $type
$required

make()

make(string  $name, string  $config) : \Orpheus\InputController\CLIArgument

Make a CLIArgument from config

Parameters

string $name
string $config

Returns

\Orpheus\InputController\CLIArgument

getUsageCommand()

getUsageCommand()

getLongCommand()

getLongCommand(  $value,   $usage = false)

Parameters

$value
$usage

isRequiringValue()

isRequiringValue()

getValueFrom()

getValueFrom(  $values)

Parameters

$values

verify()

verify(  $value)

Parameters

$value

getLongName()

getLongName() : string

Get the long name

Returns

string

getShortName()

getShortName() : string

Get the short name

Returns

string

hasShortName()

hasShortName() : boolean

Test argument has a short name

Returns

boolean

getType()

getType() : string

Get the type

Returns

string

isRequired()

isRequired() : boolean

Is this argument required ?

Returns

boolean

getValidatorByType()

getValidatorByType(string  $type) : \Orpheus\DataType\AbstractType

Get a type validator by type name

Parameters

string $type

Returns

\Orpheus\DataType\AbstractType

registerTypeValidator()

registerTypeValidator(\Orpheus\DataType\AbstractType  $type)

Add the type validator to validate parameters

Parameters

\Orpheus\DataType\AbstractType $type

validateParameter()

validateParameter(\Orpheus\DataType\AbstractType  $type, mixed  $value) : boolean

Add the type validator to validate parameters

Parameters

\Orpheus\DataType\AbstractType $type
mixed $value

Returns

boolean