Documentation

Tab extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Tabs

Canvas LMS Tabs API

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

// List all tabs for the course
$tabs = Tab::get();

// Get paginated tabs
$paginationResult = Tab::paginate();

// Update a tab
$updatedTab = Tab::update('assignments', ['position' => 3, 'hidden' => false]);

// Update using DTO
$updateDto = new UpdateTabDTO(position: 2, hidden: true);
$updatedTab = Tab::update('home', $updateDto);

// Update using instance method
$tab = Tab::get()[0];
$tab->position = 5;
$tab->hidden = true;
$success = $tab->save();

Table of Contents

Properties

$hidden  : bool|null

Whether the tab is hidden from students

$htmlUrl  : string|null

HTML URL of the tab

$id  : string|null

Unique identifier for the tab

$label  : string|null

Display label for the tab

$position  : int|null

Position of the tab in the navigation (1-based)

$type  : string|null

Type of tab (internal or external)

$visibility  : string|null

Visibility level of the tab (public, members, admins, none)

$course  : Course|null

$methodAliases  : array<string, array<string|int, string>>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Create a new Tab instance

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

Get all pages of results

checkCourse()  : bool

Check if course context is set

find()  : static

Find a single tab by ID

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

Get first page of results

getHidden()  : bool|null

Get hidden status

getHtmlUrl()  : string|null

Get HTML URL

getId()  : string|null

Get ID

getLabel()  : string|null

Get label

getPosition()  : int|null

Get position

getType()  : string|null

Get type

getVisibility()  : string|null

Get visibility

overrideApiClient()  : void

Set an API client for this class only, leaving other resources on the shared default.

paginate()  : PaginationResult

Get paginated results with metadata

resetApiClients()  : void

Clear the shared default client and all per-class overrides.

save()  : self

Save the current tab (update only)

setApiClient()  : void

Set the shared default API client used by ALL resource classes.

setCourse()  : void

Set the course context for tab operations

setHidden()  : void

Set hidden status

setHtmlUrl()  : void

Set HTML URL

setId()  : void

Set ID

setLabel()  : void

Set label

setPosition()  : void

Set position

setType()  : void

Set type

setVisibility()  : void

Set visibility

stream()  : Generator<int, static>

Stream all items across all pages one at a time.

toArray()  : array<string, mixed>

Convert tab to array

toDtoArray()  : array<string, mixed>

Convert tab to DTO array format

update()  : self

Update a tab

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

getAliasMap()  : array<string, string>

Build a flat alias-to-method lookup from $methodAliases.

getApiClient()  : HttpClientInterface

Get the API client, initializing if necessary

getContextCourseId()  : int

Get the Course ID from context, ensuring course is set

getCourse()  : Course

Get the Course instance, ensuring it is set

getEndpoint()  : string

Get the API endpoint for this resource

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

hydrate()  : void

Assign API response data to properties with type coercion.

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

Parse JSON response from API safely handling StreamInterface

populate()  : void

Populate the object with new data

validateContext()  : void

Validate a context type path segment against an allowlist.

foreach (User::stream(['per_page' => 100]) as $user) {
    processUser($user);
}