Documentation

ModuleItem extends AbstractBaseApi

in package

• Application

Module Item Class

$course = Course::find(1);
$module = Module::find(1);
ModuleItem::setCourse($course);
ModuleItem::setModule($module);

// Get all module items
$items = ModuleItem::fetchAll();

// Create new assignment module item
$item = ModuleItem::create([
    'title' => 'Assignment 1',
    'type' => 'Assignment',
    'content_id' => 123,
    'position' => 1
]);

// Create page module item
$item = ModuleItem::create([
    'title' => 'Course Introduction',
    'type' => 'Page',
    'page_url' => 'course-introduction'
]);

// Create external tool module item
$item = ModuleItem::create([
    'title' => 'External Learning Tool',
    'type' => 'ExternalTool',
    'external_url' => 'https://example.com/tool',
    'new_tab' => true,
    'iframe' => ['width' => 800, 'height' => 600]
]);

// Update module item
$item->setTitle('Updated Assignment');
$item->save();

// Mark item as read (fulfills must_view requirement)
$item->markAsRead();

// Mark item as done (manual completion)
$item->markAsDone();

// Delete module item
$item->delete();

Table of Contents

Constants

VALID_COMPLETION_TYPES  = [ 'must_view', // All types 'must_contribute', // Assignment, Discussion, Page 'must_submit', // Assignment, Quiz 'min_score', // Assignment, Quiz 'must_mark_done', ]

Canvas API supported completion requirement types

VALID_TYPES  = ['File', 'Page', 'Discussion', 'Assignment', 'Quiz', 'SubHeader', 'ExternalUrl', 'ExternalTool']

Canvas API supported module item types

Properties

$completionRequirement  : array<string, mixed>|null

Completion requirement structure.

$contentDetails  : array<string, mixed>|null

Type-specific details.

$contentId  : int|null

ID of associated content object (not required for ExternalUrl, Page, SubHeader).

$externalUrl  : string|null

For ExternalUrl/ExternalTool types.

$htmlUrl  : string

Canvas URL for this item.

$id  : int

Unique identifier for the module item.

$iframe  : array<string, int>|null

External tool iframe configuration (when type = ExternalTool).

$indent  : int

0-based hierarchy indent level (0-5 allowed).

$moduleId  : int

ID of the module containing this item.

$newTab  : bool|null

Whether external tool opens in new tab.

$pageUrl  : string|null

Only for 'Page' type - wiki page URL slug.

$position  : int

1-based position in module.

$published  : bool|null

Visibility flag (optional, requires permissions).

$title  : string

Item title.

$type  : string

Content type (File, Page, Discussion, Assignment, Quiz, SubHeader, ExternalUrl, ExternalTool).

$url  : string|null

Optional API endpoint URL.

$apiClient  : HttpClientInterface

$course  : Course

Course context (required)

$methodAliases  : array<string|int, mixed>

Define method aliases

$module  : Module

Module context (required)

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

BaseApi constructor.

checkCourse()  : bool

Check if course exists and has id

checkModule()  : bool

Check if module exists and has id

create()  : self

Create a new module item

delete()  : bool

Delete a module item

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

Get all module items for a module.

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

Fetch all module items from all pages

fetchAllPaginated()  : PaginatedResponse

Fetch module items with pagination support

fetchPage()  : PaginationResult

Fetch module items from a specific page

find()  : self

Find a module item by its ID.

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

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

getContentId()  : int|null

getExternalUrl()  : string|null

getHtmlUrl()  : string

getId()  : int

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

getIndent()  : int

getModuleId()  : int

getNewTab()  : bool|null

getPageUrl()  : string|null

getPosition()  : int

getPublished()  : bool|null

getTitle()  : string

getType()  : string

getUrl()  : string|null

markAsDone()  : bool

Mark module item as done (manual completion marking)

markAsNotDone()  : bool

Mark module item as not done (removes manual completion marking)

markAsRead()  : bool

Mark module item as read (fulfills must_view completion requirement) Cannot be used on locked or unpublished items

save()  : bool

Save the module item

setApiClient()  : void

Set the API client

setCompletionRequirement()  : void

setContentDetails()  : void

setContentId()  : void

setCourse()  : void

Set the course context

setExternalUrl()  : void

setHtmlUrl()  : void

setId()  : void

setIframe()  : void

setIndent()  : void

setModule()  : void

Set the module context

setModuleId()  : void

setNewTab()  : void

setPageUrl()  : void

setPosition()  : void

setPublished()  : void

setTitle()  : void

setType()  : void

setUrl()  : void

update()  : self

Update a module item

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