Monolog\Registry Class Reference

Monolog log registry. More...

Collaboration diagram for Monolog\Registry:

Static Public Member Functions
static	addLogger (Logger $logger, $name=null, $overwrite=false)
	Adds new logging channel to the registry. More...
static	hasLogger ($logger)
	Checks if such logging channel exists by name or instance. More...
static	removeLogger ($logger)
	Removes instance from registry by name or instance. More...
static	clear ()
	Clears the registry. More...
static	getInstance ($name)
	Gets Logger instance from the registry. More...
static	__callStatic ($name, $arguments)
	Gets Logger instance from the registry via static method call. More...

Static Private Attributes
static	$loggers = array()

Detailed Description

Monolog log registry.

Allows to get Logger instances in the global scope via static method calls on this class.

$application = new Monolog\Logger('application'); $api = new Monolog\Logger('api');

Monolog\Registry::addLogger($application); Monolog\Registry::addLogger($api);

function testLogger() { Monolog\Registry::api()->addError('Sent to $api Logger instance'); Monolog\Registry::application()->addError('Sent to $application Logger instance'); }

Author

Tomas Tatarko tomas.nosp@m.@tat.nosp@m.arko..nosp@m.sk

Definition at line 38 of file Registry.php.

Member Function Documentation

__callStatic()

static Monolog\Registry::__callStatic (   $name,   $arguments  )

static

Gets Logger instance from the registry via static method call.

Parameters

string	$name	Name of the requested Logger instance
array	$arguments	Arguments passed to static method call

Returns

Logger Requested instance of Logger

Exceptions

InvalidArgumentException If named Logger instance is not in the registry

Definition at line 130 of file Registry.php.

    {
        return self::getInstance($name);
    }

addLogger()

static Monolog\Registry::addLogger ( Logger  $logger,   $name = null,   $overwrite = false  )

static

Adds new logging channel to the registry.

Parameters

Logger	$logger	Instance of the logging channel
string | null	$name	Name of the logging channel ($logger->getName() by default)
boolean	$overwrite	Overwrite instance in the registry if the given name already exists?

Exceptions

InvalidArgumentException If $overwrite set to false and named Logger instance already exists

Definition at line 55 of file Registry.php.

    {
        $name = $name ?: $logger->getName();
 
        if (isset(self::$loggers[$name]) && !$overwrite) {
            throw new InvalidArgumentException('Logger with the given name already exists');
        }
 
        self::$loggers[$name] = $logger;
    }

References Monolog\Logger\getName().

Here is the call graph for this function:

clear()

static Monolog\Registry::clear ( )

static

Clears the registry.

Definition at line 101 of file Registry.php.

    {
        self::$loggers = array();
    }

getInstance()

static Monolog\Registry::getInstance (   $name )

static

Gets Logger instance from the registry.

Parameters

string

$name

Name of the requested Logger instance

Returns

Logger Requested instance of Logger

Exceptions

InvalidArgumentException If named Logger instance is not in the registry

Definition at line 113 of file Registry.php.

    {
        if (!isset(self::$loggers[$name])) {
            throw new InvalidArgumentException(sprintf('Requested "%s" logger instance is not in the registry', $name));
        }
 
        return self::$loggers[$name];
    }

hasLogger()

static Monolog\Registry::hasLogger (   $logger )

static

Checks if such logging channel exists by name or instance.

Parameters

string | Logger

$logger

Name or logger instance

Definition at line 71 of file Registry.php.

    {
        if ($logger instanceof Logger) {
            $index = array_search($logger, self::$loggers, true);
 
            return false !== $index;
        } else {
            return isset(self::$loggers[$logger]);
        }
    }

removeLogger()

static Monolog\Registry::removeLogger (   $logger )

static

Removes instance from registry by name or instance.

Parameters

string | Logger

$logger

Name or logger instance

Definition at line 87 of file Registry.php.

    {
        if ($logger instanceof Logger) {
            if (false !== ($idx = array_search($logger, self::$loggers, true))) {
                unset(self::$loggers[$idx]);
            }
        } else {
            unset(self::$loggers[$logger]);
        }
    }

Field Documentation

$loggers

Monolog\Registry::$loggers = array()

staticprivate

Definition at line 45 of file Registry.php.

---

The documentation for this class was generated from the following file:

• Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Registry.php