Class TaskCollection

Collection object for Tasks. Provides features for lazily loading tasks, and firing callbacks on loaded tasks.

TaskCollection

Package: Cake\Console
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Console/TaskCollection.php

Properties summary

$_Shell protected

Shell

Shell to use to set params to tasks.
$taskPathPrefix public

string

The directory inside each shell path that contains tasks.

Inherited Properties

_enabled, _loaded, defaultPriority

Method Summary

__construct() public

Constructor
load() public

Loads/constructs a task. Will return the instance in the registry if it already exists.

Method Detail

__construct() public ¶

__construct( Shell $Shell )

Constructor

Parameters

Shell $Shell: The shell this task collection is attached to.

load() public ¶

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

Loads/constructs a task. Will return the instance in the registry if it already exists.

You can alias your task as an existing task by setting the 'className' key, i.e.,

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

All calls to the DbConfig task would use DbConfigure found in the Bakeplus plugin instead.

Parameters

string $task: Task name to load
array $settings optional array(): Settings for the task.

Returns

AppShell
A task object, Either the existing loaded task or a new one.

Throws

MissingTaskException
when the task could not be found

Methods inherited from ObjectCollection

__get() public ¶

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name: Name of property to read

Returns

mixed

__isset() public ¶

__isset( string $name )

Provide isset access to _loaded

Parameters

string $name: Name of object being checked.

Returns

boolean

attached() public deprecated ¶

attached( string $name = null )

Gets the list of attached objects, or, whether the given object is attached

Deprecated

3.0.0 Will be removed in 3.0. Use loaded instead.

Parameters

string $name optional null: Optional. The name of the object to check the status of. If omitted, returns an array of currently-attached objects

Returns

mixed

If $name is specified, returns the boolean status of the corresponding object. Otherwise, returns an array of all attached objects.

disable() public ¶

disable( string|array $name )

Disables callbacks on an object or array of objects. Public object methods are still callable as normal.

Parameters

string|array $name: CamelCased name of the objects(s) to disable (string or array)

enable() public ¶

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

Enables callbacks on an object or array of objects

Parameters

string|array $name: CamelCased name of the object(s) to enable (string or array)
boolean $prioritize optional true: Prioritize enabled list after enabling object(s)

enabled() public ¶

enabled( string $name = null )

Gets the list of currently-enabled objects, or, the current status of a single objects

Parameters

string $name optional null: Optional. The name of the object to check the status of. If omitted, returns an array of currently-enabled object

Returns

mixed

If $name is specified, returns the boolean status of the corresponding object. Otherwise, returns an array of all enabled objects.

loaded() public ¶

loaded( string $name = null )

Gets the list of loaded objects, or, whether the given object is loaded

Parameters

string $name optional null: Optional. The name of the object to check the status of. If omitted, returns an array of currently-loaded objects

Returns

mixed

If $name is specified, returns the boolean status of the corresponding object. Otherwise, returns an array of all loaded objects.

normalizeObjectArray() public static ¶

normalizeObjectArray( array $objects )

Normalizes an object array, creates an array that makes lazy loading easier

Parameters

array $objects: Array of child objects to normalize.

Returns

array
Array of normalized objects.

prioritize() public ¶

prioritize( )

Prioritize list of enabled object

Returns

array
Prioritized list of object

set() public ¶

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

Adds or overwrites an instantiated object to the collection

Parameters

string $name optional null: Name of the object
CakeObject $object optional null: The object to use

Returns

array
Loaded objects

setPriority() public ¶

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

Set priority for an object or array of objects

Parameters

string|array $name: CamelCased name of the object(s) to enable (string or array) If string the second param $priority is used else it should be an associative array with keys as object names and values as priorities to set.
integer|null $priority optional null: Integer priority to set or null for default

trigger() public ¶

trigger( string|CakeEvent $callback , array $params = array() , array $options = array() )

Trigger a callback method on every object in the collection. Used to trigger methods on objects in the collection. Will fire the methods in the order they were attached.

Options

breakOn Set to the value or values you want the callback propagation to stop on. Can either be a scalar value, or an array of values to break on. Defaults to false.
break Set to true to enabled breaking. When a trigger is broken, the last returned value will be returned. If used in combination with collectReturn the collected results will be returned. Defaults to false.
collectReturn Set to true to collect the return of each object into an array. This array of return values will be returned from the trigger() call. Defaults to false.
modParams Allows each object the callback gets called on to modify the parameters to the next object. Setting modParams to an integer value will allow you to modify the parameter with that index. Any non-null value will modify the parameter index indicated. Defaults to false.

Parameters

string|CakeEvent $callback: Method to fire on all the objects. Its assumed all the objects implement the method you are calling. If an instance of CakeEvent is provided, then then Event name will parsed to get the callback name. This is done by getting the last word after any dot in the event name (eg. Model.afterSave event will trigger the afterSave callback)
array $params optional array(): Array of parameters for the triggered callback.
array $options optional array(): Array of options.

Returns

mixed
Either the last result or all results if collectReturn is on.

Throws

CakeException
when modParams is used with an index that does not exist.

unload() public ¶

unload( string $name )

Name of the object to remove from the collection

Parameters

string $name: Name of the object to delete.

Properties detail

`$_Shell` ¶

protected Shell

Shell to use to set params to tasks.

`$taskPathPrefix` ¶

public string

The directory inside each shell path that contains tasks.

'tasks/'

Packages

Classes

Class TaskCollection

Properties summary

Inherited Properties

Method Summary

__construct() public

load() public

Method Detail

__construct() public ¶

Parameters

load() public ¶

Parameters

Returns

Throws

Methods inherited from ObjectCollection

__get() public ¶

Parameters

Returns

__isset() public ¶

Parameters

Returns

attached() public deprecated ¶

Deprecated

Parameters

Returns

disable() public ¶

Parameters

enable() public ¶

Parameters

enabled() public ¶

Parameters

Returns

loaded() public ¶

Parameters

Returns

normalizeObjectArray() public static ¶

Parameters

Returns

prioritize() public ¶

Returns

set() public ¶

Parameters

Returns

setPriority() public ¶

Parameters

trigger() public ¶

Options

Parameters

Returns

Throws

unload() public ¶

Parameters

Properties detail

$_Shell ¶

$taskPathPrefix ¶

`$_Shell` ¶

`$taskPathPrefix` ¶