Class LogEngineRegistry

_create()source protected

_create( string|Psr\Log\LoggerInterface $class , string $alias , array $settings )

Create the logger instance.

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

Parameters

string|Psr\Log\LoggerInterface $class

The classname or object to make.

string $alias

The alias of the object.

array $settings

An array of settings to use for the logger.

Returns

Psr\Log\LoggerInterface
The constructed logger class.

Throws

RuntimeException
when an object doesn't implement the correct interface.

_resolveClassName()source protected

_resolveClassName( string $class )

Resolve a logger 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.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

Throws an exception when a logger 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 logger is missing in.

Throws

RuntimeException

unload()source public

unload( string $name )

Remove a single logger from the registry.

Parameters

string $name

The logger name.

Overrides

Cake\Core\ObjectRegistry::unload()

__debugInfo()source public

__debugInfo( )

Debug friendly object properties.

Returns

array

__get()source public

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name

Name of property to read

Returns

mixed

__isset()source public

__isset( string $name )

Provide isset access to _loaded

Parameters

string $name

Name of object being checked.

Returns

boolean

__set()source public

__set( string $name , mixed $object )

Sets an object.

Parameters

string $name

Name of a property to set.

mixed $object

Object to set.

__unset()source public

__unset( string $name )

Unsets an object.

Parameters

string $name

Name of a property to unset.

_checkDuplicate()source 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.

count()source public

count( )

Returns the number of loaded objects.

Returns

integer

Implementation of

Countable::count()

get()source public

get( string $name )

Get loaded object instance.

Parameters

string $name

Name of object.

Returns

object|null
Object instance if loaded else null.

getIterator()source public

getIterator( )

Returns an array iterator.

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()

has()source 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.

load()source 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

loaded()source public

loaded( )

Get the list of loaded objects.

Returns

array
List of object names.

normalizeArray()source 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.

reset()source 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.

Returns

$this

set()source 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

Returns

$this