Documentation

CreateRubricDTO extends AbstractBaseDto
in package
implements DTOInterface

Data Transfer Object for creating Canvas rubrics.

Tags
see
https://canvas.instructure.com/doc/api/rubrics.html#method.RubricsController.create

Table of Contents

Interfaces

DTOInterface

Properties

$association  : array<string, mixed>|null
Association data for creating a rubric association at the same time
$criteria  : array<int, array<string, mixed>>|null
An array of criteria objects for the rubric
$freeFormCriterionComments  : bool|null
Whether or not you can write custom comments in the ratings field for a rubric
$hideScoreTotal  : bool|null
Whether or not the score total is displayed within the rubric
$rubricAssociationId  : int|null
The ID of the rubric association (if associating with an existing object)
$title  : string|null
The title of the rubric
$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

$association

Association data for creating a rubric association at the same time

public array<string, mixed>|null $association = null

$criteria

An array of criteria objects for the rubric

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

$freeFormCriterionComments

Whether or not you can write custom comments in the ratings field for a rubric

public bool|null $freeFormCriterionComments = null

$hideScoreTotal

Whether or not the score total is displayed within the rubric

public bool|null $hideScoreTotal = null

$rubricAssociationId

The ID of the rubric association (if associating with an existing object)

public int|null $rubricAssociationId = null

$apiPropertyName

The name of the property in the API

protected string $apiPropertyName = 'rubric'

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>
Return values
array<string|int, mixed>

        
On this page

Search results