PHP Класс Newscoop\TemplateList\PaginatedBaseList

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

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

Свойство Тип Описание
$cacheService Newscoop\Services\CacheService
$pageNumber integer
$pageParameterName string
$paginatorService Newscoop\Services\TemplatesService

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

Метод Описание
__construct ( Criteria $criteria, TemplatesService $paginatorService, CacheService $cacheService )
getPageNumber ( ) : mixed Gets the value of pageNumber.
getPageParameterName ( ) : mixed Gets the value of pageParameterName.
getPaginator ( ) : Knp\Component\Pager\Paginator Get Paginator instance from PaginatorService
setPageNumber ( mixed $pageNumber = 1 ) : self Sets the value of pageNumber.
setPageParameterName ( mixed $pageParameterName ) : self Sets the value of pageParameterName.

Защищенные методы

Метод Описание
paginateList ( mixed $target, integer $pageNumber, integer $maxResults, ListResult $list = null, boolean $useCache = true ) : ListResult Paginate target and fill list items

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

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

public __construct ( Criteria $criteria, TemplatesService $paginatorService, CacheService $cacheService )
$criteria Newscoop\Criteria
$paginatorService Newscoop\Services\TemplatesService
$cacheService Newscoop\Services\CacheService

getPageNumber() публичный метод

Gets the value of pageNumber.
public getPageNumber ( ) : mixed
Результат mixed

getPageParameterName() публичный метод

Gets the value of pageParameterName.
public getPageParameterName ( ) : mixed
Результат mixed

getPaginator() публичный метод

Get Paginator instance from PaginatorService
public getPaginator ( ) : Knp\Component\Pager\Paginator
Результат Knp\Component\Pager\Paginator

paginateList() защищенный метод

Paginate target and fill list items
protected paginateList ( mixed $target, integer $pageNumber, integer $maxResults, ListResult $list = null, boolean $useCache = true ) : ListResult
$target mixed
$pageNumber integer
$maxResults integer
$list Newscoop\ListResult
$useCache boolean
Результат Newscoop\ListResult

setPageNumber() публичный метод

Sets the value of pageNumber.
public setPageNumber ( mixed $pageNumber = 1 ) : self
$pageNumber mixed the page number
Результат self

setPageParameterName() публичный метод

Sets the value of pageParameterName.
public setPageParameterName ( mixed $pageParameterName ) : self
$pageParameterName mixed the page parameter name
Результат self

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

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

protected CacheService,Newscoop\Services $cacheService
Результат Newscoop\Services\CacheService

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

protected int $pageNumber
Результат integer

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

protected string $pageParameterName
Результат string

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

protected TemplatesService,Newscoop\Services $paginatorService
Результат Newscoop\Services\TemplatesService