PHP Класс think\console\input\Option

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

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

Метод	Описание
__construct ( string $name, string \| array $shortcut = null, integer $mode = null, string $description = '', mixed $default = null )	构造方法
acceptValue ( ) : boolean	是否可以设置值
equals ( Option $option ) : boolean	检查所给选项是否是当前这个
getDefault ( ) : mixed	获取默认值
getDescription ( ) : string	获取描述文字
getName ( ) : string	获取选项名
getShortcut ( ) : string	获取短名称
isArray ( ) : boolean	选项值是否接受数组
isValueOptional ( ) : boolean	是否可选
isValueRequired ( ) : boolean	是否必须
setDefault ( mixed $default = null )	设置默认值

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

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

构造方法

public __construct ( string $name, string \| array $shortcut = null, integer $mode = null, string $description = '', mixed $default = null )
$name	string	选项名
$shortcut	string \| array	短名称,多个用\|隔开或者使用数组
$mode	integer	选项类型(可选类型为 self::VALUE_*)
$description	string	描述
$default	mixed	默认值 (类型为 self::VALUE_REQUIRED 或者 self::VALUE_NONE 的时候必须为null)

acceptValue() публичный метод

是否可以设置值

public acceptValue ( ) : boolean
Результат	boolean	类型不是 self::VALUE_NONE 的时候返回true,其他均返回false

equals() публичный метод

检查所给选项是否是当前这个

public equals ( Option $option ) : boolean
$option	Option
Результат	boolean

getDefault() публичный метод

获取默认值

public getDefault ( ) : mixed
Результат	mixed

getDescription() публичный метод

获取描述文字

public getDescription ( ) : string
Результат	string

getName() публичный метод

获取选项名

public getName ( ) : string
Результат	string

getShortcut() публичный метод

获取短名称

public getShortcut ( ) : string
Результат	string

isArray() публичный метод

选项值是否接受数组

public isArray ( ) : boolean
Результат	boolean	类型是 self::VALUE_IS_ARRAY 的时候返回true,其他均返回false

isValueOptional() публичный метод

是否可选

public isValueOptional ( ) : boolean
Результат	boolean	类型是 self::VALUE_OPTIONAL 的时候返回true,其他均返回false

isValueRequired() публичный метод

是否必须

public isValueRequired ( ) : boolean
Результат	boolean	类型是 self::VALUE_REQUIRED 的时候返回true,其他均返回false

setDefault() публичный метод

设置默认值

public setDefault ( mixed $default = null )
$default	mixed	默认值