PHP Class Newscoop\Services\ListPaginatorService

Show file Open project: sourcefabric/newscoop

Protected Properties

Property Type Description
$paginator Knp\Component\Pager\Paginator

Public Methods

Method Description
__construct ( )
getPaginator ( ) : Knp\Component\Pager\Paginator Get paginator
paginate ( mixed $target, integer $pageNumber = 1, integer $limit = 10 ) : Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination Paginate target with passed page and limit, apply default pagination remplate to renderer
setPageParameterName ( string $pageParameterName ) : self Set page partameter name
setRoute ( string $route ) : self Set used route
setRouteParams ( array $params = [] ) : self Set parameters required by route generator for used route

Method Details

__construct() public method

public __construct ( )

getPaginator() public method

Get paginator
public getPaginator ( ) : Knp\Component\Pager\Paginator
return Knp\Component\Pager\Paginator

paginate() public method

Paginate target with passed page and limit, apply default pagination remplate to renderer
public paginate ( mixed $target, integer $pageNumber = 1, integer $limit = 10 ) : Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination
$target mixed
$pageNumber integer
$limit integer
return Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination

setPageParameterName() public method

Set page partameter name
public setPageParameterName ( string $pageParameterName ) : self
$pageParameterName string
return self

setRoute() public method

Set used route
public setRoute ( string $route ) : self
$route string Used route in request
return self

setRouteParams() public method

Set parameters required by route generator for used route
public setRouteParams ( array $params = [] ) : self
$params array Route parameters
return self

Property Details

$paginator protected property

protected Paginator,Knp\Component\Pager $paginator
return Knp\Component\Pager\Paginator