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

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

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

Метод	Описание
__construct ( array $definition = [] )	构造方法
addArgument ( Argument $argument )	添加一个参数
addArguments ( Argument[] $arguments = [] )	添加参数
addOption ( Option $option )	添加一个选项
addOptions ( Option[] $options = [] )	添加选项
getArgument ( string \| integer $name ) : Argument	根据名称或者位置获取参数
getArgumentCount ( ) : integer	获取参数数量
getArgumentDefaults ( ) : array	获取参数默认值
getArgumentRequiredCount ( ) : integer	获取必填的参数的数量
getArguments ( ) : Argument[]	获取所有的参数
getOption ( string $name ) : Option	根据名称获取选项
getOptionDefaults ( ) : array	获取所有选项的默认值
getOptionForShortcut ( string $shortcut ) : Option	根据短名称获取选项
getOptions ( ) : Option[]	获取所有选项
getSynopsis ( boolean $short = false ) : string	获取该指令的介绍
hasArgument ( string \| integer $name ) : boolean	根据名称或位置检查是否具有某个参数
hasOption ( string $name ) : boolean	根据名称检查是否有这个选项
hasShortcut ( string $name ) : boolean	根据名称检查某个选项是否有短名称
setArguments ( Argument[] $arguments = [] )	设置参数
setDefinition ( array $definition )	设置指令的定义
setOptions ( Option[] $options = [] )	设置选项

Приватные методы

Метод	Описание
shortcutToName ( string $shortcut ) : string	根据短名称获取选项名

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

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

构造方法

public __construct ( array $definition = [] )
$definition	array

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

添加一个参数

public addArgument ( Argument $argument )
$argument	Argument	参数

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

添加参数

public addArguments ( Argument[] $arguments = [] )
$arguments	Argument[]	参数数组

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

添加一个选项

public addOption ( Option $option )
$option	Option	选项

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

添加选项

public addOptions ( Option[] $options = [] )
$options	Option[]	选项数组

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

根据名称或者位置获取参数

public getArgument ( string \| integer $name ) : Argument
$name	string \| integer	参数名或者位置
Результат	Argument	参数

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

获取参数数量

public getArgumentCount ( ) : integer
Результат	integer

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

获取参数默认值

public getArgumentDefaults ( ) : array
Результат	array

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

获取必填的参数的数量

public getArgumentRequiredCount ( ) : integer
Результат	integer

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

获取所有的参数

public getArguments ( ) : Argument[]
Результат	Argument[]	参数数组

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

根据名称获取选项

public getOption ( string $name ) : Option
$name	string	选项名
Результат	Option

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

获取所有选项的默认值

public getOptionDefaults ( ) : array
Результат	array

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

根据短名称获取选项

public getOptionForShortcut ( string $shortcut ) : Option
$shortcut	string	短名称
Результат	Option

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

获取所有选项

public getOptions ( ) : Option[]
Результат	Option[]

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

获取该指令的介绍

public getSynopsis ( boolean $short = false ) : string
$short	boolean	是否简洁介绍
Результат	string

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

根据名称或位置检查是否具有某个参数

public hasArgument ( string \| integer $name ) : boolean
$name	string \| integer	参数名或者位置
Результат	boolean

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

根据名称检查是否有这个选项

public hasOption ( string $name ) : boolean
$name	string	选项名
Результат	boolean

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

根据名称检查某个选项是否有短名称

public hasShortcut ( string $name ) : boolean
$name	string	短名称
Результат	boolean

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

设置参数

public setArguments ( Argument[] $arguments = [] )
$arguments	Argument[]	参数数组

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

设置指令的定义

public setDefinition ( array $definition )
$definition	array	定义的数组

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

设置选项

public setOptions ( Option[] $options = [] )
$options	Option[]	选项数组