cuttlefish/php-trello-api

Trello API v1 客户端

0.9.3 2015-06-16 14:25 UTC

This package is auto-updated.

Last update: 2024-09-15 22:22:10 UTC


README

Build Status Code Coverage Code Quality Packagist

一个简单的Trello API对象封装,使用PHP5编写。

使用 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();

文档

贡献

请随意提出任何评论、提交问题或发起pull请求。

许可

php-trello-api 采用MIT许可证 - 请参阅LICENSE文件以获取详细信息

致谢

  • 很大程度上受到由 php-github-api 开发者 KnpLabs 开发的优秀项目的启发
  • 感谢Trello提供API和文档。