README

为BEAR.Sunday提供使用 Accept* 头的内容协商功能

Composer 安装

$ composer require bear/accept

模块安装

use Ray\Di\AbstractModule;
use Ray\Di\Scope;

class AppModule extends AbstractModule
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $available = [
            'Accept' => [
                'application/hal+json' => 'prod-hal-app',
                'application/json' => 'prod-app',
                'text/csv' => 'prod-csv-app',
                'cli' => 'prod-html-app'
            ],
            'Accept-Language' => [
                'en-US' => 'en',
                'ja-JP' => 'ja'
            ]
        ];
        // $available support 'Accept' and 'Accept-Language' key only
        $this->install(new AcceptModule($available));
    }
}

Accept 以格式 [$mediatype => $context] 指定所有可用的媒体。在控制台访问的情况下，cli 是上下文。使用内容协商匹配的媒体类型上下文的渲染器用于渲染资源。

Accept-Language 以格式 [$lang => $contextKey] 指定所有可用的语言。

例如，如果 application/hal+json 和 ja-JP 匹配，则 $context 为 prod-hal-jp-app。（我们在 App\Module 文件夹中设置 JpModule 并为其绑定日语。）

用法

应用于指定资源

使用 @Produces 注解资源以执行内容协商。

use use BEAR\Accept\Annotation\Produces;

/**
 * @Produces({"application/json", "text/csv"})
 */
public function onGet()

该资源提供 application/json 和 text/csv 媒体类型。自动添加 Vary 头。

应用于所有资源

要对所有资源执行内容协商，准备一个特殊的引导文件。当进行语言协商时，这特别有用。

cn.php

require dirname(__DIR__) . '/vendor/autoload.php';

$available = [
    'Accept' => [
        'text/html' => 'prod-html-app',
        'application/hal+json' => 'prod-hal-app',
        'application/json' => 'prod-app',
        'cli' => 'cli-html-app'
    ],
    'Accept-Language' => [
        'ja' => 'ja',
        'en-US' => 'us'
    ]
];
$accept = new \BEAR\Accept\Accept($available);
[$context, $vary] = $accept($_SERVER);
//

在 Bootstrap 中添加一个 vary 头以在执行内容协商时启用缓存。

+    /* @global \BEAR\Resource\Vary $vary */
+    if (isset($vary)) {
+        $page->headers['Vary'] = $vary;
+    }
     $page->transfer($app->responder, $_SERVER);

为每种语言准备必要的 DI 设置模块。

use BEAR\Sunday\Module\Constant\NamedModule;

class JaModule extends AbstractModule
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $text = ['greeting' => 'こんにちは'];
        $this->install(new NamedModule($text));
    }
}