bartosz-maciaszek / php-rtm
PHP 的 Remember The Milk API 客户端
Requires
- php: >=5.3.0
Requires (Dev)
- phpunit/dbunit: 1.2.3
- phpunit/php-invoker: >=1.1.0,<1.2.0
- phpunit/phpunit: 3.7.*
- phpunit/phpunit-selenium: 1.3.1
- phpunit/phpunit-story: 1.0.2
This package is not auto-updated.
Last update: 2024-09-23 11:09:20 UTC
README
基本信息
这个库是为了简化与 Remember The Milk API 的通信而创建的。它为 PHP 程序员提供了简单、面向对象的接口。有关 Remember The Milk API 方法的列表,请参见这里。每个方法组都有自己的服务类,位于 src/Rtm/Service/
目录。
安装
开始使用 php-rtm 库的最简单方法是将它添加到您的 composer.json
文件的要求中
"bartosz-maciaszek/php-rtm": "dev-master"
并更新您的 composer 依赖项。
或者,您可以手动克隆此存储库
git clone git://github.com/bartosz-maciaszek/php-rtm.git
基本使用
要调用 API 中的任何方法,您只需创建一个 Rtm
类实例和服务对象,然后推送一些基本信息,如您的 API 密钥和密钥。此外,您还需要从 Remember The Milk 获取认证令牌。为此,用户必须授权您的应用程序。有关详细信息,请参阅 sample-app/rtm.php
文件,它逐步解释了操作方法。
<?php use Rtm\Rtm; $rtm = new Rtm; $rtm->setApiKey('Your API key'); $rtm->setSecret('Your secret'); $rtm->setAuthToken('Your Auth Token from RTM'); $taskService = $rtm->getService(Rtm::SERVICE_TASKS); $taskList = $taskService->getList();
API 的响应被包装在方便的类 Rtm\DataContainer
中,它允许您进行方法链,如 $response->getUser()->getName()
,因为它支持递归。要查看其代码和单元测试,请参阅 src/Rtm/DataContainer.php
和 tests/RtmTest/DataContainerTest.php
。您可以通过调用 toArray()
或 toJson()
方法轻松地将此对象转换为数组或 JSON 字符串。
单元测试
所有单元测试都位于 tests/
目录中。您可以通过在主目录中调用命令 phpunit
(其中 phpunit.xml
位于)来运行它们,或者在调用 phpunit tests/path/to/test/class
时单独运行,例如 phpunit tests/RtmTest/RtmTest.php
。
示例应用程序
使用此库的示例应用程序位于 sample-app/
目录中。