Класс 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 )

Генерирует первое число для метода 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

Номер страницы, которую проверяем.

Возвращает

логическое значение
True, если модель имеет страницу $page, иначе False.

_lastNumber()source protected

_lastNumber( string $ellipsis , array $params , integer $end , array $options )

Генерирует последний номер для метода paginator numbers().

Параметры

строка $ellipsis

Символ эллипса.

массив $params

Параметры из метода numbers().

целое число $end

Конечный номер страницы.

массив $options

Опции из метода numbers().

Возвращает

строка
Выводимая разметка.

_modulusNumbers()source protected

_modulusNumbers( Cake\View\StringTemplate $templater , array $params , array $options )

Генерирует номера страниц для метода paginator numbers().

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $params

Параметры из метода numbers().

массив $options

Опции из метода numbers().

Возвращает

строка
Выводимая разметка.

_numbers()source protected

_numbers( Cake\View\StringTemplate $templater , array $params , array $options )

Генерирует номера страниц для метода paginator numbers().

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $params

Параметры из метода numbers().

массив $options

Опции из метода numbers().

Возвращает

строка
Выводимая разметка.

_removeAlias()source protected

_removeAlias( string $field , string|null $model = null )

Удаляет псевдоним, если необходимо.

Параметры

строка $field

Текущее поле.

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

Текущий псевдоним модели.

Возвращает

строка
Поле без псевдонима, если применимо

_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 Нужно ли экранировать текст.
• url Массив дополнительных опций URL для генерации ссылки.

Параметры

строка|целое число $first необязательно '<< first'

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

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

Массив опций.

Возвращает

строка|ложь
Строка с номерами страниц.

Ссылка

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 $urlOptions = [] )

Объединяет переданные параметры URL с текущим состоянием пагинации для генерации URL пагинации.

Параметры URL:

• escape: Если false, URL будет возвращен без экранирования. Используйте только в случае, если он будет вручную экранирован перед отображением.
• fullBase: Если true, полный базовый URL будет добавлен к результату.

Параметры

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

Массив параметров пагинации/URL

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

Модель, на которой нужно выполнить пагинацию

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

Массив параметров. Булева версия этого аргумента устарела и будет удалена в версии 4.0.0

Возвращает

строка
По умолчанию возвращает полную строку 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, если заданный результат не на последней странице.

Параметры

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

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

Возвращает

логическое значение
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.

Параметры

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

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

целое число $page необязательно 1

Номер страницы - по умолчанию 1.

Возвращает

логическое значение
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, если заданный результат не на первой странице.

Параметры

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

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

Возвращает

логическое значение
True, если результат не на первой странице.

Ссылка

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

implementedEvents()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 необязательно []

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

Возвращает

строка|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 = [] )

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

Параметры

массив $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-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 Нужно ли генерировать ссылки на первую страницу, установите целое число для определения количества ссылок «первая» для генерации. Если установлена строка, ссылка на первую страницу будет сгенерирована со значением в качестве заголовка.
• 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-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( )

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

Возвращает

array

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

__set()source public

__set( string $name , mixed $value )

Магический установщик для удаленных свойств.

Параметры

string $name

Имя свойства.

mixed $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую для использования в confirm()

Параметры

string $message

Сообщение для очистки

Возвращает

mixed

_confirm()source protected

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

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

Параметры

string $message

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

string $okCode

Код, который выполняется после того, как пользователь выбрал 'OK'

string $cancelCode optional ''

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

array $options optional []

Массив опций

Возвращает

string
JS-код onclick

addClass()source public

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

Добавляет указанный класс к опциям элемента.

Параметры

array $options optional []

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

string|null $class optional null

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

string $key optional 'class'

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

Возвращает

array
Массив опций с установленным $key.

getView()source public

getView( )

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

Возвращает

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

initialize()source public

initialize( array $config )

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

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

Параметры

array $config

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

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

string $name

Имя шаблона.

array $data

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

Возвращает

string

getTemplates()source public

getTemplates( string|null $template = null )

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

Параметры

string|null $template optional null

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

Возвращает

string|array

setTemplates()source public

setTemplates( array $templates )

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

Параметры

array $templates

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

Возвращает

$this

templater()source public

templater( )

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

Возвращает

Cake\View\StringTemplate

templates()source public deprecated

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

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

Устарело

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

Параметры

string|null|array $templates optional null

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

Возвращает

$this|string|array

_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 $merge optional false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключение

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

config()source public deprecated

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 $key optional null

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

mixed|null $value optional null

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

boolean $merge optional 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 $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');

Параметры

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
При попытке установить недопустимый ключ.

[
    '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']