Класс TaskCollection

__construct()source public

__construct( Shell $Shell )

Конструктор

Параметры

Shell $Shell

Оболочка, к которой прикреплена эта коллекция задач.

load()source public

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

Загружает/создаёт задачу. Вернёт экземпляр из реестра, если он уже существует.

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

public $tasks = array(
'DbConfig' => array(
'className' => 'Bakeplus.DbConfigure'
);
);

Все вызовы к задаче DbConfig будут использовать задачу DbConfigure, которая находится в плагине Bakeplus.

Параметры

строка $task

Имя задачи для загрузки

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

Настройки для задачи.

Возвращает

Задача
Объект задачи, либо уже загруженную, либо новую.

Исключения

MissingTaskException
если задача не найдена

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанное

__isset()source public

__isset( string $name )

Предоставляет доступ isset к _loaded

Параметры

строка $name

Имя проверяемого объекта.

Возвращает

boolean

attached()source public

attached( string $name null )

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

Устарело

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

Параметры

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

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

Возвращает

смешанное

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

disable()source public

disable( string|array $name )

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

Параметры

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

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

enable()source public

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

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

Параметры

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

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

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

Установить список включённых объектов после включения

enabled()source public

enabled( string $name null )

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

Параметры

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

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

Возвращает

смешанное

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

loaded()source public

loaded( string $name null )

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

Параметры

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

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

Возвращает

смешанное

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

normalizeObjectArray()source public static

normalizeObjectArray( array $objects )

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

Параметры

массив $objects

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

Возвращает

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

prioritize()source public

prioritize( )

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

Возвращает

массив
Приоритетизированный список объектов

set()source public

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

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

Параметры

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

Имя объекта

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

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

Возвращает

массив
Загруженные объекты

setPriority()source public

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

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

Параметры

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

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

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

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

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 с индексом, который не существует.

unload()source public

unload( string $name )

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

Параметры

строка $name

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

'tasks/'