Documentation

Enrollment extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Enrollments

Canvas LMS Enrollment API Class

Tags

example

Basic relationship access

// Set course context for enrollment operations
$course = Course::find(123);
Enrollment::setCourse($course);

// Find and work with an enrollment
$enrollment = Enrollment::find(456);

// Access related objects using explicit methods
$user = $enrollment->user();      // Returns User object
$course = $enrollment->course();  // Returns Course object

echo $user->getName();
echo $course->getName();

example

Working with enrollment collections

// Get enrollments from course perspective
$course = Course::find(123);
$enrollments = $course->enrollments();

// Get enrollments from user perspective
$user = User::find(456);
$enrollments = $user->enrollments();

foreach ($enrollments as $enrollment) {
    echo $enrollment->getTypeName() . ': ' . $enrollment->getStateName();
}

example

Pagination for large datasets (IMPORTANT for large institutions)

// ⚠️ CAUTION: Universities can have MILLIONS of enrollments!

// ✅ GOOD: Process in batches
$page = 1;
do {
    $batch = Enrollment::paginate(['page' => $page++, 'per_page' => 500]);
    foreach ($batch->getData() as $enrollment) {
        // Process enrollment...
    }
} while ($batch->hasNextPage());

// ❌ DANGEROUS: Could crash with memory exhaustion
// $allEnrollments = Enrollment::all(); // DON'T DO THIS IN PRODUCTION!

// ✅ GOOD: Get just what you need
$activeEnrollments = Enrollment::get(['state' => ['active'], 'per_page' => 100]);

Table of Contents

Constants

NOTIFY_FALSE  = false

NOTIFY_TRUE  = true

STATE_ACTIVE  = 'active'

STATE_COMPLETED  = 'completed'

STATE_CREATION_PENDING  = 'creation_pending'

STATE_DELETED  = 'deleted'

STATE_INACTIVE  = 'inactive'

STATE_INVITED  = 'invited'

STATE_REJECTED  = 'rejected'

TYPE_DESIGNER  = 'DesignerEnrollment'

TYPE_OBSERVER  = 'ObserverEnrollment'

TYPE_STUDENT  = 'StudentEnrollment'

TYPE_TA  = 'TaEnrollment'

TYPE_TEACHER  = 'TeacherEnrollment'

Properties

$canBeRemoved  : bool|null

$courseId  : int|null

$createdAt  : string|null

$currentGrade  : string|null

$currentPoints  : float|null

$currentScore  : float|null

$endAt  : string|null

$enrollmentState  : string|null

$enrollmentTermId  : int|null

$finalGrade  : string|null

$finalScore  : float|null

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

$gradingPeriodId  : int|null

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

$id  : int|null

$lastActivityAt  : string|null

$limitPrivilegesToCourseSection  : bool|null

$locked  : bool|null

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

$role  : string|null

$roleId  : int|null

$rootAccountId  : int|null

$sectionId  : int|null

$sisAccountId  : string|null

$sisCourseId  : string|null

$sisSectionId  : string|null

$sisUserId  : string|null

$startAt  : string|null

$totalActivityTime  : int|null

$type  : string|null

$unpostedCurrentGrade  : string|null

$unpostedCurrentPoints  : float|null

$unpostedCurrentScore  : float|null

$unpostedFinalGrade  : string|null

$unpostedFinalScore  : float|null

$updatedAt  : string|null

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

$userId  : int|null

$uuid  : string|null

$apiClient  : HttpClientInterface

$course  : Course|null

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

BaseApi constructor.

accept()  : self

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

Get all pages of results

canBeRemoved()  : bool|null

checkCourse()  : bool

Check if course context is set and valid

course()  : Course|null

Get the associated Course object (relationship method alias)

create()  : self

delete()  : self

Delete the current enrollment

fetchAllBySection()  : array<string|int, self>

fetchAllByUser()  : array<string|int, self>

find()  : self

Find a single record by ID

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

Get first page of results

getCourseId()  : int|null

getCreatedAt()  : string|null

getCurrentGrade()  : string|null

getCurrentPoints()  : float|null

getCurrentScore()  : float|null

getEndAt()  : string|null

getEnrollmentState()  : string|null

getEnrollmentTermId()  : int|null

getFinalGrade()  : string|null

getFinalScore()  : float|null

getGrades()  : array<string|int, mixed>|null

getGradingPeriodId()  : int|null

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

getId()  : int|null

getLastActivityAt()  : string|null

getObservedUsers()  : array<string|int, mixed>|null

getRole()  : string|null

getRoleId()  : int|null

getRootAccountId()  : int|null

getSectionId()  : int|null

getSisAccountId()  : string|null

getSisCourseId()  : string|null

getSisSectionId()  : string|null

getSisUserId()  : string|null

getStartAt()  : string|null

getStateName()  : string

Get a human-readable enrollment state name

getTotalActivityTime()  : int|null

getType()  : string|null

getTypeName()  : string

Get a human-readable enrollment type name

getUnpostedCurrentGrade()  : string|null

getUnpostedCurrentPoints()  : float|null

getUnpostedCurrentScore()  : float|null

getUnpostedFinalGrade()  : string|null

getUnpostedFinalScore()  : float|null

getUpdatedAt()  : string|null

getUserData()  : array<string|int, mixed>|null

Get the user data array (raw Canvas API data)

getUserId()  : int|null

getUuid()  : string|null

isActive()  : bool

Check if this enrollment is active

isCompleted()  : bool

Check if this enrollment is completed

isDesigner()  : bool

Check if this enrollment is for a designer

isInactive()  : bool

Check if this enrollment is inactive

isLimitPrivilegesToCourseSection()  : bool|null

isLocked()  : bool|null

isObserver()  : bool

Check if this enrollment is for an observer

isPending()  : bool

Check if this enrollment is pending (invited)

isStudent()  : bool

Check if this enrollment is for a student

isTa()  : bool

Check if this enrollment is for a TA

isTeacher()  : bool

Check if this enrollment is for a teacher

paginate()  : PaginationResult

Get paginated results with metadata

reactivate()  : self

reject()  : self

save()  : self

Save the current enrollment (create or update)

section()  : Section|null

Get the section for this enrollment

setApiClient()  : void

Set the API client

setCourse()  : void

Set the course context for enrollment operations

setEndAt()  : void

setEnrollmentState()  : void

setLimitPrivilegesToCourseSection()  : void

setRoleId()  : void

setSectionId()  : void

setSisUserId()  : void

setStartAt()  : void

setType()  : void

setUserId()  : void

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

update()  : self

user()  : User|null

Get the associated User object (relationship method alias)

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

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

Convert the object to an array

validateEnrollmentState()  : bool

Validate enrollment state

validateEnrollmentType()  : bool

Validate enrollment type