README

Arbor Education SDK 库。

简介

PHP SDK 是一个库，简化了将 Arbor REST API 集成到您自己的软件中的过程。

而不是在您的代码中处理 XML 和进行 HTTP 请求，您只需包含 SDK 并使用模型上的 getter 和 setter 来访问来自 Arbor 的数据。PHP SDK 包含数百个模型，以及用于通过查询模型查询 API 的网关模式。

要求

• PHP 7.1 或更高版本
• Composer

安装

只需下载项目，然后在项目根目录中运行 composer install 以用于测试目的。

在 Packagist 上找到最新版本：Arbor Education - PHP SDK，然后直接在您的项目中使用 composer 安装：composer require arbor-education/arbor-sdk-php

一旦设置完毕，使用 examples/config-dist.php 创建您自己的配置。为此，您需要在 Arbor Education - 开发者门户 上添加您的应用程序凭据，以便能够向沙盒环境发出请求。

用法

在 examples/example-bootstrap 中，您将找到进行请求所需的配置，无论是直接从 examples/config.php 使用，还是使用您自己的配置。整个 examples 目录都专注于帮助您更快地开发应用程序。编写的脚本代表了一些最常用的查询。

示例

使用 Arbor\Api\Gateway\RestGateway 来执行 GET、POST、PUT 和 DELETE 请求，并使用 Arbor\Query\Query 来为您的请求添加过滤器。

GET 请求

$student = \Arbor\Model\Student::retrieve(16);

或使用 examples/student-retrieve.php 来查看如何检索记录。

POST 请求

使用 examples/staff-create.php 来查看如何创建新记录。

PUT 请求

使用 examples/staff-create.php 来查看如何更新现有记录。

DELETE 请求

$api->delete($staff->getPerson()); // assuming that you are deleting your newly created staff record

查询过滤器

过滤器列表可在 Arbor\Query\Query 中找到

$query = new \Arbor\Query\Query(Arbor\Resource\ResourceType::ARBOR_MODEL);
$query->addPropertyFilter(ArborModel::PROPERTY_NAME, OPERATOR, $value);
$query->addPropertyFilter(ArborModel::PROPERTY_NAME, SECOND_OPERATOR, $value);
... 

$records = \Arbor\Model\ArborModel::query($query); // will return an array of records

foreach ($records as $record) {
    // e.g. $record->getDisplayName();
}

查看 examples 目录以查看过滤器的用法。