Класс BreadcrumbsHelper

add()source public

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

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

Параметры

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

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

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

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

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

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

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

Возвращает

$this

findCrumb()source protected

findCrumb( string $title )

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

Параметры

строка $title

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

Возвращает

целое число|null
Индекс найденного сухаря или null, если сухарь не найден.

getCrumbs()source public

getCrumbs( )

Возвращает список сухарей.

Возвращает

массив

insertAfter()source public

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

Вставляет сухарь после первого соответствующего сухаря с указанным заголовком.

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

Параметры

строка $matchingTitle

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

строка $title

Заголовок сухаря.

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

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

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

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

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

Возвращает

$this

Выбрасывает

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

insertAt()source public

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

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

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

Параметры

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

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

строка $title

Заголовок сухаря.

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

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

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

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

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

Возвращает

$this

Выбрасывает

LogicException
В случае, если индекс выходит за пределы

insertBefore()source public

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

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

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

Параметры

строка $matchingTitle

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

строка $title

Заголовок сухаря.

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

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

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

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

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

Возвращает

$this

Выбрасывает

LogicException
В случае, если соответствующий сухарь не найден

prepend()source public

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

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

Параметры

строка $title

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

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

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

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

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

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

Возвращает

$this

render()source public

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

Отображает след хлебных крошек.

Параметры

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

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

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

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

Возвращает

строка
След хлебных крошек

reset()source public

reset( )

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

Возвращает

$this

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__construct()source public

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

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

Параметры

Cake\View\View $View

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

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

Параметры настройки помощника.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__set()source public

__set( string $name , mixed $value )

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

Параметры

строка $name

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

смешанное $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

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

Параметры

строка $message

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

Возвращает

смешанное

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

строка $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
Экземпляр привязанного представления.

implementedEvents()source public

implementedEvents( )

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

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

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

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

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 deprecated

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

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

Устарело

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

Параметры

string|null|array $templates необязательно 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 необязательно 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 необязательно 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']);

Параметры

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

Параметры

string|array $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']