Класс BreadcrumbsHelper

add()source public

add( string|array $title , string|array|null $url = null , array $options = [] )

Добавляет крошку в конец цепочки.

Параметры

string|array $title

Если предоставлено в виде строки, она представляет собой заголовок крошки. В противном случае, если вы хотите добавить сразу несколько крошек, можно предоставить массив, где каждое значение будет одной крошкой. Массивы ожидаются в этом формате: - title Заголовок крошки - link Ссылка на крошку. Если не указано, ссылка не будет создана - options Параметры крошки. См. описание параметров этого метода.

string|array|null $url optional null

URL крошки. Либо строка, либо массив параметров маршрута для передачи в Url::build(), либо null/пустая строка, если у крошки нет ссылки.

array $options optional []

Массив параметров. Эти параметры будут использоваться в качестве атрибутов HTML-атрибутов, в которых будет отображаться крошка (по умолчанию тег <li>). Он принимает два специальных ключа: - innerAttrs: Массив, который позволяет определить атрибуты для внутреннего элемента крошки (по умолчанию, для ссылки) - templateVars: Специфические переменные шаблона в случае переопределения предоставленных шаблонов.

Возвращает

$this

findCrumb()source protected

findCrumb( string $title )

Ищет крошку в текущей стопке, заголовок которой соответствует переданному в качестве аргумента. Если найдена, возвращается индекс соответствующей крошки.

Параметры

string $title

Заголовок для поиска.

Возвращает

integer|null
Индекс найденной крошки или null, если она не найдена.

getCrumbs()source public

getCrumbs( )

Возвращает список крошек.

Возвращает

array

insertAfter()source public

insertAfter( string $matchingTitle , string $title , string|array|null $url = null , array $options = [] )

Вставляет крошку после первой соответствующей крошки с указанным названием.

Находит индекс первой крошки, которая соответствует предоставленному классу, и вставляет переданный вызываемый объект перед ним.

Параметры

string $matchingTitle

Заголовок крошки, после которой вы хотите вставить эту.

string $title

Заголовок крошки.

string|array|null $url optional null

URL крошки. Либо строка, либо массив параметров маршрута для передачи в Url::build(), либо null/пустая строка, если у крошки нет ссылки.

array $options optional []

Массив параметров. Эти параметры будут использоваться в качестве атрибутов HTML-атрибутов, в которых будет отображаться крошка (по умолчанию тег <li>). Он принимает два специальных ключа: - innerAttrs: Массив, который позволяет определить атрибуты для внутреннего элемента крошки (по умолчанию, для ссылки) - templateVars: Специфические переменные шаблона в случае переопределения предоставленных шаблонов.

Возвращает

$this

Вызывает исключение

LogicException
В случае, если соответствующая крошка не найдена.

insertAt()source public

insertAt( integer $index , string $title , string|array|null $url = null , array $options = [] )

Вставляет крошку в определенный индекс.

Если индекс уже существует, новая крошка будет вставлена, а существующий элемент будет сдвинут на один индекс больше. Если индекс находится вне границ, будет выброшено исключение.

Параметры

integer $index

Индекс, в который следует вставить.

string $title

Заголовок крошки.

string|array|null $url optional null

URL крошки. Либо строка, либо массив параметров маршрута для передачи в Url::build(), либо null/пустая строка, если у крошки нет ссылки.

array $options optional []

Массив параметров. Эти параметры будут использоваться в качестве атрибутов HTML-атрибутов, в которых будет отображаться крошка (по умолчанию тег <li>). Он принимает два специальных ключа: - innerAttrs: Массив, который позволяет определить атрибуты для внутреннего элемента крошки (по умолчанию, для ссылки) - templateVars: Специфические переменные шаблона в случае переопределения предоставленных шаблонов.

Возвращает

$this

Вызывает исключение

LogicException
В случае, если индекс находится за пределами границ

insertBefore()source public

insertBefore( string $matchingTitle , string $title , string|array|null $url = null , array $options = [] )

Вставляет крошку перед первой соответствующей крошкой с указанным названием.

Находит индекс первой крошки, которая соответствует предоставленному классу, и вставляет переданный вызываемый объект перед ним.

Параметры

string $matchingTitle

Заголовок крошки, перед которой вы хотите вставить эту.

string $title

Заголовок крошки.

string|array|null $url optional null

URL крошки. Либо строка, либо массив параметров маршрута для передачи в Url::build(), либо null/пустая строка, если у крошки нет ссылки.

array $options optional []

