Properties

$stubList

$stubList : 

Type

$fieldSelectpageMap

$fieldSelectpageMap : 

Selectpage搜索字段关联

Type

$enumRadioSuffix

$enumRadioSuffix : 

Enum类型识别为单选框的结尾字符,默认会识别为单选下拉列表

Type

$setCheckboxSuffix

$setCheckboxSuffix : 

Set类型识别为复选框的结尾字符,默认会识别为多选下拉列表

Type

$intDateSuffix

$intDateSuffix : 

Int类型识别为日期时间的结尾字符,默认会识别为日期文本框

Type

$switchSuffix

$switchSuffix : 

开关后缀

Type

$editorSuffix

$editorSuffix : 

富文本后缀

Type

$citySuffix

$citySuffix : 

城市后缀

Type

$selectpageSuffix

$selectpageSuffix : 

Selectpage对应的后缀

Type

$selectpagesSuffix

$selectpagesSuffix : 

Selectpage多选对应的后缀

Type

$fieldFormatterSuffix

$fieldFormatterSuffix : 

以指定字符结尾的字段格式化函数

Type

$imageField

$imageField : 

识别为图片字段

Type

$fileField

$fileField : 

识别为文件字段

Type

$reservedField

$reservedField : 

保留字段

Type

$ignoreFields

$ignoreFields : 

排除字段

Type

$sortField

$sortField : 

排序字段

Type

$headingFilterField

$headingFilterField : string

筛选字段

Type

string

$editorClass

$editorClass : 

编辑器的Class

Type

$name

$name : 

Type

$aliases

$aliases : 

Type

$definition

$definition : 

Type

$help

$help : 

Type

$description

$description : 

Type

$ignoreValidationErrors

$ignoreValidationErrors : 

Type

$consoleDefinitionMerged

$consoleDefinitionMerged : 

Type

$consoleDefinitionMergedWithArgs

$consoleDefinitionMergedWithArgs : 

Type

$code

$code : 

Type

$synopsis

$synopsis : 

Type

$usages

$usages : 

Type

Methods

__construct()

__construct(string|null  $name = null) 

构造方法

Parameters

string|null $name

命令名称,如果没有设置则比如在 configure() 里设置

Throws

\LogicException

ignoreValidationErrors()

ignoreValidationErrors() 

忽略验证错误

setConsole()

setConsole(\think\Console  $console = null) 

设置控制台

Parameters

\think\Console $console

getConsole()

getConsole() : \think\Console

获取控制台

Returns

\think\Console

isEnabled()

isEnabled() : boolean

是否有效

Returns

boolean

setCode()

setCode(callable  $code) : \think\console\Command

设置执行代码

Parameters

callable $code

callable(InputInterface $input, OutputInterface $output)

Throws

\InvalidArgumentException

Returns

\think\console\Command

mergeConsoleDefinition()

mergeConsoleDefinition(boolean  $mergeArgs = true) 

合并参数定义

Parameters

boolean $mergeArgs

addArgument()

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

添加参数

Parameters

string $name

名称

integer $mode

类型

string $description

描述

mixed $default

默认值

Returns

\think\console\Command

addOption()

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

添加选项

Parameters

string $name

选项名称

string $shortcut

别名

integer $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

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(array<mixed,string>  $aliases) : \think\console\Command

设置别名

Parameters

array<mixed,string> $aliases

Throws

\InvalidArgumentException

Returns

\think\console\Command

getAliases()

getAliases() : array

获取别名

Returns

array

getSynopsis()

getSynopsis(boolean  $short = false) : string

获取简介

Parameters

boolean $short

是否简单的

Returns

string

addUsage()

addUsage(string  $usage) : $this

添加用法介绍

Parameters

string $usage

Returns

$this

getUsages()

getUsages() : array

获取用法介绍

Returns

array

configure()

configure() 

配置指令

initialize()

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

初始化

Parameters

\think\console\Input $input

An InputInterface instance

\think\console\Output $output

An OutputInterface instance

getEnum()

getEnum(  $getEnum,   $controllerAssignList,   $field,   $itemArr = '',   $inputType = '') 

Parameters

$getEnum
$controllerAssignList
$field
$itemArr
$inputType

getAttr()

getAttr(  $getAttr,   $field,   $inputType = '') 

Parameters

$getAttr
$field
$inputType

setAttr()

setAttr(  $setAttr,   $field,   $inputType = '') 

Parameters

$setAttr
$field
$inputType

appendAttr()

appendAttr(  $appendAttrList,   $field) 

Parameters

$appendAttrList
$field

removeEmptyBaseDir()

removeEmptyBaseDir(  $parseFile,   $parseArr) : boolean

移除相对的空目录

Parameters

$parseFile
$parseArr

Returns

boolean

getControllerData()

getControllerData(  $module,   $controller,   $table) : array

获取控制器相关信息

Parameters

$module
$controller
$table

Returns

array

getModelData()

getModelData(  $module,   $model,   $table) : array

获取模型相关信息

Parameters

$module
$model
$table

Returns

array

getValidateData()

getValidateData(  $module,   $validate,   $table) : array

获取验证器相关信息

Parameters

$module
$validate
$table

Returns

array

getParseNameData()

getParseNameData(  $module,   $name,   $table,   $type) : array

获取已解析相关信息

Parameters

$module
$name
$table
$type

Returns

array

writeToFile()

writeToFile(string  $name, array  $data, string  $pathname) : mixed

写入到文件

Parameters

string $name
array $data
string $pathname

Returns

mixed

getReplacedStub()

getReplacedStub(string  $name, array  $data) : string

获取替换后的数据

Parameters

string $name
array $data

Returns

string

getStub()

getStub(string  $name) : string

获取基础模板

Parameters

string $name

Returns

string

getLangItem()

getLangItem(  $field,   $content) 

Parameters

$field
$content

getLangArray()

getLangArray(array  $arr, boolean  $withTpl = TRUE) : array

读取数据和语言数组列表

Parameters

array $arr
boolean $withTpl

Returns

array

getArrayString()

getArrayString(array  $arr) : string

将数据转换成带字符串

Parameters

array $arr

Returns

string

getItemArray()

getItemArray(  $item,   $field,   $comment) 

Parameters

$item
$field
$comment

getFieldType()

getFieldType(  $v) 

Parameters

$v

isMatchSuffix()

isMatchSuffix(string  $field, mixed  $suffixArr) : boolean

判断是否符合指定后缀

Parameters

string $field

字段名称

mixed $suffixArr

后缀

Returns

boolean

getFormGroup()

getFormGroup(string  $field, string  $content) : string

获取表单分组数据

Parameters

string $field
string $content

Returns

string

getImageUpload()

getImageUpload(string  $field, string  $content) : string

获取图片模板数据

Parameters

string $field
string $content

Returns

string

getJsColumn()

getJsColumn(string  $field, string  $datatype = '', string  $extend = '', array  $itemArr = array()) : string

获取JS列数据

Parameters

string $field
string $datatype
string $extend
array $itemArr

Returns

string

getCamelizeName()

getCamelizeName(  $uncamelized_words,   $separator = '_') 

Parameters

$uncamelized_words
$separator

getFieldListName()

getFieldListName(  $field) 

Parameters

$field

validateName()

validateName(string  $name) 

验证指令名称

Parameters

string $name

Throws

\InvalidArgumentException