Documentation

RubricAssessment extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Rubrics

RubricAssessment Class

// Set course context first
$course = Course::find(123);
RubricAssessment::setCourse($course);

// Creating a rubric assessment (using array)
$assessment = RubricAssessment::create([
    'userId' => 123,
    'assessmentType' => 'grading',
    'criterionData' => [...]
], 456); // rubric_association_id

// Creating using DTO (still supported)
$dto = new CreateRubricAssessmentDTO();
$dto->userId = 123;
$dto->assessmentType = 'grading';
$dto->criterionData = [...];
$assessment = RubricAssessment::create($dto, 456);

// Updating an assessment (using array)
$assessment = RubricAssessment::update(111, [
    'criterionData' => [...]
], 456); // rubric_association_id

// Updating using DTO (still supported)
$updateDto = new UpdateRubricAssessmentDTO();
$updateDto->criterionData = [...];
$assessment = RubricAssessment::update(111, $updateDto, 456);

Table of Contents

Properties

$artifact  : array<string, mixed>|null

The artifact being assessed

$artifactAttempt  : int|null

The current number of attempts made on the object of the assessment

$artifactId  : int|null

The ID of the artifact being assessed

$artifactType  : string|null

The type of the artifact being assessed

$assessmentType  : string|null

The type of assessment Values: 'grading', 'peer_review', or 'provisional_grade'

$assessorId  : int|null

User ID of the person who made the assessment

$assessorName  : string|null

Name of the assessor

$comments  : string|null

Overall comments for the assessment

$createdAt  : string|null

Created timestamp

$criterionData  : array<string, mixed>|null

Criterion data for assessment creation/updates

$data  : array<string, mixed>|null

Full assessment data (when style='full' is requested)

$id  : int|null

The ID of the rubric assessment

$provisionalGradeId  : int|null

Provisional grade ID for moderated grading

$ratings  : array<int, mixed>|null

Additional assessment details

$relatedGroupSubmissionsAndAssessments  : array<int, mixed>|null

Related group submissions and assessments

$rubricAssociationId  : int|null

The ID of the rubric association

$rubricId  : int|null

The ID of the rubric

$score  : float|null

The overall score for this assessment

$updatedAt  : string|null

Updated timestamp

$userId  : int|null

User ID of the person being assessed

$apiClient  : HttpClientInterface

$course  : Course|null

Course context for operations

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Constructor

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

Get all pages of results

create()  : self

Create a new rubric assessment

delete()  : self

Delete a rubric assessment

find()  : self

Find a rubric assessment by ID

get()  : array<int, self>

Fetch all rubric assessments

paginate()  : PaginationResult

Get paginated results with metadata

rubric()  : Rubric

Get the associated rubric

rubricAssociation()  : RubricAssociation

Get the rubric association

save()  : self

Save the rubric assessment (create or update)

setApiClient()  : void

Set the API client

setCourse()  : void

Set the course context for rubric assessment operations

update()  : self

Update a rubric assessment

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

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

getEndpoint()  : string

Get the API endpoint for this resource Note: RubricAssessment is a nested resource under RubricAssociation

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

getResourceEndpoint()  : string

Get the resource endpoint

getResourceIdentifier()  : string

Get the resource identifier for API endpoints

populate()  : void

Populate the object with new data

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

Convert the object to an array