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);

// Get first page of assignments (memory efficient)
$assignments = Assignment::get();
$assignments = Assignment::get(['order_by' => 'due_at']);

// Get ALL assignments from all pages (be mindful of memory)
$allAssignments = Assignment::all();

// Get paginated results with metadata (recommended)
$paginated = Assignment::paginate(['per_page' => 25]);
echo "Page {$paginated->getCurrentPage()} of {$paginated->getTotalPages()}";

// 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

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

Academic benchmark GUIDs

$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

$annotatableAttachmentId  : int|null

Annotatable attachment ID

$anonymizeStudents  : bool|null

Whether student names are anonymized

$anonymousGrading  : bool|null

Whether grading is anonymous

$anonymousInstructorAnnotations  : bool|null

Whether instructor annotations are anonymous

$anonymousPeerReviews  : bool|null

Whether peer reviews are anonymous

$anonymousSubmissions  : bool|null

Whether anonymous submissions are allowed

$assignmentGroupId  : int|null

Assignment group ID

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

Array of student IDs who can see assignment

$automaticPeerReviews  : bool|null

Whether automatic peer reviews are enabled

$canDuplicate  : bool|null

Whether assignment can be duplicated

$canSubmit  : bool|null

Whether user can submit

$courseId  : int|null

Course ID this assignment belongs to

$createdAt  : string|null

Assignment creation timestamp

$description  : string|null

Assignment description (HTML)

$discussionTopic  : array<string, mixed>|null

Associated discussion topic

$dueAt  : string|null

Assignment due date

$dueDateRequired  : bool|null

Boolean flag indicating whether assignment requires due date

$externalToolTagAttributes  : array<string, mixed>|null

External tool tag attributes

$finalGraderId  : int|null

Final grader user ID

$freezeOnCopy  : bool|null

Whether assignment is frozen on copy

$frozen  : bool|null

Whether assignment is frozen

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

Array of frozen attributes

$gradedSubmissionsExist  : bool|null

Whether assignment has graded submissions

$gradeGroupStudentsIndividually  : bool|null

Whether group students are graded individually

$graderCommentsVisibleToGraders  : bool|null

Whether grader comments are visible to graders

$graderCount  : int|null

Number of provisional graders

$gradersAnonymousToGraders  : bool|null

Whether graders are anonymous to other graders

$gradersNamesVisibleToFinalGrader  : bool|null

Whether grader names are visible to final grader

$gradingStandardId  : int|null

Grading standard ID

$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

$hasSubmittedSubmissions  : bool|null

Whether assignment has submitted submissions

$hideInGradebook  : bool|null

Whether assignment is hidden in gradebook

$htmlUrl  : string|null

HTML URL to the assignment

$id  : int|null

Assignment unique identifier

$importantDates  : bool|null

Whether assignment has important dates

$inClosedGradingPeriod  : bool|null

Whether assignment is in closed grading period

$integrationData  : array<string, mixed>|null

Third-party integration data

$integrationId  : string|null

Third-party integration ID

$intraGroupPeerReviews  : bool|null

Whether intra-group peer reviews are allowed

$isQuizAssignment  : bool|null

Whether this is a quiz assignment

$lockAt  : string|null

Date when assignment becomes locked

$lockedForUser  : bool|null

Whether assignment is locked for the current user

$lockExplanation  : string|null

Lock explanation text

$lockInfo  : array<string, mixed>|null

Lock information object

$maxNameLength  : int|null

Integer indicating maximum assignment name length

$moderatedGrading  : bool|null

Whether moderated grading is enabled

$muted  : bool|null

Whether notifications are muted (deprecated)

$name  : string|null

Assignment name

$needsGradingCount  : int|null

Number of submissions needing grading

$needsGradingCountBySection  : array<string|int, array<string, mixed>>|null

Grading count by section

$omitFromFinalGrade  : bool|null

Whether assignment is omitted from final grade

$onlyVisibleToOverrides  : bool|null

Whether assignment is only visible to users with overrides

$originalAssignmentId  : int|null

Original assignment ID if duplicated

$originalAssignmentName  : string|null

Original assignment name if duplicated

$originalCourseId  : int|null

Original course ID if duplicated

$originalLtiResourceLinkId  : int|null

Original LTI resource link ID if duplicated

$originalQuizId  : int|null

Original quiz ID if duplicated

$overrides  : array<string|int, array<string, mixed>>|null

Array of assignment override objects

$peerReviewCount  : int|null

Number of peer reviews per user

$peerReviews  : bool|null

Whether peer reviews are enabled

$peerReviewsAssignAt  : string|null

Date peer reviews are assigned

$pointsPossible  : float|null

Maximum points possible for this assignment

$position  : int|null

Assignment position in the group

$postManually  : bool|null

Whether assignment posts grades manually

$postToSis  : bool|null

Whether to post to SIS

$published  : bool|null

Whether the assignment is published

$quizId  : int|null

Associated quiz ID

$requireLockdownBrowser  : bool|null

Whether LockDown Browser is required

$rubric  : array<string, mixed>|null

Rubric criteria and ratings

$rubricSettings  : array<string, mixed>|null

Rubric settings

$scoreStatistics  : array<string, mixed>|null

Score statistics

$submission  : array<string, mixed>|null

Current user's submission

$submissionsDownloadUrl  : string|null

URL to download all submissions as a zip

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

Allowed submission types

$turnitinEnabled  : bool|null

Whether Turnitin is enabled for this assignment

$turnitinSettings  : array<string, mixed>|null

Turnitin settings object

$unlockAt  : string|null

Date when assignment becomes available

$unpublishable  : bool|null

Whether assignment can be unpublished

$updatedAt  : string|null

Assignment last update timestamp

$useRubricForGrading  : bool|null

Whether rubric is used for grading

$vericiteEnabled  : bool|null

Whether VeriCite is enabled for this assignment

$workflowState  : string|null

Assignment workflow state (published, unpublished, etc.)

$apiClient  : HttpClientInterface

$course  : Course|null

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Create a new Assignment instance

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

Get all pages of results

checkCourse()  : bool

Check if course context is set

create()  : self

Create a new assignment

delete()  : self

Delete the assignment

duplicate()  : self

Duplicate an assignment

find()  : self

Find a single assignment by ID

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

Get first page of results

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

getSubmissionCount()  : int

Get count of submissions for this assignment

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

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

Get assignment overrides

paginate()  : PaginationResult

Get paginated results with metadata

rubric()  : Rubric|null

Get rubric associated with this assignment

rubricAssociation()  : RubricAssociation|null

Get rubric association for this assignment

save()  : self

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

submissionForUser()  : Submission|null

Get submission for a specific user

submissions()  : array<string|int, Submission>

Get submissions for this assignment

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

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

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

populate()  : void

Populate the object with new data