PHP Класс GetOptionKit\Option

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$defaultValue
$desc the description of this option
$filter The filter closure of the option value.
$flag
$incremental
$isa * name for the value place holder, for printing
$isaOption
$key The option key
$long
$multiple
$optional
$required
$short
$suggestions
$type
$validValues
$validator
$value * key to store values
$valueName

Защищенные свойства (Protected)

Свойство Тип Описание
$trigger trigger callback after value is set.

Открытые методы

Метод Описание
__construct ( $spec )
__toString ( )
defaultValue ( $value )
desc ( $desc )
filter ( $cb ) Set up a filter function for the option value.
flag ( )
getId ( ) * get the option key for result key mapping.
getSuggestions ( ) : string[] Return suggestions.
getTypeClass ( )
getValidValues ( ) : string[] Return valud values array.
getValue ( )
increaseValue ( ) This method is for incremental option.
incremental ( ) To make -v, -vv, -vvv works.
isFlag ( )
isIncremental ( )
isMultiple ( )
isOptional ( )
isRequired ( )
isType ( $type )
isTypeNumber ( )
isa ( string $type, mixed $option = null ) Value Type Setters.
multiple ( )
optional ( )
pushValue ( $value ) push option value, when the option accept multiple values.
renderReadableSpec ( string $renderHint = true ) get readable spec for printing.
renderValueHint ( )
required ( )
setValue ( $value ) * set option value
suggestions ( $suggestions ) Assign suggestions.
testValue ( $value )
trigger ( callable $trigger )
validValues ( $values ) Assign validValues to member value.
validate ( $value )
validator ( $cb )
valueName ( $name ) valueName is for option value hinting:.

Защищенные методы

Метод Описание
_preprocessValue ( $value )
callTrigger ( )
initFromSpecString ( string $specString ) Build spec attributes from spec string.

Описание методов

__construct() публичный Метод

public __construct ( $spec )

__toString() публичный Метод

public __toString ( )

_preprocessValue() защищенный Метод

protected _preprocessValue ( $value )

callTrigger() защищенный Метод

protected callTrigger ( )

defaultValue() публичный Метод

public defaultValue ( $value )

desc() публичный Метод

public desc ( $desc )

filter() публичный Метод

todo: add "callable" type hint later.
public filter ( $cb )

flag() публичный Метод

public flag ( )

getId() публичный Метод

* get the option key for result key mapping.
public getId ( )

getSuggestions() публичный Метод

Return suggestions.
public getSuggestions ( ) : string[]
Результат string[] or nil

getTypeClass() публичный Метод

public getTypeClass ( )

getValidValues() публичный Метод

Return valud values array.
public getValidValues ( ) : string[]
Результат string[] or nil

getValue() публичный Метод

public getValue ( )

increaseValue() публичный Метод

This method is for incremental option.
public increaseValue ( )

incremental() публичный Метод

To make -v, -vv, -vvv works.
public incremental ( )

initFromSpecString() защищенный Метод

Build spec attributes from spec string.
protected initFromSpecString ( string $specString )
$specString string

isFlag() публичный Метод

public isFlag ( )

isIncremental() публичный Метод

public isIncremental ( )

isMultiple() публичный Метод

public isMultiple ( )

isOptional() публичный Метод

public isOptional ( )

isRequired() публичный Метод

public isRequired ( )

isType() публичный Метод

public isType ( $type )

isTypeNumber() публичный Метод

public isTypeNumber ( )

isa() публичный Метод

Value Type Setters.
public isa ( string $type, mixed $option = null )
$type string the value type, valid values are 'number', 'string', 'file', 'boolean', you can also use your own value type name.
$option mixed option(s) for value type class (optionnal)

multiple() публичный Метод

public multiple ( )

optional() публичный Метод

public optional ( )

pushValue() публичный Метод

push option value, when the option accept multiple values.
public pushValue ( $value )

renderReadableSpec() публичный Метод

get readable spec for printing.
public renderReadableSpec ( string $renderHint = true )
$renderHint string render also value hint

renderValueHint() публичный Метод

public renderValueHint ( )

required() публичный Метод

public required ( )

setValue() публичный Метод

* set option value
public setValue ( $value )

suggestions() публичный Метод

Assign suggestions.
public suggestions ( $suggestions )

testValue() публичный Метод

public testValue ( $value )

trigger() публичный Метод

public trigger ( callable $trigger )
$trigger callable

validValues() публичный Метод

Assign validValues to member value.
public validValues ( $values )

validate() публичный Метод

public validate ( $value )

validator() публичный Метод

public validator ( $cb )

valueName() публичный Метод

--name=
public valueName ( $name )

Описание свойств

$defaultValue публичное свойство

public $defaultValue

$desc публичное свойство

the description of this option
public $desc

$filter публичное свойство

The filter closure of the option value.
public $filter

$flag публичное свойство

public $flag

$incremental публичное свойство

public $incremental

$isa публичное свойство

* name for the value place holder, for printing
public $isa

$isaOption публичное свойство

public $isaOption

$key публичное свойство

The option key
public $key

$long публичное свойство

public $long

$multiple публичное свойство

public $multiple

$optional публичное свойство

public $optional

$required публичное свойство

public $required

$short публичное свойство

public $short

$suggestions публичное свойство

public $suggestions

$trigger защищенное свойство

trigger callback after value is set.
protected $trigger

$type публичное свойство

public $type

$validValues публичное свойство

public $validValues

$validator публичное свойство

public $validator

$value публичное свойство

* key to store values
public $value

$valueName публичное свойство

public $valueName