Массив параметров. Эти параметры будут использоваться в качестве атрибутов HTML-атрибутов, в которых будет отображаться крошка (по умолчанию тег <li>). Он принимает два специальных ключа: - innerAttrs: Массив, который позволяет определить атрибуты для внутреннего элемента крошки (по умолчанию, для ссылки) - templateVars: Специфические переменные шаблона в случае переопределения предоставленных шаблонов.

Возвращает

$this

Вызывает исключение

LogicException
В случае, если соответствующая крошка не найдена

prepend()source public

prepend( string $title , string|array|null $url = null , array $options = [] )

Добавить сухарь в начало очереди.

Параметры

string $title

Если передано как строка, она представляет собой заголовок сухаря. В противном случае, если вы хотите добавить сразу несколько сухарей, можно передать массив, где каждый элемент — это один сухарь. Массивы должны иметь следующий формат: - title Заголовок сухаря - link Ссылка сухаря. Если не указано, ссылка не будет создана - options Параметры сухаря. Смотрите описание параметра params этого метода.

string|array|null $url необязательно null

URL сухаря. Может быть строкой, массивом параметров маршрута для передачи в Url::build() или null/пустым, если у сухаря нет ссылки.

array $options необязательно []

Массив параметров. Эти параметры будут использованы в качестве атрибутов HTML, в которых будет отображаться сухарь (по умолчанию тег

). Он принимает два специальных ключа: - innerAttrs: Массив, который позволяет определить атрибуты для внутреннего элемента сухаря (по умолчанию, для ссылки) - templateVars: Специфические переменные шаблона в случае переопределения предоставленных шаблонов.

Возвращает

$this

render()source public

render( array $attributes = [] , array $separator = [] )

Отображает цепочку хлебных крошек.

Параметры

array $attributes необязательно []

Массив атрибутов, применяемых к шаблону wrapper. Принимает ключ templateVars, чтобы разрешить вставку пользовательских переменных шаблона в шаблон.

array $separator необязательно []

Массив атрибутов для шаблона separator шаблона. Возможные свойства: - separator Строка, отображаемая в качестве разделителя - templateVars Разрешает вставку пользовательских переменных шаблона в шаблон - innerAttrs Для указания атрибутов, если ваш разделитель разделен на два элемента. Все остальные свойства будут преобразованы в атрибуты HTML и заменят ключ attrs в шаблоне. Если вы используете по умолчанию этот параметр (пустой), разделитель не будет отображаться.

Возвращает

string
Цепочка хлебных крошек

reset()source public

reset( )

Удаляет все существующие сухари.

Возвращает

$this

__call()source public

__call( string $method , array $params )

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

Параметры

string $method

Метод для вызова

array $params

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

__construct()source public

__construct( Cake\View\View $View , array $config = [] )

Конструктор по умолчанию

Параметры

Cake\View\View $View

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

array $config необязательно []

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

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

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

array $options необязательно []

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

Возвращает

string
Код onclick JS

addClass()source public

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

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

Параметры

array $options необязательно []

Массив параметров/атрибутов, к которым нужно добавить класс

string|null $class необязательно null

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

string $key необязательно 'class'

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

Возвращает

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

getView()source public

getView( )

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

Возвращает

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

implementedEvents()source public

implementedEvents( )

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

Определяя один из обратных вызовов, помощник предполагается, что интересуется связанным событием.

Переопределите этот метод, если вам необходимо добавить нестандартные обработчики событий. Или если вы хотите, чтобы помощники слушали нестандартные события.

Возвращает

array

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public

initialize( array $config )

Метод обратного вызова конструктора.

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

Параметры

array $config

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

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

string $name

Имя шаблона.

array $data

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

Возвращает

string

getTemplates()source public

getTemplates( string|null $template = null )

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

Параметры

string|null $template необязательно null

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

Возвращает

string|array

setTemplates()source public

setTemplates( array $templates )

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

Параметры

массив $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() вместо этого.

Параметры

строка|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

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

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

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

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

mixed $value

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

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

Параметры

строка|массив|null $key опционально null

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

mixed|null $value опционально null

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

boolean $merge опционально 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

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

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

Параметры

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

Параметры

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

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

mixed|null $value опционально null

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

boolean $merge опционально true

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

Возвращает

$this

Выбрасывает

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

[
    'templates' => [
        'wrapper' => '<ul{{attrs}}>{{content}}</ul>',
        'item' => '<li{{attrs}}><a href="{{url}}"{{innerAttrs}}>{{title}}</a></li>{{separator}}',
        'itemWithoutLink' => '<li{{attrs}}><span{{innerAttrs}}>{{title}}</span></li>{{separator}}',
        'separator' => '<li{{attrs}}><span{{innerAttrs}}>{{separator}}</span></li>'
    ]
]

[]

['Url']