Класс BreadcrumbsHelper

add()source public

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

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

Параметры

string|array $title

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

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

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

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

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

Возвращаемое значение

$this

findCrumb()source protected

findCrumb( string $title )

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

Параметры

строка $title

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

Возвращает

integer|null
Индекс найденного сухаря или null, если он не может быть найден.

getCrumbs()source public

getCrumbs( )

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

Возвращает

array

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
Экземпляр помощника, если помощник с указанным именем существует

_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
Значение конфигурации.

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