Documentation

SubmissionHistory
in package

SubmissionHistory represents the complete history of versions for a submission.

This is a read-only object that does not extend AbstractBaseApi.

Tags
see
https://canvas.instructure.com/doc/api/gradebook_history.html#SubmissionHistory

Table of Contents

Properties

$submissionId  : int|null
$versions  : array<string|int, SubmissionVersion>

Methods

__construct()  : mixed
Constructor to hydrate the object from API response.
findVersion()  : SubmissionVersion|null
Find a version by its ID.
fromArray()  : self
Create a SubmissionHistory from an array.
getEarliestVersion()  : SubmissionVersion|null
Get the earliest version of the submission.
getGraderIds()  : array<string|int, int>
Get all unique grader IDs from the submission history.
getLatestVersion()  : SubmissionVersion|null
Get the latest version of the submission.
getVersionCount()  : int
Get the number of versions in this submission history.
getVersionsWithGradeChanges()  : array<string|int, SubmissionVersion>
Get all versions that have grade changes.

Properties

Methods

__construct()

Constructor to hydrate the object from API response.

public __construct([array<string, mixed> $data = [] ]) : mixed
Parameters
$data : array<string, mixed> = []

fromArray()

Create a SubmissionHistory from an array.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>
Return values
self

getGraderIds()

Get all unique grader IDs from the submission history.

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

getVersionCount()

Get the number of versions in this submission history.

public getVersionCount() : int
Return values
int

        
On this page

Search results