Documentation

Assignment extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Assignments

Canvas LMS Assignments API

// Set course context (required for all operations)
$course = Course::find(123);
Assignment::setCourse($course);

// Create a new assignment
$assignmentData = [
    'name' => 'Homework Assignment 1',
    'description' => 'Complete exercises 1-10',
    'points_possible' => 100,
    'due_at' => '2024-12-31T23:59:59Z'
];
$assignment = Assignment::create($assignmentData);

// Find an assignment by ID
$assignment = Assignment::find(456);

// List all assignments for the course
$assignments = Assignment::fetchAll();

// Get paginated assignments
$paginatedAssignments = Assignment::fetchAllPaginated();
$paginationResult = Assignment::fetchPage();

// Update an assignment
$updatedAssignment = Assignment::update(456, ['points_possible' => 150]);

// Update using DTO
$updateDto = new UpdateAssignmentDTO(['name' => 'Updated Assignment Name']);
$updatedAssignment = Assignment::update(456, $updateDto);

// Update using instance method
$assignment = Assignment::find(456);
$assignment->setPointsPossible(125);
$success = $assignment->save();

// Delete an assignment
$assignment = Assignment::find(456);
$success = $assignment->delete();

// Duplicate an assignment
$duplicatedAssignment = Assignment::duplicate(456);

Table of Contents

Properties

$allDates  : array<string, mixed>|null

All date variations for the assignment

$allowedAttempts  : int|null

Maximum number of submission attempts allowed

$allowedExtensions  : array<string|int, string>|null

Allowed file extensions for submissions

$anonymousGrading  : bool|null

Whether grading is anonymous

$assignmentGroupId  : int|null

Assignment group ID

$courseId  : int|null

Course ID this assignment belongs to

$createdAt  : string|null

Assignment creation timestamp

$description  : string|null

Assignment description (HTML)

$dueAt  : string|null

Assignment due date

$gradingType  : string|null

Grading type (points, percent, pass_fail, etc.)

$groupCategoryId  : int|null

Group category ID for group assignments

$hasOverrides  : bool|null

Whether the assignment has date overrides

$htmlUrl  : string|null

HTML URL to the assignment

$id  : int|null

Assignment unique identifier

$lockAt  : string|null

Date when assignment becomes locked

$lockedForUser  : bool|null

Whether assignment is locked for the current user

$moderatedGrading  : bool|null

Whether moderated grading is enabled

$name  : string|null

Assignment name

$onlyVisibleToOverrides  : bool|null

Whether assignment is only visible to users with overrides

$peerReviews  : bool|null

Whether peer reviews are enabled

$pointsPossible  : float|null

Maximum points possible for this assignment

$position  : int|null

Assignment position in the group

$published  : bool|null

Whether the assignment is published

$submissionTypes  : array<string|int, string>|null

Allowed submission types

$unlockAt  : string|null

Date when assignment becomes available

$updatedAt  : string|null

Assignment last update timestamp

$workflowState  : string|null

Assignment workflow state (published, unpublished, etc.)

$apiClient  : HttpClientInterface

$course  : Course

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Create a new Assignment instance

checkCourse()  : bool

Check if course context is set

create()  : self

Create a new assignment

delete()  : bool

Delete the assignment

duplicate()  : self

Duplicate an assignment

fetchAll()  : array<string|int, Assignment>

Fetch all assignments for the course

fetchAllPages()  : array<string|int, Assignment>

Fetch all pages of assignments

fetchAllPaginated()  : PaginatedResponse

Fetch all assignments with pagination support

fetchPage()  : PaginationResult

Fetch a single page of assignments

find()  : self

Find a single assignment by ID

getAllDates()  : array<string, mixed>|null

Get all dates

getAllowedAttempts()  : int|null

Get allowed attempts

getAllowedExtensions()  : array<string|int, string>|null

Get allowed extensions

getAnonymousGrading()  : bool|null

Get anonymous grading status

getAssignmentGroupId()  : int|null

Get assignment group ID

getCourseId()  : int|null

Get course ID

getCreatedAt()  : string|null

Get created at timestamp

getDescription()  : string|null

Get assignment description

getDueAt()  : string|null

Get due date

getGradingType()  : string|null

Get grading type

getGroupCategoryId()  : int|null

Get group category ID

getHasOverrides()  : bool|null

Get has overrides status

getHtmlUrl()  : string|null

Get HTML URL

getId()  : int|null

Get assignment ID

getLockAt()  : string|null

Get lock date

getLockedForUser()  : bool|null

Get locked for user status

getModeratedGrading()  : bool|null

Get moderated grading status

getName()  : string|null

Get assignment name

getOnlyVisibleToOverrides()  : bool|null

Get only visible to overrides status

getPeerReviews()  : bool|null

Get peer reviews status

getPointsPossible()  : float|null

Get points possible

getPosition()  : int|null

Get assignment position

getPublished()  : bool|null

Get published status

getSubmissionTypes()  : array<string|int, string>|null

Get submission types

getUnlockAt()  : string|null

Get unlock date

getUpdatedAt()  : string|null

Get updated at timestamp

getWorkflowState()  : string|null

Get workflow state

save()  : bool

Save the current assignment (create or update)

setAllDates()  : void

Set all dates

setAllowedAttempts()  : void

Set allowed attempts

setAllowedExtensions()  : void

Set allowed extensions

setAnonymousGrading()  : void

Set anonymous grading status

setApiClient()  : void

Set the API client

setAssignmentGroupId()  : void

Set assignment group ID

setCourse()  : void

Set the course context for assignment operations

setCourseId()  : void

Set course ID

setCreatedAt()  : void

Set created at timestamp

setDescription()  : void

Set assignment description

setDueAt()  : void

Set due date

setGradingType()  : void

Set grading type

setGroupCategoryId()  : void

Set group category ID

setHasOverrides()  : void

Set has overrides status

setHtmlUrl()  : void

Set HTML URL

setId()  : void

Set assignment ID

setLockAt()  : void

Set lock date

setLockedForUser()  : void

Set locked for user status

setModeratedGrading()  : void

Set moderated grading status

setName()  : void

Set assignment name

setOnlyVisibleToOverrides()  : void

Set only visible to overrides status

setPeerReviews()  : void

Set peer reviews status

setPointsPossible()  : void

Set points possible

setPosition()  : void

Set assignment position

setPublished()  : void

Set published status

setSubmissionTypes()  : void

Set submission types

setUnlockAt()  : void

Set unlock date

setUpdatedAt()  : void

Set updated at timestamp

setWorkflowState()  : void

Set workflow state

toArray()  : array<string, mixed>

Convert assignment to array

toDtoArray()  : array<string, mixed>

Convert assignment to DTO array format

update()  : self

Update an assignment

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

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

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

Helper method to fetch all pages and convert to model instances

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

populate()  : void

Populate the object with new data