Класс HelperCollection

__construct()source public

__construct( View $view )

Конструктор

Параметры

View $view

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

__get()source public

__get( string $name )

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

Параметры

string $name

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

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

mixed

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

ObjectCollection::__get()

__isset()source public

__isset( string $helper )

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

Параметры

string $helper

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

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

boolean
Флаг успешной загрузки помощника

Исключения

MissingHelperException

Возникает, когда помощник не найден. Поиск производится сначала в помощниках приложения, а затем в помощниках плагинов.

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

ObjectCollection::__isset()

implementedEvents()source public

implementedEvents( )

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

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

array

Реализация

CakeEventListener::implementedEvents()

load()source public

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

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

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

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

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

Параметры

string $helper

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

array $settings optional array()

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

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

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.

Параметры

string|CakeEvent $callback

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

array $params optional array()

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

array $options optional array()

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

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

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

Исключения

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

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

ObjectCollection::trigger()

attached()source public

attached( string $name null )

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

Устарело

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

Параметры

string $name optional null

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

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

mixed

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

disable()source public

disable( string|array $name )

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

Параметры

string|array $name

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

enable()source public

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

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

Параметры

string|array $name

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

boolean $prioritize optional 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

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