Класс PaginatorHelper

__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 к модели

_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-counter

current()source public

current( string|null $model = null )

Получает текущую страницу набора записей для указанной модели.

Параметры

строка или null $model по желанию null

Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращаемое значение

Целое число
Номер текущей страницы набора записей.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-state

defaultModel()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 по желанию '<< первый'

Если строка, используется в качестве метки для ссылки. Если число, количество ссылок на страницы в начале диапазона.

массив $options по желанию []

Массив параметров.

Возвращаемое значение

Строка или false
Строка с номерами.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-links

generateUrl()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-urls

generateUrlParams()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, если заданный результат не на последней странице

Параметры

string|null $model дополнительный null

Дополнительное имя модели. Используется по умолчанию, если не указано.

Возвращает

boolean
True, если набор результатов не на последней странице.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-state

hasPage()source public

hasPage( string|null $model = null , integer $page = 1 )

Возвращает true, если заданный набор результатов содержит номер страницы, заданный $page

Параметры

string|null $model дополнительный null

Дополнительное имя модели. Используется по умолчанию, если не указано.

integer $page дополнительный 1

Номер страницы — если не задан, по умолчанию равен 1.

Возвращает

boolean
True, если заданный набор результатов содержит указанный номер страницы.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-state

hasPrev()source public

hasPrev( string|null $model = null )

Возвращает true, если заданный набор результатов не на первой странице

Параметры

string|null $model дополнительный null

Дополнительное имя модели. Используется по умолчанию, если не указано.

Возвращает

boolean
True, если набор результатов не на первой странице.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#checking-the-pagination-state

implementedEvents()source public

implementedEvents( )

Обработчики событий.

Возвращает

array

Переопределяет

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 для генерации ссылок.

Параметры

string|integer $last дополнительный 'последняя >>'

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

array $options дополнительный []

Массив параметров

Возвращает

string|false
Строка с числами.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-links

limitControl()source public

limitControl( array $limits = [] , integer|null $default = null , array $options = [] )

Выпадающий список для ограничения постраничной навигации. Это сгенерирует обёртку формы.

Параметры

array $limits дополнительный []

Массив параметров.

integer|null $default дополнительный null

Значение параметра по умолчанию для ограничения постраничной навигации. По умолчанию $this->param('perPage').

array $options дополнительный []

Параметры для атрибутов тега Select, такие как класс, id или событие

Возвращает

string
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, чтобы сгенерировать мета-данные для последней страницы

Параметры

array $options дополнительный []

Массив параметров

Возвращает

string|null
Мета-ссылки

next()source public

next( string $title = 'Next >>' , array $options = [] )

Генерирует ссылку "следующая" для набора отсортированных записей

Параметры:

• disabledTitle Текст, используемый, когда ссылка отключена. По умолчанию совпадает с текстом активной ссылки. Установка в false приведет к тому, что этот метод вернёт ''.
• escape Требуется ли кодировать содержимое в HTML-сущности, по умолчанию true
• model Модель для использования, по умолчанию PaginatorHelper::defaultModel()
• url Массив дополнительных параметров URL для генерации ссылок.
• templates Массив шаблонов или имя файла шаблона, содержащий шаблоны, которые вы хотели бы использовать при генерации ссылки для следующей страницы. Исходные шаблоны помощника будут восстановлены после завершения next().

Параметры

string $title дополнительный 'Следующая >>'

Заголовок ссылки. По умолчанию 'Следующая >>'.

array $options дополнительный []

Параметры для ссылки постраничной навигации. См. выше перечень ключей.

Возвращает

string
Ссылка "следующая" или текст $disabledTitle, если ссылка отключена.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-jump-links

numbers()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 для генерации ссылок.

Сгенерированные ссылки на числа будут включать шаблон "многоточие" (ellipsis) когда значения параметров first и last и количество страниц превышает модуль. Например, если у вас 25 страниц, и вы используете параметры first/last и модуль 8, содержимое многоточия будет вставлено после наборов первых и последних ссылок.

Параметры

array $options дополнительный []

Параметры для чисел.

Возвращает

string|false
Строка с числами.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-page-number-links

options()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-links

sort()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 будет использован для названия и будет сгенерирован с помощью инфлексии.

массив $options необязательно []

