Tsugi

LessonsLegacyGift
in package

Legacy /cc/export helper: optionally turn GIFT LTI launches into QTI assessments.

Used by cc/export.php and course copy of a file-based lessons.json. Settings / LessonsCartridge native Quiz1 export is intentionally separate.

Default is convert found GIFT quizzes to QTI. Keep-as-LTI is opt-out. Conversion reads $CFG->giftquizzes and ignores .lock / other gift-tool access checks.

Table of Contents

Properties

$convertToQti  : bool
When false, gift LTI launches stay LTI even if GIFT text is on disk.
$giftquizzes  : string|null
Override for tests. Null means use $CFG->giftquizzes.
$warnings  : array<int, string>

Methods

__construct()  : mixed
addToModule()  : string
Add an LTI lesson item as QTI when conversion is on and GIFT is on disk; otherwise keep it as an LTI outcome launch.
giftquizzesDir()  : string|null
isGiftLaunch()  : bool
True when a launch URL is the old mod/gift tool or the in-tree tool/gift tool.
listQuizFiles()  : array<int, string>
Filenames in $CFG->giftquizzes (or $dir). Skips directories, dotfiles, and .lock.
quizNameFromItem()  : string|null
Quiz filename from launch ?quiz= or a custom quiz parameter.
quizNameFromLaunch()  : string|null
readGiftText()  : string|null
GIFT text for a quiz name, or null.
resolveGiftFile()  : string|null
Real path of a quiz file under giftquizzes, or null. No lock check.
summarize()  : array{scanned: int, gift: int, found: int, lti: int, paths: list, warnings: list, by_module: array}
Count LTI items that look like GIFT quizzes and which have convertible GIFT on disk.
wantsGiftQti()  : bool
Convert found GIFT to QTI unless the caller explicitly keeps LTI.
warnings()  : array<int, string>
assignExportIds()  : mixed
Qti12Exporter requires positive integer ids. File-based GIFT has none.
cleanQuizName()  : string|null
customMap()  : array<string, string>
emptySummary()  : array{scanned: int, gift: int, found: int, lti: int, paths: list, warnings: list, by_module: array}
exportIdentifier()  : string|null
Cartridge item identifier for a lesson resource link id.
itemTitle()  : string
ltiItemsForModule()  : array<int, object>
tryConvertItem()  : Quiz, xml: string, warnings: list}|null
writeQti()  : mixed

Properties

$convertToQti

When false, gift LTI launches stay LTI even if GIFT text is on disk.

private bool $convertToQti = true

$giftquizzes

Override for tests. Null means use $CFG->giftquizzes.

private string|null $giftquizzes

Methods

__construct()

public __construct([bool $convertToQti = true ][, string|null $giftquizzes = null ]) : mixed
Parameters
$convertToQti : bool = true

Default true: convert found GIFT to QTI

$giftquizzes : string|null = null

addToModule()

Add an LTI lesson item as QTI when conversion is on and GIFT is on disk; otherwise keep it as an LTI outcome launch.

public addToModule(ZipArchive $zip, CC $cc_dom, DOMNode $module_node, object $item, object $module[, string|null $parentPath = null ]) : string
Parameters
$zip : ZipArchive
$cc_dom : CC
$module_node : DOMNode
$item : object
$module : object
$parentPath : string|null = null
Return values
string —

'qti' or 'lti'

giftquizzesDir()

public static giftquizzesDir([string|null $dir = null ]) : string|null
Parameters
$dir : string|null = null
Return values
string|null

isGiftLaunch()

True when a launch URL is the old mod/gift tool or the in-tree tool/gift tool.

public static isGiftLaunch(mixed $launch) : bool
Parameters
$launch : mixed
Return values
bool

listQuizFiles()

Filenames in $CFG->giftquizzes (or $dir). Skips directories, dotfiles, and .lock.

public static listQuizFiles([string|null $dir = null ]) : array<int, string>

Does not honor gift-tool lock/password.

Parameters
$dir : string|null = null
Return values
array<int, string>

quizNameFromItem()

Quiz filename from launch ?quiz= or a custom quiz parameter.

public static quizNameFromItem(object|array<string|int, mixed> $item) : string|null
Parameters
$item : object|array<string|int, mixed>
Return values
string|null

quizNameFromLaunch()

public static quizNameFromLaunch(mixed $launch) : string|null
Parameters
$launch : mixed
Return values
string|null

readGiftText()

GIFT text for a quiz name, or null.

public static readGiftText(string $name[, string|null $dir = null ]) : string|null
Parameters
$name : string
$dir : string|null = null
Return values
string|null

resolveGiftFile()

Real path of a quiz file under giftquizzes, or null. No lock check.

public static resolveGiftFile(string $name[, string|null $dir = null ]) : string|null
Parameters
$name : string
$dir : string|null = null
Return values
string|null

summarize()

Count LTI items that look like GIFT quizzes and which have convertible GIFT on disk.

public static summarize(object $l[, array<string|int, mixed>|false $anchors = false ][, string|null $giftquizzes = null ]) : array{scanned: int, gift: int, found: int, lti: int, paths: list, warnings: list, by_module: array}
Parameters
$l : object

Lessons

$anchors : array<string|int, mixed>|false = false
$giftquizzes : string|null = null
Return values
array{scanned: int, gift: int, found: int, lti: int, paths: list, warnings: list, by_module: array}

wantsGiftQti()

Convert found GIFT to QTI unless the caller explicitly keeps LTI.

public static wantsGiftQti(mixed $raw) : bool
Parameters
$raw : mixed

Query value, usually "qti" or "lti"

Return values
bool

warnings()

public warnings() : array<int, string>
Return values
array<int, string>

assignExportIds()

Qti12Exporter requires positive integer ids. File-based GIFT has none.

private static assignExportIds(Quiz1 $quiz, mixed $stableKey) : mixed
Parameters
$quiz : Quiz1
$stableKey : mixed

cleanQuizName()

private static cleanQuizName(mixed $name) : string|null
Parameters
$name : mixed
Return values
string|null

customMap()

private static customMap(object $item) : array<string, string>
Parameters
$item : object
Return values
array<string, string>

emptySummary()

private static emptySummary() : array{scanned: int, gift: int, found: int, lti: int, paths: list, warnings: list, by_module: array}
Return values
array{scanned: int, gift: int, found: int, lti: int, paths: list, warnings: list, by_module: array}

exportIdentifier()

Cartridge item identifier for a lesson resource link id.

private static exportIdentifier(mixed $resourceLinkId) : string|null

":" is written as colon. Empty when the lesson has no link id.

Parameters
$resourceLinkId : mixed
Return values
string|null

itemTitle()

private static itemTitle(object $item, object $module) : string
Parameters
$item : object
$module : object
Return values
string

ltiItemsForModule()

private static ltiItemsForModule(object $module) : array<int, object>
Parameters
$module : object
Return values
array<int, object>

tryConvertItem()

private static tryConvertItem(object $item, string $title, string|null $giftquizzes, array<int, string> &$warnings) : Quiz, xml: string, warnings: list}|null
Parameters
$item : object
$title : string
$giftquizzes : string|null
$warnings : array<int, string>
Return values
Quiz, xml: string, warnings: list}|null

writeQti()

private writeQti(mixed $zip, mixed $cc_dom, mixed $module_node, mixed $title, Quiz, name?: string} $payload, mixed $parentPath) : mixed
Parameters
$zip : mixed
$cc_dom : mixed
$module_node : mixed
$title : mixed
$payload : Quiz, name?: string}
$parentPath : mixed

        
On this page

Search results