Documentation

QuizSubmission extends AbstractBaseApi

in package

• CanvasLMS
• Api
• QuizSubmissions

Canvas LMS Quiz Submissions API

// Set course and quiz context (required for all operations)
$course = Course::find(123);
$quiz = Quiz::find(456);
QuizSubmission::setCourse($course);
QuizSubmission::setQuiz($quiz);

// Start a new quiz submission
$submission = QuizSubmission::start(['access_code' => 'secret123']);

// Get current user's submission
$submission = QuizSubmission::getCurrentUserSubmission();

// List all submissions for the quiz
$submissions = QuizSubmission::get();

// Get submissions with specific parameters
$submissions = QuizSubmission::get(['include' => ['user', 'quiz']]);

// Find specific submission
$submission = QuizSubmission::find(789);

// Update submission scores manually
$updatedSubmission = QuizSubmission::update(789, [
    'fudge_points' => 2.5,
    'quiz_submissions' => [
        ['attempt' => 1, 'fudge_points' => 2.5]
    ]
]);

// Complete a submission
$submission = QuizSubmission::find(789);
$success = $submission->complete();

// Check submission state
if ($submission->isComplete()) {
    echo "Submission completed with score: " . $submission->getScore();
}

Table of Contents

Properties

$attempt  : int|null

Attempt number (1-based)

$endAt  : DateTime|null

When the submission will end (time limit)

$extraAttempts  : int|null

Extra attempts allowed for this user

$extraTime  : int|null

Extra time allowed for this user (in minutes)

$finishedAt  : DateTime|null

When the submission was finished

$fudgePoints  : float|null

Fudge points added to the score

$hasSeenResults  : bool|null

Whether user has seen the results

$id  : int|null

Quiz submission unique identifier

$keptScore  : float|null

Score kept after regrade

$manuallyUnlocked  : bool|null

Whether submission was manually unlocked

$overdueAndNeedsSubmission  : bool|null

Whether submission is overdue and needs submission

$quizData  : array<string|int, mixed>|null

Associated quiz data (when included)

$quizId  : int|null

Quiz ID this submission belongs to

$score  : float|null

Current score for the submission

$scoreBeforeRegrade  : float|null

Score before any regrade

$startedAt  : DateTime|null

When the submission was started

$submission  : array<string|int, mixed>|null

Associated submission data (when included)

$submissionId  : int|null

Associated submission ID

$timeSpent  : int|null

Time spent on the quiz (in seconds)

$user  : array<string|int, mixed>|null

Associated user data (when included)

$userId  : int|null

User ID who made the submission

$validationToken  : string|null

Validation token for submission completion

$workflowState  : string|null

Workflow state (untaken, pending_review, complete, settings_only, preview)

$course  : Course|null

$methodAliases  : array<string, array<string|int, string>>

Define method aliases

$quiz  : Quiz|null

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

BaseApi constructor.

all()  : array<string|int, self>

Fetch all pages of quiz submissions

canBeRetaken()  : bool

Check if submission can be retaken

complete()  : self

Complete a quiz submission

create()  : self

find()  : static

Find a specific quiz submission by ID

get()  : array<string|int, self>

Fetch all quiz submissions for the quiz

getAttempt()  : int|null

Get attempt number

getCurrentUserSubmission()  : self|null

Get current user's submission for the quiz

getEndAt()  : DateTime|null

Get end at timestamp

getExtraAttempts()  : int|null

Get extra attempts

getExtraTime()  : int|null

Get extra time in minutes

getFinishedAt()  : DateTime|null

Get finished at timestamp

getFudgePoints()  : float|null

Get fudge points

getHasSeenResults()  : bool|null

Get has seen results status

getId()  : int|null

Get quiz submission ID

getKeptScore()  : float|null

Get kept score

getManuallyUnlocked()  : bool|null

Get manually unlocked status

getOverdueAndNeedsSubmission()  : bool|null

Get overdue and needs submission status

getQuizData()  : array<string|int, mixed>|null

Get associated quiz data

getQuizId()  : int|null

