\think\console\commandHelp

Summary

Methods

Properties

Constants

__construct()
ignoreValidationErrors()
setConsole()
getConsole()
setApp()
getApp()
isEnabled()
run()
mergeConsoleDefinition()
setDefinition()
getDefinition()
getNativeDefinition()
addArgument()
addOption()
setName()
setProcessTitle()
getName()
setDescription()
getDescription()
setHelp()
getHelp()
getProcessedHelp()
setAliases()
getAliases()
getSynopsis()
addUsage()
getUsages()
setCommand()

No public properties found

No constants found

configure()
execute()
interact()
initialize()
table()

$input
$output
$app

N/A

validateName()

$console
$name
$processTitle
$aliases
$definition
$help
$description
$ignoreValidationErrors
$consoleDefinitionMerged
$consoleDefinitionMergedWithArgs
$synopsis
$usages
$command

N/A

File: vendor/topthink/framework/src/think/console/command/Help.php
Package: Application
Class hierarchy: Command

\think\console\command\Help
Uses

Tags

None found

Properties

$input

$input : \think\console\Input

Type

Input —

$output

$output : \think\console\Output

Type

Output —

$app

$app : \think\App

Type

App —

$console

$console : \think\Console

Type

Console —

$name

$name

$processTitle

$processTitle

$aliases

$aliases

$definition

$definition

$help

$help

$description

$description

$ignoreValidationErrors

$ignoreValidationErrors

$consoleDefinitionMerged

$consoleDefinitionMerged

$consoleDefinitionMergedWithArgs

$consoleDefinitionMergedWithArgs

$synopsis

$synopsis

$usages

$usages

$command

$command

Methods

__construct()

__construct() : mixed

构造方法

Throws

\LogicException

Returns

mixed —

Inherited from: \think\console\Command
Uses

Tags

api

ignoreValidationErrors()

ignoreValidationErrors() : void

忽略验证错误

setConsole()

setConsole(\think\Console  $console = null) : void

设置控制台

Parameters

\think\Console

$console

getConsole()

getConsole() : \think\Console

获取控制台

Returns

\think\Console —

Inherited from: \think\console\Command
Uses

Tags

api

setApp()

setApp(\think\App  $app) : mixed

设置app

Parameters

\think\App

$app

Returns

mixed —

getApp()

getApp() : \think\App

获取app

Returns

\think\App —

isEnabled()

isEnabled() : bool

是否有效

Returns

bool —

run()

run(\think\console\Input  $input, \think\console\Output  $output) : int

执行

Parameters

\think\console\Input	$input
\think\console\Output	$output

Throws

\Exception

Returns

int —

mergeConsoleDefinition()

mergeConsoleDefinition(bool  $mergeArgs = true) : mixed

合并参数定义

Parameters

bool

$mergeArgs

Returns

mixed —

setDefinition()

setDefinition(array|\think\console\input\Definition  $definition) : \think\console\Command

设置参数定义

Parameters

array|\think\console\input\Definition

$definition

Returns

\think\console\Command —

Inherited from: \think\console\Command
Uses

Tags

api

getDefinition()

getDefinition() : \think\console\input\Definition

获取参数定义

Returns

\think\console\input\Definition —

Inherited from: \think\console\Command
Uses

Tags

api

getNativeDefinition()

getNativeDefinition() : \think\console\input\Definition

获取当前指令的参数定义

Returns

\think\console\input\Definition —

addArgument()

addArgument(string  $name, int  $mode = null, string  $description = '', mixed  $default = null) : \think\console\Command

添加参数

Parameters

string	$name	名称
int	$mode	类型
string	$description	描述
mixed	$default	默认值

Returns

\think\console\Command —

addOption()

addOption(string  $name, string  $shortcut = null, int  $mode = null, string  $description = '', mixed  $default = null) : \think\console\Command

添加选项

Parameters

string	$name	选项名称
string	$shortcut	别名
int	$mode	类型
string	$description	描述
mixed	$default	默认值

Returns

\think\console\Command —

setName()

setName(string  $name) : \think\console\Command

设置指令名称

Parameters

string

$name

Throws

\InvalidArgumentException

Returns

\think\console\Command —

setProcessTitle()

setProcessTitle(string  $title) : $this

设置进程名称

PHP 5.5+ or the proctitle PECL library is required

Parameters

string

$title

The process title

Returns

$this —

getName()

getName() : string

获取指令名称

Returns

string —

setDescription()

setDescription(string  $description) : \think\console\Command

设置描述

Parameters

string

$description

Returns

\think\console\Command —

getDescription()

getDescription() : string

获取描述

Returns

string —

setHelp()

setHelp(string  $help) : \think\console\Command

设置帮助信息

Parameters

string

$help

Returns

\think\console\Command —

getHelp()

getHelp() : string

获取帮助信息

Returns

string —

getProcessedHelp()

getProcessedHelp() : string

描述信息

Returns

string —

setAliases()

setAliases(string[]  $aliases) : \think\console\Command

设置别名

Parameters

string[]

$aliases

Throws

\InvalidArgumentException

Returns

\think\console\Command —

getAliases()

getAliases() : array

获取别名

Returns

array —

getSynopsis()

getSynopsis(bool  $short = false) : string

获取简介

Parameters

bool

$short

是否简单的

Returns

string —

addUsage()

addUsage(string  $usage) : $this

添加用法介绍

Parameters

string

$usage

Returns

$this —

getUsages()

getUsages() : array

获取用法介绍

Returns

array —

setCommand()

setCommand(\think\console\Command  $command) : void

Sets the command.

Parameters

\think\console\Command

$command

The command to set

configure()

configure() : mixed

配置指令

Returns

mixed —

execute()

execute(\think\console\Input  $input, \think\console\Output  $output) : null|int

执行指令

Parameters

\think\console\Input	$input
\think\console\Output	$output

Returns

null|int —

interact()

interact(\think\console\Input  $input, \think\console\Output  $output) : mixed

用户验证

Parameters

\think\console\Input	$input
\think\console\Output	$output

Returns

mixed —

initialize()

initialize(\think\console\Input  $input, \think\console\Output  $output) : mixed

初始化

Parameters

\think\console\Input	$input	An InputInterface instance
\think\console\Output	$output	An OutputInterface instance

Returns

mixed —

table()

table(\think\console\Table  $table) : string

输出表格

Parameters

\think\console\Table

$table

Returns

string —

validateName()

validateName(string  $name) : mixed

验证指令名称

Parameters

string

$name

Throws

\InvalidArgumentException

Returns

mixed —