Класс 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

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

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

булево

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 (строка или массив)

булево $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 , Object $object null )

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

Параметры

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

Имя объекта

Object $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.

Параметры

string|CakeEvent $callback

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

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

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

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

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

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

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

Исключения

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

unload()source public

unload( string $name )

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

Параметры

строка $name

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

'tasks/'