Tsugi

Lti13CourseTool
in package

Course Settings editor for one LTI 1.3 registration this course owns.

Scopes, claims, and placements stay on the tool when they are turned off. A grant or an enabled placement is the on switch. Delete removes the item from the registration. Add puts a known vocabulary value on the tool and turns it on. A placement string that is not in the menu is stored as typed. Messages, redirect URLs, and custom parameters are added, changed, and removed.

Table of Contents

Methods

apply()  : string
createManual()  : int
Create an empty LTI 1.3 registration this course owns.
draftIds()  : array<int, true>
LTI 1.3 registrations in this set that are still missing a required URL.
editState()  : array<string, mixed>
missingRequired()  : array<int, string>
Login URL, keyset URL, target link, and one redirect URL.
addClaim()  : void
addCustom()  : void
addMessage()  : void
addPlacement()  : void
addRedirect()  : void
addScope()  : void
claimCatalog()  : array<int, array{value: string, label: string}>
claimRows()  : array<int, array<string, mixed>>
column()  : string
configCustom()  : mixed
courseDeployments()  : array<int, array<string, mixed>>
customName()  : string
customValue()  : string
db()  : PDOX
deleteClaim()  : void
deleteCustom()  : void
deleteMessage()  : void
deletePlacement()  : void
deleteRedirect()  : void
deleteScope()  : void
dispatch()  : string
document()  : array<string, mixed>
documentCustom()  : array<string, string>
documentMessageMatches()  : bool
The document message at this sequence is the same launch as the row.
enabledPlacementIds()  : array<int, int>
grantFlags()  : array<int, array{tool_deployment_id: int, deployment_id: string, on: bool}>
httpUrl()  : string
knownClaim()  : string
knownScope()  : string
messageLabel()  : string
messageObject()  : array<string, mixed>
missingRows()  : array<int, array{value: string, label: string}>
optionalLabel()  : string|null
optionalUrl()  : string|null
orderedClaims()  : array<int, string>
iss and sub stay first. Unknown claims already on the tool stay after the known ones.
orderedScope()  : string
placementCatalog()  : array<int, array{label: string, placements: array}>
Suggested placements for the editor. The stored value is the identifier.
placementChoices()  : array<int, array{label: string, placements: array}>
Menu of placements this message type can still add.
placementDescribe()  : array{label: string, group: string, menu: bool}
posted()  : string
postedInt()  : int
postedMessageId()  : int|null
prefix()  : string
presentRows()  : array<int, array<string, mixed>>
prettyDocument()  : string
putConfigOptional()  : array<string, mixed>
putOptional()  : array<string, mixed>
rawCustom()  : array<string, mixed>
redirectList()  : array<int, string>
rejectLockedClaim()  : void
requireDeployment()  : array<string, mixed>
requireMessage()  : array<string, mixed>
requireOwned()  : array<string, mixed>
requirePlacement()  : array<string, mixed>
saveMessage()  : void
saveProfile()  : void
scopeCatalog()  : array<int, array{value: string, label: string}>
setClaim()  : void
setConfigValue()  : array<string, mixed>
setPlacement()  : void
setScope()  : void
updateColumns()  : void
uuid()  : string
writeClaims()  : void
writeConfigCustom()  : void
writeMessageCustom()  : void
writeMessageObject()  : void
writeRedirects()  : void
writeScopes()  : void

Methods

apply()

public static apply(int $contextId, int $registrationId, array<string, mixed> $post) : string
Parameters
$contextId : int
$registrationId : int
$post : array<string, mixed>
Return values
string —

flash message

createManual()

Create an empty LTI 1.3 registration this course owns.

public static createManual(int $contextId, int|null $userId, array<string, mixed> $post) : int

Client id and deployment id are assigned here. The login URL, keyset URL, target link, and a redirect URL can wait. Until those are set, the tool is a draft. Messages, scopes, and placements are added on the editor.

Parameters
$contextId : int
$userId : int|null
$post : array<string, mixed>
Return values
int —

registration_id

draftIds()

LTI 1.3 registrations in this set that are still missing a required URL.

public static draftIds(array<int, mixed> $registrationIds) : array<int, true>
Parameters
$registrationIds : array<int, mixed>
Return values
array<int, true>

