Yet Another Framework
简介
Yet Another Framework(Yaf)扩展是一个用来开发 web 应用程序的 PHP 框架。
与典型的 PHP 框架不同,Yaf 使用 C 语言编写并编译为扩展:框架类、自动加载器、路由器和分发循环都运行在编译后的代码中,因此单次请求的框架开销以微秒而非毫秒计,也没有需要加载的框架 PHP 文件。它为引导成本至关重要的高流量应用,以及每个请求都需要一个干净的分发周期的长生命周期服务运行时(例如 Swoole)而设计。
Yaf 实现了经典的 MVC 架构:单一入口脚本、带有环境分节的配置文件、引导钩子、具有七个分发钩子的插件系统、六种内置路由类型、PSR-0 风格的自动加载器(Yaf_Loader)以及轻量级的 PHP 模板视图(Yaf_View_Simple)。
可以在 » Yaf Performance 中找到简单的 Yaf 基准测试。快速入门指南请参见 教程 部分。
注意:
Yaf 需要 PHP 7.0 或更高版本(其源码仓库的 master 分支);另有 php5 分支支持 PHP 5.2 及更高版本。
- 安装/配置
- 预定义常量
- 示例
- 应用程序配置
- Yaf_Application — Yaf_Application 类
- Yaf_Application::app — 检索 Application 实例
- Yaf_Application::bootstrap — 调用 bootstrap
- Yaf_Application::clearLastError — 清除最后的错误信息
- Yaf_Application::__construct — Yaf_Application 的构造函数
- Yaf_Application::environ — 检索环境名
- Yaf_Application::execute — 运行回调
- Yaf_Application::getAppDirectory — 获取应用的目录
- Yaf_Application::getConfig — 获取配置实例
- Yaf_Application::getDispatcher — 获取 Yaf_Dispatcher 的实例
- Yaf_Application::getLastErrorMsg — 获取最近产生的错误的错误信息
- Yaf_Application::getLastErrorNo — 获取最后产生的错误的错误代码
- Yaf_Application::getModules — 获取定义的模块名
- Yaf_Application::run — 运行 Yaf_Application
- Yaf_Application::setAppDirectory — 改变应用目录
- Yaf_Bootstrap_Abstract — Yaf_Bootstrap_Abstract 类
- Yaf_Dispatcher — Yaf_Dispatcher 类
- Yaf_Dispatcher::autoRender — 开启/关闭自动渲染
- Yaf_Dispatcher::catchException — 开启/关闭异常捕获
- Yaf_Dispatcher::__construct — Yaf_Dispatcher 构造方法
- Yaf_Dispatcher::disableView — 禁用视图渲染
- Yaf_Dispatcher::dispatch — 分发请求
- Yaf_Dispatcher::enableView — 开启视图渲染
- Yaf_Dispatcher::flushInstantly — 打开/关闭即时刷新
- Yaf_Dispatcher::getApplication — 获取应用实例
- Yaf_Dispatcher::getDefaultAction — 获取默认 action 名称
- Yaf_Dispatcher::getDefaultController — 获取默认控制器名称
- Yaf_Dispatcher::getDefaultModule — 获取默认模块名称
- Yaf_Dispatcher::getInstance — 获取分发器实例
- Yaf_Dispatcher::getRequest — 获取请求实例
- Yaf_Dispatcher::getResponse — 获取响应对象
- Yaf_Dispatcher::getRouter — 获取路由器实例
- Yaf_Dispatcher::initView — 初始化视图并返回它
- Yaf_Dispatcher::registerPlugin — 注册插件
- Yaf_Dispatcher::returnResponse — 打开/关闭返回响应
- Yaf_Dispatcher::setDefaultAction — 更改默认动作名
- Yaf_Dispatcher::setDefaultController — 更改默认控制器名
- Yaf_Dispatcher::setDefaultModule — 更改默认模块名
- Yaf_Dispatcher::setErrorHandler — 设置错误处理器
- Yaf_Dispatcher::setRequest — 设置请求对象
- Yaf_Dispatcher::setResponse — 设置响应对象
- Yaf_Dispatcher::setView — 设置自定义视图引擎
- Yaf_Dispatcher::throwException — 开启/关闭异常抛出
- Yaf_Config_Abstract — Yaf_Config_Abstract 类
- Yaf_Config_Abstract::get — 获取配置值
- Yaf_Config_Abstract::readonly — 检查配置是否只读
- Yaf_Config_Abstract::set — 设置配置值
- Yaf_Config_Abstract::toArray — 以数组形式导出配置
- Yaf_Config_Ini — Yaf_Config_Ini 类
- Yaf_Config_Ini::__construct — Yaf_Config_Ini 构造方法
- Yaf_Config_Ini::count — 统计配置项的数量
- Yaf_Config_Ini::current — 获取当前配置项的值
- Yaf_Config_Ini::get — 获取配置值
- Yaf_Config_Ini::__isset — 检查键是否存在
- Yaf_Config_Ini::key — 获取当前配置项的键
- Yaf_Config_Ini::next — 移动到下一个配置项
- Yaf_Config_Ini::offsetExists — 检查键是否存在(ArrayAccess)
- Yaf_Config_Ini::offsetGet — 获取配置值(ArrayAccess)
- Yaf_Config_Ini::offsetSet — 设置配置值(ArrayAccess)
- Yaf_Config_Ini::offsetUnset — 删除配置键(ArrayAccess)
- Yaf_Config_Ini::readonly — 检查配置是否只读
- Yaf_Config_Ini::rewind — 将迭代器重置到第一个配置项
- Yaf_Config_Ini::set — 设置配置值
- Yaf_Config_Ini::toArray — 以数组形式导出配置
- Yaf_Config_Ini::valid — 检查当前位置是否有效
- Yaf_Config_Simple — Yaf_Config_Simple 类
- Yaf_Config_Simple::__construct — Yaf_Config_Simple 的构造方法
- Yaf_Config_Simple::count — 统计配置项数量
- Yaf_Config_Simple::current — 获取当前配置项的值
- Yaf_Config_Simple::get — 获取配置值
- Yaf_Config_Simple::__isset — 检查键是否存在
- Yaf_Config_Simple::key — 获取当前配置项的键
- Yaf_Config_Simple::next — 移动到下一个配置项
- Yaf_Config_Simple::offsetExists — 检查键是否存在(ArrayAccess)
- Yaf_Config_Simple::offsetGet — 获取配置值(ArrayAccess)
- Yaf_Config_Simple::offsetSet — 设置配置值(ArrayAccess)
- Yaf_Config_Simple::offsetUnset — 移除配置项(ArrayAccess)
- Yaf_Config_Simple::readonly — 检查配置是否只读
- Yaf_Config_Simple::rewind — 将迭代器重置到第一个元素
- Yaf_Config_Simple::set — 设置配置值
- Yaf_Config_Simple::toArray — 以数组形式导出配置
- Yaf_Config_Simple::valid — 检查当前位置是否有效
- Yaf_Controller_Abstract — Yaf_Controller_Abstract 类
- Yaf_Controller_Abstract::__construct — Yaf_Controller_Abstract 的构造函数
- Yaf_Controller_Abstract::display — 渲染并直接显示视图
- Yaf_Controller_Abstract::forward — 将当前请求转发到另一个动作
- Yaf_Controller_Abstract::getInvokeArg — 获取一个动作调用参数
- Yaf_Controller_Abstract::getInvokeArgs — 获取全部动作调用参数
- Yaf_Controller_Abstract::getModuleName — 获取模块名
- Yaf_Controller_Abstract::getName — 获取控制器名称
- Yaf_Controller_Abstract::getRequest — 获取当前请求对象
- Yaf_Controller_Abstract::getResponse — 获取当前响应对象
- Yaf_Controller_Abstract::getView — 获取视图引擎
- Yaf_Controller_Abstract::getViewpath — 获取视图路径
- Yaf_Controller_Abstract::init — 控制器初始化钩子
- Yaf_Controller_Abstract::initView — 初始化视图并返回
- Yaf_Controller_Abstract::redirect — 重定向到 URL
- Yaf_Controller_Abstract::render — 渲染视图模板
- Yaf_Controller_Abstract::setViewpath — 设置视图路径
- Yaf_Action_Abstract — Yaf_Action_Abstract 类
- Yaf_Action_Abstract::execute — 动作入口点
- Yaf_Action_Abstract::getController — 获取控制器对象
- Yaf_Action_Abstract::getControllerName — 获取控制器名称
- Yaf_View_Interface — Yaf_View_Interface 类
- Yaf_View_Interface::assign — 为视图分配变量
- Yaf_View_Interface::display — 渲染并输出模板
- Yaf_View_Interface::getScriptPath — 获取模板目录
- Yaf_View_Interface::render — 渲染模板
- Yaf_View_Interface::setScriptPath — 设置模板目录
- Yaf_View_Simple — Yaf_View_Simple 类
- Yaf_View_Simple::assign — 为视图分配变量
- Yaf_View_Simple::assignRef — Yaf_View_Simple::assign 的别名
- Yaf_View_Simple::clear — 移除已分配的变量
- Yaf_View_Simple::__construct — Yaf_View_Simple 的构造方法
- Yaf_View_Simple::display — 渲染模板并将结果存入响应
- Yaf_View_Simple::eval — 渲染模板字符串
- Yaf_View_Simple::get — 获取已分配的变量
- Yaf_View_Simple::getScriptPath — 获取模板目录
- Yaf_View_Simple::__isset — 检查变量是否已赋值
- Yaf_View_Simple::render — 渲染模板
- Yaf_View_Simple::__set — 通过属性写入来分配变量
- Yaf_View_Simple::setScriptPath — 设置模板目录
- Yaf_Loader — Yaf_Loader 类
- Yaf_Loader::autoload — 自动加载类
- Yaf_Loader::clearLocalNamespace — 清除已注册的命名空间
- Yaf_Loader::__construct — 构造函数是私有的
- Yaf_Loader::getInstance — 获取 Yaf_Loader 实例
- Yaf_Loader::getLibraryPath — 获取库路径
- Yaf_Loader::getLocalNamespace — 获取已注册的命名空间
- Yaf_Loader::getNamespacePath — 获取类的库文件路径
- Yaf_Loader::getNamespaces — getLocalNamespace 的别名
- Yaf_Loader::import — 加载 PHP 脚本
- Yaf_Loader::isLocalName — 判断类名是否是本地类名
- Yaf_Loader::registerLocalNamespace — 注册本地命名空间
- Yaf_Loader::registerNamespace — registerLocalNamespace 的别名
- Yaf_Loader::setLibraryPath — 更改库路径
- Yaf_Plugin_Abstract — Yaf_Plugin_Abstract 类
- Yaf_Plugin_Abstract::dispatchLoopShutdown — 分发循环之后的钩子
- Yaf_Plugin_Abstract::dispatchLoopStartup — 分发循环之前的钩子
- Yaf_Plugin_Abstract::postDispatch — 每次分发之后的钩子
- Yaf_Plugin_Abstract::preDispatch — 每次分发之前的钩子
- Yaf_Plugin_Abstract::preResponse — 响应发出前的钩子
- Yaf_Plugin_Abstract::routerShutdown — 路由完成后的钩子
- Yaf_Plugin_Abstract::routerStartup — 路由开始前的钩子
- Yaf_Registry — Yaf_Registry 类
- Yaf_Registry::__construct — Yaf_Registry 的构造函数
- Yaf_Registry::del — 从注册表中移除条目
- Yaf_Registry::get — 从注册表中检索条目
- Yaf_Registry::has — 检测条目是否存在
- Yaf_Registry::set — 向注册表添加条目
- Yaf_Request_Abstract — Yaf_Request_Abstract 类
- Yaf_Request_Abstract::clearParams — 移除所有参数
- Yaf_Request_Abstract::get — 从请求中获取变量
- Yaf_Request_Abstract::getActionName — 获取动作名称
- Yaf_Request_Abstract::getBaseUri — 获取基础 URI
- Yaf_Request_Abstract::getControllerName — 获取控制器名称
- Yaf_Request_Abstract::getCookie — 获取 COOKIE 变量
- Yaf_Request_Abstract::getEnv — 检索 ENV 变量
- Yaf_Request_Abstract::getException — 获取异常
- Yaf_Request_Abstract::getFiles — 获取上传文件
- Yaf_Request_Abstract::getLanguage — 检索客户端的首选语言
- Yaf_Request_Abstract::getMethod — 检索请求方法
- Yaf_Request_Abstract::getModuleName — 获取模块名称
- Yaf_Request_Abstract::getParam — 检索调用的参数
- Yaf_Request_Abstract::getParams — 获取所有调用的参数
- Yaf_Request_Abstract::getPost — 获取 POST 参数
- Yaf_Request_Abstract::getQuery — 获取查询参数
- Yaf_Request_Abstract::getRaw — 获取原始请求体
- Yaf_Request_Abstract::getRequest — 获取 REQUEST 变量
- Yaf_Request_Abstract::getRequestUri — 获取请求 URI
- Yaf_Request_Abstract::getServer — 检索 SERVER 变量
- Yaf_Request_Abstract::isCli — 判断请求是否是 CLI 请求
- Yaf_Request_Abstract::isDelete — 判断请求是否为 DELETE 请求
- Yaf_Request_Abstract::isDispatched — 判断请求是否已分发
- Yaf_Request_Abstract::isGet — 判断请求是否是 GET 请求
- Yaf_Request_Abstract::isHead — 判断请求是否是 HEAD 请求
- Yaf_Request_Abstract::isOptions — 判断请求是否是 OPTIONS 请求
- Yaf_Request_Abstract::isPatch — 判断请求是否为 PATCH 请求
- Yaf_Request_Abstract::isPost — 判断请求是否是 POST 请求
- Yaf_Request_Abstract::isPut — 判断请求是否是 PUT 请求
- Yaf_Request_Abstract::isRouted — 判断请求是否已路由
- Yaf_Request_Abstract::isXmlHttpRequest — 判断请求是否是 AJAX 请求
- Yaf_Request_Abstract::setActionName — 设置 action 名
- Yaf_Request_Abstract::setBaseUri — 设置基础 URI
- Yaf_Request_Abstract::setControllerName — 设置控制器名
- Yaf_Request_Abstract::setDispatched — 将请求标记为已分发
- Yaf_Request_Abstract::setModuleName — 设置模块名
- Yaf_Request_Abstract::setParam — 设置请求参数
- Yaf_Request_Abstract::setRequestUri — 设置请求 URI
- Yaf_Request_Abstract::setRouted — 将请求标记为已路由
- Yaf_Request_Http — The Yaf_Request_Http class
- Yaf_Request_Http::__construct — Yaf_Request_Http 构造方法
- Yaf_Request_Simple — Yaf_Request_Simple 类
- Yaf_Request_Simple::__construct — Yaf_Request_Simple 构造方法
- Yaf_Response_Abstract — Yaf_Response_Abstract 类
- Yaf_Response_Abstract::appendBody — 向响应 body 追加内容
- Yaf_Response_Abstract::clearBody — 丢弃所有已存在的响应 body
- Yaf_Response_Abstract::clearHeaders — 丢弃所有已设置的响应头
- Yaf_Response_Abstract::__construct — 构造一个响应对象
- Yaf_Response_Abstract::getBody — 获取一个响应 body 块的内容
- Yaf_Response_Abstract::getHeader — 获取 HTTP 响应头
- Yaf_Response_Abstract::prependBody — 向响应 body 前置插入内容
- Yaf_Response_Abstract::response — 发送响应
- Yaf_Response_Abstract::setAllHeaders — 批量设置 HTTP 响应头
- Yaf_Response_Abstract::setBody — 设置内容到响应
- Yaf_Response_Abstract::setHeader — 设置 HTTP 响应头
- Yaf_Response_Abstract::setRedirect — 重定向到另一个 URL
- Yaf_Response_Abstract::__toString — 获取字符串形式的所有 body
- Yaf_Response_Cli — Yaf_Response_Cli 类
- Yaf_Response_Http — Yaf_Response_Http 类
- Yaf_Route_Interface — Yaf_Route_Interface 类
- Yaf_Route_Interface::assemble — 组装一个请求
- Yaf_Route_Interface::route — 路由请求
- Yaf_Route_Map — Yaf_Route_Map 类
- Yaf_Route_Map::assemble — 组合url
- Yaf_Route_Map::__construct — 构造一个 Map 路由
- Yaf_Route_Map::route — 路由请求
- Yaf_Route_Regex — Yaf_Route_Regex 类
- Yaf_Route_Regex::assemble — 组合 url
- Yaf_Route_Regex::__construct — Yaf_Route_Regex 构造方法
- Yaf_Route_Regex::route — 路由请求
- Yaf_Route_Rewrite — Yaf_Route_Rewrite 类
- Yaf_Route_Rewrite::assemble — 组合 url
- Yaf_Route_Rewrite::__construct — Yaf_Route_Rewrite 构造方法
- Yaf_Route_Rewrite::route — 路由请求
- Yaf_Router — Yaf_Router 类
- Yaf_Router::addConfig — 向 Router 中添加配置文件中定义的路由
- Yaf_Router::addRoute — 往 Router 中添加新的路由
- Yaf_Router::__construct — Yaf_Router 构造方法
- Yaf_Router::getCurrentRoute — 取得当前有效的路由名
- Yaf_Router::getRoute — 通过名称检索路由
- Yaf_Router::getRoutes — 检索已注册的路由
- Yaf_Router::route — 路由请求
- Yaf_Route_Simple — Yaf_Route_Simple 类
- Yaf_Route_Simple::assemble — 组合url
- Yaf_Route_Simple::__construct — 构造一个 Simple 路由
- Yaf_Route_Simple::route — 路由请求
- Yaf_Route_Static — Yaf_Route_Static 类
- Yaf_Route_Static::assemble — 组合 url
- Yaf_Route_Static::match — 判断路由是否匹配 URI
- Yaf_Route_Static::route — 路由请求
- Yaf_Route_Supervar — Yaf_Route_Supervar 类
- Yaf_Route_Supervar::assemble — 组合 url
- Yaf_Route_Supervar::__construct — 构造超级变量路由
- Yaf_Route_Supervar::route — 路由请求
- Yaf_Session — Yaf_Session 类
- Yaf_Session::__construct — Yaf_Session 构造方法
- Yaf_Session::count — 统计会话条目的数量
- Yaf_Session::current — 获取当前会话条目的值
- Yaf_Session::del — 删除会话键
- Yaf_Session::get — 获取会话值
- Yaf_Session::getInstance — 获取会话单例
- Yaf_Session::has — 检查会话键是否存在
- Yaf_Session::__isset — 检查会话键是否存在
- Yaf_Session::key — 获取当前会话条目的键
- Yaf_Session::next — 前进到下一个会话条目
- Yaf_Session::offsetExists — 检查会话键是否存在(ArrayAccess)
- Yaf_Session::offsetGet — 获取会话值(ArrayAccess)
- Yaf_Session::offsetSet — 设置会话值(ArrayAccess)
- Yaf_Session::offsetUnset — 移除会话键(ArrayAccess)
- Yaf_Session::rewind — 将会话迭代器重置到第一个条目
- Yaf_Session::set — 设置会话值
- Yaf_Session::start — 启动会话
- Yaf_Session::__unset — 移除会话键
- Yaf_Session::valid — 检查当前会话位置是否有效
- Yaf_Exception — Yaf_Exception 类
- Yaf_Exception::__construct — 构造一个 Yaf 异常
- Yaf_Exception::getPrevious — 获取前一个异常
- Yaf_Exception_TypeError — Yaf_Exception_TypeError 类
- Yaf_Exception_StartupError — Yaf_Exception_StartupError 类
- Yaf_Exception_DispatchFailed — Yaf_Exception_DispatchFailed 类
- Yaf_Exception_RouterFailed — Yaf_Exception_RouterFailed 类
- Yaf_Exception_LoadFailed — Yaf_Exception_LoadFailed 类
- Yaf_Exception_LoadFailed_Module — Yaf_Exception_LoadFailed_Module 类
- Yaf_Exception_LoadFailed_Controller — Yaf_Exception_LoadFailed_Controller 类
- Yaf_Exception_LoadFailed_Action — Yaf_Exception_LoadFailed_Action 类
- Yaf_Exception_LoadFailed_View — Yaf_Exception_LoadFailed_View 类
来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。
