PHP Класс think\console\Command

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

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

Свойство	Тип	Описание
$input	Input
$output	Output

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

Метод	Описание
__construct ( string \| null $name = null )	构造方法
addArgument ( string $name, integer $mode = null, string $description = '', mixed $default = null ) : Command	添加参数
addOption ( string $name, string $shortcut = null, integer $mode = null, string $description = '', mixed $default = null ) : Command	添加选项
addUsage ( string $usage )	添加用法介绍
getAliases ( ) : array	获取别名
getConsole ( ) : Console	获取控制台
getDefinition ( ) : Definition	获取参数定义
getDescription ( ) : string	获取描述
getHelp ( ) : string	获取帮助信息
getName ( ) : string	获取指令名称
getNativeDefinition ( ) : Definition	获取当前指令的参数定义
getProcessedHelp ( ) : string	描述信息
getSynopsis ( boolean $short = false ) : string	获取简介
getUsages ( ) : array	获取用法介绍
ignoreValidationErrors ( )	忽略验证错误
isEnabled ( ) : boolean	是否有效
mergeConsoleDefinition ( boolean $mergeArgs = true )	合并参数定义
run ( Input $input, Output $output ) : integer	执行
setAliases ( string[] $aliases ) : Command	设置别名
setCode ( callable $code ) : Command	设置执行代码
setConsole ( Console $console = null )	设置控制台
setDefinition ( array \| Definition $definition ) : Command	设置参数定义
setDescription ( string $description ) : Command	设置描述
setHelp ( string $help ) : Command	设置帮助信息
setName ( string $name ) : Command	设置指令名称

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

Метод	Описание
configure ( )	配置指令
execute ( Input $input, Output $output ) : null \| integer	执行指令
initialize ( Input $input, Output $output )	初始化
interact ( Input $input, Output $output )	用户验证

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

Метод	Описание
validateName ( string $name )	验证指令名称

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

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

构造方法

public __construct ( string \| null $name = null )
$name	string \| null	命令名称,如果没有设置则比如在 configure() 里设置

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

添加参数

public addArgument ( string $name, integer $mode = null, string $description = '', mixed $default = null ) : Command
$name	string	名称
$mode	integer	类型
$description	string	描述
$default	mixed	默认值
Результат	Command

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

添加选项

public addOption ( string $name, string $shortcut = null, integer $mode = null, string $description = '', mixed $default = null ) : Command
$name	string	选项名称
$shortcut	string	别名
$mode	integer	类型
$description	string	描述
$default	mixed	默认值
Результат	Command

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

添加用法介绍

public addUsage ( string $usage )
$usage	string

configure() защищенный метод

配置指令

protected configure ( )

execute() защищенный метод

执行指令

См. также: setCode()

protected execute ( Input $input, Output $output ) : null \| integer
$input	Input
$output	Output
Результат	null \| integer

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

获取别名

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

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

获取控制台

public getConsole ( ) : Console
Результат	think\Console

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

获取参数定义

public getDefinition ( ) : Definition
Результат	think\console\input\Definition

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

获取描述

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

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

获取帮助信息

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

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

获取指令名称

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

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

获取当前指令的参数定义

public getNativeDefinition ( ) : Definition
Результат	think\console\input\Definition

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

描述信息

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

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

获取简介

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

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

获取用法介绍

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

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

忽略验证错误

public ignoreValidationErrors ( )

initialize() защищенный метод

初始化

protected initialize ( Input $input, Output $output )
$input	Input	An InputInterface instance
$output	Output	An OutputInterface instance

interact() защищенный метод

用户验证

protected interact ( Input $input, Output $output )
$input	Input
$output	Output

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

是否有效

public isEnabled ( ) : boolean
Результат	boolean

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

合并参数定义

public mergeConsoleDefinition ( boolean $mergeArgs = true )
$mergeArgs	boolean

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

执行

См. также: setCode()

См. также: execute()

public run ( Input $input, Output $output ) : integer
$input	Input
$output	Output
Результат	integer

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

设置别名

public setAliases ( string[] $aliases ) : Command
$aliases	string[]
Результат	Command

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

设置执行代码

См. также: execute()

public setCode ( callable $code ) : Command
$code	callable	callable(InputInterface $input, OutputInterface $output)
Результат	Command

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

设置控制台

public setConsole ( Console $console = null )
$console	think\Console

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

设置参数定义

public setDefinition ( array \| Definition $definition ) : Command
$definition	array \| think\console\input\Definition
Результат	Command

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

设置描述

public setDescription ( string $description ) : Command
$description	string
Результат	Command

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

设置帮助信息

public setHelp ( string $help ) : Command
$help	string
Результат	Command

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

设置指令名称

public setName ( string $name ) : Command
$name	string
Результат	Command

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

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

protected Input,think\console $input
Результат	Input

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

protected Output,think\console $output
Результат	Output