allejo/php-pulse

此包已被废弃且不再维护。未建议替代包。

用于操作monday.com API(原名DaPulse)的包装器

0.3.4 2019-03-02 03:34 UTC

README

此库已正式停止维护。它不支持也不将支持新的GraphQL API。

https://github.com/allejo/PhpPulse/issues/20

PhpPulse

Stable Release Dev Release Scrutinizer Code Quality Code Coverage

分支 状态
0.3 Build Status
0.4 Build Status

用于操作 monday.com API 第1版本的PHP包装器。

要求

PHP 5.5+

  • 此库可能与PHP 5.4一起工作,但是不再受支持
  • 如果您需要PHP 5.3或5.4支持,您最好的选择是使用0.2.x分支,但是它也不再受支持

使用

安装

推荐使用此项目的方require式是通过 Composer。然而,PHAR存档在 发布页面 上也可以找到。

composer require allejo/php-pulse

请确保在使用此库时直接 require 自动加载器或PHAR存档。

require 'vendor/autoload.php';

// or

require 'phppulse.phar';

访问看板

use allejo\DaPulse\PulseBoard;

// Set our API key to access the API
PulseBoard::setApiKey("monday.com API Key");

// Get all of our boards
$boards = PulseBoard::getBoards();

foreach ($boards as $board)
{
    echo "Board Name: {$board->getName()}";
    echo "Board Description: {$board->getDescription()}";

    // Create a Pulse with the owner of user id 1
    $pulse = $board->createPulse("Sample Pulse Title", 1);
}

弃用 & 向后兼容

此项目完全稳定,但尚未达到1.0.0,因为还有一些事情可能会改变。如果有任何函数被弃用,它们将在下一个次要版本中删除;例如,如果在0.1.x分支中弃用了某些内容,则将从0.3.0版本开始删除。所有弃用和删除都通过phpDocs中的@deprecated标签、变更日志和GitHub发布进行记录。

除了在0.x阶段更快地删除弃用功能外,此项目将尽力遵守 Symfony的向后兼容承诺。一旦此项目达到1.0.0,这种做法可能会发生变化。

获取帮助

要获取帮助,您可以 创建一个问题 或访问IRC;我在IRC上名为"allejo",所以请随时ping我。我建议创建一个问题,因为其他人可能有相同的问题,但对于快速帮助,IRC效果很好。

要报告错误或请求功能,请提交问题。

文档

我已经尽力记录了这个项目以及生成的 phpDoc,您可以访问。如果您愿意帮助编写文档或教程,我非常欢迎您为此项目的 wiki 做出贡献。

IRC

频道: #sujevo
网络: irc.freenode.net

许可证

MIT