Class LogEngineRegistry
Registry of loaded log engines
Property Summary
-
$_loaded protected
array<string, object>
Map of loaded objects.
Method Summary
-
__debugInfo() public
Debug friendly object properties.
-
__get() public
Provide public read access to the loaded objects
-
__isset() public
Provide isset access to _loaded
-
__set() public
Sets an object.
-
__unset() public
Unsets an object.
-
_checkDuplicate() protected
Check for duplicate object loading.
-
_create() protected
Create the logger instance.
-
_resolveClassName() protected
Resolve a logger classname.
-
_throwMissingClassError() protected
Throws an exception when a logger is missing.
-
count() public
Returns the number of loaded objects.
-
get() public
Get loaded object instance.
-
getIterator() public
Returns an array iterator.
-
has() public
Check whether 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 configuration array into associative form for making 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 a single logger from the registry.
Method Detail
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>
Debug friendly object properties.
Returns
array<string, mixed>
__get() ¶ public
__get(string $name): object|null
Provide public read access to the loaded objects
Parameters
-
string
$name Name of property to read
Returns
object|null
__isset() ¶ public
__isset(string $name): bool
Provide isset access to _loaded
Parameters
-
string
$name Name of object being checked.
Returns
bool
__set() ¶ public
__set(string $name, object $object): void
Sets an object.
Parameters
-
string
$name Name of a property to set.
-
object
$object Object to set.
Returns
void
__unset() ¶ public
__unset(string $name): void
Unsets an object.
Parameters
-
string
$name Name of a property to unset.
Returns
void
_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array<string, mixed> $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<string, mixed>
$config The config data for the new instance.
Returns
void
Throws
Cake\Core\Exception\CakeException
When a duplicate is found.
_create() ¶ protected
_create(Psr\Log\LoggerInterface|callable|class-stringPsr\Log\LoggerInterface> $class, string $alias, array<string, mixed> $config): Psr\Log\LoggerInterface
Create the logger instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
Psr\Log\LoggerInterface|callable|class-stringPsr\Log\LoggerInterface>
$class The classname or object to make.
-
string
$alias The alias of the object.
-
array<string, mixed>
$config An array of settings to use for the logger.
Returns
Psr\Log\LoggerInterface
_resolveClassName() ¶ protected
_resolveClassName(string $class): class-stringPsr\Log\LoggerInterface>|null
Resolve a logger classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
string
$class Partial classname to resolve.
Returns
class-stringPsr\Log\LoggerInterface>|null
_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): void
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|null
$plugin The plugin the logger is missing in.
Returns
void
Throws
Cake\Core\Exception\CakeException
get() ¶ public
get(string $name): object
Get loaded object instance.
Parameters
-
string
$name Name of object.
Returns
object
Throws
Cake\Core\Exception\CakeException
If not loaded or found.
has() ¶ public
has(string $name): bool
Check whether a given object is loaded.
Parameters
-
string
$name The object name to check for.
Returns
bool
load() ¶ public
load(string $name, array<string, mixed> $config = []): object
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 {@link \Cake\Controller\Component::$components} as an example. You can alias an object by setting the 'className' key, i.e.,
protected $components = [
'Email' => [
'className' => 'App\Controller\Component\AliasedEmailComponent'
];
];
All calls to the Email
component would use AliasedEmail
instead.
Parameters
-
string
$name The name/class of the object to load.
-
array<string, mixed>
$config optional Additional settings to use when loading the object.
Returns
object
Throws
Exception
If the class cannot be found.
normalizeArray() ¶ public
normalizeArray(array $objects): array<string, array>
Normalizes an object configuration array into associative form for making lazy loading easier.
Parameters
-
array
$objects Array of child objects to normalize.
Returns
array<string, array>
reset() ¶ public
reset(): $this
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() ¶ public
set(string $name, object $object): $this
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
$name The name of the object to set in the registry.
-
object
$object instance to store in the registry
Returns
$this
unload() ¶ public
unload(string $name): $this
Remove a single logger from the registry.
If this registry has an event manager, the object will be detached from any events as well.
Parameters
-
string
$name The logger name.
Returns
$this