tomatbn/php-trello-api

Trello API v2 客户端

2.0.0 2020-12-14 02:49 UTC

This package is not auto-updated.

Last update: 2024-10-03 03:13:40 UTC


README

Build Status Code Coverage Code Quality Packagist

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

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

特性

  • 遵循PSR-0约定和编码标准:易于自动加载
  • 轻量级且快速,得益于API类的懒加载
  • 广泛测试
  • 支持Symfony 5

要求

安装

推荐使用composer

$ composer require tomatbn/php-trello-api dev-master

然而,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组件将发生在传入webhook上的事件分发给应用程序。

请参阅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文件

致谢