系统为一些常用的操作方法封装了助手函数,便于使用,包含如下:
| 助手函数 | 描述 |
| --- | --- |
| abort | 中断执行并发送HTTP状态码 |
| app | 快速获取容器中的实例 支持依赖注入 |
| bind | 快速绑定对象实例 |
| cache | 缓存管理 |
| class\_basename | 获取类名(不包含命名空间) |
| class\_uses\_recursive | 获取一个类里所有用到的trait |
| config | 获取和设置配置参数 |
| cookie | Cookie管理 |
| download | 获取\\think\\response\\Download对象实例 |
| dump | 浏览器友好的变量输出 |
| env | 获取环境变量 |
| event | 触发事件 |
| halt | 变量调试输出并中断执行 |
| input | 获取输入数据 支持默认值和过滤 |
| invoke | 调用反射执行callable 支持依赖注入 |
| json | JSON数据输出 |
| jsonp | JSONP数据输出 |
| lang | 获取语言变量值 |
| parse\_name | 字符串命名风格转换 |
| redirect | 重定向输出 |
| request | 获取当前Request对象 |
| response | 实例化Response对象 |
| session | Session管理 |
| token | 生成表单令牌输出 |
| trace | 记录日志信息 |
| trait\_uses\_recursive | 获取一个trait里所有引用到的trait |
| url | Url生成 |
| validate | 实例化验证器 |
| view | 渲染模板输出 |
| display | 渲染内容输出 |
| xml | XML数据输出 |
| app\_path | 当前应用目录 |
| base\_path | 应用基础目录 |
| config\_path | 应用配置目录 |
| public\_path | web根目录 |
| root\_path | 应用根目录 |
| runtime\_path | 应用运行时目录 |
vendor\topthink\framework\src\helper.php
```
//中断执行并发送HTTP状态码
abort($code, string $message = '', array $header = [])
//快速获取容器中的实例 支持依赖注入
app(string $name = '', array $args = [], bool $newInstance = false):object|App
//快速绑定对象实例
bind($abstract, $concrete = null):Container
//缓存管理
cache(string $name = null, $value = '', $options = null, $tag = null):mixed
//获取和设置配置参数
config($name = '', $value = null):mixed
//Cookie管理
cookie(string $name, $value = '', $option = null):mixed
//获取\\think\\response\\Download对象实例
download(string $filename, string $name = '', bool $content = false, int $expire = 180):\think\response\File
//浏览器友好的变量输出
dump(...$vars):void
//获取环境变量
env(string $name = null, $default = null):mixed
//触发事件
event($event, $args = null):mixed
//变量调试输出并中断执行 在tp中替代die和exit
halt(...$vars)
//获取输入数据 支持默认值和过滤
input(string $key = '', $default = null, $filter = ''):mixed
//调用反射执行callable 支持依赖注入
invoke($call, array $args = []):mixed
//JSON数据输出
json($data = [], $code = 200, $header = [], $options = []): Json
//JSONP数据输出
jsonp($data = [], $code = 200, $header = [], $options = []): Jsonp
//获取语言变量值
lang(string $name, array $vars = [], string $lang = ''):mixed
//字符串命名风格转换
parse_name(string $name, int $type = 0, bool $ucfirst = true): string
//重定向输出
redirect(string $url = '', int $code = 302): \think\response\Redirect
//获取当前Request对象
request(): \think\Request
//实例化Response对象
response($data = '', $code = 200, $header = [], $type = 'html'): Response
//Session管理
session($name = '', $value = ''):mixed
//生成表单令牌输出
token(string $name = '__token__', string $type = 'md5'): string
//生成令牌隐藏表单
token_field(string $name = '__token__', string $type = 'md5'): string
//生成令牌meta
token_meta(string $name = '__token__', string $type = 'md5'): string
//记录日志信息
trace($log = '[think]', string $level = 'log')
//Url生成
url(string $url = '', array $vars = [], $suffix = true, $domain = false): UrlBuild
//实例化验证器
validate($validate = '', array $message = [], bool $batch = false, bool $failException = true): Validate
//渲染模板输出
view(string $template = '', $vars = [], $code = 200, $filter = null): View
//渲染内容输出
display(string $content, $vars = [], $code = 200, $filter = null): View
//XML数据输出
xml($data = [], $code = 200, $header = [], $options = []): Xml
//当前应用目录
app_path($path = ''):string
//应用基础目录
base_path($path = ''):string
//应用配置目录
config_path($path = ''):string 获取应用配置目录
//web根目录
public_path($path = ''):string
//应用运行时目录
runtime_path($path = ''):string
//应用根目录
root_path($path = ''):string
```
vendor\topthink\think-helper\src\helper.php
```
//按条件抛异常
throw_if($condition, $exception, ...$parameters):mixed
//按条件抛异常
throw_unless($condition, $exception, ...$parameters):mixed
//对一个值调用给定的闭包,然后返回该值
tap($value, $callback = null):mixed
//返回给定值的默认值。
value($value):mixed
//Create a collection from the given value.
collect($value = null):Collection
//Fill in data where it's missing.
data_fill(&$target, $key, $value):mixed
//Get an item from an array or object using "dot" notation.
data_get($target, $key, $default = null):mixed
//Set an item on an array or object using dot notation.
data_set(&$target, $key, $value, $overwrite = true):mixed
//获取一个trait里所有引用到的trait
trait_uses_recursive(string $trait): array
//获取类名(不包含命名空间)
class_basename($class): string
//取一个类里所有用到的trait,包括父类的
class_uses_recursive($class): array
```
> 可以在应用的公共函数文件中重写上面这些助手函数。
- 空白目录
- php语法结构
- 安装与更新
- 开启调试模式及代码跟踪器
- 架构
- 源码分析
- 应用初始化
- 请求流程
- 中间件源码分析
- 请求处理源码分析
- Request源码分析
- 模板编译流程
- 路由与请求流程
- 容器
- 获取目录位置
- 入口文件
- 多应用模式及URL访问
- 依赖注入与容器
- 容器属性及方法
- Container
- App
- facade
- 中间件(middleware)
- 系统服务
- extend 扩展类库
- 笔记
- 配置
- env配置定义及获取
- 配置文件的配置获取
- 单应用模式-(配置)文件目录结构(默认)
- 多应用模式(配置)文件目录结构(配置文件)
- 配置文件
- 应用配置:app.php
- 缓存配置: cache.php
- 数据库配置:database.php
- 路由和URL配置:route.php
- Cookie配置:cookie.php
- Session配置:session.php
- 命令行配置:console.php
- 多语言配置:lang.php
- 日志配置:log.php
- 页面Trace配置:trace.php
- 磁盘配置: filesystem.php
- 中间件配置:middleware.php
- 视图配置:view.php
- 改成用yaconf配置
- 事件
- 例子:省略事件类的demo
- 例子2:完整事件类
- 例子3:事件订阅,监听多个事件
- 解析
- 路由
- 路由定义
- 路由地址
- 变量规则
- MISS路由
- URL生成
- 闭包支持
- 路由参数
- 路由中间件
- 路由分组
- 资源路由
- 注解路由
- 路由绑定
- 域名路由
- 路由缓存
- 跨域路由
- 控制器
- 控制器定义
- 空控制器、空操作
- 空模块处理
- RESTFul资源控制器
- 控制器中间件
- 请求对象Request(url参数)
- 请求信息
- 获取输入变量($_POST、$_GET等)
- 请求类型的获取与伪装
- HTTP头信息
- 伪静态
- 参数绑定
- 请求缓存
- 响应对象Response
- 响应输出
- 响应参数
- 重定向
- 文件下载
- 错误页面的处理办法
- 应用公共文件common.php
- 模型
- 模型定义及常规属性
- 模型数据获取与模型赋值
- 查询
- 数据集
- 增加
- 修改
- 删除
- 条件
- 查询范围scope
- 获取器
- 修改器
- 搜索器
- 软删除
- 模型事件
- 关联预载入
- 模型关联
- 一对一关联
- 一对多关联
- 多对多关联
- 自动时间戳
- 事务
- 数据库
- 查询构造器
- 查询合集
- 子查询
- 聚合查询
- 时间查询
- 视图查询(比join简单)
- 获取查询参数
- 快捷方法
- 动态查询
- 条件查询
- 打印sql语句
- 增
- 删
- 改
- 查
- 链式操作
- 查询表达式
- 分页查询
- 原生查询
- JSON字段
- 链接数据库配置
- 分布式数据库
- 查询事件
- Db获取器
- 事务操作
- 存储过程
- Db数据集
- 数据库驱动
- 视图
- 模板
- 模板配置
- 模板位置
- 模板渲染
- 模板变量与赋值(assign)
- 模板输出替换
- url生成
- 模板详解
- 内置标签
- 三元运算
- 变量输出
- 函数输出
- Request请求参数
- 模板注释及原样输出
- 模板继承
- 模板布局
- 原生PHP
- 模板引擎
- 视图过滤
- 视图驱动
- 验证
- 验证进阶之最终版
- 错误和日志
- 异常处理
- 日志处理
- 调试
- 调试模式
- Trace调试
- SQL调试
- 变量调试
- 远程调试
- 杂项
- 缓存
- Session
- Cookie
- 多语言
- 上传
- 扩展说明
- N+1查询
- TP类库
- 扩展类库
- 数据库迁移工具
- Workerman
- think助手工具库
- 验证码
- Swoole
- request
- app
- Response
- View
- Validate
- Config
- 命令行
- 助手函数
- 升级指导(功能的添加与删除说明)
- siyucms
- 开始
- 添加页面流程
- 列表页加载流程
- 弹出框
- 基础控制器
- 基础模型
- 快速构建
- 表单form构建
- 表格table构建
- MakeBuilder
- 前端组件
- 日期组件
- layer 弹层组件
- Moment.js 日期处理插件
- siyucms模板布局
- 函数即其变量
- 前端页面
- $.operate.方法
- $.modal.方法:弹出层
- $.common.方法:通用方法
- 被cms重写的表格options
- 自定义模板
- 搜索框
- 自定义form表单
- 获取表单搜索参数并组装为url字符串