Класс BreadcrumbsHelper

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

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

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

$Url public @property

Cake\View\Helper\UrlHelper
$_View protected

Cake\View\View

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

array<string, mixed>

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

bool

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

array<string, mixed>

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

array<string, 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<string, mixed> $config = [])

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

Параметры

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

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

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

Возвращает

void

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

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

_confirm() protected

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

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

Параметры

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

Возвращает

string

add() public

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

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

Параметры

array|string $title: Если предоставлен как строка, он представляет заголовок элемента. В качестве альтернативы, если вы хотите добавить несколько элементов одновременно, вы можете предоставить массив, где каждое значение является одним элементом. Ожидается, что массивы будут иметь следующий формат:
array|string|null $url optional: URL элемента. Либо строка, либо массив параметров маршрута для передачи в Url::build(), либо null/пустое значение, если элемент не имеет ссылки.
array<string, mixed> $options optional: Массив параметров. Эти параметры будут использоваться в качестве атрибутов HTML-атрибута, в котором будет отображаться элемент (по умолчанию тег

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

Возвращает

$this

addClass() public

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

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

Параметры

array<string, mixed> $options: Массив параметров/атрибутов для добавления класса.
string $class: Добавляемое имя класса.
string $key optional: Ключ для использования для класса. По умолчанию 'class'.

Возвращает

array<string, mixed>

configShallow() public

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

$this

findCrumb() protected

findCrumb(string $title): int|null

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

Параметры

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

Возвращает

int|null

formatTemplate() public

formatTemplate(string $name, array<string, mixed> $data): string

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

Параметры

string $name: Имя шаблона.
array<string, mixed> $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): array|string

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

Параметры

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

Возвращает

array|string

getView() public

getView(): Cake\View\View

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

Возвращает

Cake\View\View

implementedEvents() public

implementedEvents(): array<string, mixed>

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

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

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

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

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

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

Параметры

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

Возвращает

void

insertAfter() public

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

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

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

Параметры

string $matchingTitle

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

string $title

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

array|string|null $url optional

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

array<string, mixed> $options optional

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

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

Возвращает

$this

Исключения

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

insertAt() public

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

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

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

Если индекс выходит за пределы границ, будет выброшено исключение.

Параметры

int $index

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

string $title

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

array|string|null $url optional

array<string, mixed> $options optional

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

Возвращает

$this

Исключения

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

insertBefore() public

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

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

Параметры

string $matchingTitle

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

string $title

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

array|string|null $url optional

array<string, mixed> $options optional

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

Возвращает

$this

Исключения

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

prepend() public

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

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

Параметры

array|string $title

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

array|string|null $url optional

array<string, mixed> $options optional

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

Возвращает

$this

render() public

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

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

Параметры

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

Возвращает

string

reset() public

reset(): $this

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

Возвращает

$this

setConfig() public

setConfig(array<string, mixed>|string $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']);

Параметры

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

Возвращает

$this

Исключения

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

setTemplates() public

setTemplates(array<string> $templates): $this

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

Параметры

array<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<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

Тип

array<string, mixed>

`$_helperMap` protected

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

Тип

array<string, 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.3/class-Cake.View.Helper.BreadcrumbsHelper.html