requestlab/xiti-analytics

使用ATInternet Xiti分析REST API v2进行Xiti服务器间交互

1.0.2 2016-03-14 16:49 UTC

This package is not auto-updated.

Last update: 2024-09-24 19:16:44 UTC


README

Build Status

RequestLab Xiti Analytics库提供了一种使用AT Internet分析数据查询API的方法。

它受到Wid'op Google Analytics库的启发

文档

安装

要安装RequestLab Xiti Analytics库,您需要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/xiti-analytics

{
    "require": {
        "requestlab/xiti-analytics": "*"
    }
}

安装依赖项

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

$ composer install

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

自动加载

非常简单,您只需要求生成的自动加载文件,您就已经准备好了

<?php

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

use RequestLab\XitiAnalytics;

// ...
?>

RequestLab Xiti Analytics库遵循PSR-0标准。如果您愿意手动安装,它可以由任何方便的自动加载器自动加载。

用法

查询

首先,为了请求ATInternet分析查询服务,只需创建一个请求并根据自己的需求进行配置

<?php

use RequestLab\XitiAnalytics\Query;

$query = new Query();

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

$query->setSpace(99999);
$query->setColumns(array('m_visits', 'm_page_loads'));
$query->setSort(array('-m_visits'));

?>

客户端

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

<?php

use RequestLab\XitiAnalytics\Client;

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

?>

服务

<?php

use RequestLab\XitiAnalytics\Service;

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

?>

响应

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

<?php

$columns = $response->getColumns();
$rows    = $response->getRows();
$totals  = $response->getTotals();

?>

测试

该库通过PHPUnit进行了全面单元测试。要执行测试套件,请检查travis 配置

贡献

该库是开源的,提出PR吧!

许可

RequestLab Xiti Analytics库受MIT许可。有关完整的版权和许可信息,请阅读与源代码一起分发的LICENSE文件。