uisits/blackboardintegration

允许与Blackboard API进行交互

dev-master 2019-08-06 22:00 UTC

This package is auto-updated.

Last update: 2024-09-07 08:38:13 UTC


README

安装

  • 步骤 1 composer require uisits/blackboardintegration
  • 步骤 2 php artisan vendor:publish --tag=bbconfig
  • 步骤 3 将服务提供者添加到您的 config/app.php 文件中
    uisits\blackboardintegration\BlackboardintegrationServiceProvider::class,
    
  • 步骤 4 将外观添加到您的 config/app.php 文件中
    'Blackboard' => uisits\blackboardintegration\Facades\Blackboard::class,
    
  • 步骤 5 配置您的 config/bbconfig.php 文件。将以下环境变量添加到此文件中
    BB_HOSTNAME = 'https://bbdev.uis.edu:443'
    BB_KEY = 'xxxxxxxx' BB_SECRET = 'yyyyyyyy'
    BB_AUTH_PATH = '/learn/api/public/v1/oauth2/token'
    BB_DSK_PATH = '/learn/api/public/v1/dataSources'
    BB_TERM_PATH = '/learn/api/public/v1/terms'
    BB_COURSE_PATH = '/learn/api/public/v1/courses'
    BB_USER_PATH = '/learn/api/public/v1/users'

用法: 在您的控制器中

  • use BlackBoard;
  •   $token = Blackboard::token_authorize();
      dd($token);
    

示例

    $classid = "123456";
    $token = (BlackBoard::token_authorize())->access_token;
    $courseid = (BlackBoard::getCourseIdbyCourseId($token, $classid))->id;
    $course = BlackBoard::readCourse($token, $courseid);

可用方法

  • token_authorize(): 创建并返回令牌对象
  • createDatasource($access_token): 创建并返回一个新的数据源
  • readDatasource($access_token, $dsk_id): 获取并返回具有 $dsk_id ID 的数据源
  • updateDatasource($access_token, $dsk_id): 更新并返回具有 $dsk_id ID 的数据源
  • deleteDatasource($access_token, $dsk_id): 删除具有 $dsk_id ID 的数据源并返回成功或失败的结果
  • createTerm($access_token, $dsk_id): 在具有 $dsk_id ID 的数据源上创建并返回一个新的Blackboard学期
  • readTerm($access_token, $term_id): 获取并返回具有 $term_id ID 的学期
  • updateTerm($access_token, $dsk_id, $term_id): 更新具有磁盘 ID $dsk_id 和学期 ID $term_id 的学期
  • deleteTerm($access_token, $term_id): 删除具有 $term_id ID 的学期
  • createCourse($access_token, $dsk_id, $term_id): 创建并返回一个新的课程
  • readCourse($access_token, $course_id): 获取并返回具有 $course_id ID 的课程
  • getCourseIdbyCourseId($access_token, $course_id): 获取并返回具有 $course_id 外部 ID 的课程
  • getCourseGradebookColumnIdbyExternalId($access_token, $course_id, $external_id): 获取并返回具有 $external_id 外部 ID 的成绩单列,来自 $course_id 课程
  • getCourseGradebookColumns($access_token, $course_id): 获取并返回具有 $course_id 课程 ID 的所有成绩单列的集合
  • createCourseGradebookColumn($access_token, $name, $course_id): 为具有 $course_id ID 的课程创建并返回一个名为 $name 的成绩单列
  • getCourseGradebookColumnGrade($access_token, $course_id, $column_id, $user_id): 获取并返回 $user_id 学生在具有 $course_id ID 的课程中,成绩单列 ID 为 $column_id 的成绩对象
  • updateCourseGradebookColumnGrade($access_token, $course_id, $user_id, $column_id, $score): 更新并返回 $user_id 学生在具有 $course_id ID 的课程中,成绩单列 ID 为 $column_id 的成绩,值为 $score
  • updateCourse($access_token, $dsk_id, $course_id, $course_uuid, $course_created, $termId): 更新具有 $dsk_id、$course_uuid、$course_created 和 $termId 的课程值,其中课程 ID 为 $course_id
  • deleteCourse($access_token, $course_id): 删除具有 $course_id ID 的课程并返回成功或失败的结果
  • createUser($access_token, $dsk_id): 在具有 $dsk_id ID 的数据源上创建并返回一个用户
  • readUser($access_token, $user_id): 获取并返回具有 $user_id ID 的用户
  • readUserCourses($access_token, $user_id): 获取并返回与具有 $user_id ID 的用户关联的课程集合
  • getUserIdbyNetid($access_token, $user_id): 获取并返回具有 $user_id 网络标识的用户对象
  • updateUser($access_token, $dsk_id, $user_id, $user_uuid, $user_created): 更新并返回一个用户,其 $dsk_id、$user_uuid 和 $user_created 的值为 $user_id
  • deleteUser($access_token, $user_id): 删除具有 $user_id 的用户并返回 True 或 False,表示成功与否
  • createMembership($access_token, $dsk_id, $course_id, $user_id): 为具有 $user_id 的用户在具有 $course_id 的课程中创建并返回会员资格
  • readMembership($access_token, $course_id, $user_id): 获取并返回具有 $user_id 的用户在 $course_id 课程中的会员资格
  • updateMembership($access_token, $dsk_id, $course_id, $user_id, $membership_created): 更新并返回会员资格,其值为 $membership_created 和 $dsk_id,适用于 $user_id 在 $course_id 课程中
  • deleteMembership($access_token, $course_id, $user_id): 删除具有 $user_id 的用户和具有 $course_id 的会员资格,并根据成功与否返回 True 或 False

资源:Blackboard API: https://developer.blackboard.com/portal/displayApi