Класс HelperCollection

__construct()source public

__construct( View $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 необязательно массив()

Массив опций.

Возвращает

смешанное
Либо последнее возвращенное значение, либо все результаты, если включен collectReturn.

Исключения

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

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

ObjectCollection::trigger()

attached()source public

attached( string $name null )

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

Устарело

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

Параметры

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

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

Возвращает

смешанное

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

disable()source public

disable( string|array $name )

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

Параметры

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

Имя (или имена) объектов в формате ВерблюжийРегистр (строка или массив)

enable()source public

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

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

Параметры

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

Имя (или имена) объектов в формате ВерблюжийРегистр (строка или массив)

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

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

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 , CakeObject $object null )

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

Параметры

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

Имя объекта

CakeObject $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

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