Класс PaginatorHelper
Класс помощника для пагинации, обеспечивающий лёгкую генерацию ссылок пагинации.
PaginatorHelper содержит все необходимые методы для работы с пагинацией.
- Cake\View\Helper реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\PaginatorHelper использует 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Генерирует первое число для метода numbers() пагинатора.
- _formatNumber() protectedФорматирует число для вывода номера пагинатора.
- _getNumbersStartAndEnd() protectedВычисляет начальное и конечное значение для номеров пагинации.
- _hasPage() protectedСодержит ли $model страницу $page в своём диапазоне?
- _lastNumber() protectedГенерирует последнее число для метода numbers() пагинатора.
- _modulusNumbers() protectedГенерирует числа для метода numbers() пагинатора.
- _numbers() protectedГенерирует числа для метода 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( Cake\View\StringTemplate $ellipsis , array $params , integer $start , array $options )
Генерирует первое число для метода numbers() пагинатора.
Параметры
-
Cake\View\StringTemplate$ellipsis - Экземпляр StringTemplate.
- массив
$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 - Имя модели для получения параметров.
- целое число
$page - Номер страницы, которую проверяем.
Возвращает
логическое значениеЕсть ли у модели страница $page
_lastNumber()source protected
_lastNumber( Cake\View\StringTemplate $ellipsis , array $params , integer $end , array $options )
Генерирует последний номер для метода numbers() пагинатора.
Параметры
-
Cake\View\StringTemplate$ellipsis - Экземпляр StringTemplate.
- массив
$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Нужно ли экранировать текст. -
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, такие как class, id или event
Возвращает
строкаHTML вывод.
meta()source public
meta( array $options [] )
Возвращает мета-ссылки для набора постраничных результатов.
echo $this->Paginator->meta();
Выводит ссылки непосредственно; ничего не выводит, если нет ни предыдущей, ни следующей страницы.
$this->Paginator->meta(['block' => true]);
Добавит вывод функции meta в указанный блок — если передано 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Нужно ли генерировать ссылки first, устанавливается в целое число для определения количества ссылок 'first'. Если установлена строка, ссылка на первую страницу будет сгенерирована со значением в качестве заголовка. -
lastНужно ли генерировать ссылки last, устанавливается в целое число для определения количества ссылок 'last'. Если установлена строка, ссылка на последнюю страницу будет сгенерирована со значением в качестве заголовка. -
templatesМассив шаблонов или имя файла шаблона, содержащий шаблоны, которые вы хотите использовать при генерации номеров. Исходные шаблоны помощника будут восстановлены после завершения numbers(). -
urlМассив дополнительных параметров URL, которые нужно использовать для генерации ссылок.
Сгенерированные ссылки на номера будут включать шаблон 'многоточие', когда опции first и last и количество страниц превышают модуль. Например, если у вас 25 страниц, и вы используете опции first/last и модуль 8, содержимое многоточия будет вставлено после наборов ссылок first и last.
Параметры
- массив
$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 [] - Массив опций
Возвращает
stringкод onclick JS
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–2017 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.4/class-Cake.View.Helper.PaginatorHelper.html