GETTING STARTED / 使用指南

从 Hello, SlightPHP!
开始您的第一个应用。

先运行示例,再理解入口、目录和方法之间的关系。以下代码采用当前仓库支持的 PHP 8.0+ 语法。

00 / TRY IT FIRST

体验站点与交互示例

从当前站点的导航进入功能介绍、插件和交互示例,也可以打开任务工作台体验任务、路由与配置。部署时将 Web 请求转发到 index.php,并保留原始 URI;公开网址无需包含入口文件名。

php samples/tests/routing.php

上述 CLI 命令通过实际入口验证 Composer 自动加载与 URI 解析,不会启动 HTTP 服务。入口通过 vendor/autoload.php 加载框架与插件;缺少 vendor 时先执行 composer install。部署时网站根目录设为 samples/www,配置、应用代码与模板位于公开目录之外。

01 / INSTALL

为新项目安装依赖

composer require hetao29/slightphp:^6.5.2

Composer 包仅强制要求 PHP ≥ 8.0;PDO、Redis、Guzzle 与 Gregwar Captcha 等插件依赖按需安装。添加可选依赖后,运行要求以应用的 Composer 解析结果为准。

02 / BOOTSTRAP

创建 public/index.php

配置 appDir 和默认入口。run() 不会自动输出返回值,因此在入口中处理字符串结果和未匹配路径。

<?php
require dirname(__DIR__) . '/vendor/autoload.php';
SlightPHP::setAppDir(dirname(__DIR__) . '/app');
SlightPHP::setDefaultZone('home');
SlightPHP::setDefaultPage('main');
SlightPHP::setDefaultEntry('entry');
SlightPHP::setPathInfo(parse_url($_SERVER['REQUEST_URI'] ?? '/', PHP_URL_PATH) ?: '/');
try {
    $result = SlightPHP::run();
    if (is_string($result)) {
        echo $result;
    }
} catch (\SlightPHP\Exception $error) {
    http_response_code($error->getStatusCode());
    if ($error->getCode() === \SlightPHP\Exception::METHOD_NOT_ALLOWED && !empty($error->getContext()['allowedMethods'])) {
        header('Allow: ' . implode(', ', $error->getContext()['allowedMethods']));
    }
    echo $error->getStatusCode() === 404 ? '页面不存在' : '请求失败';
}
03 / CONTROLLERS

编写命名空间控制器

请求 /home/main/entry 对应下列控制器。目录的大小写需与框架转换规则一致。

app/Home/MainController.php

<?php
// app/Home/MainController.php
namespace Home;

class MainController
{
    /**
     * @param \SlightPHP\Request $request 当前请求。
     * @param \SlightPHP\Response $response 当前响应。
     */
    public function Entry(\SlightPHP\Request $request, \SlightPHP\Response $response)
    {
        return 'Hello, SlightPHP!';
    }
}

没有 Request-Type 请求头时,入口方法不添加前缀。

04 / REQUEST

访问页面与配置部署

将 Web 根目录设置为 public,访问 /home/main/entry,预期输出 Hello, SlightPHP!。Web 服务器需要将不存在的文件路径转发到 index.php,并保留原始 REQUEST_URI。

路径来源要明确

本示例入口优先解析 REQUEST_URI 中的路径,去除查询串后传给核心。即使转发后 PATH_INFO 为空或为 /,也不会把内页误判为首页。

常用配置

SlightPHP::setControllerSuffix('Controller');
SlightPHP::setSplitFlag('/');

业务入口自行校验 HTTP 方法、权限与输入,输出时按上下文转义。生产环境不要公开配置、日志及模板编译目录。

KEEP BUILDING

接下来,动手试试。

完整源码文档位于仓库 docs/README.md,覆盖调度细节、插件和部署排错。