Версия: 6.x
burger close
Класс Control
Граф наследования:Control:
AbstractHtml ElementInterface

Подробное описание

Класс управления элементом пагинации

Открытые члены

 __construct ($options=[])
 
 setAutoFill ($autofill)
 
 setPaginator (Element $paginator)
 
 getPaginator ()
 
 addHiddenFields (array $hidden_fields)
 
 getPage ()
 
 getPageSize ()
 
 fill ()
 
 saveGetParams ()
 
 getView ($local_options=[])
 
- Открытые члены унаследованные от AbstractHtml
 __construct (array $options=[])
 
 setOptions (array $options)
 
 setOption ($key, $value)
 
 getOption ($key, $default=null)
 
- Открытые члены унаследованные от ElementInterface
 getView ()
 

Поля данных

 $pagesize_var = 'perpage'
 
 $page_var = 'p'
 
 $action
 
 $element
 
 $auto_fill = true
 
 $hidden_fields = []
 
- Поля данных унаследованные от AbstractHtml
 $options = []
 
 $option_prefixes = ['set', 'add']
 

Дополнительные унаследованные члены

- Защищенные данные унаследованные от AbstractHtml
 $url
 

Конструктор(ы)

__construct (   $options = [])

Control constructor.

Аргументы
array$options
Исключения
Exception

Методы

addHiddenFields ( array  $hidden_fields)

Добавляет параметры, которые будут добавлены в GET запрос, вместе с переключением страницы

Аргументы
array$hidden_fields
Возвращает
Control
fill ( )

Заполняет пагинатор значениями из GET

Возвращает
$this
Исключения
Exception
getPage ( )

Возвращает номер текущей страницы пагинатора, начиная с 1

Возвращает
integer
getPageSize ( )

Возвращает количество элементов на странице

Возвращает
integer
getPaginator ( )

Возвращает подконтрольный элемент пагинатора

Возвращает
Element
getView (   $local_options = [])

Возвращает HTML код формы пагинатора

Аргументы
mixed$local_options- массив параметров, передаваемый в шаблон пагинатора Поддерживаются ключи: array( 'short' => true //Не будет выводится надпись с общим количеством элементов )
Возвращает
string
Исключения
\Exception
\SmartyException
saveGetParams ( )

Добавляет текущие параметры из GET в форму пагинатора

Возвращает
$this
Исключения
Exception
setAutoFill (   $autofill)

Устанавливает, заполнять ли элемент пагинатора значениями из GET при создании текущего объекта Необходимо использовать через параметр в конструкторе

Аргументы
bool$autofill
Возвращает
$this
setPaginator ( Element  $paginator)

Устанавливает подконтрольный элемент пагинатора

Аргументы
Element$paginator- пагинатор
Возвращает
$this

Поля

$action
$auto_fill = true
$element
$hidden_fields = []
$page_var = 'p'
$pagesize_var = 'perpage'