Класс BreadcrumbsHelper

add()source public

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

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

Параметры

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

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

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

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

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

Массив опций. Эти опции будут использоваться в качестве атрибутов HTML-атрибутов, в которых будет отображаться сухарь (по умолчанию тег <li>). Он принимает два специальных ключа: - 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-атрибутов, в которых будет отображаться сухарь (по умолчанию тег <li>). Он принимает два специальных ключа: - 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-атрибутов, в которых будет отображаться сухарь (по умолчанию тег <li>). Он принимает два специальных ключа: - 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-атрибутов, в которых будет отображаться сухарь (по умолчанию тег <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 в шаблоне. Если вы используете по умолчанию (пустой массив), разделитель не будет отображаться.

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

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

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

Ключ для использования класса.

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

массив
Массив опций со свойством $key.

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

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

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

строка

templater()source public

templater( )

templater

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

Cake\View\StringTemplate

templates()source public

templates( string|null|array $templates null )

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

Параметры

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

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

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

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

_configDelete()source protected

_configDelete( string $key )

Удалить единственный ключ конфигурации

Параметры

строка $key

Ключ для удаления.

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

строка|null $key

Ключ для чтения.

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

смешанное

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записать переменную конфигурации

Параметры

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

Ключ для записи.

смешанное $value

Значение для записи.

boolean|строка $merge необязательно false

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

Исключения

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

Параметры

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->config('key', $value);

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

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

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

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

Параметры

string|array $key

Ключ для установки или массив настроек.

mixed|null $value необязательно null

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

Возвращает

$this Сам объект.

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