Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/izumi-kun/yii2-lti-tool-provider
LTI Tool Provider library for Yii2
https://github.com/izumi-kun/yii2-lti-tool-provider
lti lti-provider wip yii2 yii2-extension
Last synced: 30 days ago
JSON representation
LTI Tool Provider library for Yii2
- Host: GitHub
- URL: https://github.com/izumi-kun/yii2-lti-tool-provider
- Owner: Izumi-kun
- License: bsd-3-clause
- Created: 2018-04-13T07:13:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-02T09:03:01.000Z (2 months ago)
- Last Synced: 2024-10-14T13:43:32.582Z (30 days ago)
- Topics: lti, lti-provider, wip, yii2, yii2-extension
- Language: PHP
- Size: 71.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Yii2 LTI Tool
======================
LTI Tool module for Yii2.
[](https://packagist.org/packages/izumi-kun/yii2-lti-tool-provider)
[](https://packagist.org/packages/izumi-kun/yii2-lti-tool-provider)
[](https://packagist.org/packages/izumi-kun/yii2-lti-tool-provider)
Installation
------------
```
composer require izumi-kun/yii2-lti-tool-provider
```
Usage
-----
### Migrations
Add namespaced migrations: `izumi\yii2lti\migrations`. Apply new migrations.
### Application config
Add the module to the web config and configure it. The module supports the following events for handling messages from Platforms:
- `launch`
- `configure`
- `dashboard`
- `contentItem`
- `contentItemUpdate`
- `submissionReview`
Make sure to configure access to the `lti/platform` controller actions.
All messages from Platforms are handled by the `lti/tool` controller, and there are no access restrictions.
```php
$config = [
'modules' => [
'lti' => [
'class' => \izumi\yii2lti\Module::class,
'tool' => [
'debugMode' => YII_DEBUG,
'rsaKey' => 'A PEM formatted private key (for LTI 1.3 support)',
],
'on launch' => [SiteController::class, 'ltiLaunch'],
'on error' => [SiteController::class, 'ltiError'],
'as access' => [
'class' => \yii\filters\AccessControl::class,
'rules' => [
['allow' => true, 'controllers' => ['lti/tool']],
['allow' => true, 'controllers' => ['lti/platform'], 'roles' => ['admin']],
],
],
],
],
];
```
### Event handlers
Create event handlers according to the module configuration.
```php
namespace app\controllers;
use izumi\yii2lti\ToolEvent;
use Yii;
use yii\web\BadRequestHttpException;
use yii\web\Controller;
class SiteController extends Controller
{
/**
* basic-lti-launch-request handler
* @param ToolEvent $event
*/
public static function ltiLaunch(ToolEvent $event)
{
$tool = $event->sender;
// $userPk can be used for user identity
$userPk = $tool->user->getRecordId();
$isAdmin = $tool->user->isStaff() || $tool->user->isAdmin();
Yii::$app->session->set('isAdmin', $isAdmin);
Yii::$app->session->set('userPk', $userPk);
Yii::$app->controller->redirect(['/site/index']);
$tool->ok = true;
$event->handled = true;
}
/**
* LTI error handler
* @param ToolEvent $event
* @throws BadRequestHttpException
*/
public static function ltiError(ToolEvent $event)
{
$tool = $event->sender;
$msg = $tool->message;
if (!empty($tool->reason)) {
Yii::error($tool->reason);
if ($tool->debugMode) {
$msg = $tool->reason;
}
}
throw new BadRequestHttpException($msg);
}
}
```
### Outcome
```php
use ceLTIc\LTI;
/* @var \izumi\yii2lti\Module $module */
$module = Yii::$app->getModule('lti');
$user = $module->findUserById(Yii::$app->session->get('userPk'));
$result = '0.8';
$outcome = new LTI\Outcome($result);
if ($module->doOutcomesService(LTI\Enum\ServiceAction::Write, $outcome, $user)) {
Yii::$app->session->addFlash('success', 'Result sent successfully');
}
```
### Sample app
[https://github.com/Izumi-kun/yii2-lti-tool-provider-sample](https://github.com/Izumi-kun/yii2-lti-tool-provider-sample)
### Useful
- [LTI Platform emulator](https://saltire.lti.app/platform)
- [celtic-project/LTI-PHP/wiki](https://github.com/celtic-project/LTI-PHP/wiki)