README

将 OpenLRW 集成到您的 PHP 应用程序中的最简单方法（文档尚未完成）

客户端旨在以简单的方式请求 OpenLRW API，同时也允许操作这些请求中的对象。

要求

PHP >= 5.6

安装

$ composer require openlrw/api-client

用法

初始化客户端

use OpenLRW\OpenLRW;

$client = new OpenLRW(URL, KEY, PASSWORD);

检查服务器是否运行

$isServerUp = OpenLRW::isUp();

生成 JSON Web Token

OpenLRW::generateJwt();

OneRoster 对象

并非所有 OneRoster 模型都已实现，如果需要新的集合，请发送问题通知我们

使用用户集合的基本函数示例

所有 OneRoster 模型都有这些函数

// Get and edit a user
$user = User::find('foobar');
$user->status = 'active';
$user->save();


// Create a new user
$user = new User();
$user->sourcedId = 'foo';
$user->name = 'bar';
$user->status 'inactive';
$user->save();

// Delete a user
$user->delete(); /** or */ User::destroy('foo-bar');

// Get all the users
$users = Users::all();

每个类的特定函数的一些示例

查看类以了解所有这些特定函数

/** Klass model */
$enrollments = Klass::enrollments($classId); // array
$events = Klass::events($classId); // array
// ...

/** Risk */
$latestRisk = Risk::latestByClassAndUser($classId, $userId); // Risk::class
// ...

通用用法

$user = OneRoster::httpGet('users/test2u'); // return an array

$jsonInArray = ['...'];
$response = OneRoster::httpPost('users', $jsonInArray);

助手

执行测试

由于它是一个 API 客户端，您将需要编辑凭据以登录到 API

\vendor\bin\phpunit.bat --bootstrap vendor\autoload.php  tests\ApiClientTest.php

openlrw / api-client

维护者

详情

README

要求

安装

用法

初始化客户端

检查服务器是否运行

生成 JSON Web Token

OneRoster 对象

使用用户集合的基本函数示例

每个类的特定函数的一些示例

通用用法

助手

执行测试