CURRENT
CURRENT
Name of the current page link
An object to represent Canvas API pagination information.
As the whole point of CanvasPest is to abstract the actual API response out
of the way, concealing the mundane details of the response pagination, this
particular object is used only internally to create object-oriented access
to the API response's link
header.
__construct()
Construct a new Canvas page link object.
CanvasPageLinks can be constructed with two possible parameter lists:
__construct(string $pageUrl, string $pageName)
which expects a
non-empty string representing the URL of the API endpoint to retrieve the
page and a non-empty string representing the canonical name of the page
relative to the current page.__construct(int $pageNumber, CanvasPageLink $modelCanvasPageLink, string $pageName)
which expects a page number greater than zero, any CanvasPageLink object
relative to the current page (to be used as a model) and a non-empty string
representing the canonical name of the page relative to the current page.INVALID_CONSTRUCTOR If $pageUrl or $pageName is empty or a non-string
INVALID_CONSTRUCTOR If $pageNumber is not a number greater than zero, $modelCanvasPageLink is not an instance of CanvasPageLink or $pageName is empty or a non-string