UpdateRubricAssociationDTO
extends AbstractBaseDto
in package
implements
DTOInterface
Data Transfer Object for updating Canvas rubric associations.
Tags
Table of Contents
Interfaces
Properties
- $associationId : int|null
- The ID of the object with which this rubric is associated
- $associationType : string|null
- The type of object this rubric is associated with Allowed values: Assignment, Course, Account
- $bookmarked : bool|null
- Whether or not the associated rubric appears in its context
- $hideOutcomeResults : bool|null
- Whether or not outcome results are hidden in the rubric
- $hidePoints : bool|null
- Whether or not points are hidden in the rubric
- $hideScoreTotal : bool|null
- Whether or not the score total is displayed within the rubric.
- $purpose : string|null
- Whether or not the association is for grading (and thus linked to an assignment) or if it's to indicate the rubric should appear in its context Allowed values: grading, bookmark
- $rubricId : int|null
- The ID of the Rubric
- $title : string|null
- The name of the object this rubric is associated with
- $useForGrading : bool|null
- Whether or not the associated rubric is used for grade calculation
- $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
$associationId
The ID of the object with which this rubric is associated
public
int|null
$associationId
= null
$associationType
The type of object this rubric is associated with Allowed values: Assignment, Course, Account
public
string|null
$associationType
= null
$bookmarked
Whether or not the associated rubric appears in its context
public
bool|null
$bookmarked
= null
$hideOutcomeResults
Whether or not outcome results are hidden in the rubric
public
bool|null
$hideOutcomeResults
= null
$hidePoints
Whether or not points are hidden in the rubric
public
bool|null
$hidePoints
= null
$hideScoreTotal
Whether or not the score total is displayed within the rubric.
public
bool|null
$hideScoreTotal
= null
This option is only available if the rubric is not used for grading.
$purpose
Whether or not the association is for grading (and thus linked to an assignment) or if it's to indicate the rubric should appear in its context Allowed values: grading, bookmark
public
string|null
$purpose
= null
$rubricId
The ID of the Rubric
public
int|null
$rubricId
= null
$title
The name of the object this rubric is associated with
public
string|null
$title
= null
$useForGrading
Whether or not the associated rubric is used for grade calculation
public
bool|null
$useForGrading
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= 'rubric_association'
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>