editState()

public static editState(int $contextId, int $registrationId) : array<string, mixed>
Parameters
$contextId : int
$registrationId : int
Return values
array<string, mixed>

missingRequired()

Login URL, keyset URL, target link, and one redirect URL.

public static missingRequired(string|null $login, string|null $jwks, string|null $launch, array<int, mixed> $redirects) : array<int, string>

An empty list means the registration is still a draft.

Parameters
$login : string|null
$jwks : string|null
$launch : string|null
$redirects : array<int, mixed>
Return values
array<int, string>

addClaim()

private static addClaim(int $contextId, int $registrationId, string $claim) : void
Parameters
$contextId : int
$registrationId : int
$claim : string

addCustom()

private static addCustom(int $registrationId, array<string, mixed> $post) : void
Parameters
$registrationId : int
$post : array<string, mixed>

addMessage()

private static addMessage(int $registrationId, array<string, mixed> $post) : void
Parameters
$registrationId : int
$post : array<string, mixed>

addPlacement()

private static addPlacement(int $contextId, int $registrationId, int $messageId, string $placement) : void
Parameters
$contextId : int
$registrationId : int
$messageId : int
$placement : string

addRedirect()

private static addRedirect(int $registrationId, string $uri) : void
Parameters
$registrationId : int
$uri : string

addScope()

private static addScope(int $contextId, int $registrationId, string $scope) : void
Parameters
$contextId : int
$registrationId : int
$scope : string

claimCatalog()

private static claimCatalog() : array<int, array{value: string, label: string}>
Return values
array<int, array{value: string, label: string}>

claimRows()

private static claimRows(array<int, string> $requested, array<int, array<string, mixed>> $grantRows) : array<int, array<string, mixed>>
Parameters
$requested : array<int, string>
$grantRows : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>

column()

private static column(int $registrationId, string $column) : string
Parameters
$registrationId : int
$column : string
Return values
string

configCustom()

private static configCustom(array<string, mixed> $document) : mixed
Parameters
$document : array<string, mixed>

courseDeployments()

private static courseDeployments(int $contextId, int $registrationId) : array<int, array<string, mixed>>
Parameters
$contextId : int
$registrationId : int
Return values
array<int, array<string, mixed>>

customName()

private static customName(string $name) : string
Parameters
$name : string
Return values
string

customValue()

private static customValue(string $value) : string
Parameters
$value : string
Return values
string

deleteClaim()

private static deleteClaim(int $registrationId, string $claim) : void
Parameters
$registrationId : int
$claim : string

deleteCustom()

private static deleteCustom(int $registrationId, array<string, mixed> $post) : void
Parameters
$registrationId : int
$post : array<string, mixed>

deleteMessage()

private static deleteMessage(int $registrationId, int $messageId) : void
Parameters
$registrationId : int
$messageId : int

deletePlacement()

private static deletePlacement(int $registrationId, int $messageId, int $messagePlacementId) : void
Parameters
$registrationId : int
$messageId : int
$messagePlacementId : int

deleteRedirect()

private static deleteRedirect(int $registrationId, string $uri) : void
Parameters
$registrationId : int
$uri : string

deleteScope()

private static deleteScope(int $registrationId, string $scope) : void
Parameters
$registrationId : int
$scope : string

dispatch()

private static dispatch(int $contextId, int $registrationId, string $action, array<string, mixed> $post) : string
Parameters
$contextId : int
$registrationId : int
$action : string
$post : array<string, mixed>
Return values
string

document()

private static document(int $registrationId) : array<string, mixed>
Parameters
$registrationId : int
Return values
array<string, mixed>

documentCustom()

private static documentCustom(array<string, mixed> $document) : array<string, string>
Parameters
$document : array<string, mixed>
Return values
array<string, string>

documentMessageMatches()

The document message at this sequence is the same launch as the row.

private static documentMessageMatches(array<int, mixed> $messages, int $sequence, string $messageType) : bool

The document may still say LtiResourceLink. The row says LtiResourceLinkRequest.

Parameters
$messages : array<int, mixed>
$sequence : int
$messageType : string
Return values
bool

enabledPlacementIds()