Get quiz ID

getRemainingTime()  : int|null

Get remaining time in seconds

getScore()  : float|null

Get current score

getScoreBeforeRegrade()  : float|null

Get score before regrade

getStartedAt()  : DateTime|null

Get started at timestamp

getSubmission()  : array<string|int, mixed>|null

Get associated submission data

getSubmissionId()  : int|null

Get submission ID

getTimeSpent()  : int|null

Get time spent in seconds

getUser()  : array<string|int, mixed>|null

Get associated user data

getUserId()  : int|null

Get user ID

getValidationToken()  : string|null

Get validation token

getWorkflowState()  : string|null

Get workflow state

hasTimeLimit()  : bool

Check if quiz has time limit

isComplete()  : bool

Check if submission is complete

isInProgress()  : bool

Check if submission is in progress

isOverdue()  : bool

Check if submission is overdue

overrideApiClient()  : void

Set an API client for this class only, leaving other resources on the shared default.

paginate()  : PaginationResult

Get paginated quiz submissions

resetApiClients()  : void

Clear the shared default client and all per-class overrides.

save()  : self

Save the quiz submission (update if exists)

setApiClient()  : void

Set the shared default API client used by ALL resource classes.

setAttempt()  : void

Set attempt number

setCourse()  : void

Set the course context for quiz submissions

setEndAt()  : void

Set end at timestamp

setExtraAttempts()  : void

Set extra attempts

setExtraTime()  : void

Set extra time in minutes

setFinishedAt()  : void

Set finished at timestamp

setFudgePoints()  : void

Set fudge points

setHasSeenResults()  : void

Set has seen results status

setId()  : void

Set quiz submission ID

setKeptScore()  : void

Set kept score

setManuallyUnlocked()  : void

Set manually unlocked status

setOverdueAndNeedsSubmission()  : void

Set overdue and needs submission status

setQuiz()  : void

Set the quiz context for quiz submissions

setQuizData()  : void

Set associated quiz data

setQuizId()  : void

Set quiz ID

setScore()  : void

Set current score

setScoreBeforeRegrade()  : void

Set score before regrade

setStartedAt()  : void

Set started at timestamp

setSubmission()  : void

Set associated submission data

setSubmissionId()  : void

Set submission ID

setTimeSpent()  : void

Set time spent in seconds

setUser()  : void

Set associated user data

setUserId()  : void

Set user ID

setValidationToken()  : void

Set validation token

setWorkflowState()  : void

Set workflow state

start()  : self

Start a quiz submission (alias for create)

stream()  : Generator<int, static>

Stream all items across all pages one at a time.

toArray()  : array<string|int, mixed>

Convert quiz submission to array

toDtoArray()  : array<string|int, mixed>

Convert quiz submission to DTO-compatible array

update()  : self

castValue()  : DateTime|mixed

Cast a value to the correct type

checkApiClient()  : void

Check if the API client is set, if not, instantiate a new one

checkContext()  : bool

Check if both course and quiz contexts are set

checkCourse()  : bool

Check if course context is set

checkQuiz()  : bool

Check if quiz context is set

convertPaginatedResponseToModels()  : array<string|int, static>

Helper method to convert paginated response data to model instances

createConfiguredHttpClient()  : HttpClient

Create an HttpClient with configured middleware

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

getAliasMap()  : array<string, string>

Build a flat alias-to-method lookup from $methodAliases.

getApiClient()  : HttpClientInterface

Get the API client, initializing if necessary

getCourse()  : Course

Get the Course instance, ensuring it is set

getEndpoint()  : string

Get the API endpoint for this resource

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

getQuiz()  : Quiz

Get the Quiz instance, ensuring it is set

hydrate()  : void

Assign API response data to properties with type coercion.

parseJsonResponse()  : array<string|int, mixed>

Parse JSON response from API safely handling StreamInterface

populate()  : void

Populate the object with new data

validateContext()  : void

Validate a context type path segment against an allowlist.

foreach (User::stream(['per_page' => 100]) as $user) {
    processUser($user);
}