Documentation

ApiInterface

Table of Contents

Methods

all()  : array<string|int, static>
Get all records from all pages
find()  : static
Find a single record by ID
get()  : array<string|int, static>
Get first page of records

Methods

all()

Get all records from all pages

public static all([array<string, mixed> $params = [] ]) : array<string|int, static>
Parameters
$params : array<string, mixed> = []
Tags
throws
CanvasApiException
Return values
array<string|int, static>

find()

Find a single record by ID

public static find(int $id[, array<string, mixed> $params = [] ]) : static
Parameters
$id : int
$params : array<string, mixed> = []

Optional query parameters

Tags
throws
CanvasApiException
Return values
static

get()

Get first page of records

public static get([array<string, mixed> $params = [] ]) : array<string|int, static>
Parameters
$params : array<string, mixed> = []
Tags
throws
CanvasApiException
Return values
array<string|int, static>

        
On this page

Search results