private static enabledPlacementIds(int $toolDeploymentId) : array<int, int>
Parameters
$toolDeploymentId : int
Return values
array<int, int>

grantFlags()

private static grantFlags(array<int, array<string, mixed>> $grantRows, string $key, int|string $value) : array<int, array{tool_deployment_id: int, deployment_id: string, on: bool}>
Parameters
$grantRows : array<int, array<string, mixed>>
$key : string
$value : int|string
Return values
array<int, array{tool_deployment_id: int, deployment_id: string, on: bool}>

httpUrl()

private static httpUrl(string $value, string $label) : string
Parameters
$value : string
$label : string
Return values
string

knownClaim()

private static knownClaim(string $claim) : string
Parameters
$claim : string
Return values
string

knownScope()

private static knownScope(string $scope) : string
Parameters
$scope : string
Return values
string

messageLabel()

private static messageLabel(string $type) : string
Parameters
$type : string
Return values
string

messageObject()

private static messageObject(array<string, mixed> $message) : array<string, mixed>
Parameters
$message : array<string, mixed>
Return values
array<string, mixed>

missingRows()

private static missingRows(array<int, array{value: string, label: string}> $catalog, array<int, string> $requested) : array<int, array{value: string, label: string}>
Parameters
$catalog : array<int, array{value: string, label: string}>
$requested : array<int, string>
Return values
array<int, array{value: string, label: string}>

optionalLabel()

private static optionalLabel(string $value) : string|null
Parameters
$value : string
Return values
string|null

optionalUrl()

private static optionalUrl(string $value, string $label) : string|null
Parameters
$value : string
$label : string
Return values
string|null

orderedClaims()

iss and sub stay first. Unknown claims already on the tool stay after the known ones.

private static orderedClaims(array<int, string> $claims) : array<int, string>
Parameters
$claims : array<int, string>
Return values
array<int, string>

orderedScope()

private static orderedScope(array<int, string> $scopes) : string
Parameters
$scopes : array<int, string>
Return values
string

placementCatalog()

Suggested placements for the editor. The stored value is the identifier.

private static placementCatalog() : array<int, array{label: string, placements: array}>

Dynamic Registration names ContentArea and RichTextEditor. Everything else is a platform extension. A string that is not listed here can still be stored.

Return values
array<int, array{label: string, placements: array}>

placementChoices()

Menu of placements this message type can still add.

private static placementChoices(string $messageType, array<string, true> $have) : array<int, array{label: string, placements: array}>

A known placement is offered only when this message type can carry it. A placement the catalog does not name stays available under Other.

Parameters
$messageType : string
$have : array<string, true>
Return values
array<int, array{label: string, placements: array}>

placementDescribe()

private static placementDescribe(string $placement) : array{label: string, group: string, menu: bool}
Parameters
$placement : string
Return values
array{label: string, group: string, menu: bool}

posted()

private static posted(array<string, mixed> $post, string $key) : string
Parameters
$post : array<string, mixed>
$key : string
Return values
string

postedInt()

private static postedInt(array<string, mixed> $post, string $key) : int
Parameters
$post : array<string, mixed>
$key : string
Return values
int

postedMessageId()

private static postedMessageId(array<string, mixed> $post) : int|null
Parameters
$post : array<string, mixed>
Return values
int|null

presentRows()

private static presentRows(array<int, array{value: string, label: string}> $catalog, array<int, string> $requested, array<int, array<string, mixed>> $grantRows, string $key) : array<int, array<string, mixed>>
Parameters
$catalog : array<int, array{value: string, label: string}>
$requested : array<int, string>
$grantRows : array<int, array<string, mixed>>
$key : string
Return values
array<int, array<string, mixed>>

prettyDocument()

private static prettyDocument(array<string, mixed> $document) : string
Parameters
$document : array<string, mixed>
Return values
string

putConfigOptional()

private static putConfigOptional(array<string, mixed> $document, string $key, string|null $value) : array<string, mixed>
Parameters
$document : array<string, mixed>
$key : string
$value : string|null
Return values
array<string, mixed>

putOptional()

private static putOptional(array<string, mixed> $document, string $key, string|null $value) : array<string, mixed>
Parameters
$document : array<string, mixed>
$key : string
$value : string|null
Return values
array<string, mixed>

rawCustom()

