Snaju Inception Docs

DefaultPaginator
in package

Table of Contents

$baseUrl  : string
$defaultPageLimit  : int
$defaultPageNum  : int
$modelUrlPath  : string
$page  : int
$paginator  : Paginator
$query  : QueryBuilder
$recordsPerPage  : int
$totalRecords  : int
$usesCursor  : bool
__construct()  : mixed
createMetaData()  : array<string|int, mixed>
createResponse()  : array<string|int, mixed>
getBaseRecordUrl()  : string
getBaseUrl()  : string
getModelUrlPath()  : string
getPageLimitFromRequest()  : int
getPageNumFromRequest()  : int
getPaginator()  : Paginator
getRecords()  : array<string|int, mixed>
setBaseUrl()  : void
setModelUrlPath()  : void
setPaginator()  : mixed

Properties

Methods

__construct()

public __construct(QueryBuilder $query[, int $recordsPerPage = 100 ]) : mixed
Parameters
$query : QueryBuilder
$recordsPerPage : int = 100
Return values
mixed —

createMetaData()

public createMetaData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

createResponse()

public createResponse([bool $includeMetaData = true ]) : array<string|int, mixed>
Parameters
$includeMetaData : bool = true
Return values
array<string|int, mixed> —

getBaseRecordUrl()

public getBaseRecordUrl() : string
Return values
string —

getModelUrlPath()

public getModelUrlPath() : string
Return values
string —

getPaginator()

public getPaginator() : Paginator
Return values
Paginator —

getRecords()

public getRecords() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setBaseUrl()

public setBaseUrl(string $baseUrl) : void
Parameters
$baseUrl : string
Return values
void —

setModelUrlPath()

public setModelUrlPath(string $modelUrlPath) : void
Parameters
$modelUrlPath : string
Return values
void —

Search results