pgrenaud/php-trello-api

Trello API v2 客户端

v1.0.0 2022-04-10 16:12 UTC

This package is auto-updated.

Last update: 2024-09-10 21:46:11 UTC


README

Build Status Code Coverage Code Quality Packagist

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

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

特性

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

要求

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

安装

推荐使用 composer

$ composer require matteocacciola/php-trello-api

但是,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 文件

致谢