Параметры для ссылки сортировки. Список ключей см. выше.

Возвращает

строка

Ссылка для сортировки по умолчанию 'asc'. Если набор результатов отсортирован по 'asc' по указанному ключу, возвращаемая ссылка будет отсортирована по 'desc'.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-sort-links

sortDir()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-links

sortKey()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-links

total()source public

total( string|null $model = null )

Получает общее количество страниц в наборе записей для заданной модели.

Параметры

строка|null $model необязательно null

Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

целое число
Общее количество страниц для набора записей.

__call()source public

__call( string $method , array $params )

Предоставляет некритические ошибки при вызовах отсутствующих методов.

Параметры

строка $method

Вызываемый метод

массив $params

Массив параметров для метода.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Лениво загружает помощников.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с указанным именем существует

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )

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

Параметры

строка $message

Сообщение для отображения

строка $okCode

Код, который будет выполнен после выбора 'OK'

строка $cancelCode необязательно ''

Код, который будет выполнен после выбора 'Отмена'

массив $options необязательно []

Массив параметров

Возвращает

строка
JS-код onclick

addClass()source public

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Добавляет заданный класс к параметрам элемента.

Параметры

массив $options необязательно []

Массив параметров/атрибутов для добавления класса

строка|null $class необязательно null

Имя добавляемого класса.

строка $key необязательно 'class'

Ключ для использования для класса.

Возвращает

массив
Массив параметров со значением $key.

getView()source public

getView( )

Получить экземпляр представления, к которому привязан этот помощник.

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

Метод обработчика конструктора.

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

Параметры

массив $config

Настройки конфигурации, предоставленные для этого помощника.

formatTemplate()source public

formatTemplate( string $name , array $data )

Форматирует строку шаблона с данными $data

Параметры

строка $name

Имя шаблона.

массив $data

Данные для вставки.

Возвращает

строка

getTemplates()source public

getTemplates( string|null $template = null )

Получает шаблоны для использования или конкретный шаблон.

Параметры

строка|null $template необязательно null

Строка для чтения определенного шаблона, null для всех.

Возвращает

строка|массив

setTemplates()source public

setTemplates( array $templates )

Устанавливает шаблоны для использования.

Параметры

массив $templates

Шаблоны, которые нужно добавить.

Возвращает

$this

templater()source public

templater( )

Возвращает экземпляр templater.

Возвращает

Cake\View\StringTemplate

templates()source public устарело

templates( string|null|array $templates = null )

Получает/устанавливает используемые шаблоны.

Устарело

3.4.0 Используйте setTemplates()/getTemplates() вместо этого.

Параметры

строка|null|массив $templates необязательно null

null или строка позволяют читать шаблоны. Массив позволяет добавлять шаблоны.

Возвращает

$this|строка|массив

_configDelete()source protected

_configDelete( string $key )

Удаляет единственный ключ конфигурации.

Параметры

строка $key

Ключ для удаления.

Возбуждает

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

строка|null $key

Ключ для чтения.

Возвращает

смешанное

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

строка|массив $key

Ключ для записи.

смешанное $value

Значение для записи.

логическое|строка $merge необязательно 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() вместо этого.

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанное|null $value необязательно null

Значение для установки.

логическое $merge необязательно true

Слияние или перезапись существующей конфигурации рекурсивно, по умолчанию true.

Возвращает

смешанное
Значение конфигурации, которое читается, или сам объект при операциях записи.

Возбуждает

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']);

Параметры

строка|массив $key

Ключ для установки или полный массив конфигураций.

смешанное|null $value необязательно 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');

Параметры

строка|null $key необязательно null

Ключ для получения или null для всей конфигурации.

смешанное $default необязательно null

Значение, возвращаемое, когда ключ не существует.

Возвращает

смешанное
Значение конфигурации, которое читается.

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']);

Параметры

строка|массив $key

Ключ для установки или полный массив конфигураций.

смешанное|null $value необязательно null

Значение для установки.

логическое $merge необязательно true

Слияние или перезапись существующей конфигурации рекурсивно, по умолчанию true.

Возвращает

$this

Возбуждает

Cake\Core\Exception\Exception
При попытке установить недействительный ключ.

[
    '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">&hellip;</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>',
    ]
]

['Url', 'Number', 'Html', 'Form']