webwizo/php-trello-api

Trello API v1 客户端

0.9.5 2017-02-24 12:41 UTC

This package is auto-updated.

Last update: 2024-09-05 23:35:59 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 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和文档。