pavlokrostylov/php-trello-api

Trello API v2客户端

0.9.10 2022-07-05 14:47 UTC

This package is auto-updated.

Last update: 2024-09-05 20:08:00 UTC


README

Build Status Code Coverage Code Quality Packagist

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

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

功能

  • 遵循PSR-0约定和编码标准:易于自动加载
  • 由于API类的懒加载而轻量快速
  • 经过广泛测试
  • 已准备好用于Symfony 5

需求

  • PHP >= 7.4,需要cURL扩展、
  • Guzzle库、
  • (可选)PHPUnit来运行测试。

安装

推荐的方式是使用composer

$ composer require pavlokrostylov/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组件将发生在传入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();

文档

贡献

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

许可证

php-trello-api遵循MIT许可证 - 有关详细信息,请参阅LICENSE文件

致谢