diff options
author | Luke Shumaker <lukeshu@sbcglobal.net> | 2016-05-01 15:30:02 -0400 |
---|---|---|
committer | Luke Shumaker <lukeshu@sbcglobal.net> | 2016-05-01 15:30:02 -0400 |
commit | 1de335ad3f395ca6861085393ba366a9e3fb4a0d (patch) | |
tree | f1fdd326034e05177596851be6a7127615d81498 /includes/debug/logger/LoggerFactory.php | |
parent | 9c75fa8ff6d4d38ef552c00fef5969fb154765e8 (diff) | |
parent | f6d65e533c62f6deb21342d4901ece24497b433e (diff) |
Merge commit 'f6d65'
# Conflicts:
# skins/ArchLinux/ArchLinux.php
Diffstat (limited to 'includes/debug/logger/LoggerFactory.php')
-rw-r--r-- | includes/debug/logger/LoggerFactory.php | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/includes/debug/logger/LoggerFactory.php b/includes/debug/logger/LoggerFactory.php new file mode 100644 index 00000000..b3078b9a --- /dev/null +++ b/includes/debug/logger/LoggerFactory.php @@ -0,0 +1,121 @@ +<?php +/** + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +namespace MediaWiki\Logger; + +use ObjectFactory; + +/** + * 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 \MediaWiki\Logger\Spi + * @since 1.25 + * @author Bryan Davis <bd808@wikimedia.org> + * @copyright © 2014 Bryan Davis and Wikimedia Foundation. + */ +class LoggerFactory { + + /** + * Service provider. + * @var Spi $spi + */ + private static $spi; + + + /** + * Register a service provider to create new \Psr\Log\LoggerInterface + * instances. + * + * @param Spi $provider Provider to register + */ + public static function registerProvider( Spi $provider ) { + self::$spi = $provider; + } + + + /** + * 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. + * + * @return Spi + * @see registerProvider() + * @see ObjectFactory::getObjectFromSpec() + */ + public static function getProvider() { + if ( self::$spi === null ) { + global $wgMWLoggerDefaultSpi; + $provider = ObjectFactory::getObjectFromSpec( + $wgMWLoggerDefaultSpi + ); + self::registerProvider( $provider ); + } + return self::$spi; + } + + + /** + * Get a named logger instance from the currently configured logger factory. + * + * @param string $channel Logger channel (name) + * @return \Psr\Log\LoggerInterface + */ + public static function getInstance( $channel ) { + if ( !interface_exists( '\Psr\Log\LoggerInterface' ) ) { + $message = ( + 'MediaWiki requires the <a href="https://github.com/php-fig/log">PSR-3 logging ' . + "library</a> to be present. This library is not embedded directly in MediaWiki's " . + "git repository and must be installed separately by the end user.\n\n" . + 'Please see <a href="https://www.mediawiki.org/wiki/Download_from_Git' . + '#Fetch_external_libraries">mediawiki.org</a> for help on installing ' . + 'the required components.' + ); + echo $message; + trigger_error( $message, E_USER_ERROR ); + die( 1 ); + } + + return self::getProvider()->getLogger( $channel ); + } + + + /** + * Construction of utility class is not allowed. + */ + private function __construct() { + // no-op + } +} |