PHP Trait WoohooLabs\Yin\JsonApi\Schema\Pagination\OffsetBasedPaginationLinkProviderTrait

Exibir arquivo Open project: woohoolabs/yin

Public Methods

Method	Description
getFirstLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
getLastLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
getNextLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
getPrevLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
getSelfLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null

Protected Methods

Method	Description
appendQueryStringToUrl ( string $url, string $queryString ) : string
createPaginatedLink ( string $url, integer $page, integer $size ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
getLimit ( ) : integer
getOffset ( ) : integer
getTotalItems ( ) : integer

Method Details

appendQueryStringToUrl() protected method

protected appendQueryStringToUrl ( string $url, string $queryString ) : string
$url	string
$queryString	string
return	string

createPaginatedLink() protected method

protected createPaginatedLink ( string $url, integer $page, integer $size ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
$url	string
$page	integer
$size	integer
return	WoohooLabs\Yin\JsonApi\Schema\Link \| null

getFirstLink() public method

public getFirstLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
$url	string
return	WoohooLabs\Yin\JsonApi\Schema\Link \| null

getLastLink() public method

public getLastLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
$url	string
return	WoohooLabs\Yin\JsonApi\Schema\Link \| null

getLimit() abstract protected method

abstract protected getLimit ( ) : integer
return	integer

getNextLink() public method

public getNextLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
$url	string
return	WoohooLabs\Yin\JsonApi\Schema\Link \| null

getOffset() abstract protected method

abstract protected getOffset ( ) : integer
return	integer

getPrevLink() public method

public getPrevLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
$url	string
return	WoohooLabs\Yin\JsonApi\Schema\Link \| null

getSelfLink() public method

public getSelfLink ( string $url ) : WoohooLabs\Yin\JsonApi\Schema\Link \| null
$url	string
return	WoohooLabs\Yin\JsonApi\Schema\Link \| null

getTotalItems() abstract protected method

abstract protected getTotalItems ( ) : integer
return	integer