PLUGIN TOOLBOX / 插件生态

按需选择,
让应用具备合适的能力。

通过 Composer 加载所需插件,并准备对应的扩展、配置和服务。Route 提供自定义 URL 映射和 Controller 请求方法注解,下方可直接查看代码与运行示例。

插件清单 · 按需加载

Tpl

基础

模板编译与变量赋值,支持条件、循环和公共模板拆分。本站正在使用。

运行条件需要可信模板与可写编译目录

Config

基础

解析 JSON/JSONC 配置,支持对象、数组与基本类型,并提供进程内缓存。

运行条件配置文件;开发时可关闭缓存

Route

基础

支持 PHP / JSON 自定义 URL 映射,以及 Controller 方法上的 HTTP 请求方法注解。

运行条件URL 规则在 run() 前注册;方法限制由核心识别

自定义 URL 映射 → · HTTP 方法注解 →

Log

基础

提供分级日志,可配置控制台输出与文件记录。

运行条件写文件时需要目录权限

Db

数据

提供数据库表操作及读写配置组织能力。

运行条件数据库服务、对应驱动和连接配置

Redis

数据

封装 Redis 的配置与访问,适合缓存等数据场景。

运行条件Redis PHP 扩展及实际服务

Http

扩展

通过 Guzzle 发起 HTTP 请求,支持超时、请求头与参数。

运行条件Composer 安装 Guzzle 与可用网络

Language

扩展

组织多语言词条与语言文件。

运行条件准备 locale 资源

Captcha

扩展

基于 Gregwar Captcha 生成验证码图片。

运行条件Composer 依赖、GD、mbstring、fileinfo 和会话

Error

扩展

格式化并记录 PHP 错误和异常。

运行条件需配置适合运行环境的错误输出策略
JSON RESPONSE

原生 JSON:返回结构化数据

header('Content-Type: application/json; charset=utf-8');
echo json_encode(
    ['message' => '你好,SlightPHP'],
    JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR
);
TEMPLATE RENDERING

Tpl:组织页面模板

\SlightPHP\Tpl::setTemplateDir(__DIR__ . '/templates');
\SlightPHP\Tpl::setCompileDir(__DIR__ . '/var/templates_c');
$tpl = new \SlightPHP\Tpl();
$tpl->render('index.tpl', ['title' => 'SlightPHP']);
ROUTE / URL MAPPING

Route:自定义 URL 映射

将 /r/hello 映射到 Lab\RouteController::Entry()。PHP 与 JSON 规则按注册顺序匹配,查询串不参与匹配,参数保留在 $request->get 中。

PHP:samples/config/routes.php

<?php

use SlightPHP\Route;

// PHP 规则:/r/hello -> /lab/route/entry/hello。
Route::set([
    'pattern' => '^\/r\/:slug$',
    ':slug' => '[A-Za-z0-9_]{1,40}',
    'zone' => 'lab',
    'page' => 'route',
    'entry' => 'entry',
]);

// JSON 数组中的规则追加在 PHP 规则之后,首条匹配规则优先。
Route::setConfigFile(__DIR__ . '/routes.json');

JSON:samples/config/routes.json

[
    {
        "pattern": "^\\/r-json\\/:slug$",
        ":slug": "[A-Za-z0-9_]{1,40}",
        "zone": "lab",
        "page": "route",
        "entry": "entry"
    },
    {
        "pattern": "^\\/r-pair\\/:year\\/:month$",
        ":year": "\\d{4}",
        ":month": "(?:0[1-9]|1[0-2])",
        "zone": "lab",
        "page": "route",
        "entry": "entry"
    },
    {
        "pattern": "^\\/tasks$",
        "zone": "workspace",
        "page": "main",
        "entry": "entry"
    },
    {
        "pattern": "^\\/tasks\\.json$",
        "zone": "workspace",
        "page": "main",
        "entry": "api"
    },
    {
        "pattern": "^\\/tasks\\/save$",
        "zone": "workspace",
        "page": "main",
        "entry": "save"
    }
]

在 run() 前加载配置;入口已规范化 URI 时,用 Route::parse($requestPath) 显式匹配原始路径。未命中规则时继续默认命名空间调度。

运行本站真实规则

PHP 单参数 → · JSON 单参数 → · JSON 多参数 → · 固定短地址 →

路由实验室显示原始 URL、映射后的完整路径、查询参数和实际配置。月份 13 不符合规则,访问 /r-pair/2026/13 会返回 404。

ROUTE / HTTP METHODS

Route:Controller 请求方法注解

<?php
namespace Demo;

use SlightPHP\Request;
use SlightPHP\Response;
use SlightPHP\Route;

class MainController
{
    #[Route(method: 'GET')]
    public function Info(Request $request, Response $response)
    {
        return $response->end('仅允许 GET');
    }

    #[Route(methods: ['GET', 'POST'])]
    public function Preview(Request $request, Response $response)
    {
        return $response->end('允许 GET 或 POST');
    }
}

单方法与多方法

method 限制单个方法,methods 允许多个方法。同时设置时取并集并去重;未声明限制时保持原有行为。HEAD 和 OPTIONS 需要显式加入列表。

不匹配时在构造 Controller 前抛出 SlightPHP\Exception,入口根据 METHOD_NOT_ALLOWED 生成 405,并使用 allowedMethods 设置 Allow 响应头。自定义 URL 映射同样执行这些限制。

点击验证实际响应

本站 /tasks.json 映射到只允许 GET 的 Api;/r/hello 的 Entry 同时允许 GET 与 POST。以下 POST 示例只验证请求方法,不修改任务数据。

GET 接口:200 →

GET 路由:200 →

方法限制不替代权限或 CSRF 校验。完整约定见仓库 docs/routes.md 和 docs/framework.md。

使用前,先确认依赖。

核心需要 PHP ≥ 8.0;插件依赖通过 Composer suggest 提示,默认不安装。使用数据库、Redis、HTTP 或验证码插件时,再安装对应扩展或 Composer 包,并准备所需服务。

Tpl 当前实现直接输出模板,不返回 HTML 字符串;Config 支持 JSON/JSONC,默认仅保留进程内缓存。具体行为请查看仓库文档。

运行配置解析与环境检测 →