README

管理 TAO 的 LTI 服务的扩展

安装说明

这些说明假设您已经在系统上安装了 TAO。如果没有，请访问 package/tao 并按照安装说明进行操作。

如果您通过 package/tao 安装了您的 TAO 实例，则 oat-sa/extension-tao-lti 很可能已经安装。您可以在 设置 -> 扩展管理器 中验证此信息，其中它将显示在左侧，名称为 taoLti。或者您可以在 /config/generis/installation.conf.php 的代码中找到它。

注意，您必须以系统管理员身份登录才能执行此操作。

将扩展添加到您的 TAO composer 和自动加载器

composer require oat-sa/extension-tao-lti

从项目根目录使用 CLI 安装扩展

Linux

sudo php tao/scripts/installExtension oat-sa/extension-tao-lti

Windows

php tao\scripts\installExtension oat-sa/extension-tao-lti

作为系统管理员，您也可以通过 TAO 扩展管理器安装它

• 设置（菜单右侧的齿轮） -> 扩展管理器
• 在右侧选择 taoLti，勾选复选框，然后点击 安装

REST API

Lti REST API

配置选项

ServiceOptions.conf.php

描述：此选项指定 LTI 客户端配置。

如果配置文件不存在于 ../config/generis/ServiceOptions.conf.php，请通过从 ../generis/config/default/ServiceOptions.conf.php 复制来创建它。

示例

<?php

return new oat\generis\model\DependencyInjection\ServiceOptions(
    [
        oat\taoLti\models\classes\Client\LtiClientFactory::class => [
            'config' => [    // This configuration accepts
                'proxy' => [ // [Guzzle Request Options](https://docs.guzzlephp.org/en/stable/request-options.html)
                    'http'  => 'https://:8125',
                    'https' => 'https://:9124',
                ],
            ],
        ],
    ]
);

auth.conf.php

配置选项 config

描述：此选项指定数组中作为 adapter 键的单个选项。此适配器用于验证 LTI 请求，并在 FactoryLtiAuthAdapterService 中检索。

adapter 键的可能值

• 实现了 common_user_auth_Adapter 接口的任何类的实例

值示例

• ['config' => ['adapter' => 'oat\\taoLti\\models\\classes\\LtiAuthAdapter']]

CookieVerifyService.conf.php

配置选项 verify_cookie

描述：此选项确定在启动 LTI 工具之前是否检查 'session' 请求参数是否与内部 PHP 会话 ID 匹配。

可能值

• true：启用会话检查。需要 2 个额外的 HTTP 重定向
• false：禁用会话检查

LtiUserService.conf.php

配置选项 factoryLtiUser

描述：生成 LTI 用户的工厂

可能值

• 实现了 oat\taoLti\models\classes\user\LtiUserFactoryInterface 接口的任何类的实例

配置选项 transaction-safe（仅适用于 OntologyLtiUserService 实现）

描述：未使用

配置选项 transaction-safe-retry（仅适用于 OntologyLtiUserService 实现）

描述：未使用

配置选项 lti_ku_（仅适用于 KvLtiUserService 实现）

描述：在键值存储中存储 taoId => ltiId 关系的前缀，以查找 LTI 用户

可能值

• 任何唯一的字符串

配置选项 lti_ku_lkp_（仅适用于 KvLtiUserService 实现）

描述: 用于在键值存储中存储 ltiId => taoId 关系的键前缀，以执行反向查找

可能值

• 任何唯一的字符串

LtiValidatorService.conf.php

配置选项 launchDataValidator

描述: 指定用于验证 LTI 启动数据的验证器列表

可能值

• 任何实现了 LtiValidatorInterface 接口类的实例列表。验证器在数据无效的情况下应抛出 LtiException，返回值不考虑

值示例

• [ new oat\taoLti\models\classes\LaunchData\Validator\Lti11LaunchDataValidator() ]

依赖注入服务提供者

LtiServiceProvider

AuthorizationServerFactory 的配置

扩展维基

您可以在这里找到扩展维基。