Documentation

AbstractBaseApi
in package

Application

implements ApiInterface

AbstractYes

Abstract base class for Canvas LMS API resources.

Provides common functionality for all API resource classes including CRUD operations, pagination support, HTTP client management, and data population from API responses. Implements the Active Record pattern for Canvas API interactions.

Interfaces

ApiInterface

Properties

$methodAliases : array<string, array<string|int, string>>: Define method aliases
$propertyTypeCache : array<class-string, array<string, string|null>>: Cached property-to-builtin-type maps, keyed by class name.

Methods

__callStatic() : mixed: Magic method to handle function aliases
__construct() : mixed: BaseApi constructor.
all() : array<string|int, static>: Get all pages of results
get() : array<string|int, static>: Get first page of results
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.
setApiClient() : void: Set the shared default API client used by ALL resource classes.
stream() : Generator<int, static>: Stream all items across all pages one at a time.
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
getEndpoint() : string: Get the API endpoint for this resource Subclasses must implement this to provide their specific endpoint
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
toDtoArray() : array<string|int, mixed>: Convert the object to an array
validateContext() : void: Validate a context type path segment against an allowlist.
getPropertyTypeMap() : array<string, string|null>: Get the builtin type name for each property of this class.

$methodAliases

Define method aliases


        protected
        static    array<string, array<string|int, string>>
    $methodAliases
     = ['get' => ['fetch', 'list'], 'all' => ['fetchAllPages', 'getAll', 'fetchAll'], 'paginate' => ['getPaginated', 'withPagination'], 'find' => ['one', 'getOne']]

$propertyTypeCache

Cached property-to-builtin-type maps, keyed by class name.


        private
        static    array<class-string, array<string, string|null>>
    $propertyTypeCache
     = []

Hydrating large result sets previously created a ReflectionClass per property per object; the map is now computed once per class.

__callStatic()

Magic method to handle function aliases


    public
            static        __callStatic(string $name, array<string|int, mixed> $arguments) : mixed

Parameters

$name : string
$arguments : array<string|int, mixed>

__construct()

BaseApi constructor.


    public
                    __construct(array<string|int, mixed> $data) : mixed

Parameters

$data : array<string|int, mixed>

all()

Get all pages of results


    public
            static        all([array<string, mixed> $params = [] ]) : array<string|int, static>

Parameters

$params : array<string, mixed> = []: Query parameters

Return values

array<string|int, static>

get()

Get first page of results


    public
            static        get([array<string, mixed> $params = [] ]) : array<string|int, static>

Parameters

$params : array<string, mixed> = []: Query parameters

Return values

array<string|int, static>

overrideApiClient()

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


    public
            static        overrideApiClient(HttpClientInterface $apiClient) : void

Parameters

$apiClient : HttpClientInterface

paginate()

Get paginated results with metadata


    public
            static        paginate([array<string, mixed> $params = [] ]) : PaginationResult

Parameters

$params : array<string, mixed> = []: Query parameters

Return values

PaginationResult

resetApiClients()

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


    public
            static        resetApiClients() : void

setApiClient()

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


    public
            static        setApiClient(HttpClientInterface $apiClient) : void

Calling this on any resource (e.g. Course::setApiClient()) replaces the client for every resource, because relationship methods cross class boundaries ($course->enrollments() calls Enrollment internally). Use overrideApiClient() to scope a client to a single class, and resetApiClients() in test teardown to avoid state leaking.

Parameters

$apiClient : HttpClientInterface

stream()

Stream all items across all pages one at a time.


    public
            static        stream([array<string|int, mixed> $params = [] ]) : Generator<int, static>

Unlike all(), only one page of raw data is held in memory at a time, making this safe for very large datasets (e.g. tens of thousands of enrollments):

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

Parameters

$params : array<string|int, mixed> = []: Query parameters for the request

Return values

Generator<int, static>

castValue()

Cast a value to the correct type


    protected
                    castValue(string $key, mixed $value) : DateTime|mixed

Parameters

$key : string
$value : mixed

Return values

