• 홈
• GetOptionKit
• Option

PHP 클래스 GetOptionKit\Option

파일 보기 프로젝트 열기: c9s/getoptionkit 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$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

보호된 프로퍼티들

프로퍼티	타입	설명
$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.

메소드 상세

프로퍼티 상세