TaskRegistry (class)
Class TaskRegistry
Registry for Tasks. Provides features for lazily loading tasks.
- Cake\Core\ObjectRegistry
-
Cake\Console\TaskRegistry
Method Detail
__constructsource public
__construct( Cake\Console\Shell $Shell )
Constructor
Parameters
-
Cake\Console\Shell
$Shell
- Shell instance
_createsource protected
_create( string $class , string $alias , array $settings )
Create the task instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
- string
$class
- The classname to create.
- string
$alias
- The alias of the task.
- array
$settings
- An array of settings to use for the task.
Returns
Cake\Console\Shell
The constructed task class.
_resolveClassNamesource protected
_resolveClassName( string $class )
Resolve a task classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
- string
$class
- Partial classname to resolve.
Returns
string|false
Either the correct classname or false.
_throwMissingClassErrorsource protected
_throwMissingClassError( string $class , string $plugin )
Throws an exception when a task is missing.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
- string
$class
- The classname that is missing.
- string
$plugin
- The plugin the task is missing in.
Throws
Cake\Console\Exception\MissingTaskException
\Cake\Console\Exception\MissingTaskException
Methods inherited from Cake\Core\ObjectRegistry
__getsource public
__get( string $name )
Provide public read access to the loaded objects
Parameters
- string
$name
- Name of property to read
Returns
mixed
mixed
__issetsource public
__isset( string $name )
Provide isset access to _loaded
Parameters
- string
$name
- Name of object being checked.
Returns
boolean
bool
_checkDuplicatesource protected
_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.
Parameters
- string
$name
- The name of the alias in the registry.
- array
$config
- The config data for the new instance.
Throws
RuntimeException
When a duplicate is found.
getsource public
get( string $name )
Get loaded object instance.
Parameters
- string
$name
- Name of object.
Returns
object|null
Object instance if loaded else null.
hassource public
has( string $name )
Check whether or not a given object is loaded.
Parameters
- string
$name
- The object name to check for.
Returns
boolean
True is object is loaded else false.
loadsource public
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.
Parameters
- string
$objectName
- The name/class of the object to load.
- array
$config
optional [] - Additional settings to use when loading the object.
Returns
mixed
mixed
normalizeArraysource public
normalizeArray( 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.
resetsource public
reset( )
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
setsource public
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
Parameters
- string
$objectName
- The name of the object to set in the registry.
- object
$object
- instance to store in the registry
unloadsource public
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.
Parameters
- string
$objectName
- The name of the object to remove from the registry.
Properties summary
Properties inherited from Cake\Core\ObjectRegistry
© 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