sherlockode/php-trello-api

Trello API v1 客户端

0.9.3 2015-06-16 14:25 UTC

This package is auto-updated.

Last update: 2024-09-21 00:53:51 UTC


README

Build Status Code Coverage Code Quality Packagist

这是一个使用 PHP5 编写的简单面向对象的 Trello API 包装器。

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

功能

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

要求

安装

推荐方式是使用 composer

$ composer require cdaguerre/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 文件

鸣谢

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