Класс BreadcrumbsHelper

add()source public

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

Добавить крошку в конец навигационной цепочки.

Параметры

string|array $title

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

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

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

Параметры

строка $title

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

_confirm()source protected

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

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

Параметры

строка $message

Сообщение, которое будет отображено

строка $okCode

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

строка $cancelCode необязательно ''

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

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

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

Возвращает

строка
JS-код onclick

addClass()source public

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

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

Параметры

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

Массив параметров/атрибутов для добавления класса

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

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

строка $key необязательно 'class'

Ключ, используемый для класса.

Возвращает

массив
Массив параметров с установленным $ключом.

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 )

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

Параметры

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

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

Истинно для рекурсивного слияния, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.

Исключение

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

config()source public

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

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

Возвращает

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
Считываемое значение конфигурации.

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

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

Возвращает

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