MediaWiki\Logger\LoggerFactory Class Reference

PSR-3 logger instance factory. More...

Static Public Member Functions
static	getInstance ( $channel)
	Get a named logger instance from the currently configured logger factory.
static	getProvider ()
	Get the registered service provider.
static	registerProvider (Spi $provider)
	Register a service provider to create new \Psr\Log\LoggerInterface instances.

Private Member Functions
	__construct ()
	Construction of utility class is not allowed.

Static Private Attributes
static	$spi
	Service provider.

Detailed Description

PSR-3 logger instance factory.

Creation of \Psr\Log\LoggerInterface instances is managed via the LoggerFactory::getInstance() static method which in turn delegates to the currently registered service provider.

A service provider is any class implementing the Spi interface. There are two possible methods of registering a service provider. The LoggerFactory::registerProvider() static method can be called at any time to change the service provider. If LoggerFactory::getInstance() is called before any service provider has been registered, it will attempt to use the $wgMWLoggerDefaultSpi global to bootstrap Spi registration. $wgMWLoggerDefaultSpi is expected to be an array usable by ObjectFactory::getObjectFromSpec() to create a class.

See also

\MediaWiki\Logger\Spi

Since

1.25

Author

Bryan Davis bd808.nosp@m.@wik.nosp@m.imedi.nosp@m.a.or.nosp@m.g

Note

© 2014 Bryan Davis and Wikimedia Foundation.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 46 of file LoggerFactory.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Logger\LoggerFactory::__construct ( )

private

Construction of utility class is not allowed.

Definition at line 100 of file LoggerFactory.php.

Member Function Documentation

getInstance()

static MediaWiki\Logger\LoggerFactory::getInstance (   $channel )

static

Get a named logger instance from the currently configured logger factory.

Parameters

string

$channel

Logger channel (name)

Returns

\Psr\Log\LoggerInterface

Definition at line 93 of file LoggerFactory.php.

References MediaWiki\Logger\LoggerFactory\getProvider().

Referenced by MediaWiki\Logger\Monolog\KafkaHandler\factory().

getProvider()

static MediaWiki\Logger\LoggerFactory::getProvider ( )

static

Get the registered service provider.

If called before any service provider has been registered, it will attempt to use the $wgMWLoggerDefaultSpi global to bootstrap Spi registration. $wgMWLoggerDefaultSpi is expected to be an array usable by ObjectFactory::getObjectFromSpec() to create a class.

Returns

\MediaWiki\Logger\Spi

See also

registerProvider()

ObjectFactory::getObjectFromSpec()

Definition at line 76 of file LoggerFactory.php.

References MediaWiki\Logger\LoggerFactory\$spi, $wgMWLoggerDefaultSpi, global, and MediaWiki\Logger\LoggerFactory\registerProvider().

Referenced by MediaWiki\Logger\LoggerFactory\getInstance().

registerProvider()

static MediaWiki\Logger\LoggerFactory::registerProvider ( Spi  $provider )

static

Register a service provider to create new \Psr\Log\LoggerInterface instances.

Parameters

\\MediaWiki\\Logger\\Spi

$provider

Provider to register

Definition at line 60 of file LoggerFactory.php.

Referenced by MediaWiki\Logger\LoggerFactory\getProvider().

Member Data Documentation

$spi

MediaWiki Logger Spi MediaWiki\Logger\LoggerFactory::$spi

staticprivate

Service provider.

Definition at line 52 of file LoggerFactory.php.

Referenced by MediaWiki\Logger\LoggerFactory\getProvider().

---

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

• includes/debug/logger/LoggerFactory.php