3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 namespace MediaWiki\Logger;
26 * PSR-3 logger instance factory.
28 * Creation of \Psr\Log\LoggerInterface instances is managed via the
29 * LoggerFactory::getInstance() static method which in turn delegates to the
30 * currently registered service provider.
32 * A service provider is any class implementing the Spi interface.
33 * There are two possible methods of registering a service provider. The
34 * LoggerFactory::registerProvider() static method can be called at any time
35 * to change the service provider. If LoggerFactory::getInstance() is called
36 * before any service provider has been registered, it will attempt to use the
37 * $wgMWLoggerDefaultSpi global to bootstrap Spi registration.
38 * $wgMWLoggerDefaultSpi is expected to be an array usable by
39 * ObjectFactory::getObjectFromSpec() to create a class.
41 * @see \MediaWiki\Logger\Spi
43 * @copyright © 2014 Wikimedia Foundation and contributors
49 * @var \MediaWiki\Logger\Spi $spi
54 * Register a service provider to create new \Psr\Log\LoggerInterface
57 * @param \MediaWiki\Logger\Spi $provider Provider to register
59 public static function registerProvider( Spi $provider ) {
60 self::$spi = $provider;
64 * Get the registered service provider.
66 * If called before any service provider has been registered, it will
67 * attempt to use the $wgMWLoggerDefaultSpi global to bootstrap
68 * Spi registration. $wgMWLoggerDefaultSpi is expected to be an
69 * array usable by ObjectFactory::getObjectFromSpec() to create a class.
71 * @return \MediaWiki\Logger\Spi
72 * @see registerProvider()
73 * @see ObjectFactory::getObjectFromSpec()
75 public static function getProvider() {
76 if ( self::$spi === null ) {
77 global $wgMWLoggerDefaultSpi;
78 $provider = ObjectFactory::getObjectFromSpec(
81 self::registerProvider( $provider );
87 * Get a named logger instance from the currently configured logger factory.
89 * @param string $channel Logger channel (name)
90 * @return \Psr\Log\LoggerInterface
92 public static function getInstance( $channel ) {
93 return self::getProvider()->getLogger( $channel );
97 * Construction of utility class is not allowed.
99 private function __construct() {