Описание класса Navigation | Universal Bot

Navigation

Класс отвечающий за корректную навигацию по элементам меню.

Class Navigation

Table of Contents

STANDARD_NEXT_TEXT ['дальше', 'вперед']
STANDARD_OLD_TEXT ['назад']
$isUsedStandardText Использование стандартных команд навигации Если true, тогда используются стандартные команды. bool
$nextText Массив с возможными командами для навигации вперед. array
$oldText Массив с возможными командами для навигации назад. array
$elements Массив элементов для обработки. array
$maxVisibleElements (default 5) Максимальное количество отображаемых элементов. int
$thisPage (default 0) Текущая страница. Рекомендуется получать это значение после завершения всех операция. int
__construct() Navigation constructor. mixed
isNext() Определяет желание пользователя двигаться вперед. bool
isOld() Определяет желание пользователя двигаться назад. bool
validatePage() Валидация введенной страницы void
numberPage() Определяет желание пользователя перейти на определенную страницу. bool
nextPage() Осуществляет переход на следующую страницу. bool
oldPage() Осуществляет переход на предыдущую страницу. bool
nav() Возвращает новый массив данных, с учетом текущего положения пользователя. array
selectedElement() Выбор определенного элемента списка на нужной странице. mixed
getPageNav() Возвращает кнопки навигации. array
getPageInfo() Возвращает информацию о текущей позиции пользователя. string
getMaxPage() Возвращает максимальное количество страниц. int

Constants

STANDARD_NEXT_TEXT

mixed $STANDARD_NEXT_TEXT = ['дальше', 'вперед']

STANDARD_OLD_TEXT

mixed $STANDARD_OLD_TEXT = ['назад']

Properties

$isUsedStandardText

Использование стандартных команд навигации Если true, тогда используются стандартные команды.

public bool $isUsedStandardText

$nextText

Массив с возможными командами для навигации вперед.

public array $nextText

$oldText

Массив с возможными командами для навигации назад.

public array $oldText

$elements

Массив элементов для обработки.

public array $elements

$maxVisibleElements

(default 5) Максимальное количество отображаемых элементов.

public int $maxVisibleElements

$thisPage

(default 0) Текущая страница. Рекомендуется получать это значение после завершения всех операция.

public int $thisPage

Methods

__construct()

Navigation constructor.

public __construct( [ $maxVisibleElements : int = 5 ] ) : mixed
Parameters
$maxVisibleElements : int = 5

Максимально количество отображаемых элементов.

Return values
mixed

isNext()

Определяет желание пользователя двигаться вперед.

public isNext( $text : string ) : bool
Parameters
$text : string

Пользовательский запрос.

Tags
api
Return values
bool

isOld()

Определяет желание пользователя двигаться назад.

public isOld( $text : string ) : bool
Parameters
$text : string

Пользовательский запрос.

Tags
api
Return values
bool

validatePage()

Валидация введенной страницы

protected validatePage( [ $maxPage : int = null ] ) : void
Parameters
$maxPage : int = null
Tags
private

numberPage()

Определяет желание пользователя перейти на определенную страницу.

public numberPage( $text : string ) : bool

В случае успешного перехода вернет true.

Parameters
$text : string

Пользовательский запрос.

Tags
api
Return values
bool

nextPage()

Осуществляет переход на следующую страницу.

protected nextPage( $text : string ) : bool

В случае успешного перехода вернет true.

Parameters
$text : string

Пользовательский запрос.

Return values
bool

oldPage()

Осуществляет переход на предыдущую страницу.

protected oldPage( $text : string ) : bool

В случае успешного перехода вернет true.

Parameters
$text : string

Пользовательский запрос.

Return values
bool

nav()

Возвращает новый массив данных, с учетом текущего положения пользователя.

public nav( [ $elements : array|null = null ] [, $text : string = '' ] ) : array
Parameters
$elements : array|null = null

Элемент для обработки.

$text : string = ''

Пользовательский запрос.

Tags
api
Return values
array

selectedElement()

Выбор определенного элемента списка на нужной странице.

public selectedElement( [ $elements : array|null = null ] [, $text : string = '' ] [, $key : array|string|null = null ] [, $thisPage : int|null = null ] ) : mixed
Parameters
$elements : array|null = null

Элемент для обработки.

$text : string = ''

Пользовательский запрос.

$key : array|string|null = null

Поиск элемента по ключу массива. Если null, тогда подразумевается, что передан массив из строк.

$thisPage : int|null = null

Текущая страница.

Tags
api
Return values
mixed

getPageNav()

Возвращает кнопки навигации.

public getPageNav( [ $isNumber : bool = false ] ) : array
Parameters
$isNumber : bool = false

Использование числовой навигации. Если true, тогда будут отображаться кнопки с числовой навигацией.

Tags
api
Return values
array

getPageInfo()

Возвращает информацию о текущей позиции пользователя.

public getPageInfo( ) : string
Tags
api
Return values
string

getMaxPage()

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

public getMaxPage( [ $elements : array|null = null ] ) : int
Parameters
$elements : array|null = null

Элемент для обработки.

Tags
api
Return values
int

Search results