Documentation

UpdateQuizSubmissionDTO extends AbstractBaseDto implements DTOInterface

DTO for updating quiz submissions in Canvas LMS

This DTO handles the data structure for updating quiz submission scores, fudge points, and manual grading operations.

Usage Example:

// Manual scoring
$updateDto = new UpdateQuizSubmissionDTO([
    'attempt' => 1,
    'fudge_points' => 2.5,
    'quiz_submissions' => [
        [
            'attempt' => 1,
            'fudge_points' => 2.5,
            'questions' => [
                'question_1' => ['score' => 5.0, 'comment' => 'Good answer'],
                'question_2' => ['score' => 3.0, 'comment' => 'Partial credit']
            ]
        ]
    ]
]);

$submission = QuizSubmission::update(123, $updateDto);

Table of Contents

Interfaces

DTOInterface

Properties

$attempt  : int|null
Attempt number being updated
$fudgePoints  : float|null
Fudge points to add or subtract from the score
$questions  : array<string|int, mixed>|null
Questions array for manual scoring
$quizSubmissions  : array<string|int, mixed>|null
Quiz submissions array for bulk updates
$validationToken  : string|null
Validation token for submission completion
$apiPropertyName  : string
The API property name for quiz submissions

Methods

__construct()  : mixed
BaseDto constructor.
getAttempt()  : int|null
Get attempt number
getFudgePoints()  : float|null
Get fudge points
getQuestions()  : array<string|int, mixed>|null
Get questions array
getQuizSubmissions()  : array<string|int, mixed>|null
Get quiz submissions array
getValidationToken()  : string|null
Get validation token
setAttempt()  : void
Set attempt number
setFudgePoints()  : void
Set fudge points
setQuestions()  : void
Set questions array
setQuizSubmissions()  : void
Set quiz submissions array
setValidationToken()  : void
Set validation token
toApiArray()  : array<string|int, mixed>
Convert the DTO to an array for API requests
toArray()  : array<string|int, mixed>
Convert the DTO to an array

Properties

$questions

Questions array for manual scoring

public array<string|int, mixed>|null $questions = null

$quizSubmissions

Quiz submissions array for bulk updates

public array<string|int, mixed>|null $quizSubmissions = null

$validationToken

Validation token for submission completion

public string|null $validationToken = null

$apiPropertyName

The API property name for quiz submissions

protected string $apiPropertyName = 'quiz_submission'

Methods

__construct()

BaseDto constructor.

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Tags
throws
Exception

getQuestions()

Get questions array

public getQuestions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getQuizSubmissions()

Get quiz submissions array

public getQuizSubmissions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getValidationToken()

Get validation token

public getValidationToken() : string|null
Return values
string|null

setAttempt()

Set attempt number

public setAttempt(int|null $attempt) : void
Parameters
$attempt : int|null

Attempt number (1-based)

setFudgePoints()

Set fudge points

public setFudgePoints(float|null $fudgePoints) : void
Parameters
$fudgePoints : float|null

Points to add or subtract

setQuestions()

Set questions array

public setQuestions(array<string|int, mixed>|null $questions) : void
Parameters
$questions : array<string|int, mixed>|null

Array of question scores and comments

setQuizSubmissions()

Set quiz submissions array

public setQuizSubmissions(array<string|int, mixed>|null $quizSubmissions) : void
Parameters
$quizSubmissions : array<string|int, mixed>|null

Array of submission updates

setValidationToken()

Set validation token

public setValidationToken(string|null $validationToken) : void
Parameters
$validationToken : string|null

Token for submission validation

toApiArray()

Convert the DTO to an array for API requests

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

toArray()

Convert the DTO to an array

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

        
On this page

Search results