PHP 클래스 Newscoop\Gimme\PaginatorService

파일 보기 프로젝트 열기: sourcefabric/newscoop 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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