CreateRubricAssessmentDTO
extends AbstractBaseDto
in package
implements
DTOInterface
Data Transfer Object for creating Canvas rubric assessments.
Tags
Table of Contents
Interfaces
Properties
- $assessmentType : string|null
- Assessment type. There are only three valid types: 'grading', 'peer_review', or 'provisional_grade'
- $criterionData : array<string, array<string, mixed>>|null
- The criterion assessment data Format: ['criterion_id' => ['points' => X, 'comments' => 'Y']]
- $final : bool|null
- Indicates a provisional grade will be marked as final.
- $gradedAnonymously : bool|null
- Whether the assessment was done anonymously
- $provisional : bool|null
- Indicates whether this assessment is provisional, defaults to false
- $userId : int|null
- The user ID that refers to the person being assessed
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- Constructor
- toApiArray() : array<int, array<string, mixed>>
- Convert the DTO to an array for API requests
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
Properties
$assessmentType
Assessment type. There are only three valid types: 'grading', 'peer_review', or 'provisional_grade'
public
string|null
$assessmentType
= null
$criterionData
The criterion assessment data Format: ['criterion_id' => ['points' => X, 'comments' => 'Y']]
public
array<string, array<string, mixed>>|null
$criterionData
= null
$final
Indicates a provisional grade will be marked as final.
public
bool|null
$final
= null
It only takes effect if the provisional param is passed as true. Defaults to false.
$gradedAnonymously
Whether the assessment was done anonymously
public
bool|null
$gradedAnonymously
= null
$provisional
Indicates whether this assessment is provisional, defaults to false
public
bool|null
$provisional
= null
$userId
The user ID that refers to the person being assessed
public
int|null
$userId
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= 'rubric_assessment'
Methods
__construct()
Constructor
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
toApiArray()
Convert the DTO to an array for API requests
public
toApiArray() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>