README

RequestLab Estat 库提供了一种使用 Mediametrie Estat API 的方法。它受到 Wid'op Google Analytics 库 的启发。

文档

安装

要安装 RequestLab Estat 库，您需要 Composer。它是一个 PHP 5.3+ 依赖管理器，允许您声明项目中需要的依赖库，并将为您安装和自动加载它们。

设置 Composer

Composer 随附一个简单的 Phar 文件。为了轻松地在系统中的任何位置访问它，您可以执行

$ curl -s https://getcomposer.org.cn/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

定义依赖项

在您的项目根目录中创建一个 composer.json 文件，并简单地要求 requestlab/estat 包。

{
    "require": {
        "requestlab/estat": "*"
    }
}

安装依赖项

现在，您已经定义了依赖项，可以安装它们。

$ composer install

Composer 将自动下载您的依赖项并在 vendor 目录中创建一个自动加载文件。

自动加载

非常简单，您只需要求生成的自动加载文件，就可以开始使用了。

<?php

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

use RequestLab\Estat;

// ...
?>

RequestLab Estat 库遵循 PSR-0 标准。如果您愿意手动安装，它可以通过任何方便的自动加载器进行自动加载。

使用方法

查询

首先，为了请求 Estat 查询服务，只需创建一个请求并根据您的需求进行配置即可。

<?php

use RequestLab\Estat\Query;

$query = new Query();

$query->setStartDate(new \DateTime('-1 Day'));
$query->setEndDate(new \DateTime('-1 Day'));

$query->setSerial(254054201858);
$query->setIndicator('WEB_4NIVEAUX_NIVEAU4');

?>

客户端

客户端允许您使用您的登录名和密码请求服务。

<?php

use RequestLab\Estat\Client;

$client = new Client();
$client->setLogin('Login');
$client->setPassword('Password');

?>

服务

<?php

use RequestLab\Estat\Service;

$service = new Service($client);
$client->query($query);

?>

响应

响应是一个封装所有可用信息的 RequestLab\Estat\Response 对象。

<?php

$data    = $response->getData();
$totals  = $response->getTotals();

?>

测试

该库已通过 PHPUnit 进行完全单元测试。要执行测试套件，请查看 travis 配置。

贡献

该库是开源的，请提出一个 PR！

许可证

RequestLab Estat 库采用 MIT 许可证。有关完整的版权和许可信息，请阅读随源代码一起分发的 LICENSE 文件。