razorbacks / blackboard-rest-api-wrapper

为 https://developer.blackboard.com/portal/displayApi 提供轻量级封装

0.2.0 2017-10-23 19:36 UTC

This package is not auto-updated.

Last update: 2024-09-19 04:58:20 UTC


README

https://developer.blackboard.com/portal/displayApi 提供轻量级封装

另请参阅 https://razorbacks.github.io/blackboard-rest-api-wrapper/

https://github.com/blackboard/BBDN-REST-Demo-PHP 启发

安装

通过 composer

composer require razorbacks/blackboard-rest-api-wrapper

使用方法

// setup
require_once __DIR__.'/vendor/autoload.php';

use razorbacks\blackboard\rest\Api;

$server = 'https://learn.uark.edu';
$applicationId = 'your-application-id';
$secret = 'secret';

$blackboard = new Api($server, $applicationId, $secret);

// create a new manual grade column for a course
$courseId = '_123_1';
$gradeColumn = [
    'name' => 'Example Assignment',
    'description' => 'This is something we did for course credit.',
    'score' => [
        'possible' => 10,
    ],
    'availability' => [
        'available' => 'Yes',
    ],
];

// create and hydrate the model with new ID
$gradeColumn = $blackboard->post("/courses/{$courseId}/gradebook/columns", $gradeColumn);

// assign a grade to a student
$username = 'jdoe';
$endpoint = "/courses/{$courseId}/gradebook/columns/{$gradeColumn['id']}/users/userName:$username";
$blackboard->patch($endpoint, [
    'score' => 9,
]);

查看 测试 以获取更多示例。

测试

测试套件由集成测试组成,进行实际网络调用。请参阅 文档 了解设置 vagrant 虚拟机服务器的方法。