Documentation

RubricAssociation extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Rubrics

RubricAssociation Class

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

// Creating a rubric association (using array)
$association = RubricAssociation::create([
    'rubricId' => 123,
    'associationId' => 456,
    'associationType' => 'Assignment',
    'useForGrading' => true
]);

// Creating using DTO (still supported)
$dto = new CreateRubricAssociationDTO();
$dto->rubricId = 123;
$dto->associationId = 456;
$dto->associationType = 'Assignment';
$dto->useForGrading = true;
$association = RubricAssociation::create($dto);

// Updating an association (using array)
$association = RubricAssociation::update(111, [
    'useForGrading' => false
]);

// Updating using DTO (still supported)
$updateDto = new UpdateRubricAssociationDTO();
$updateDto->useForGrading = false;
$association = RubricAssociation::update(111, $updateDto);

Table of Contents

Properties

$associationId  : int|null

The ID of the object this association links to

$associationType  : string|null

The type of object this association links to

$bookmarked  : bool|null

Whether or not the rubric is bookmarked

$contextId  : int|null

The context ID owning the association

$contextType  : string|null

The context type owning the association

$createdAt  : string|null

Created timestamp

$hideOutcomeResults  : bool|null

Whether or not outcome results are hidden

$hidePoints  : bool|null

Whether or not points are hidden

$hideScoreTotal  : bool|null

Whether or not the score total is displayed within the rubric

$id  : int|null

The ID of the association

$purpose  : string|null

Purpose of the association (grading or bookmark)

$rubricId  : int|null

The ID of the rubric

$summaryData  : array<string, mixed>|null

Summary data for the association

$title  : string|null

The title of the object this rubric is associated with

$updatedAt  : string|null

Updated timestamp

$useForGrading  : bool|null

Whether or not the associated rubric is used for grade calculation

$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

BaseApi constructor.

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

Get all pages of results

create()  : self

Create a new rubric association

delete()  : self

Delete a rubric association

find()  : self

Find a rubric association by ID

get()  : array<int, self>

Fetch all rubric associations

paginate()  : PaginationResult

Get paginated results with metadata

rubric()  : Rubric

Get the associated rubric

save()  : self

Save the rubric association (create or update)

setApiClient()  : void

Set the API client

setCourse()  : void

Set the course context for rubric association operations

update()  : self

Update a rubric association

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: RubricAssociation is a nested resource under Rubric

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