Класс TaskCollection

__construct()source public

__construct( Shell $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()

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

Возвращает

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

Исключения

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 , 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.

Параметры

string|CakeEvent $callback

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

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

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

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

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

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

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

Исключения

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

unload()source public

unload( string $name )

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

Параметры

string $name

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

'tasks/'