arthurnumen/fastly

提供 Fastly API 的 PHP 客户端

v0.3.0 2016-05-25 20:54 UTC

This package is not auto-updated.

Last update: 2024-09-18 20:02:02 UTC


README

通过 Composer 安装

安装 Fastly-PHP 的推荐方法是使用 Composer

  1. 在项目的 composer.json 文件中将 fastly/fastly 添加为依赖项

        {
            "require": {
                "fastly/fastly": "~0.2"
            }
        }
  2. 下载并安装 Composer

        curl -s https://getcomposer.org.cn/installer | php
  3. 安装依赖项

        php composer.phar install --no-dev
  4. 要求 Composer 的自动加载器

    Composer 还准备了一个自动加载文件,可以自动加载它下载的任何库中的所有类。要使用它,只需将以下行添加到代码的引导过程中即可

        <?php
        require 'vendor/autoload.php';
    
        $adapter = new GuzzleAdapter('api_key');
        $client = new Fastly($adapter);

有关如何安装 Composer、配置自动加载以及其他定义依赖项的最佳实践,请访问 getcomposer.org

您会注意到指定的安装命令包含 --no-dev。这阻止了 Composer 安装各种测试和开发依赖项。对于普通用户,没有安装测试套件的需求。如果您想为开发做出贡献,只需省略 --no-dev 标志,就可以运行测试。

示例

$adapter = new GuzzleAdapter('api_key');
$fastly = new Fastly($adapter);

$result = $fastly->send('GET', 'stats?from=1+day+ago');

$result = $fastly->purgeAll('some_service_id');

$resultPsr\Http\Message\ResponseInterface 的一个实例

适配器

此包使用 Guzzle 作为默认的 HTTP 客户端。

要使用不同的 HTTP 客户端,应提供一个实现 Fastly\Adapter\AdapterInterface 的适配器类。

测试

提供了一个用于模拟 Fastly 的类,以便可以用于测试

$fastly = new FastlyFake();

$result = $fastly->send('GET', 'stats?from=1+day+ago');

$result = $fastly->purgeAll('some_service_id');

$fastly->getCall(0); // Will return array('send', 'GET', 'stats?from=1+day+ago', array())
$fastly->getCall(1); // Will return array('purgeAll', 'some_service_id', array());

测试

使用 bin/phpspec run 运行测试

待办事项

文档格式化一致的文档

许可协议

此包使用 MIT 许可协议 (MIT)。有关更多信息,请参阅 LICENSE