Documentation

Module extends AbstractBaseApi

in package

• Application

Module Class

$course = Course::find(1); // or $course = new Course(['id' => 1]); to avoid making an API request
Module::setCourse($course);

// Get all modules for a course (first page only)
$modules = Module::fetchAll();

// Fetch modules with pagination support
$paginatedResponse = Module::fetchAllPaginated(['per_page' => 10]);
$modules = $paginatedResponse->getJsonData();
$pagination = $paginatedResponse->toPaginationResult($modules);

// Fetch a specific page of modules
$paginationResult = Module::fetchPage(['page' => 2, 'per_page' => 10]);
$modules = $paginationResult->getData();
$hasNext = $paginationResult->hasNext();

// Fetch all modules from all pages
$allModules = Module::fetchAllPages(['per_page' => 50]);

// Create a new module
$module = Module::create([
   'name' => 'Module 1',
   'position' => 1,
   'requireSequentialProgress' => true,
   'prerequisiteModuleIds' => [1, 2],
   'publishFinalGrade' => true
]);

// Update a module
$module->setName('Module 1 Updated');
$module->save();

// Update staticaly
$module = Module::update(1, [
  'name' => 'Module 1 Updated',
  'position' => 1,
  'requireSequentialProgress' => true,
  'prerequisiteModuleIds' => [1, 2],
  'publishFinalGrade' => true
]);

// Delete a module
$module = Module::find(1);
$module->delete();

Table of Contents

Properties

$completedAt  : string|null

The date the calling user completed the module (Optional).

$id  : int

The unique identifier for the module.

$items  : array<string|int, mixed>

The contents of this module, as an array of Module Items.

$itemsCount  : int

The number of items in the module.

$itemsUrl  : string

The API URL to retrieve this module's items.

$name  : string

The name of this module.

$position  : int

The position of this module in the course (1-based).

$prerequisiteModuleIds  : array<string|int, mixed>

IDs of Modules that must be completed before this one is unlocked.

$published  : bool

Whether this module is published.

$publishFinalGrade  : bool|null

If the student's final grade for the course should be published to the SIS upon completion of this module.

$requireSequentialProgress  : bool

Whether module items must be unlocked in order.

$state  : string|null

The state of this Module for the calling user: 'locked', 'unlocked', 'started', 'completed' (Optional).

$unlockAt  : string|null

The date this module will unlock (Optional).

$workflowState  : string

The state of the module: 'active', 'deleted'.

$apiClient  : HttpClientInterface

$course  : Course

Course

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

BaseApi constructor.

checkCourse()  : bool

Check if course exits and has id

create()  : self

Create a new module

delete()  : bool

Delete a module

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

Get all modules for a course.

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

Fetch all modules from all pages

fetchAllPaginated()  : PaginatedResponse

Fetch modules with pagination support

fetchPage()  : PaginationResult

Fetch modules from a specific page

find()  : self

Find a module by its ID.

getCompletedAt()  : string|null

getId()  : int

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

getItemsCount()  : int

getItemsUrl()  : string

getName()  : string

getPosition()  : int

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

getPublished()  : bool|null

getPublishFinalGrade()  : bool|null

getState()  : string|null

getUnlockAt()  : string|null

getWorkflowState()  : string

isRequireSequentialProgress()  : bool

save()  : bool

Save the module

setApiClient()  : void

Set the API client

setCompletedAt()  : void

setCourse()  : void

Set the course

setId()  : void

setItems()  : void

setItemsCount()  : void

setItemsUrl()  : void

setName()  : void

setPosition()  : void

setPrerequisiteModuleIds()  : void

setPublished()  : void

setPublishFinalGrade()  : void

setRequireSequentialProgress()  : void

setState()  : void

setUnlockAt()  : void

setWorkflowState()  : void

update()  : self

Update a module

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

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

Convert the object to an array