Toro PHP 路由器技术文档

1. 安装指南

1.1 手动安装

1. 从 GitHub 仓库 下载最新版本的 Toro。
2. 将 Toro.php 文件移动到你的项目根目录。

1.2 使用 Composer 安装

1. 在你的项目根目录下安装 Composer：

   $ curl -s https://getcomposer.org/installer | php
   

   或者手动下载并检查安装脚本的安全性：

   $ curl -s https://getcomposer.org/installer > installer.php
   $ less installer.php
   $ # 确认安全后执行
   $ php installer.php
   

2. 创建 composer.json 文件，内容如下：

   {
       "require": {
           "torophp/torophp": "dev-master"
       }
   }
   

3. 使用 Composer 安装 Toro：

   $ php composer.phar install
   

1.3 服务器配置

1.3.1 Apache 配置

在 Apache 的虚拟主机配置或 .htaccess 文件中添加以下内容：

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond $1 !^(index\.php)
RewriteRule ^(.*)$ /index.php/$1 [L]

或者使用以下单行配置（适用于 Apache 2.2.15 及以上版本）：

FallbackResource /index.php

1.3.2 IIS 配置

安装 URL Rewrite for IIS 后，在 web.config 文件中添加以下规则：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
          <rule name="Toro" stopProcessing="true">
            <match url="^(.*)$" ignoreCase="false" />
              <conditions logicalGrouping="MatchAll">
                <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
                <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" negate="true" />
                <add input="{R:1}" pattern="^(index\.php)" ignoreCase="false" negate="true" />
              </conditions>
            <action type="Rewrite" url="/index.php/{R:1}" />
          </rule>
        </rewrite>
    </system.webServer>
</configuration>

1.3.3 Nginx 配置

在 Nginx 的虚拟主机配置中添加以下内容：

location / {
  try_files $uri $uri/ /index.php?$args;
}

2. 项目的使用说明

2.1 基本路由

Toro 使用简单的路由机制来处理请求。路由表是一个关联数组，格式为 route_pattern => handler。例如：

Toro::serve(array(
    "/" => "SplashHandler",
    "/catalog/page/:number" => "CatalogHandler",
    "/product/:alpha" => "ProductHandler",
    "/manufacturer/:string" => "ManufacturerHandler"
));

2.2 RESTful 处理器

Toro 支持 RESTful 风格的处理器，自动根据 HTTP 请求方法调用相应的方法。例如：

class ExampleHandler {
    function get() {}
    function post() {}
    function get_xhr() {}
    function post_xhr() {}
}

2.3 ToroHook (回调)

Toro 提供了五个特定的回调钩子，用于在请求的不同阶段执行自定义逻辑：

ToroHook::add("404",  function() {});
ToroHook::add("before_request", function() {});
ToroHook::add("before_handler", function() {});
ToroHook::add("after_handler", function() {});
ToroHook::add("after_request",  function() {});

3. 项目 API 使用文档

3.1 Toro::serve()

Toro::serve() 是 Toro 的核心方法，用于注册路由和处理器。

Toro::serve(array(
    "/" => "SplashHandler",
    "/catalog/page/:number" => "CatalogHandler",
    "/product/:alpha" => "ProductHandler",
    "/manufacturer/:string" => "ManufacturerHandler"
));

3.2 ToroHook::add()

ToroHook::add() 用于注册回调钩子。

ToroHook::add("404",  function() {
    echo "Page not found";
});

4. 项目安装方式

Toro 可以通过手动下载或使用 Composer 进行安装。手动安装需要将 Toro.php 文件放置在项目根目录，而 Composer 安装则需要创建 composer.json 文件并执行安装命令。

4.1 手动安装

1. 下载 Toro.php 文件。
2. 将文件放置在项目根目录。

4.2 Composer 安装

1. 安装 Composer。
2. 创建 composer.json 文件。
3. 执行 php composer.phar install 命令。

通过以上步骤，你可以轻松地将 Toro 集成到你的 PHP 项目中，并开始使用其强大的路由功能。