Класс BreadcrumbsHelper

BreadcrumbsHelper для регистрации и отображения навигационной цепочки для ваших представлений

Пространство имён: Cake\View\Helper

Краткое описание свойств

$Url public @property

Cake\View\Helper\UrlHelper
$_View protected

Cake\View\View

Экземпляр представления, к которому прикреплен данный помощник
$_config protected

array

Конфигурация во время выполнения
$_configInitialized protected

bool

Указывает, была ли конфигурация свойств уже настроена по умолчанию
$_defaultConfig protected

array

Конфигурация по умолчанию для помощника.
$_helperMap protected

array

Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
$_templater protected

Cake\View\StringTemplate|null

Экземпляр StringTemplate.
$crumbs protected

array

Список крошек.
$helpers protected

array

Другие помощники, используемые BreadcrumbsHelper.

Краткое описание методов

__call() public

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

Конструктор по умолчанию
__debugInfo() public

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

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

Удаляет один ключ конфигурации.
_configRead() protected

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

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

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

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

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

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
findCrumb() protected

Ищет крошку в текущем стеке, заголовок которой соответствует предоставленному в качестве аргумента. Если найдена, будет возвращён индекс соответствующей крошки.
formatTemplate() public

Форматирует шаблонную строку с данными $data
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
getCrumbs() public

Возвращает список крошек.
getTemplates() public

Получает шаблоны для использования или определённый шаблон.
getView() public

Получает экземпляр представления, к которому привязан данный помощник.
implementedEvents() public

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

Метод обработчик конструктора.
insertAfter() public

Вставляет крошку после первой подходящей крошки с указанным названием.
insertAt() public

Вставляет крошку в указанный индекс.
insertBefore() public

Вставляет крошку перед первой подходящей крошкой с указанным названием.
prepend() public

Добавляет крошку в начало очереди.
render() public

Отображает навигационную цепочку.
reset() public

Удаляет все существующие крошки.
setConfig() public

Устанавливает конфигурацию.
setTemplates() public

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

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

Подробное описание методов

__call() public

__call(string $method, array $params): mixed|void

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

Параметры

string $method: Метод для вызова
array $params: Массив параметров для метода.

Возвращает

mixed|void

__construct() public

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

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

Параметры

Cake\View\View $view: Представление, к которому прикреплен этот помощник.
array $config optional: Настройки конфигурации для помощника.

__debugInfo() public

__debugInfo(): array

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

Возвращает

array

__get() public

__get(string $name): Cake\View\Helper|null|void

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

Параметры

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

Возвращает

Cake\View\Helper|null|void

_configDelete() protected

_configDelete(string $key): void

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

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

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

_configRead() protected

_configRead(string|null $key): mixed

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

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: Истинно, чтобы выполнить рекурсивное слияние, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.

Возвращает

void

Выбрасывает

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

_confirm() protected

_confirm(string $okCode, string $cancelCode): string

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

Параметры

string $okCode: Код, который выполняется после выбора пользователем 'OK'
string $cancelCode: Код, который выполняется после выбора пользователем 'Отмена'

Возвращает

string

add() public

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

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

Параметры

string|array $title

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

string|array|null $url optional

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

array $options optional

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

). Он принимает два специальных ключа:

Возвращает

$this

addClass() public

addClass(array $options, string $class, string $key = 'class'): array

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

Параметры

array $options: Массив опций/атрибутов для добавления класса.
string $class: Имя добавляемого класса.
string $key optional: Ключ для использования класса. По умолчанию 'class'.

Возвращает

array

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

findCrumb() protected

findCrumb(string $title): int|null

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

Параметры

string $title: Заголовок для поиска.

Возвращает

int|null

formatTemplate() public

formatTemplate(string $name, array $data): string

Форматирует шаблонную строку с помощью $data

Параметры

string $name: Имя шаблона.
array $data: Данные для вставки.

Возвращает

string

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для данного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getCrumbs() public

getCrumbs(): array

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

Возвращает

array

getTemplates() public

getTemplates(string|null $template = null): string|array

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

Параметры

string|null $template optional: Строка для чтения определенного шаблона, null для всех.

Возвращает

string|array

getView() public

getView(): Cake\View\View

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

Возвращает

Cake\View\View

implementedEvents() public

implementedEvents(): array

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

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

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

Возвращает

array

initialize() public

initialize(array $config): void

Метод инициализации.

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

Параметры

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

Возвращает

void

insertAfter() public

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

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

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

Параметры

string $matchingTitle

Заголовок крошки, после которой необходимо вставить текущую.

string $title

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

string|array|null $url optional

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

array $options optional

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

). Поддерживает два специальных ключа:

Возвращает

$this

Выбрасывает

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

insertAt() public

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

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

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

Параметры

int $index

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

string $title

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

string|array|null $url optional

array $options optional

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

). Поддерживает два специальных ключа:

Возвращает

$this

Выбрасывает

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

insertBefore() public

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

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

Параметры

string $matchingTitle

Заголовок крошки, перед которой необходимо вставить текущую.

string $title

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

string|array|null $url optional

array $options optional

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

). Поддерживает два специальных ключа:

Возвращает

$this

Выбрасывает

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

prepend() public

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

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

Параметры

string|array $title

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

string|array|null $url optional

array $options optional

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

). Поддерживает два специальных ключа:

Возвращает

$this

render() public

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

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

Параметры

array $attributes optional: Массив атрибутов, применяемых к шаблону wrapper. Принимает ключ templateVars, позволяющий вставить пользовательские переменные шаблона в шаблон.
array $separator optional: Массив атрибутов для шаблона separator. Возможные свойства:

Возвращает

string

reset() public

reset(): $this

Удаляет все существующие крошки.

Возвращает

$this

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка определённого значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Выбрасывает

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

setTemplates() public

setTemplates(string[] $templates): $this

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

Параметры

string[] $templates: Шаблоны для добавления.

Возвращает

$this

templater() public

templater(): Cake\View\StringTemplate

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

Возвращает

Cake\View\StringTemplate

Подробное описание свойств

`$Url` public @property

Тип

Cake\View\Helper\UrlHelper

`$_View` protected

Экземпляр View, к которому прикреплен этот помощник

Тип

Cake\View\View

`$_config` protected

Конфигурация во время выполнения

Тип

array

`$_configInitialized` protected

Указывает, была ли конфигурация свойства уже настроена по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для помощника.

Тип

array

`$_helperMap` protected

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

Тип

array

`$_templater` protected

Экземпляр StringTemplate.

Тип

Cake\View\StringTemplate|null

`$crumbs` protected

Список крошек.

Тип

array

`$helpers` protected

Другие помощники, используемые BreadcrumbsHelper.

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.View.Helper.BreadcrumbsHelper.html