Класс HelperCollection

__construct()source public

__construct( View $view )

Конструктор

Параметры

View $view

Экземпляр представления.

__get()source public

__get( string $name )

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

Параметры

строка $name

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

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

mixed

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

ObjectCollection::__get()

__isset()source public

__isset( string $helper )

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

Параметры

строка $helper

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

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

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

Вызывает исключение

MissingHelperException

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

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

ObjectCollection::__isset()

implementedEvents()source public

implementedEvents( )

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

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

массив

Реализация

CakeEventListener::implementedEvents()

load()source 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
если помощник не найден

trigger()source 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()

attached()source public

attached( string $name null )

Возвращает список присоединённых объектов или состояние прикрепления указанного объекта.

Устарело

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

Параметры

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

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

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

mixed

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

disable()source public

disable( string|array $name )

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

Параметры

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

Имя (или имена) объектов в формате CamelCase (строка или массив)

enable()source public

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

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

Параметры

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

Имя (или имена) объектов в формате CamelCase (строка или массив)

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

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

enabled()source public

enabled( string $name null )

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

Параметры

string $name необязательно null

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

Возвращает

mixed

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

loaded()source public

loaded( string $name null )

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

Параметры

string $name необязательно null

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

Возвращает

mixed

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

normalizeObjectArray()source public static

normalizeObjectArray( array $objects )

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

Параметры

array $objects

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

Возвращает

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

prioritize()source public

prioritize( )

Устанавливает приоритеты для списка активных объектов.

Возвращает

array
Список объектов с приоритетами

set()source public

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

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

Параметры

string $name необязательно null

Имя объекта

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

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

Возвращает

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

setPriority()source public

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

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

Параметры

string|array $name

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

integer|null $priority необязательно null

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

unload()source public

unload( string $name )

Имя объекта для удаления из коллекции.

Параметры

string $name

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