AssignmentsGrades
in package
LTI Advantage Assignment and Grade Services, version 2.
A line item is an lti_link. A result is the one lti_result row for that link and user. Posting a score writes that row. Reading results returns that same row. There is no second score log. A score replaces the current one when its timestamp is the same or newer. An older timestamp is ignored.
The launch claim points here only when the deployment allows a grade scope. A call still checks that deployment again.
Table of Contents
Constants
- LIMIT_MAX : mixed = 500
Methods
- coupledLineItemUrl() : mixed
- Line item coupled to this resource link, when the launch has a grade column.
-
create()
: array{status: int, body: array
|null, next: ?string, location: ?string} -
delete()
: array{status: int, body: array
|null, next: ?string, location: ?string} - lineItemsUrl() : mixed
- Absolute line-item container placed in the launch claim.
- lineItemUrl() : mixed
-
listItems()
: array{status: int, body: array
|null, next: ?string, location: ?string} - parsePath() : array{context_id: int, link_id: ?int, user_id: ?string, action: string}|null
-
readItem()
: array{status: int, body: array
|null, next: ?string, location: ?string} -
results()
: array{status: int, body: array
|null, next: ?string, location: ?string} - resultsUrl() : mixed
- resultUrl() : mixed
-
score()
: array{status: int, body: array
|null, next: ?string, location: ?string} -
update()
: array{status: int, body: array
|null, next: ?string, location: ?string} - agsJson() : array<string, mixed>
- applyDefinition() : mixed
-
authorize()
: array{key_id: int, deployment_ids: array
}|array{status: int, error: string} - canonicalInt() : mixed
- canonicalUserId() : mixed
- contentForResourceLink() : array{content_id: int, link_id: ?int, tool_deployment_id: int}|null
- createCoupled() : int|array{status: int, error: string}
- currentScore() : array{score: float, maximum: float}|null
- The cell currently showing for this user. A posted score is that cell.
- db() : PDOX
- definition() : array<string, mixed>
- document() : array<string, mixed>
- enum() : mixed
-
error()
: array{status: int, body: array
, next: ?string, location: ?string} - finiteNumber() : mixed
- flag() : mixed
- inClause() : mixed
- insertLink() : int|array{status: int, error: string}
- instant() : int|false
- limit() : int|null|false
- memberId() : mixed
- newLinkKey() : mixed
- nextUrl() : mixed
- nullableInstant() : int|null|false
- offset() : int|false
-
ok()
: array{status: int, body: array
|null, next: ?string, location: ?string} - optionalBool() : bool|null|string
- optionalInstant() : int|null|false
- ownedRow() : array<string, mixed>|null
- ownedRows() : array<int, array<string, mixed>>
- positiveNumber() : float|null|false
- prefix() : mixed
- queryString() : string|null|false
- resourceLinkId() : mixed
- resultDocuments() : array<int, array<string, mixed>>
- scoreBody() : array<string, mixed>
- scoreNumber() : float|null|false
- scoreGiven may be 0. Absent or null clears the current score.
- text() : string|null|false
- userOnKey() : mixed
- writeScore() : mixed
Constants
LIMIT_MAX
public
mixed
LIMIT_MAX
= 500
Methods
coupledLineItemUrl()
Line item coupled to this resource link, when the launch has a grade column.
public
static coupledLineItemUrl(int $contextId, string $resourceLinkId) : mixed
Parameters
- $contextId : int
- $resourceLinkId : string
create()
public
static create(string $accessToken, int $contextId, array<string, mixed> $body) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $body : array<string, mixed>
Return values
array{status: int, body: arraydelete()
public
static delete(string $accessToken, int $contextId, int $linkId) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $linkId : int
Return values
array{status: int, body: arraylineItemsUrl()
Absolute line-item container placed in the launch claim.
public
static lineItemsUrl(int $contextId) : mixed
Parameters
- $contextId : int
lineItemUrl()
public
static lineItemUrl(int $contextId, int $linkId) : mixed
Parameters
- $contextId : int
- $linkId : int
listItems()
public
static listItems(string $accessToken, int $contextId, array<string, mixed> $query) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $query : array<string, mixed>
Return values
array{status: int, body: arrayparsePath()
public
static parsePath(string $path) : array{context_id: int, link_id: ?int, user_id: ?string, action: string}|null
Parameters
- $path : string
Return values
array{context_id: int, link_id: ?int, user_id: ?string, action: string}|nullreadItem()
public
static readItem(string $accessToken, int $contextId, int $linkId) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $linkId : int
Return values
array{status: int, body: arrayresults()
public
static results(string $accessToken, int $contextId, int $linkId, array<string, mixed> $query, string|null $pathUserId) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $linkId : int
- $query : array<string, mixed>
- $pathUserId : string|null
Return values
array{status: int, body: arrayresultsUrl()
public
static resultsUrl(int $contextId, int $linkId) : mixed
Parameters
- $contextId : int
- $linkId : int
resultUrl()
public
static resultUrl(int $contextId, int $linkId, string $userId) : mixed
Parameters
- $contextId : int
- $linkId : int
- $userId : string
score()
public
static score(string $accessToken, int $contextId, int $linkId, array<string, mixed> $body) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $linkId : int
- $body : array<string, mixed>
Return values
array{status: int, body: arrayupdate()
public
static update(string $accessToken, int $contextId, int $linkId, array<string, mixed> $body) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $accessToken : string
- $contextId : int
- $linkId : int
- $body : array<string, mixed>
Return values
array{status: int, body: arrayagsJson()
private
static agsJson(mixed $json) : array<string, mixed>
Parameters
- $json : mixed
Return values
array<string, mixed>applyDefinition()
private
static applyDefinition(int $contextId, int $linkId, array<string, mixed> $fields) : mixed
Parameters
- $contextId : int
- $linkId : int
- $fields : array<string, mixed>
authorize()
private
static authorize(string $accessToken, int $contextId, array<int, string> $needed) : array{key_id: int, deployment_ids: array}|array{status: int, error: string}
Parameters
- $accessToken : string
- $contextId : int
- $needed : array<int, string>
Return values
array{key_id: int, deployment_ids: arraycanonicalInt()
private
static canonicalInt(string $raw) : mixed
Parameters
- $raw : string
canonicalUserId()
private
static canonicalUserId(string $raw) : mixed
Parameters
- $raw : string
contentForResourceLink()
private
static contentForResourceLink(int $contextId, array{key_id: int, deployment_ids: array} $auth, string $resourceLinkId) : array{content_id: int, link_id: ?int, tool_deployment_id: int}|null
Parameters
- $contextId : int
-
$auth
: array{key_id: int, deployment_ids: array
} - $resourceLinkId : string
Return values
array{content_id: int, link_id: ?int, tool_deployment_id: int}|nullcreateCoupled()
private
static createCoupled(int $contextId, array{key_id: int, deployment_ids: array} $auth, array<string, mixed> $fields) : int|array{status: int, error: string}
Parameters
- $contextId : int
-
$auth
: array{key_id: int, deployment_ids: array
} - $fields : array<string, mixed>
Return values
int|array{status: int, error: string}currentScore()
The cell currently showing for this user. A posted score is that cell.
private
static currentScore(array<string, mixed> $result, float $lineMaximum) : array{score: float, maximum: float}|null
A grade stored as a 0-1 fraction, with no scoreGiven yet, is the same cell.
Parameters
- $result : array<string, mixed>
- $lineMaximum : float
Return values
array{score: float, maximum: float}|nulldb()
private
static db() : PDOX
Return values
PDOXdefinition()
private
static definition(array<string, mixed> $body, string|null $currentId) : array<string, mixed>
Parameters
- $body : array<string, mixed>
- $currentId : string|null
Return values
array<string, mixed>document()
private
static document(int $contextId, array<string, mixed> $row) : array<string, mixed>
Parameters
- $contextId : int
- $row : array<string, mixed>
Return values
array<string, mixed>enum()
private
static enum(array<string, mixed> $body, string $key, array<int, string> $allowed) : mixed
Parameters
- $body : array<string, mixed>
- $key : string
- $allowed : array<int, string>
error()
private
static error(int $status, string $error) : array{status: int, body: array, next: ?string, location: ?string}
Parameters
- $status : int
- $error : string
Return values
array{status: int, body: arrayfiniteNumber()
private
static finiteNumber(mixed $value) : mixed
Parameters
- $value : mixed
flag()
private
static flag(bool|null $value) : mixed
Parameters
- $value : bool|null
inClause()
private
static inClause(string $prefix, array<int, int> $ids, array<string, mixed> &$params) : mixed
Parameters
- $prefix : string
- $ids : array<int, int>
- $params : array<string, mixed>
insertLink()
private
static insertLink(int $contextId, string $linkKey, string|null $resourceLinkId, int|null $ownerId, array<string, mixed> $fields) : int|array{status: int, error: string}
Parameters
- $contextId : int
- $linkKey : string
- $resourceLinkId : string|null
- $ownerId : int|null
- $fields : array<string, mixed>
Return values
int|array{status: int, error: string}instant()
private
static instant(string $value) : int|false
Parameters
- $value : string
Return values
int|falselimit()
private
static limit(array<string, mixed> $query) : int|null|false
Parameters
- $query : array<string, mixed>
Return values
int|null|falsememberId()
private
static memberId(int $contextId, int $keyId, int $userId) : mixed
Parameters
- $contextId : int
- $keyId : int
- $userId : int
newLinkKey()
private
static newLinkKey() : mixed
nextUrl()
private
static nextUrl(string $base, int $limit, int $offset, array<string, string|null> $filters) : mixed
Parameters
- $base : string
- $limit : int
- $offset : int
- $filters : array<string, string|null>
nullableInstant()
private
static nullableInstant(mixed $value) : int|null|false
Parameters
- $value : mixed
Return values
int|null|falseoffset()
private
static offset(array<string, mixed> $query, int|null $limit) : int|false
Parameters
- $query : array<string, mixed>
- $limit : int|null
Return values
int|falseok()
private
static ok(int $status, array<string, mixed>|null $body[, string|null $next = null ][, string|null $location = null ]) : array{status: int, body: array|null, next: ?string, location: ?string}
Parameters
- $status : int
- $body : array<string, mixed>|null
- $next : string|null = null
- $location : string|null = null
Return values
array{status: int, body: arrayoptionalBool()
private
static optionalBool(array<string, mixed> $body, string $key) : bool|null|string
Parameters
- $body : array<string, mixed>
- $key : string
Return values
bool|null|string —null means omitted, the string invalid means a bad value
optionalInstant()
private
static optionalInstant(array<string, mixed> $body, string $key) : int|null|false
Parameters
- $body : array<string, mixed>
- $key : string
Return values
int|null|false —null means omitted
ownedRow()
private
static ownedRow(int $contextId, int $linkId, array<int, int> $deploymentIds) : array<string, mixed>|null
Parameters
- $contextId : int
- $linkId : int
- $deploymentIds : array<int, int>
Return values
array<string, mixed>|nullownedRows()
private
static ownedRows(int $contextId, array<int, int> $deploymentIds) : array<int, array<string, mixed>>
Parameters
- $contextId : int
- $deploymentIds : array<int, int>
Return values
array<int, array<string, mixed>>positiveNumber()
private
static positiveNumber(array<string, mixed> $body, string $key, bool $required) : float|null|false
Parameters
- $body : array<string, mixed>
- $key : string
- $required : bool
Return values
float|null|falseprefix()
private
static prefix() : mixed
queryString()
private
static queryString(array<string, mixed> $query, string $key) : string|null|false
Parameters
- $query : array<string, mixed>
- $key : string
Return values
string|null|falseresourceLinkId()
private
static resourceLinkId(array<string, mixed> $row) : mixed
Parameters
- $row : array<string, mixed>
resultDocuments()
private
static resultDocuments(int $contextId, array<string, mixed> $row, string|null $userId) : array<int, array<string, mixed>>
Parameters
- $contextId : int
- $row : array<string, mixed>
- $userId : string|null
Return values
array<int, array<string, mixed>>scoreBody()
private
static scoreBody(array<string, mixed> $body) : array<string, mixed>
Parameters
- $body : array<string, mixed>
Return values
array<string, mixed>scoreNumber()
scoreGiven may be 0. Absent or null clears the current score.
private
static scoreNumber(array<string, mixed> $body, string $key) : float|null|false
Parameters
- $body : array<string, mixed>
- $key : string
Return values
float|null|falsetext()
private
static text(array<string, mixed> $body, string $key, bool $required, int $max) : string|null|false
Parameters
- $body : array<string, mixed>
- $key : string
- $required : bool
- $max : int
Return values
string|null|false —null means omitted or empty
userOnKey()
private
static userOnKey(int $keyId, int $userId) : mixed
Parameters
- $keyId : int
- $userId : int
writeScore()
private
static writeScore(int $linkId, int $userId, array<string, mixed> $parsed) : mixed
Parameters
- $linkId : int
- $userId : int
- $parsed : array<string, mixed>