Класс HelperCollection

__constructsource public

__construct( View $view )

Конструктор

Параметры

View $view

Экземпляр View.

__getsource public

__get( string $name )

Предоставляет публичный доступ для чтения к загруженным объектам.

Параметры

string $name

Имя свойства для чтения

Возвращает

mixed
смешанный тип

Переопределяет

ObjectCollection::__get()

__issetsource public

__isset( string $helper )

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

Параметры

string $helper

Имя помощника для загрузки

Возвращает

boolean
можно ли загрузить помощник или нет

Исключения

MissingHelperException
Если помощник не найден. Сначала проверяются помощники приложения, затем плагинов.

Переопределяет

ObjectCollection::__isset()

implementedEventssource public

implementedEvents( )

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

Возвращает

array
массив

Реализация

CakeEventListener::implementedEvents()

loadsource public

load( string $helper , array $settings array() )

Загружает/создаёт помощник. Вернёт экземпляр из реестра, если он уже существует. Установив $enable в false, вы можете отключить обратные вызовы для помощника. В качестве альтернативы, можно установить $settings['enabled'] = false для отключения обратных вызовов. Этот псевдоним предоставляется для того, чтобы при объявлении массивов $helpers вы могли отключить обратные вызовы для помощников.

Вы можете задать псевдоним помощника как существующий помощник, установив ключ 'className', например:

public $helpers = array(
  'Html' => array(
    'className' => 'AliasedHtml'
  );
);

Все вызовы помощника Html будут использовать AliasedHtml вместо него.

Параметры

строка $helper

Имя помощника для загрузки

массив $settings необязательно массив()

Настройки для помощника.

Возвращает

Helper
Объект помощника, либо уже загруженный помощник, либо новый.

Выбрасывает

MissingHelperException
если помощник не найден

triggersource public

trigger( string|CakeEvent $callback , array $params array() , array $options array() )

Вызывает метод обратного вызова для каждого объекта в коллекции. Используется для вызова методов объектов в коллекции. Методы будут вызываться в порядке их добавления.

Параметры

• breakOn Установите значение или значения, на которых должна остановиться передача обратного вызова. Может быть скалярным значением или массивом значений для остановки. По умолчанию false.
• break Установите в true для включения остановки. При прерывании обратного вызова возвращается последнее возвращенное значение. Если используется в сочетании с collectReturn, возвращаются собранные результаты. По умолчанию false.
• collectReturn Установите в true для сбора результатов каждого объекта в массив. Этот массив значений возврата будет возвращен вызовом trigger(). По умолчанию false.
• modParams Позволяет каждому объекту изменять параметры для следующего объекта. Установка modParams в целое число позволит изменить параметр с указанным индексом. Любое ненулевое значение будет изменять параметр с указанным индексом. По умолчанию false.

Параметры

строка/CakeEvent $callback

Метод, который необходимо вызвать для всех объектов. Предполагается, что все объекты реализуют вызываемый метод. Если предоставлен экземпляр CakeEvent, тогда имя события будет обработано для получения имени обратного вызова. Это делается путем получения последнего слова после любого разделителя в имени события (например, событие Model.afterSave вызовет обратный вызов afterSave).

массив $params необязательно массив()

Массив параметров для вызываемого обратного вызова.

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

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

Возвращает

mixed
Либо последнее значение, либо все значения, если включен collectReturn.

Выбрасывает

CakeException
при использовании modParams с несуществующим индексом.

Переопределяет

ObjectCollection::trigger()

attachedsource public

attached( string $name null )

Получает список присоединённых объектов или статус присоединённости объекта.

Устаревшее

3.0.0 Будет удалено в 3.0. Используйте loaded вместо этого.

Параметры

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

Необязательно. Имя объекта для проверки статуса. Если опущено, возвращает массив текущих присоединённых объектов

Возвращает

mixed
Если $name указан, возвращает булево значение статуса соответствующего объекта. В противном случае возвращает массив всех присоединённых объектов.

disablesource public

disable( string|array $name )

Отключает обратные вызовы для объекта или массива объектов. Публичные методы объекта по-прежнему вызываемы как обычно.

Параметры

строка/массив $name

Имя объекта(ов) с большой буквы для отключения (строка или массив)

enablesource public

enable( string|array $name , boolean $prioritize true )

Включает обратные вызовы для объекта или массива объектов

Параметры

строка/массив $name

Имя объекта(ов) с большой буквы для включения (строка или массив)

булево $prioritize необязательно true

Установить приоритет для включённого списка после включения объекта(ов)

enabledsource public

enabled( string $name null )

Получает список текущих активных объектов или текущий статус одиночного объекта

Параметры

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

Необязательно. Имя объекта для проверки статуса. Если опущено, возвращает массив текущих активных объектов

Возвращает

mixed
Если $name указан, возвращает булево значение статуса соответствующего объекта. В противном случае возвращает массив всех активных объектов.

loadedsource public

loaded( string $name null )

Получает список загруженных объектов или статус загрузки объекта.

Параметры

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

Необязательно. Имя объекта для проверки статуса. Если опущено, возвращает массив текущих загруженных объектов

Возвращает

mixed
Если $name указан, возвращает булево значение статуса соответствующего объекта. В противном случае возвращает массив всех загруженных объектов.

normalizeObjectArraysource public static

normalizeObjectArray( array $objects )

Нормализует массив объектов, создаёт массив, который облегчает ленивую загрузку

Параметры

массив $objects

Массив дочерних объектов для нормализации.

Возвращает

array
Массив нормализованных объектов.

prioritizesource public

prioritize( )

Приоритетизировать список включенных объектов

Возвращает

array
Отсортированный по приоритету список объектов

setsource public

set( string $name null , Object $object null )

Добавляет или перезаписывает экземпляр объекта в коллекцию

Параметры

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

Имя объекта

Object $object необязательно null

Объект для использования

Возвращает

array
Загруженные объекты

setPrioritysource public

setPriority( string|array $name , integer|null $priority null )

Установить приоритет для объекта или массива объектов

Параметры

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

Имя объекта в формате CamelCase (строка или массив). Если строка, используется второй параметр $priority. В противном случае должен быть ассоциативный массив, где ключи — имена объектов, а значения — приоритеты.

целое число|null $priority необязательно null

Целое число приоритета или null для значения по умолчанию

unloadsource public

unload( string $name )

Имя объекта, который нужно удалить из коллекции

Параметры

строка $name

Имя удаляемого объекта.

array()

array()

10