CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.2 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.2
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
      • Exception
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class TaskRegistry

Registry for Tasks. Provides features for lazily loading tasks.

Namespace: Cake\Console

Property Summary

  • $_Shell protected
    Cake\Console\Shell

    Shell to use to set params to tasks.

  • $_loaded protected
    array

    Map of loaded objects.

Method Summary

  • __construct() public

    Constructor

  • __debugInfo() public

    Debug friendly object properties.

  • __get() public

    Provide public read access to the loaded objects

  • __isset() public

    Provide isset access to _loaded

  • _checkDuplicate() protected

    Check for duplicate object loading.

  • _create() protected

    Create the task instance.

  • _resolveClassName() protected

    Resolve a task classname.

  • _throwMissingClassError() protected

    Throws an exception when a task is missing.

  • get() public

    Get loaded object instance.

  • has() public

    Check whether or not a given object is loaded.

  • load() public

    Loads/constructs an object instance.

  • loaded() public

    Get the list of loaded objects.

  • normalizeArray() public

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

  • reset() public

    Clear loaded instances in the registry.

  • set() public

    Set an object directly into the registry by name.

  • unload() public

    Remove an object from the registry.

Method Detail

__construct() ¶ public

__construct(Cake\Console\Shell $Shell)

Constructor

Parameters
Cake\Console\Shell $Shell

Shell instance

__debugInfo() ¶ public

__debugInfo(): array

Debug friendly object properties.

Returns
array

__get() ¶ public

__get(string $name): mixed

Provide public read access to the loaded objects

Parameters
string $name

Name of property to read

Returns
mixed

__isset() ¶ public

__isset(string $name): bool

Provide isset access to _loaded

Parameters
string $name

Name of object being checked.

Returns
bool

_checkDuplicate() ¶ protected

_checkDuplicate(string $name, array $config): void

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.

Returns
void
Throws
RuntimeException
When a duplicate is found.

_create() ¶ protected

_create(string $class, string $alias, array $settings): Cake\Console\Shell

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

_resolveClassName() ¶ protected

_resolveClassName(string $class): string|false

Resolve a task classname.

Part of the template method for Cake\Core\ObjectRegistry::load()

Parameters
string $class

Partial classname to resolve.

Returns
string|false

_throwMissingClassError() ¶ protected

_throwMissingClassError(string $class, string $plugin): void

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.

Returns
void
Throws
Cake\Console\Exception\MissingTaskException

get() ¶ public

get(string $name): object|null

Get loaded object instance.

Parameters
string $name

Name of object.

Returns
object|null

has() ¶ public

has(string $name): bool

Check whether or not a given object is loaded.

Parameters
string $name

The object name to check for.

Returns
bool

load() ¶ public

load(string $objectName, array $config = []): mixed

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

loaded() ¶ public

loaded(): array

Get the list of loaded objects.

Returns
array

normalizeArray() ¶ public

normalizeArray(array $objects): array

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

Parameters
array $objects

Array of child objects to normalize.

Returns
array

reset() ¶ public

reset(): void

Clear loaded instances in the registry.

If the registry subclass has an event manager, the objects will be detached from events as well.

Returns
void

set() ¶ public

set(string $objectName, object $object): void

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

Returns
void

unload() ¶ public

unload(string $objectName): void

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.

Returns
void

Property Detail

$_Shell ¶ protected

Shell to use to set params to tasks.

Type
Cake\Console\Shell

$_loaded ¶ protected

Map of loaded objects.

Type
array
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs