Registry for Tasks. Provides features for lazily loading tasks.
__construct( Cake\Console\Shell $Shell )
Constructor
Cake\Console\Shell
$Shell
_create( string $class , string $alias , array $settings )
Create the task instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
$class
$alias
$settings
Cake\Console\Shell
_resolveClassName( string $class )
Resolve a task classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
$class
string|false
_throwMissingClassError( string $class , string $plugin )
Throws an exception when a task is missing.
Part of the template method for Cake\Core\ObjectRegistry::load()
$class
$plugin
Cake\Console\Exception\MissingTaskException
__get( string $name )
Provide public read access to the loaded objects
$name
mixed
__isset( string $name )
Provide isset access to _loaded
$name
boolean
_checkDuplicate( string $name , array $config )
Check for duplicate object loading.
If a duplicate is being loaded and has different configuration, that is bad and an exception will be raised.
An exception is raised, as replacing the object will not update any references other objects may have. Additionally, simply updating the runtime configuration is not a good option as we may be missing important constructor logic dependent on the configuration.
$name
$config
RuntimeException
get( string $name )
Get loaded object instance.
$name
object|null
has( string $name )
Check whether or not a given object is loaded.
$name
boolean
load( string $objectName , array $config [] )
Loads/constructs an object instance.
Will return the instance in the registry if it already exists. If a subclass provides event support, you can use $config['enabled'] = false
to exclude constructed objects from being registered for events.
Using Cake\Controller\Controller::$components as an example. You can alias an object by setting the 'className' key, i.e.,
public $components = [ 'Email' => [ 'className' => '\App\Controller\Component\AliasedEmailComponent' ]; ];
All calls to the Email
component would use AliasedEmail
instead.
$objectName
$config
optional [] mixed
normalizeArray( array $objects )
Normalizes an object array, creates an array that makes lazy loading easier
$objects
array
reset( )
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
set( string $objectName , object $object )
Set an object directly into the registry by name.
If this collection implements events, the passed object will be attached into the event manager
$objectName
$object
unload( string $objectName )
Remove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
$objectName
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Console.TaskRegistry.html