yetti/api

Yetti平台API绑定

dev-master 2014-01-08 14:24 UTC

This package is not auto-updated.

Last update: 2024-09-23 13:26:19 UTC


README

Build Status

本包包含Yetti API的PHP API绑定。

有关Yetti的更多详细信息,请参阅http://yetti.co.uk。欢迎在support@yetti.co.uk处提出评论、反馈和错误报告。

要求

  • PHP 5.3或更高版本。
  • PHP的cURL模块。

安装

使用composer安装,只需将其添加到composer.json中

"require": {
	"yetti/api": "dev-master"
}

示例

创建一个项目很简单

use Yetti\API\Webservice as Webservice;
use Yetti\API\Item as Item;

Webservice::setDefaultBaseUri('https://yoursite.secure.yetti.co.uk');
Webservice::setDefaultAccessKey('your-access-key');
Webservice::setDefaultPrivateKey('your-private-key');

$item = new Item();
$item->loadTemplate(1);
$item->setName('my-big-news');
$item->setPropertyValue('Name', 'My big news..!');
$item->setPropertyValue('Body', 'I have decided to become a whale.');

echo $item->save()->success() ? 'Item saved' : 'Save failed';

除此之外,没有更复杂的事情了。请参阅附带的文档和测试目录以获取更多帮助和示例。

文档

附带的文档是直接使用phpDocumentor 2工具从源代码生成的。

要重新生成API文档,请确保已安装phpDocumentor 2,然后切换到API绑定目录,然后运行

rm -rf docs && phpdoc

测试

测试是用PHPUnit 3.7.24编写的。

要运行测试,请切换到API绑定目录,然后运行

composer install
phpunit .

贡献

Yetti API正在积极开发中,这些PHP绑定也是如此。如果您发现错误或有任何特定评论,请使用GitHub问题。如果您想帮助我们改进这些绑定,请随时分支并发送拉取请求。