horace-velmont/php-trello-api

Trello API v1 客户端

0.9.5 2018-09-13 15:20 UTC

This package is not auto-updated.

Last update: 2024-10-02 09:39:58 UTC


README

Build Status Code Coverage Code Quality Packagist

PHP5编写的Trello API简单面向对象封装。

使用 Trello API v1。对象API与RESTful API非常相似。

功能

  • 遵循PSR-0规范和编码标准:易于自动加载
  • 轻量快速,得益于API类的懒加载
  • 经过广泛测试

要求

  • PHP >= 5.3.2,并安装 cURL 扩展,
  • Guzzle 库,
  • (可选) PHPUnit 运行测试。

安装

推荐使用 composer

$ composer require horace-velmont/php-trello-api:@dev

但是,php-trello-api 遵循PSR-0命名规范,这意味着您可以将 php-trello-api 类加载集成到自己的自动加载器中。

基本用法

use Trello\Client;

$client = new Client();
$client->authenticate('api_key', 'token', Client::AUTH_URL_CLIENT_ID);

$boards = $client->api('member')->boards()->all();

$client 对象让您可以访问整个Trello API。

使用Trello管理器的进阶用法

该包在API之上包含一个简单的模型层,提供可链式API,允许对Trello对象进行操作。

use Trello\Client;
use Trello\Manager;

$client = new Client();
$client->authenticate('api_key', 'token', Client::AUTH_URL_CLIENT_ID);

$manager = new Manager($client);

$card = $manager->getCard('547440ad3f8b882bc11f0497');

$card
    ->setName('Test card')
    ->setDescription('Test description')
    ->save();

将Trello事件分发到您的应用程序

该服务使用 Symfony EventDispatcher 组件将事件分发到传入的webhooks。

查看 Events 类常量以获取名称和关联的事件类。

use Trello\Client;
use Trello\Service;
use Trello\Events;

$client = new Client();
$client->authenticate('api_key', 'token', Client::AUTH_URL_CLIENT_ID);

$service = new Service($client);

// Bind a callable to a given event...
$service->addListener(Events::BOARD_UPDATE, function ($event) {
    $board = $event->getBoard();

    // do something
});

// Check if the current request was made by a Trello webhook
// This will dispatch any Trello event to listeners defined above
$service->handleWebhook();

文档

贡献

欢迎提出任何意见、报告问题或发起拉取请求。

许可

php-trello-api 在MIT许可证下发布 - 详细信息请参阅LICENSE文件

鸣谢

  • 在很大程度上受到 php-github-api 的启发,该API由 KnpLabs 的小组开发
  • 感谢Trello提供的API和文档。