$_loaded
$_loaded : array<mixed,object>
Map of loaded objects.
Registry of loaded log engines
Provides registry & factory functionality for object types. Used as a super class for various composition based re-use features in CakePHP.
Each subclass needs to implement the various abstract methods to complete the template method load().
The ObjectRegistry is EventManager aware, but each extending class will need to use \Cake\Event\EventDispatcherTrait to attach and detach on set and bind
load(string $objectName, array $config = array()) : 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.
string | $objectName | The name/class of the object to load. |
array | $config | Additional settings to use when loading the object. |
If the class cannot be found.
set(string $objectName, 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
string | $objectName | The name of the object to set in the registry. |
object | $object | instance to store in the registry |
_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.
string | $name | The name of the alias in the registry. |
array | $config | The config data for the new instance. |
When a duplicate is found.
_throwMissingClassError(string $class, string $plugin) : void
Throws an exception when a logger is missing.
Part of the template method for Cake\Core\ObjectRegistry::load()
string | $class | The classname that is missing. |
string | $plugin | The plugin the logger is missing in. |
_create(string|\Psr\Log\LoggerInterface $class, string $alias, array $settings) : \Psr\Log\LoggerInterface
Create the logger instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
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. |
when an object doesn't implement the correct interface.
The constructed logger class.
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.2.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Log;
use Cake\Core\App;
use Cake\Core\ObjectRegistry;
use Psr\Log\LoggerInterface;
use RuntimeException;
/**
* Registry of loaded log engines
*/
class LogEngineRegistry extends ObjectRegistry
{
/**
* Resolve a logger classname.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string $class Partial classname to resolve.
* @return string|false Either the correct classname or false.
*/
protected function _resolveClassName($class)
{
if (is_object($class)) {
return $class;
}
return App::className($class, 'Log/Engine', 'Log');
}
/**
* Throws an exception when a logger is missing.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string $class The classname that is missing.
* @param string $plugin The plugin the logger is missing in.
* @return void
* @throws \RuntimeException
*/
protected function _throwMissingClassError($class, $plugin)
{
throw new RuntimeException(sprintf('Could not load class %s', $class));
}
/**
* Create the logger instance.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string|\Psr\Log\LoggerInterface $class The classname or object to make.
* @param string $alias The alias of the object.
* @param array $settings An array of settings to use for the logger.
* @return \Psr\Log\LoggerInterface The constructed logger class.
* @throws \RuntimeException when an object doesn't implement the correct interface.
*/
protected function _create($class, $alias, $settings)
{
if (is_callable($class)) {
$class = $class($alias);
}
if (is_object($class)) {
$instance = $class;
}
if (!isset($instance)) {
$instance = new $class($settings);
}
if ($instance instanceof LoggerInterface) {
return $instance;
}
throw new RuntimeException(
'Loggers must implement Psr\Log\LoggerInterface.'
);
}
/**
* Remove a single logger from the registry.
*
* @param string $name The logger name.
* @return void
*/
public function unload($name)
{
unset($this->_loaded[$name]);
}
}