Класс PaginatorHelper
Класс Paginator Helper для лёгкого создания ссылок для постраничной навигации.
PaginatorHelper включает в себя все необходимые методы при работе с постраничной навигацией.
- Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\PaginatorHelper uses Cake\View\StringTemplateTrait
Ссылка: https://book.cakephp.org/3.0/ru/views/helpers/paginator.html
Расположение: View/Helper/PaginatorHelper.php
Краткое описание свойств
-
$_defaultConfigprotectedКонфигурация по умолчанию для этого классаarray -
$_defaultModelprotectedМодель по умолчанию для постраничного набора данныхstring -
$helperspublicСписок хелперов, используемых этим хелперомarray
Краткое описание магических свойств
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор. Переопределён для объединения переданных аргументов с параметрами URL.
- _firstNumber() protectedГенерирует первое число для метода paginator numbers().
- _formatNumber() protectedФорматирует число для вывода в постраничной навигации.
- _getNumbersStartAndEnd() protectedВычисляет начальное и конечное значения для чисел постраничной навигации.
- _hasPage() protectedСодержится ли $page в диапазоне $model?
- _lastNumber() protectedГенерирует последнее число для метода paginator numbers().
- _modulusNumbers() protectedГенерирует числа для метода paginator numbers().
- _numbers() protectedГенерирует числа для метода paginator numbers().
- _toggledLink() protectedГенерирует активную/неактивную ссылку для методов next/prev.
- counter() publicВозвращает строку счётчика для постраничного набора результатов.
- current() publicПолучает текущую страницу набора записей для заданной модели.
- defaultModel() publicПолучает или задаёт модель по умолчанию для постраничных наборов данных.
- first() publicВозвращает первую или набор чисел для первых страниц.
- generateUrl() publicОбъединяет переданные параметры URL с текущим состоянием постраничной навигации для генерации URL постраничной навигации.
- generateUrlParams() publicОбъединяет переданные параметры URL с текущим состоянием постраничной навигации для генерации URL постраничной навигации.
- hasNext() publicВозвращает true, если заданный набор результатов не на последней странице.
- hasPage() publicВозвращает true, если заданный набор результатов содержит страницу с номером $page.
- hasPrev() publicВозвращает true, если заданный набор результатов не на первой странице.
- implementedEvents() publicОбработчики событий.
- last() publicВозвращает последнюю или набор чисел для последних страниц.
- limitControl() public
Выпадающий список для ограничения постраничной навигации. Это сгенерирует форму обёртки.
- meta() publicВозвращает мета-ссылки для постраничного набора результатов.
- next() publicГенерирует ссылку "следующая" для набора постраничных записей.
- numbers() public
Возвращает набор чисел для постраничного набора результатов, используя модуль для определения, сколько чисел отображать по обе стороны от текущей страницы (по умолчанию: 8).
- options() publicУстанавливает параметры по умолчанию для всех ссылок постраничной навигации.
- param() publicУдобный доступ к любому из параметров постраничной навигации.
- params() publicПолучает текущие параметры постраничной навигации из набора результатов для заданной модели.
- prev() publicГенерирует ссылку "предыдущая" для набора постраничных записей.
- sort() public
Генерирует ссылку сортировки. Устанавливает именованные параметры для сортировки и направления. Автоматически обрабатывает переключение направления.
- sortDir() publicПолучает текущее направление сортировки набора результатов.
- sortKey() publicПолучает текущий ключ, по которому сортируется набор результатов.
- total() publicПолучает общее количество страниц в наборе результатов для заданной модели.
Подробное описание методов
__construct()source public
__construct( Cake\View\View $View , array $config [] )
Конструктор. Переопределён для объединения переданных аргументов с параметрами URL.
Параметры
-
Cake\View\View$View - Представление, к которому прикрепляется хелпер.
- массив
$configнеобязательно [] - Параметры конфигурации хелпера.
Переопределяет
Cake\View\Helper::__construct() _firstNumber()source protected
_firstNumber( string $ellipsis , array $params , integer $start , array $options )
Генерирует первое число для метода paginator numbers().
Параметры
- строка
$ellipsis - Символ многоточия.
- массив
$params - Параметры из метода numbers().
- целое число
$start - Начальное число.
- массив
$options - Опции из метода numbers().
Возвращает
строкаВывод разметки.
_formatNumber()source protected
_formatNumber( Cake\View\StringTemplate $templater , array $options )
Форматирует число для вывода номера страницы пагинатора.
Параметры
-
Cake\View\StringTemplate$templater - Экземпляр StringTemplate.
- массив
$options - Опции из метода numbers().
Возвращает
строка_getNumbersStartAndEnd()source protected
_getNumbersStartAndEnd( array $params , array $options )
Вычисляет начальное и конечное значения для номеров страниц пагинации.
Параметры
- массив
$params - Параметры из метода numbers().
- массив
$options - Опции из метода numbers().
Возвращает
массивМассив с начальным и конечным номерами страниц.
_hasPage()source protected
_hasPage( string $model , integer $page )
Находится ли страница $page в диапазоне $model?
Параметры
- строка
$model - Имя модели для получения параметров.
- целое число
$page - Номер страницы, которую проверяем.
Возвращает
логическое значениеЯвляется ли $page частью диапазона $model.
_lastNumber()source protected
_lastNumber( string $ellipsis , array $params , integer $end , array $options )
Генерирует последний номер для метода numbers() пагинатора.
Параметры
- строка
$ellipsis - Символ многоточия.
- массив
$params - Параметры из метода numbers().
- целое число
$end - Конечный номер страницы.
- массив
$options - Опции из метода numbers().
Возвращает
строкаВыводимый разметка.
_modulusNumbers()source protected
_modulusNumbers( Cake\View\StringTemplate $templater , array $params , array $options )
Генерирует номера для метода numbers() пагинатора.
Параметры
-
Cake\View\StringTemplate$templater - Экземпляр StringTemplate.
- массив
$params - Параметры из метода numbers().
- массив
$options - Опции из метода numbers().
Возвращает
строкаВыводимая разметка.
_numbers()source protected
_numbers( Cake\View\StringTemplate $templater , array $params , array $options )
Генерирует номера для метода numbers() пагинатора.
Параметры
-
Cake\View\StringTemplate$templater - Экземпляр StringTemplate.
- массив
$params - Параметры из метода numbers().
- массив
$options - Опции из метода numbers().
Возвращает
строкаВыводимая разметка.
_toggledLink()source protected
_toggledLink( string|boolean $text , boolean $enabled , array $options , array $templates )
Генерирует активную/неактивную ссылку для методов next/prev.
Параметры
- строка/логическое значение
$text - Текст, отображаемый для активной ссылки.
- логическое значение
$enabled - Нужно ли генерировать ссылку для активного/неактивного состояния.
- массив
$options - Массив опций из вызывающего метода.
- массив
$templates - Массив шаблонов с ключами 'active' и 'disabled'.
Возвращает
строкаСгенерированный HTML
counter()source public
counter( string|array $options [] )
Возвращает строку счётчика для результата запроса, разбитого на страницы.
Опции
-
modelИмя модели, используется по умолчанию PaginatorHelper::defaultModel(); -
formatСтрока форматирования, по умолчанию 'pages' (выводит '1 из 5'), 'range' (выводит '1 - 3 из 13'), или настраиваемая строка, содержащая следующие плейсхолдеры{{page}},{{pages}},{{current}},{{count}},{{model}},{{start}},{{end}}.
Параметры
- строка/массив
$optionsнеобязательно [] Опции для строки счётчика. См. раздел #options для списка ключей. Если строка, она будет использована как формат.
Возвращает
строкаСтрока счётчика.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-a-page-countercurrent()source public
current( string|null $model null )
Возвращает текущую страницу набора записей для заданной модели.
Параметры
- строка/null
$modelнеобязательно null - Необязательное имя модели. Используется значение по умолчанию, если не указано.
Возвращает
целое числоНомер текущей страницы набора записей.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-statedefaultModel()source public
defaultModel( string|null $model null )
Получает или задаёт модель по умолчанию для набора страниц.
Параметры
- строка/null
$modelнеобязательно null - Имя модели для установки.
Возвращает
строка/nullИмя модели или null, если пагинация не инициализирована.
first()source public
first( string|integer $first '<< first' , array $options [] )
Возвращает первый или набор номеров для первых страниц.
echo $this->Paginator->first('< first'); Создаёт единственную ссылку на первую страницу. Не выводит ничего, если вы находитесь на первой странице.
echo $this->Paginator->first(3);
Создаёт ссылки на первые 3 страницы, когда вы находитесь на третьей или более странице. До этого ничего не выводится.
Опции:
-
modelМодель по умолчанию, по умолчанию PaginatorHelper::defaultModel() -
escapeНужно ли HTML-экранировать текст. -
urlМассив дополнительных опций URL для генерации ссылки.
Параметры
- строка/целое число
$firstнеобязательно '<< first' Если строка, используется в качестве метки для ссылки. Если число, количество ссылок на страницы в начале диапазона.
- массив
$optionsнеобязательно [] - Массив опций.
Возвращает
строка/falseСтрока с номерами.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-linksgenerateUrl()source public
generateUrl( array $options [] , string|null $model null , array|boolean $urlOptions false )
Объединяет переданные опции URL с текущим состоянием пагинации для генерации URL-адреса пагинации.
Опции URL:
-
escape: Если false, URL будет возвращён без экранирования, используйте только если он вручную экранирован до отображения. -
fullBase: Если true, к результату будет добавлен полный базовый URL.
Параметры
- массив
$optionsнеобязательно [] - Массив опций пагинации/URL
- строка/null
$modelнеобязательно null - Модель для пагинации
- массив/логическое значение
$urlOptionsнеобязательно false - Массив опций или булевое значение
fullBaseдля обратной совместимости.
Возвращает
строкаПо умолчанию возвращает полную строку URL пагинации для использования в нестандартных контекстах (например, JavaScript)
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#generating-pagination-urlsgenerateUrlParams()source public
generateUrlParams( array $options [] , string|null $model null )
Объединяет переданные параметры URL с текущим состоянием пагинации для генерации URL пагинации.
Параметры
- массив
$optionsнеобязательно [] - Массив опций пагинации/URL
- строка|null
$modelнеобязательно null - Модель, по которой производить пагинацию
Возвращает
массивМассив параметров URL
hasNext()source public
hasNext( string|null $model null )
Возвращает true, если заданный результат не на последней странице.
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Используется значение по умолчанию, если не указано.
Возвращает
booleanTrue, если результат не на последней странице.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-statehasPage()source public
hasPage( string|null $model null , integer $page 1 )
Возвращает true, если заданный результат имеет номер страницы, заданный $page.
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Используется значение по умолчанию, если не указано.
- целое число
$pageнеобязательно 1 - Номер страницы. Если не задан, используется 1.
Возвращает
booleanTrue, если заданный результат содержит указанную страницу.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-statehasPrev()source public
hasPrev( string|null $model null )
Возвращает true, если заданный результат не на первой странице.
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Используется значение по умолчанию, если не указано.
Возвращает
booleanTrue, если результат не на первой странице.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-stateimplementedEvents()source public
implementedEvents( )
Обработчики событий.
Возвращает
массивПереопределяет
Cake\View\Helper::implementedEvents() last()source public
last( string|integer $last 'last >>' , array $options [] )
Возвращает последнюю страницу или набор чисел для последних страниц.
echo $this->Paginator->last('last >'); Создает единственную ссылку на последнюю страницу. Ничего не выводит, если вы находитесь на последней странице.
echo $this->Paginator->last(3);
Создает ссылки на последние 3 страницы. После вхождения в диапазон страниц, ничего не выводится.
Опции:
-
modelМодель для использования, по умолчанию PaginatorHelper::defaultModel() -
escapeНеобходимо ли кодировать HTML-сущности. -
urlМассив дополнительных параметров URL для генерации ссылки.
Параметры
- строка|целое число
$lastнеобязательно 'последняя >>' - Если строка, используется в качестве метки ссылки; если число, выводятся номера страниц
- массив
$optionsнеобязательно [] - Массив опций
Возвращает
строка|ложьСтрока с номерами.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-linkslimitControl()source public
limitControl( array $limits [] , integer|null $default null , array $options [] )
Выпадающий список для ограничения пагинации. Будет генерировать форму обёртку.
Параметры
- массив
$limitsнеобязательно [] - Массив опций.
- целое число|null
$defaultнеобязательно null - Значение по умолчанию для ограничения пагинации. По умолчанию
$this->param('perPage'). - массив
$optionsнеобязательно [] - Опции для атрибутов тега Select, таких как класс, id или событие
Возвращает
строкаHTML вывод.
meta()source public
meta( array $options [] )
Возвращает мета-ссылки для набора результатов пагинации.
echo $this->Paginator->meta();
Выводит ссылки напрямую, не выводит ничего, если нет предыдущей или следующей страницы.
$this->Paginator->meta(['block' => true]);
Добавляет вывод функции мета в указанный блок. Если передано true, используется блок "meta".
Опции:
-
modelМодель для использования, по умолчанию PaginatorHelper::defaultModel() -
blockИмя блока, в который нужно добавить вывод, или false/отсутствует, чтобы вернуть строку. -
prev(по умолчанию True) True для генерации мета для предыдущей страницы -
next(по умолчанию True) True для генерации мета для следующей страницы -
first(по умолчанию False) True для генерации мета для первой страницы -
last(по умолчанию False) True для генерации мета для последней страницы
Параметры
- массив
$optionsнеобязательно [] - Массив опций
Возвращает
строка|nullМета-ссылки
next()source public
next( string $title 'Next >>' , array $options [] )
Генерирует ссылку "следующая" для набора страниц записей.
Опции:
-
disabledTitleТекст, используемый, когда ссылка отключена. По умолчанию совпадает с активной ссылкой. Установка в false приведет к возврату '' этим методом. -
escapeНеобходимо ли кодировать HTML-сущности, по умолчанию true -
modelМодель для использования, по умолчанию PaginatorHelper::defaultModel() -
urlМассив дополнительных параметров URL для генерации ссылки. -
templatesМассив шаблонов или имя файла шаблона, содержащий шаблоны, которые нужно использовать при генерации ссылки для следующей страницы. Исходные шаблоны помощника будут восстановлены после завершения next().
Параметры
- строка
$titleнеобязательно 'Следующая >>' - Заголовок для ссылки. По умолчанию 'Следующая >>'.
- массив
$optionsнеобязательно [] - Опции для ссылки на пагинацию. См. выше список ключей.
Возвращает
строкаСсылка "следующая" или текст $disabledTitle, если ссылка отключена.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-linksnumbers()source public
numbers( array $options [] )
Возвращает набор чисел для результата запроса с постраничной навигацией, использует модуль для определения, сколько чисел отображать по обе стороны от текущей страницы (по умолчанию: 8).
$this->Paginator->numbers(['first' => 2, 'last' => 2]);
Используя опции first и last, вы можете создать ссылки на начало и конец набора страниц.
Параметры
-
beforeСодержимое, которое будет вставлено перед числами, но после первых ссылок. -
afterСодержимое, которое будет вставлено после чисел, но перед последними ссылками. -
modelМодель для создания чисел, по умолчанию PaginatorHelper::defaultModel() -
modulusКоличество чисел, включаемых по обе стороны от текущей страницы, по умолчанию 8. Установите значениеfalse, чтобы отключить и отобразить все числа. -
firstНужно ли генерировать ссылки на первую страницу, установите целое число для определения количества ссылок «первая» страница. Если установлена строка, будет сгенерирована ссылка на первую страницу со значением в качестве заголовка. -
lastНужно ли генерировать ссылки на последнюю страницу, установите целое число для определения количества ссылок «последняя» страница. Если установлена строка, будет сгенерирована ссылка на последнюю страницу со значением в качестве заголовка. -
templatesМассив шаблонов или имя файла шаблона, содержащие шаблоны, которые вы хотите использовать при генерации чисел. Исходные шаблоны помощника будут восстановлены после выполнения numbers(). -
urlМассив дополнительных параметров URL, используемых для генерации ссылок.
Сгенерированные числовые ссылки будут включать шаблон «многоточие», когда опции first и last и количество страниц превышает модуль. Например, если у вас 25 страниц, и вы используете опции first/last и модуль 8, содержимое многоточия будет вставлено после наборов первой и последней ссылок.
Параметры
- массив
$optionsнеобязательно [] - Параметры для чисел.
Возвращает
строка|ложьСтрока чисел.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-page-number-linksoptions()source public
options( array $options [] )
Устанавливает параметры по умолчанию для всех ссылок постраничной навигации
Параметры
- массив
$optionsнеобязательно [] Параметры по умолчанию для ссылок постраничной навигации. См. PaginatorHelper::$options для списка ключей.
param()source public
param( string $key , string|null $model null )
Удобный доступ к любым параметрам постраничной навигации.
Параметры
- строка
$key - Ключ массива параметров постраничной навигации для извлечения.
- строка|null
$modelнеобязательно null - Необязательное имя модели. Использует значение по умолчанию, если не указано.
Возвращает
смешанноеСодержание запрошенного параметра.
params()source public
params( string|null $model null )
Получает текущие параметры постраничной навигации из набора результатов для заданной модели.
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Использует значение по умолчанию, если не указано.
Возвращает
массивМассив параметров постраничной навигации для набора результатов с постраничной навигацией.
prev()source public
prev( string $title '<< Previous' , array $options [] )
Генерирует ссылку «предыдущая» для набора страниц с записями.
Параметры:
-
disabledTitleТекст, используемый, когда ссылка отключена. По умолчанию совпадает с текстом активной ссылки. Установка в значение false приведет к тому, что этот метод вернет ''. -
escapeНужно ли кодировать содержимое в html-сущности, по умолчанию true -
modelМодель для использования, по умолчанию PaginatorHelper::defaultModel() -
urlМассив дополнительных параметров URL для использования при генерации ссылок. -
templatesМассив шаблонов или имя файла шаблона, содержащие шаблоны, которые вы хотите использовать при генерации ссылки на предыдущую страницу. Исходные шаблоны помощника будут восстановлены после выполнения prev().
Параметры
- строка
$titleнеобязательно '<< Предыдущая' - Заголовок ссылки. По умолчанию «<< Предыдущая».
- массив
$optionsнеобязательно [] - Параметры для ссылки постраничной навигации. Список ключей см. выше.
Возвращает
строкаСсылка «предыдущая» или ссылка, помеченная как неактивная.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-linkssort()source public
sort( string $key , string|null $title null , array $options [] )
Генерирует ссылку сортировки. Устанавливает именованные параметры для сортировки и направления. Автоматически обрабатывает переключение направления.
Параметры:
-
escapeНужно ли кодировать содержимое в html-сущности, по умолчанию true. -
modelМодель для использования, по умолчанию PaginatorHelper::defaultModel(). -
directionНаправление по умолчанию для использования, когда эта ссылка не активна. -
lockЗаблокировать направление. Будет использоваться только направление по умолчанию, по умолчанию false.
Параметры
- строка
$key - Имя ключа, по которому набор записей должен быть отсортирован.
- строка|null
$titleнеобязательно null Заголовок ссылки. Если $title равен null, $key будет использован для заголовка и будет сгенерирован с помощью inflection.
- массив
$optionsнеобязательно [] - Параметры для ссылки сортировки. Список ключей см. выше.
Возвращает
строкаСсылка сортировки по умолчанию по «asc». Если набор результатов отсортирован по «asc» по указанному ключу, возвращаемая ссылка будет отсортирована по «desc».
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-sort-linkssortDir()source public
sortDir( string|null $model null , array $options [] )
Получает текущее направление сортировки набора записей
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Использует значение по умолчанию, если не указано.
- массив
$optionsнеобязательно [] - Параметры для ссылок постраничной навигации. Список ключей см. в разделе #options.
Возвращает
строкаНаправление, по которому отсортирован набор записей, или null, если результаты не отсортированы в настоящее время.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-sort-linkssortKey()source public
sortKey( string|null $model null , array $options [] )
Получает текущий ключ, по которому отсортирован набор записей
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Использует значение по умолчанию, если не указано.
- массив
$optionsнеобязательно [] - Параметры для ссылок постраничной навигации. Список ключей см. в разделе #options.
Возвращает
строка|nullИмя ключа, по которому отсортирован набор записей, или null, если результаты не отсортированы в настоящее время.
Ссылка
https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-sort-linkstotal()source public
total( string|null $model null )
Получает общее количество страниц в наборе записей для заданной модели.
Параметры
- строка|null
$modelнеобязательно null - Необязательное имя модели. Использует значение по умолчанию, если не указано.
Возвращает
целое числоОбщее количество страниц для набора записей.
Методы, унаследованные от Cake\View\Helper
__call()source public
__call( string $method , array $params )
Предоставляет некритические ошибки при вызовах отсутствующих методов.
Параметры
- строка
$method - Метод для вызова
- массив
$params - Массив параметров для метода.
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
array__get()source public
__get( string $name )
Лениво загружает помощники.
Параметры
- string
$name - Имя свойства, к которому осуществляется доступ.
Возвращает
Cake\View\Helper|nullЭкземпляр помощника, если помощник с указанным именем существует
_confirm()source protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.
Параметры
- string
$message - Сообщение, которое будет отображено
- string
$okCode - Код, который будет выполнен после выбора пользователем «ОК»
- string
$cancelCodeoptional '' - Код, который будет выполнен после выбора пользователем «Отмена»
- array
$optionsoptional [] - Массив опций
Возвращает
stringJS-код onclick
addClass()source public
addClass( array $options [] , string|null $class null , string $key 'class' )
Добавляет заданный класс к опциям элемента
Параметры
- array
$optionsoptional [] - Массив опций/атрибутов, к которым нужно добавить класс
- string|null
$classoptional null - Имя добавляемого класса.
- string
$keyoptional 'class' - ключ для использования класса.
Возвращает
arrayМассив опций с установленным $key.
getView()source public
getView( )
Получить экземпляр представления, к которому привязан этот помощник.
Возвращает
Cake\View\ViewЭкземпляр привязанного представления.
initialize()source public
initialize( array $config )
Метод обработки конструктора.
Реализуйте этот метод, чтобы избежать необходимости перезаписывать конструктор и вызывать родительский.
Параметры
- array
$config - Настройки конфигурации, предоставленные этому помощнику.
Методы, используемые из Cake\View\StringTemplateTrait
formatTemplate()source public
formatTemplate( string $name , array $data )
Форматирует строку шаблона с данными $data
Параметры
- string
$name - Имя шаблона.
- array
$data - Данные для вставки.
Возвращает
stringgetTemplates()source public
getTemplates( string|null $template null )
Получение используемых шаблонов или конкретного шаблона.
Параметры
- string|null
$templateoptional null - Строка для чтения конкретного шаблона, null для всех.
Возвращает
string|arraysetTemplates()source public
setTemplates( array $templates )
Устанавливает используемые шаблоны.
Параметры
- array
$templates - Шаблоны, которые необходимо добавить.
Возвращает
$this
templater()source public
templater( )
Возвращает экземпляр templater.
Возвращает
Cake\View\StringTemplatetemplates()source public
templates( string|null|array $templates null )
Получение/установка используемых шаблонов.
Устарело
3.4.0 Используйте setTemplates()/getTemplates() вместо этого.Параметры
- string|null|array
$templatesoptional null null или строка позволяют читать шаблоны. Массив позволяет добавлять шаблоны.
Возвращает
$this|string|array
Методы, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет один ключ конфигурации.
Параметры
- string
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
_configRead()source protected
_configRead( string|null $key )
Считывает ключ конфигурации.
Параметры
- string|null
$key - Ключ для чтения.
Возвращает
mixed_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Записывает ключ конфигурации.
Параметры
- string|array
$key - Ключ для записи.
- mixed
$value - Значение для записи.
- boolean|string
$mergeoptional false True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
config()source public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Получение/Установка конфигурации.
Использование
Чтение всей конфигурации:
$this->config();
Чтение определенного значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Устарело
3.4.0 используйте setConfig()/getConfig() вместо этого.Параметры
- string|array|null
$keyoptional null - Ключ для получения/установки или полный массив конфигураций.
- mixed|null
$valueoptional null - Значение для установки.
- boolean
$mergeoptional true - Флаг, указывающий, нужно ли рекурсивно сливать или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
mixedЗначение конфигурации, которое считывается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Слияние предоставленной конфигурации с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определенного значения:
$this->configShallow('key', $value); Установка вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
- string|array
$key - Ключ для установки или полный массив конфигураций.
- mixed|null
$valueoptional null - Значение для установки.
Возвращает
$this
getConfig()source public
getConfig( string|null $key null , mixed $default null )
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определенного значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
- string|null
$keyнеобязательно null - Ключ для получения или null для всей конфигурации.
- mixed
$defaultнеобязательно null - Возвращаемое значение, если ключ не существует.
Возвращаемое значение
mixedЗначение конфигурации, которое читается.
setConfig()source public
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Устанавливает конфигурацию.
Использование
Установка определенного значения:
$this->setConfig('key', $value); Установка вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
- string|array
$key - Ключ для установки или полный массив конфигураций.
- mixed|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Нужно ли рекурсивно объединять или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращаемое значение
$this
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недействительный ключ.
Подробное описание свойств
$_defaultConfigsource
protected array
Конфигурация по умолчанию для этого класса
Параметры: Содержит параметры по умолчанию для ссылок постраничной навигации
Возможные значения:
-
urlАдрес действия. См. Router::url() -
url['sort']ключ, по которому сортируется набор записей. -
url['direction']Направление сортировки (по умолчанию: 'asc'). -
url['page']Номер страницы для использования в ссылках. -
modelИмя модели. -
escapeОпределяет, нужно ли экранировать поле заголовка для ссылки (по умолчанию: true).
Шаблоны: шаблоны, используемые этим классом
[
'options' => [],
'templates' => [
'nextActive' => '<li class="next"><a rel="next" href="{{url}}">{{text}}</a></li>',
'nextDisabled' => '<li class="next disabled"><a href="" onclick="return false;">{{text}}</a></li>',
'prevActive' => '<li class="prev"><a rel="prev" href="{{url}}">{{text}}</a></li>',
'prevDisabled' => '<li class="prev disabled"><a href="" onclick="return false;">{{text}}</a></li>',
'counterRange' => '{{start}} - {{end}} of {{count}}',
'counterPages' => '{{page}} of {{pages}}',
'first' => '<li class="first"><a href="{{url}}">{{text}}</a></li>',
'last' => '<li class="last"><a href="{{url}}">{{text}}</a></li>',
'number' => '<li><a href="{{url}}">{{text}}</a></li>',
'current' => '<li class="active"><a href="">{{text}}</a></li>',
'ellipsis' => '<li class="ellipsis">…</li>',
'sort' => '<a href="{{url}}">{{text}}</a>',
'sortAsc' => '<a class="asc" href="{{url}}">{{text}}</a>',
'sortDesc' => '<a class="desc" href="{{url}}">{{text}}</a>',
'sortAscLocked' => '<a class="asc locked" href="{{url}}">{{text}}</a>',
'sortDescLocked' => '<a class="desc locked" href="{{url}}">{{text}}</a>',
]
] $helperssource
public array
Список помощников, используемых этим помощником
['Url', 'Number', 'Html', 'Form']
Подробное описание магических свойств
$Formsource
public Cake\View\Helper\FormHelper
$Htmlsource
public Cake\View\Helper\HtmlHelper
$Numbersource
$Urlsource
public Cake\View\Helper\UrlHelper
© 2005–2018 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.5/class-Cake.View.Helper.PaginatorHelper.html