ajt/guzzle-addons-mozilla

基于Guzzle PHP的Mozilla插件统计API客户端

dev-master / 1.0.x-dev 2013-05-06 14:24 UTC

This package is auto-updated.

Last update: 2024-08-28 12:35:40 UTC


README

一个简单的PHP API客户端,用于Mozilla插件统计服务

安装

该库通过Composer提供,因此获取它很容易。只需将以下内容添加到您的 composer.json 文件中

"require": {
    "ajt/guzzle-addons-mozilla": "dev-master"
}

然后运行 composer install

功能

  • 支持每天的当前统计信息

待办事项

  • 添加测试
  • 添加一些响应模型
  • 找出是否有登录方式,以便私有统计也能工作

使用方法

您需要一个公开的统计板才能使它工作,目前没有认证支持

要使用Mozilla插件API客户端,只需实例化客户端

<?php

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

use AJT\MozillaAddons\MozillaAddonsClient;

/**
 * For example, for the JSON-handle dashboard :
 * https://addons.mozilla.org/en-us/firefox/addon/JSON-handle/statistics/?last=30
 * @var string
 */
$app_name = 'JSON-handle'; // Fill in your appname here

// Get the client
$client = MozillaAddonsClient::factory(array('app_name' => $app_name, 'debug' => false));

// Get downloads
print "getDownloadsPerDay\n";
$downloads = $client->getDownloadsPerDay(array('date_start' => '20130504', 'date_end' => '20130506'));
print_r($downloads);

使用我们的 __call 方法调用命令(包括自动完成的phpDocs)

<?php 
// Get the client
$client = MozillaAddonsClient::factory(array('app_name' => $app_name, 'debug' => false));

// Get downloads
print "getDownloadsPerDay\n";
$downloads = $client->getDownloadsPerDay(array('date_start' => '20130504', 'date_end' => '20130506'));
print_r($downloads);

示例

将 api.config.php.dist 复制到 api.config.php 并填写 app-name。之后,您可以在 examples 目录中执行示例 getUsage.php。

您可以通过 services.json 了解可用的方法和调用它们的参数

欢迎贡献

发现了一个错误,请创建一个问题,最好附上调试输出和您所做的事情。错误修复?创建一个Pull Request,我会查看的。

许可证

Mozilla插件API客户端可在MIT许可证下获得。