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

Модель $model содержит $page в своем диапазоне?

Параметры

строка $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().

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

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

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

Опции для строки счётчика. См. раздел «Опции» для списка ключей. Если строка, она будет использоваться как формат.

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

строка
Строка счётчика.

Ссылка

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 необязательно '<< 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

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

Возвращает

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.

Параметры

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

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

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

Параметры

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

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

Возвращает

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

Параметры

строка|число $last необязательно 'последняя >>'

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

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

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

Возвращает

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

Ссылка

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

Добавит результат работы функции мета в указанный блок — если передано true, используется блок "мета".

Параметры:

• 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 страниц, и вы используете опции «первая»/«последняя» и модуль 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 будет использован для заголовка и будет сгенерирован с помощью inflection.

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

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

Возвращает

строка

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

Ссылка

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
код onclick JS

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

Параметры

строка|массив $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

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

Возвращает

смешанное
Конфигурационные данные по указанному ключу или 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']