Swiftlet 技术文档

1. 安装指南

Swiftlet 是一个非常轻量级的 MVC 框架。以下是安装指南：

1. 将 Swiftlet 克隆（或下载并解压）到您的 PHP 支持的 Web 服务器上的一个目录中。
2. 确保已经安装了 Composer，然后运行 composer dump-autoload。

2. 项目使用说明

Swiftlet 采用 MVC（模型-视图-控制器）架构，以下是创建和使用一个基本页面的说明：

创建控制器和视图

每个页面都由一个控制器和至少一个视图组成。

• 控制器负责大部分工作；视图应仅限于简单的展示逻辑（循环和条件语句）。

控制器 src/HelloWorld/Controllers/Foo.php

<?php
namespace HelloWorld\Controllers;

use \Swiftlet\Abstracts\Controller as ControllerAbstract;

class Foo extends ControllerAbstract
{
    protected $title = 'Foo'; // 可选但通常需要

    // 默认动作
    public function index(array $args = [])
    {
        // 将变量传递给视图
        $this->view->helloWorld = 'Hello world!';
    }
}

视图 views/foo.php

<h1><?= $this->pageTitle ?></h1>

<p>
    <?= $this->helloWorld ?>
</p>

控制器可以直接在视图中设置变量。值将自动被处理为 HTML 安全的，对于应被视为代码的值，使用 $this->get('variable', false)。

现在，您可以通过在 Web 浏览器中导航到 http://<swiftlet>/foo 来查看页面！

如果收到 "404 Not Found"，则需要在使用 Swiftlet 的 Web 服务器配置中启用重写。

路由

Swiftlet 将 URL 映射到控制器、动作和参数。

例如，对于 URL /foo/bar：

• foo 成为控制器和视图的名称
• bar 成为动作的名称

动作是控制器类中的公共方法。

自定义路由

除了自动路由，还可以定义自定义路由以实现更细粒度的控制。

一个路由将一个 URL 映射到一个动作（方法）。

URL 段可以被替换为带有冒号前缀的变量名作为通配符占位符。这个值将在控制器中可用。

考虑以下路由：bar/:qux

导航到 <controller>/bar/something 将匹配这个路由。$args['qux'] 的值将是 something。

3. 项目 API 使用文档

Swiftlet 提供了一些公共方法，以下是一些主要的 API 方法：

Application Swiftlet\App

• App dispatchController()：确定要使用哪个控制器并运行它
• App serve()：服务页面
• mixed getConfig(string $variable)：获取配置值
• App setConfig(string $variable, mixed $value)：设置配置值
• App registerHook(string $hookName, array $params)：注册一个钩子

View Swiftlet\View

• mixed get(string $variable [, bool $htmlEncode = true ])：获取视图变量，默认对 HTML 进行编码
• View set(string $variable [, mixed $value ])：设置视图变量
• mixed get(string $variable [, bool $htmlEncode ])：获取视图变量，第二个参数为 false 时，不进行 HTML 编码
• string getRootPath()：网站的绝对客户端路径
• mixed htmlEncode(mixed $value)：递归地使值对 HTML 安全
• mixed htmlDecode(mixed $value)：递归解码之前编码的值以呈现 HTML
• View render(string $path)：渲染视图

4. 项目安装方式

安装 Swiftlet 的方式已在安装指南中说明，概括如下：

1. 克隆或下载 Swiftlet 到 PHP 支持的 Web 服务器上的目录。
2. 确保已安装 Composer，并运行 composer dump-autoload。

以上就是关于 Swiftlet 的技术文档，希望能帮助您更好地使用和理解这个项目。