Класс 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 необязательно null

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

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

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

). Он принимает два специальных ключа: - 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 необязательно null

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

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

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

). Он принимает два специальных ключа: - 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 необязательно null

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

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

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

). Он принимает два специальных ключа: - 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 необязательно null

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

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

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

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

Возвращает

$this

Возбуждает

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

prepend()source public

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

Добавить элемент в начало очереди.

Параметры

строка $title

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

строка|массив|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'

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

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

массив
Массив параметров со значением $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

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

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