Klein.php 技术文档

1. 安装指南

环境要求

• PHP 5.3.x 或更高版本

安装方式

推荐使用 Composer 进行安装。

使用 Composer 安装

1. 安装 Composer：

   curl -sS https://getcomposer.org/installer | php
   

2. 在项目根目录下创建 composer.json 文件，并添加以下内容：

   {
       "require": {
           "klein/klein": "*"
       }
   }
   

3. 运行 Composer 安装命令：

   php composer.phar install
   

4. 在应用的主 PHP 文件中引入自动加载文件：

   require 'vendor/autoload.php';
   

手动安装

1. 下载 Klein.php 的源码。
2. 将源码放置在项目的 vendor 目录下。
3. 在应用的主 PHP 文件中手动引入 Klein.php：

   require 'vendor/klein/klein.php';
   

URL 重写

为了确保所有请求都由 index.php 处理，需要设置 URL 重写。以下是一个常见的 Apache 重写规则示例：

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]

可选优化

为了提高性能，可以安装 APC 扩展。

2. 项目使用说明

基本使用

以下是一个简单的 "Hello World" 示例：

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

$klein = new \Klein\Klein();

$klein->respond('GET', '/hello-world', function () {
    return 'Hello World!';
});

$klein->dispatch();

处理所有请求

$klein->respond(function () {
    return 'All the things';
});

命名参数

$klein->respond('/[:name]', function ($request) {
    return 'Hello ' . $request->name;
});

RESTful 路由

$klein->respond('GET', '/posts', $callback);
$klein->respond('POST', '/posts', $callback);
$klein->respond('PUT', '/posts/[i:id]', $callback);
$klein->respond('DELETE', '/posts/[i:id]', $callback);
$klein->respond('OPTIONS', null, $callback);

// 匹配多个请求方法
$klein->respond(array('POST','GET'), $route, $callback);

发送对象或文件

$klein->respond(function ($request, $response, $service) {
    $service->xml = function ($object) {
        // 自定义 XML 输出函数
    }
    $service->csv = function ($object) {
        // 自定义 CSV 输出函数
    }
});

$klein->respond('/report.[xml|csv|json:format]?', function ($request, $response, $service) {
    $send = $request->param('format', 'json');
    $response->$send($report);
});

$klein->respond('/report/latest', function ($request, $response, $service) {
    $response->file('/tmp/cached_report.zip');
});

3. 项目 API 使用文档

路由命名空间

$klein->with('/users', function () use ($klein) {
    $klein->respond('GET', '/?', function ($request, $response) {
        // 显示所有用户
    });

    $klein->respond('GET', '/[:id]', function ($request, $response) {
        // 显示单个用户
    });
});

懒加载服务

$klein->respond(function ($request, $response, $service, $app) {
    $app->register('lazyDb', function() {
        $db = new stdClass();
        $db->name = 'foo';
        return $db;
    });
});

$klein->respond('GET', '/posts', function ($request, $response, $service, $app) {
    return $app->lazyDb->name;
});

自定义验证器

$service->addValidator('hex', function ($str) {
    return preg_match('/^[0-9a-f]++$/i', $str);
});

$service->validateParam('key')->isHex();

4. 项目安装方式

使用 Composer 安装

1. 安装 Composer。
2. 运行以下命令安装 Klein.php：

   php composer.phar require klein/klein
   

3. 在应用的主 PHP 文件中引入自动加载文件：

   require 'vendor/autoload.php';
   

手动安装

1. 下载 Klein.php 的源码。
2. 将源码放置在项目的 vendor 目录下。
3. 在应用的主 PHP 文件中手动引入 Klein.php：

   require 'vendor/klein/klein.php';
   

通过以上步骤，您可以成功安装并使用 Klein.php 进行快速灵活的路由配置。