README

VoogPHP是VOOG CMS平台API的PHP实现。

当前实现版本为2.x - 是一次重大更新，与1.x版本不兼容。对此表示歉意。

此外，目前的文档不太有帮助，但代码应该相当易于理解。大多数关于“这个参数是什么意思？”的问题都可以在VOOG API文档中找到。

安装

最佳安装方式是使用Composer，在您的composer.json文件中包含以下内容

"require": {
  "codelab/voogphp": ">=2.0.0"
},

API的要求相当微妙 - PHP版本5.5或更高；以及FlaskHTTP HTTP请求库。当然，还需要一个Voog网站来进行工作。

使用

初始化连接

要创建连接，初始化一个VoogPHP实例

$Voog=new \Codelab\VoogPHP\VoogPHP(
  'http://yoursite.voog.com',  // Your Voog site URL
  '1234567890abcdef'           // Your Voog API token
);

此外，如果您想调试所有发生的事情，可以将日志文件路径作为第三个参数添加。

使用API

一旦初始化VoogPHP实例，它将包含以下子对象

• 网站
• 用户
• 管理员用户
• 语言
• 节点
• 布局
• 页面
• 文章
• 元素
• 元素定义
• 媒体集
• 资产
• 文本
• 表单
• 内容部分
• 购买按钮
• 商店
• 产品
• 购物车
• 折扣
• 订单
• 发票
• 运输方式
• 支付网关

几乎所有这些都与VOOG API文档中同名部分相对应。

规则例外的是

• 内容 - 在相应的对象（页面、文章、元素、语言）下可用
• 评论 - 在文章下可用
• 标签 - 在文章下可用
• 票据 - 在表单下可用
• 布局资产 - 在布局下可用

帮助和问题

如果您对API有任何疑问，可以在BitBucket上提出问题或写信给Indrek Siitan indrek.siitan@codelab.ee。

如果您对Voog或底层Voog API有任何疑问，最佳提问地点是slack.voog.com的Voog Slack频道。