vrerabek/vre_trello_cms

使用 Trello 卡片作为数据源的极简 PHP CMS

v1.1 2020-08-02 07:54 UTC

README

vre_trello_cms 是一个极简的 PHP 库,允许您从 Trello 板中获取网站内容。

安装

  • 通过运行 composer require vrerabek/vre_trello_cms 安装包
  • 在您的项目根目录中创建 .env 文件(对于其他目录,请参阅故障排除部分),并插入以下环境变量(或者如果您已经使用 .env 文件,请追加以下内容)
TRELLO_API_KEY="your_trello_api_key_goes_here"
TRELLO_API_TOKEN="your_trello_api_token_goes_here"
TRELLO_BOARD_URL="your_trello_board_url_goes_here"

您可以在此处获取您的 API 密钥和令牌 https://trello.com/app-key

如何使用

require __DIR__ . '/vendor/autoload.php';

try {
    $vreClient = new \Vrerabek\VreClient();
    $vreClient->setDev(false);
    $vreClient->setCacheSeconds(600);
    $cards = $vreClient->getCards();
    echo $cards['title'];

} catch (Exception $e) {

    echo $e->getMessage();

}

通过调用 ->getCards(),您的所有板卡都存储在 Array 中。

数组的键是卡片的名称。例如,$cards['title'] 保存了名为 title 的 Trello 板中的卡片描述。

‼️ 访问卡片时区分大小写。因此,您不能通过调用 $cards['title'] 来访问名为 Title 的卡片,反之亦然!

‼️ 如果有多个同名卡片,则只有最新的一个可用。计划在将来改进这一点。

方法

->getCards() 返回格式化以供轻松使用的 Trello 板卡片。(见上面的示例)

$vreClient->getCards();

->setDev(true) 在开发过程中推荐使用。它忽略缓存,因此您可以看到实时结果。

$vreClient->setDev(true);

->setCacheSeconds(60) 设置缓存到期前的秒数。

$vreClient->setCacheSeconds(60);

缓存

通过存储两个文件实现真正的简单缓存:content.jsonlastCache.json。这些文件默认存储在您的项目根目录中(有关如何更改此目录的说明,请参阅故障排除部分)

故障排除

.env 文件目录

默认情况下,库会搜索 .env 文件并在 $_SERVER['DOCUMENT_ROOT'] 中存储缓存

如果您想将 .env 文件存储在不同的文件夹中或默认设置不起作用,您可以在 VreClient 构造函数中提供目录,如下所示

$vreClient = new \Vrerabek\VreClient(dirname(__FILE__ ) . '/src');

🕛 我花了整个晚上才完成这个项目,它肯定会在未来变得更好:) 🕛