private static rawCustom(mixed $value) : array<string, mixed>
Parameters
$value : mixed
Return values
array<string, mixed>

redirectList()

private static redirectList(array<string, mixed> $document) : array<int, string>
Parameters
$document : array<string, mixed>
Return values
array<int, string>

rejectLockedClaim()

private static rejectLockedClaim(string $claim) : void
Parameters
$claim : string

requireDeployment()

private static requireDeployment(int $contextId, int $registrationId, int $toolDeploymentId) : array<string, mixed>
Parameters
$contextId : int
$registrationId : int
$toolDeploymentId : int
Return values
array<string, mixed>

requireMessage()

private static requireMessage(int $registrationId, int $messageId) : array<string, mixed>
Parameters
$registrationId : int
$messageId : int
Return values
array<string, mixed>

requireOwned()

private static requireOwned(int $contextId, int $registrationId) : array<string, mixed>
Parameters
$contextId : int
$registrationId : int
Return values
array<string, mixed>

requirePlacement()

private static requirePlacement(array<string, mixed> $message, int $messagePlacementId) : array<string, mixed>
Parameters
$message : array<string, mixed>
$messagePlacementId : int
Return values
array<string, mixed>

saveMessage()

private static saveMessage(int $registrationId, array<string, mixed> $post) : void
Parameters
$registrationId : int
$post : array<string, mixed>

saveProfile()

private static saveProfile(int $contextId, int $registrationId, array<string, mixed> $post) : void
Parameters
$contextId : int
$registrationId : int
$post : array<string, mixed>

scopeCatalog()

private static scopeCatalog() : array<int, array{value: string, label: string}>
Return values
array<int, array{value: string, label: string}>

setClaim()

private static setClaim(int $contextId, int $registrationId, string $claim, int $toolDeploymentId, bool $on) : void
Parameters
$contextId : int
$registrationId : int
$claim : string
$toolDeploymentId : int
$on : bool

setConfigValue()

private static setConfigValue(array<string, mixed> $document, string $key, mixed $value) : array<string, mixed>
Parameters
$document : array<string, mixed>
$key : string
$value : mixed
Return values
array<string, mixed>

setPlacement()

private static setPlacement(int $contextId, int $registrationId, int $messageId, int $messagePlacementId, int $toolDeploymentId, bool $on) : void
Parameters
$contextId : int
$registrationId : int
$messageId : int
$messagePlacementId : int
$toolDeploymentId : int
$on : bool

setScope()

private static setScope(int $contextId, int $registrationId, string $scope, int $toolDeploymentId, bool $on) : void
Parameters
$contextId : int
$registrationId : int
$scope : string
$toolDeploymentId : int
$on : bool

updateColumns()

private static updateColumns(int $contextId, int $registrationId, array<string, string|null> $fields) : void
Parameters
$contextId : int
$registrationId : int
$fields : array<string, string|null>

writeClaims()

private static writeClaims(int $registrationId, array<string, mixed> $document, array<int, string> $claims) : void
Parameters
$registrationId : int
$document : array<string, mixed>
$claims : array<int, string>

writeConfigCustom()

private static writeConfigCustom(int $registrationId, array<string, mixed> $document, array<string, mixed> $custom) : void
Parameters
$registrationId : int
$document : array<string, mixed>
$custom : array<string, mixed>

writeMessageCustom()

private static writeMessageCustom(int $registrationId, array<string, mixed> $message, array<string, mixed> $custom) : void
Parameters
$registrationId : int
$message : array<string, mixed>
$custom : array<string, mixed>

writeMessageObject()

private static writeMessageObject(int $registrationId, array<string, mixed> $message, array<string, mixed> $object) : void
Parameters
$registrationId : int
$message : array<string, mixed>
$object : array<string, mixed>

writeRedirects()

private static writeRedirects(int $registrationId, array<string, mixed> $document, array<int, string> $uris) : void
Parameters
$registrationId : int
$document : array<string, mixed>
$uris : array<int, string>

writeScopes()

private static writeScopes(int $registrationId, array<string, mixed> $document, array<int, string> $scopes) : void
Parameters
$registrationId : int
$document : array<string, mixed>
$scopes : array<int, string>

        
On this page

Search results