\app\common\controllerCommon

框架公共控制器

Summary

Methods

Properties

Constants

__construct()
registerMiddleware()
__debugInfo()

No public properties found

No constants found

initialize()
beforeAction()
fetch()
display()
assign()
filter()
engine()
validateFailException()
validate()
success()
error()
result()
redirect()
getResponseType()
pluginsFetch()

$view
$request
$failException
$batchValidate
$beforeActionList
$middleware
$app

N/A

No private methods found

No private properties found

N/A

File: application/common/controller/Common.php
Package: common\controller
Class hierarchy: \think\Controller

\app\common\controller\Common

Properties

$view

$view : \think\View

视图类实例

Type

\think\View

$request

$request : \think\Request

Request实例

Type

\think\Request

$failException

$failException : boolean

验证失败是否抛出异常

Type

boolean

$batchValidate

$batchValidate : boolean

是否批量验证

Type

boolean

$beforeActionList

$beforeActionList : array

前置操作方法列表（即将废弃）

Type

array

$middleware

$middleware : array

控制器中间件

Type

array

$app

$app : \think\App

应用实例

Type

\think\App

Methods

__construct()

__construct(\think\App  $app = null)

构造方法

Parameters

\think\App

$app

registerMiddleware()

registerMiddleware()

__debugInfo()

__debugInfo()

initialize()

initialize()

beforeAction()

beforeAction(string  $method, array  $options = array())

前置操作

Parameters

string	$method	前置操作方法名
array	$options	调用参数 ['only'=>[...]] 或者['except'=>[...]]

fetch()

fetch(string  $template = '', array  $vars = array(), array  $replace = array(), array  $config = array(), boolean  $renderContent = false) : string

解析和获取模板内容用于输出

Parameters

string	$template	模板文件名或者内容
array	$vars	模板输出变量
array	$replace	替换内容
array	$config	模板参数
boolean	$renderContent	是否渲染内容

Throws

\app\common\controller\Exception

Returns

string

final

Inherited from: \app\common\controller\Common

Tags

author	橘子俊 364666827@qq.com

display()

display(string  $content = '', array  $vars = array(), array  $config = array()) : mixed

渲染内容输出

Parameters

string	$content	模板内容
array	$vars	模板输出变量
array	$config	模板参数

Returns

mixed

assign()

assign(mixed  $name, mixed  $value = '') : $this

模板变量赋值

Parameters

mixed	$name	要显示的模板变量
mixed	$value	变量的值

Returns

$this

filter()

filter(Callable  $filter) : $this

视图过滤

Parameters

Callable

$filter

过滤方法或闭包

Returns

$this

engine()

engine(array|string  $engine) : $this

初始化模板引擎

Parameters

array|string

$engine

引擎参数

Returns

$this

validateFailException()

validateFailException(boolean  $fail = true) : $this

设置验证失败后是否抛出异常

Parameters

boolean

$fail

是否抛出异常

Returns

$this

validate()

validate(array  $data, string|array  $validate, array  $message = array(), boolean  $batch = false, mixed  $callback = null) : array|string|true

验证数据

Parameters

array	$data	数据
string\|array	$validate	验证器名或者验证规则数组
array	$message	提示信息
boolean	$batch	是否批量验证
mixed	$callback	回调方法（闭包）

Throws

\think\exception\ValidateException

Returns

array|string|true

success()

success(mixed  $msg = '', string  $url = null, mixed  $data = '', integer  $wait = 3, array  $header = array()) : void

操作成功跳转的快捷方法

Parameters

mixed	$msg	提示信息
string	$url	跳转的URL地址
mixed	$data	返回的数据
integer	$wait	跳转等待时间
array	$header	发送的Header信息

error()

error(mixed  $msg = '', string  $url = null, mixed  $data = '', integer  $wait = 3, array  $header = array()) : void

操作错误跳转的快捷方法

Parameters

mixed	$msg	提示信息
string	$url	跳转的URL地址
mixed	$data	返回的数据
integer	$wait	跳转等待时间
array	$header	发送的Header信息

result()

result(mixed  $data, integer  $code, mixed  $msg = '', string  $type = '', array  $header = array()) : void

返回封装后的API数据到客户端

Parameters

mixed	$data	要返回的数据
integer	$code	返回的code
mixed	$msg	提示信息
string	$type	返回数据格式
array	$header	发送的Header信息

redirect()

redirect(string  $url, array|integer  $params = array(), integer  $code = 302, array  $with = array()) : void

URL重定向

Parameters

string	$url	跳转的URL表达式
array\|integer	$params	其它URL参数
integer	$code	http code
array	$with	隐式传参

getResponseType()

getResponseType() : string

获取当前的response 输出类型

Returns

string

pluginsFetch()

pluginsFetch(string  $template = '', array  $vars = array(), array  $replace = array(), array  $config = array(), boolean  $renderContent = false) : string

渲染插件模板

Parameters

string	$template	模板文件名或者内容
array	$vars	模板输出变量
array	$replace	替换内容
array	$config	模板参数
boolean	$renderContent	是否渲染内容

Throws

\app\common\controller\Exception

Returns

string

final

Inherited from: \app\common\controller\Common