PHP Router 类技术文档

1. 安装指南

使用 Composer 安装

PHP Router 可以通过 Composer 进行安装。Composer 是 PHP 的依赖管理工具，能够帮助你轻松管理项目中的依赖包。

1. 打开终端或命令行工具。

2. 运行以下命令来安装 PHP Router：

   composer require dannyvankooten/php-router
   

3. 安装完成后，Composer 会自动将 PHP Router 添加到你的项目依赖中。

配置 Web 服务器

Apache

如果你使用的是 Apache 服务器，并且启用了 mod_rewrite 模块，可以在项目根目录下创建一个 .htaccess 文件，内容如下：

Options +FollowSymLinks
RewriteEngine On
RewriteRule ^(.*)$ index.php [NC,L]

Nginx

如果你使用的是 Nginx 服务器，可以在服务器配置文件中添加以下内容：

server {
    listen 80;
    server_name mydevsite.dev;
    root /var/www/mydevsite/public;

    index index.php;

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

    location ~ \.php$ {
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        # NOTE: 你应该在 php.ini 中设置 "cgi.fix_pathinfo = 0;"

        # 使用 php5-fpm:
        fastcgi_pass unix:/var/run/php5-fpm.sock;
        fastcgi_index index.php;
        include fastcgi.conf;
        fastcgi_intercept_errors on;
    }
}

2. 项目的使用说明

基本用法

PHP Router 提供了一个简单易用的路由系统，支持不同的 HTTP 方法、RESTful 路由、命名路由以及动态 URL。

以下是一个简单的示例，展示了如何使用 PHP Router：

<?php
require __DIR__.'/vendor/autoload.php';

use PHPRouter\RouteCollection;
use PHPRouter\Router;
use PHPRouter\Route;

$collection = new RouteCollection();
$collection->attachRoute(new Route('/users/', array(
    '_controller' => 'someController::usersCreate',
    'methods' => 'GET'
)));

$collection->attachRoute(new Route('/', array(
    '_controller' => 'someController::indexAction',
    'methods' => 'GET'
)));

$router = new Router($collection);
$router->setBasePath('/PHP-Router');
$route = $router->matchCurrentRequest();

var_dump($route);

从 YAML 文件加载路由

你还可以通过 YAML 文件来定义路由，这样可以更方便地管理和维护路由配置。

1. 创建一个 router.yaml 文件，内容如下：

   base_path: /blog
   
   routes:
     index: [/index, someClass.indexAction, GET]
     contact: [/contact, someClass.contactAction, GET]
     about: [/about, someClass.aboutAction, GET]
   

2. 在项目的前端控制器中加载该 YAML 文件：

   <?php
   require __DIR__.'/vendor/autoload.php';
   
   use PHPRouter\RouteCollection;
   use PHPRouter\Config;
   use PHPRouter\Router;
   use PHPRouter\Route;
   
   $config = Config::loadFromFile(__DIR__.'/router.yaml');
   $router = Router::parseConfig($config);
   $router->matchCurrentRequest();
   

3. 项目 API 使用文档

RouteCollection 类

RouteCollection 类用于管理路由集合。你可以通过 attachRoute 方法将路由添加到集合中。

$collection = new RouteCollection();
$collection->attachRoute(new Route('/users/', array(
    '_controller' => 'someController::usersCreate',
    'methods' => 'GET'
)));

Router 类

Router 类是路由系统的核心类，负责匹配当前请求并执行相应的控制器方法。

$router = new Router($collection);
$router->setBasePath('/PHP-Router');
$route = $router->matchCurrentRequest();

Route 类

Route 类用于定义单个路由。你可以指定路由的 URL、控制器方法以及支持的 HTTP 方法。

$route = new Route('/users/', array(
    '_controller' => 'someController::usersCreate',
    'methods' => 'GET'
));

4. 项目安装方式

PHP Router 的安装方式非常简单，只需通过 Composer 进行安装即可。安装完成后，你可以通过 require __DIR__.'/vendor/autoload.php'; 来加载自动加载器，并开始使用 PHP Router。

composer require dannyvankooten/php-router

安装完成后，你可以在项目中使用 PHP Router 提供的路由功能，轻松管理你的应用程序路由。