1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
}
}
|