DateTime|mixed

checkApiClient()

Check if the API client is set, if not, instantiate a new one


    protected
            static        checkApiClient() : void

convertPaginatedResponseToModels()

Helper method to convert paginated response data to model instances


    protected
            static        convertPaginatedResponseToModels(PaginatedResponse $paginatedResponse) : array<string|int, static>

Parameters

$paginatedResponse : PaginatedResponse

Return values

array<string|int, static>

createConfiguredHttpClient()

Create an HttpClient with configured middleware


    protected
            static        createConfiguredHttpClient() : HttpClient

Return values

HttpClient

createPaginationResult()

Helper method to create PaginationResult from paginated response


    protected
            static        createPaginationResult(PaginatedResponse $paginatedResponse) : PaginationResult

Parameters

$paginatedResponse : PaginatedResponse

Return values

PaginationResult

getAliasMap()

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


    protected
            static        getAliasMap() : array<string, string>

Return values

array<string, string>

getApiClient()

Get the API client, initializing if necessary


    protected
            static        getApiClient() : HttpClientInterface

Return values

HttpClientInterface

getEndpoint()

Get the API endpoint for this resource Subclasses must implement this to provide their specific endpoint


    protected
    abstract        static        getEndpoint() : string

Return values

string

getPaginatedResponse()

Helper method to get paginated response from API endpoint


    protected
            static        getPaginatedResponse(string $endpoint[, array<string|int, mixed> $params = [] ]) : PaginatedResponse

Parameters

$endpoint : string: The API endpoint path
$params : array<string|int, mixed> = []: Query parameters for the request

Return values

PaginatedResponse

hydrate()

Assign API response data to properties with type coercion.


    protected
                    hydrate(array<string|int, mixed> $data) : void

Shared by the constructor and populate() so objects keep the same type guarantees after save()/update() round-trips as on creation.

Parameters

$data : array<string|int, mixed>

parseJsonResponse()

Parse JSON response from API safely handling StreamInterface


    protected
            static        parseJsonResponse(ResponseInterface $response) : array<string|int, mixed>

Parameters

$response : ResponseInterface

Return values

array<string|int, mixed>

populate()

Populate the object with new data


    protected
                    populate(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

toDtoArray()

Convert the object to an array


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

Return values

array<string|int, mixed>

validateContext()

Validate a context type path segment against an allowlist.


    protected
            static        validateContext(string|null $contextType, array<int, string> $allowed) : void

Context types are interpolated into URL paths; validating against the contexts Canvas actually supports prevents crafted values from injecting extra path segments or query parameters.

Parameters

$contextType : string|null: The context type (plural, e.g. 'courses'); null is ignored
$allowed : array<int, string>: Allowed context types

getPropertyTypeMap()

Get the builtin type name for each property of this class.


    private
            static        getPropertyTypeMap() : array<string, string|null>

Return values

array<string, string|null> —

Property name => builtin type name, or null for non-builtin/untyped properties

AbstractBaseApi in package Application implements ApiInterface

Tags

Table of Contents

Interfaces

Properties

Methods

Properties

$methodAliases

$propertyTypeCache

Methods

__callStatic()

Parameters

Tags

__construct()

Parameters

all()

Parameters

Return values

get()

Parameters

Return values

overrideApiClient()

Parameters

paginate()

Parameters

Return values

resetApiClients()

setApiClient()

Parameters

stream()

Parameters

Tags

Return values

castValue()

Parameters

Tags

Return values

checkApiClient()

convertPaginatedResponseToModels()

Parameters

Return values

createConfiguredHttpClient()

Return values

createPaginationResult()

Parameters

Return values

getAliasMap()

Return values

getApiClient()

Return values

getEndpoint()

Return values

getPaginatedResponse()

Parameters

Return values

hydrate()

Parameters

parseJsonResponse()

Parameters

Return values

populate()

Parameters

Tags

toDtoArray()

Return values

validateContext()

Parameters

Tags

getPropertyTypeMap()

Return values

AbstractBaseApi
in package

Application

implements ApiInterface