Класс TaskCollection

__constructsource public

__construct( Shell $Shell )

Конструктор

Параметры

Shell $Shell

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

loadsource public

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

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

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

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

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

Параметры

строка $task

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

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

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

Возвращает

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

Исключения

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

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
смешанный тип

__issetsource public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
булево значение

attachedsource public

attached( string $name null )

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

Устаревший

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

Параметры

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

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

Возвращает

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

disablesource public

disable( string|array $name )

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

Параметры

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

Имя объекта(ов) с большой буквы (строка или массив) для отключения.

enablesource public

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

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

Параметры

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

Имя объекта(ов) с большой буквы (строка или массив) для включения.

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

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

enabledsource public

enabled( string $name null )

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

Параметры

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

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

Возвращает

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

loadedsource public

loaded( string $name null )

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

Параметры

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

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

Возвращает

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

normalizeObjectArraysource public static

normalizeObjectArray( array $objects )

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

Параметры

массив $objects

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

Возвращает

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

prioritizesource public

prioritize( )

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

Возвращает

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

setsource public

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

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

Параметры

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

Имя объекта.

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

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

Возвращает

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

setPrioritysource public

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

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

Параметры

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

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

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

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

triggersource 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 необязательно array()

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

array $options необязательно array()

Массив параметров.

Возвращает

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

Исключения

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

unloadsource public

unload( string $name )

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

Параметры

string $name

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

'tasks/'

array()

array()

10