$pages->request->checkScheme() $pages->request->checkScheme(Page $page) $pages->request->checkScheme(Page $page) | None | If the template requires a different scheme/protocol than what is here, then redirect to it. | |
$pages->request->getClosestPage() $pages->request->getClosestPage() $pages->request->getClosestPage() | Page NullPage | Get closest matching page when getPage() returns an error/NullPage | |
$pages->request->getFile() $pages->request->getFile() $pages->request->getFile() | string | Get the requested file | |
$pages->request->getLanguageName() $pages->request->getLanguageName() $pages->request->getLanguageName() | string | Get request language name | |
$pages->request->getLoginPageOrUrl() $pages->request->getLoginPageOrUrl() $pages->request->getLoginPageOrUrl($page = null) | string Page null | Get login Page object or URL to redirect to for login needed to access given $page | |
$pages->request->getPage() $pages->request->getPage() $pages->request->getPage(array $options = []) | Page NullPage | Get the requested page | |
$pages->request->getPageForUser() $pages->request->getPageForUser(Page $page, User $user) $pages->request->getPageForUser(Page $page, User $user) | Page NullPage | Update/get page for given user | |
$pages->request->getPageInfo() $pages->request->getPageInfo() $pages->request->getPageInfo() | array | Get array of page info (as provided by PagePathFinder) | |
$pages->request->getPageNum() $pages->request->getPageNum() $pages->request->getPageNum() | null int | Get the requested pagination number | |
$pages->request->getPageNumPrefix() $pages->request->getPageNumPrefix() $pages->request->getPageNumPrefix() | null string | Get the requested pagination number prefix | |
$pages->request->getRedirectType() $pages->request->getRedirectType() $pages->request->getRedirectType() | int | Get the redirect type (0, 301, 302, 307, 308) | |
$pages->request->getRedirectUrl() $pages->request->getRedirectUrl() $pages->request->getRedirectUrl() | string | Get the redirect URL | |
$pages->request->getRequestFile() $pages->request->getRequestFile() $pages->request->getRequestFile() | string | Get the requested file (alias of getFile method) | |
$pages->request->getRequestPage() $pages->request->getRequestPage() $pages->request->getRequestPage() | NullPage Page | Get page that was requested | |
$pages->request->getRequestPath() $pages->request->getRequestPath() $pages->request->getRequestPath() | string | Get request path | |
$pages->request->getResponseCode() $pages->request->getResponseCode() $pages->request->getResponseCode() | int | Get response http code for this request | |
$pages->request->getResponseCodeName() $pages->request->getResponseCodeName() $pages->request->getResponseCodeName() | string | Get response type name for this request | |
$pages->request->getResponseCodeNames() $pages->request->getResponseCodeNames() $pages->request->getResponseCodeNames() | array | Get all possible response code names indexed by http response code | |
$pages->request->getResponseError() $pages->request->getResponseError() $pages->request->getResponseError() | string | Get message about response only if response was an error, blank otherwise | |
$pages->request->getResponseMessage() $pages->request->getResponseMessage() $pages->request->getResponseMessage() | string | Get message string about response | |
$pages->request->setPage() $pages->request->setPage($page) $pages->request->setPage($page) | Page NullPage null | Set current request page | |
$pages->request->setRedirectPath() $pages->request->setRedirectPath(string $redirectPath) $pages->request->setRedirectPath(string $redirectPath, int $type = 301) | None | Set the redirect path | |
$pages->request->setRedirectUrl() $pages->request->setRedirectUrl(string $redirectUrl) $pages->request->setRedirectUrl(string $redirectUrl, int $type = 301) | None | Set the redirect URL | |
$pages->request->setRequestPath() $pages->request->setRequestPath(string $requestPath) $pages->request->setRequestPath(string $requestPath) | None | Set request path | |
$pages->request->setResponseMessage() $pages->request->setResponseMessage(string $message) $pages->request->setResponseMessage(string $message, bool $append = false) | None | Set response message | |