PHP Класс Newscoop\Gimme\PaginatorService

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$pagination Pagination Pagination object with parsed data from request.
$paginationData array Extra data injected to response when result have more items than requested.
$paginator Knp\Component\Pager\Paginator Paginator class
$partialResponse PartialResponse PartialResponse object with parsed data from request.
$route string Used route name
$routeParams array Used route params
$router Symfony\Bundle\FrameworkBundle\Routing\Router Router class

Открытые методы

Метод Описание
__construct ( Knp\Component\Pager\Paginator $paginator, Router $router ) Construct Paginator service object
getPagination ( ) : Pagination Get Pagination object
getPartialResponse ( ) : PartialResponse Get PartialResponse object
paginate ( mixed $data, array $params = [] ) : array Paginate data
setPagination ( Pagination $pagination ) Set Pagination object
setPaginationData ( array $paginationData ) Set pagination data from paginator
setPartialResponse ( PartialResponse $partialResponse ) Set PartialResponse object
setUsedRoute ( string $route ) Set used route
setUsedRouteParams ( array $params = [] ) Set parameters required by route generator for used route

Приватные методы

Метод Описание
getPaginationLinks ( array $paginationData ) : array Generate links for pagination object

Описание методов

__construct() публичный Метод

Construct Paginator service object
public __construct ( Knp\Component\Pager\Paginator $paginator, Router $router )
$paginator Knp\Component\Pager\Paginator Paginator object
$router Symfony\Bundle\FrameworkBundle\Routing\Router Router object

getPagination() публичный Метод

Get Pagination object
public getPagination ( ) : Pagination
Результат Pagination Pagination object

getPartialResponse() публичный Метод

Get PartialResponse object
public getPartialResponse ( ) : PartialResponse
Результат PartialResponse PartialResponse object

paginate() публичный Метод

Paginate data
public paginate ( mixed $data, array $params = [] ) : array
$data mixed Data to paginate
$params array Parameters for Paginator
Результат array Paginated data

setPagination() публичный Метод

Set Pagination object
public setPagination ( Pagination $pagination )
$pagination Pagination Pagination object

setPaginationData() публичный Метод

Set pagination data from paginator
public setPaginationData ( array $paginationData )
$paginationData array array with calculated pagination data

setPartialResponse() публичный Метод

Set PartialResponse object
public setPartialResponse ( PartialResponse $partialResponse )
$partialResponse PartialResponse PartialResponse object

setUsedRoute() публичный Метод

Set used route
public setUsedRoute ( string $route )
$route string Used route in request

setUsedRouteParams() публичный Метод

Set parameters required by route generator for used route
public setUsedRouteParams ( array $params = [] )
$params array Route parameters

Описание свойств

$pagination защищенное свойство

Pagination object with parsed data from request.
protected Pagination,Newscoop\Gimme $pagination
Результат Pagination

$paginationData защищенное свойство

Extra data injected to response when result have more items than requested.
protected array $paginationData
Результат array

$paginator защищенное свойство

Paginator class
protected Paginator,Knp\Component\Pager $paginator
Результат Knp\Component\Pager\Paginator

$partialResponse защищенное свойство

PartialResponse object with parsed data from request.
protected PartialResponse,Newscoop\Gimme $partialResponse
Результат PartialResponse

$route защищенное свойство

Used route name
protected string $route
Результат string

$routeParams защищенное свойство

Used route params
protected array $routeParams
Результат array

$router защищенное свойство

Router class
protected Router,Symfony\Bundle\FrameworkBundle\Routing $router
Результат Symfony\Bundle\FrameworkBundle\Routing\Router