MediaWiki  1.30.0
MonologSpi.php
Go to the documentation of this file.
1 <?php
21 namespace MediaWiki\Logger;
22 
24 use Monolog\Logger;
26 
115 class MonologSpi implements Spi {
116 
120  protected $singletons;
121 
126  protected $config;
127 
131  public function __construct( array $config ) {
132  $this->config = [];
133  $this->mergeConfig( $config );
134  }
135 
142  public function mergeConfig( array $config ) {
143  foreach ( $config as $key => $value ) {
144  if ( isset( $this->config[$key] ) ) {
145  $this->config[$key] = array_merge( $this->config[$key], $value );
146  } else {
147  $this->config[$key] = $value;
148  }
149  }
150  $this->reset();
151  }
152 
159  public function reset() {
160  $this->singletons = [
161  'loggers' => [],
162  'handlers' => [],
163  'formatters' => [],
164  'processors' => [],
165  ];
166  }
167 
178  public function getLogger( $channel ) {
179  if ( !isset( $this->singletons['loggers'][$channel] ) ) {
180  // Fallback to using the '@default' configuration if an explict
181  // configuration for the requested channel isn't found.
182  $spec = isset( $this->config['loggers'][$channel] ) ?
183  $this->config['loggers'][$channel] :
184  $this->config['loggers']['@default'];
185 
186  $monolog = $this->createLogger( $channel, $spec );
187  $this->singletons['loggers'][$channel] = $monolog;
188  }
189 
190  return $this->singletons['loggers'][$channel];
191  }
192 
199  protected function createLogger( $channel, $spec ) {
200  $obj = new Logger( $channel );
201 
202  if ( isset( $spec['calls'] ) ) {
203  foreach ( $spec['calls'] as $method => $margs ) {
204  call_user_func_array( [ $obj, $method ], $margs );
205  }
206  }
207 
208  if ( isset( $spec['processors'] ) ) {
209  foreach ( $spec['processors'] as $processor ) {
210  $obj->pushProcessor( $this->getProcessor( $processor ) );
211  }
212  }
213 
214  if ( isset( $spec['handlers'] ) ) {
215  foreach ( $spec['handlers'] as $handler ) {
216  $obj->pushHandler( $this->getHandler( $handler ) );
217  }
218  }
219  return $obj;
220  }
221 
227  public function getProcessor( $name ) {
228  if ( !isset( $this->singletons['processors'][$name] ) ) {
229  $spec = $this->config['processors'][$name];
230  $processor = ObjectFactory::getObjectFromSpec( $spec );
231  $this->singletons['processors'][$name] = $processor;
232  }
233  return $this->singletons['processors'][$name];
234  }
235 
241  public function getHandler( $name ) {
242  if ( !isset( $this->singletons['handlers'][$name] ) ) {
243  $spec = $this->config['handlers'][$name];
245  if ( isset( $spec['formatter'] ) ) {
246  $handler->setFormatter(
247  $this->getFormatter( $spec['formatter'] )
248  );
249  }
250  if ( isset( $spec['buffer'] ) && $spec['buffer'] ) {
252  }
253  $this->singletons['handlers'][$name] = $handler;
254  }
255  return $this->singletons['handlers'][$name];
256  }
257 
263  public function getFormatter( $name ) {
264  if ( !isset( $this->singletons['formatters'][$name] ) ) {
265  $spec = $this->config['formatters'][$name];
266  $formatter = ObjectFactory::getObjectFromSpec( $spec );
267  $this->singletons['formatters'][$name] = $formatter;
268  }
269  return $this->singletons['formatters'][$name];
270  }
271 }
MediaWiki\Logger\MonologSpi\getFormatter
getFormatter( $name)
Create or return cached formatter.
Definition: MonologSpi.php:263
MediaWiki\Logger\MonologSpi
LoggerFactory service provider that creates loggers implemented by Monolog.
Definition: MonologSpi.php:115
MediaWiki\Logger\MonologSpi\$singletons
$singletons
Definition: MonologSpi.php:120
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
MediaWiki\Logger\MonologSpi\getProcessor
getProcessor( $name)
Create or return cached processor.
Definition: MonologSpi.php:227
MediaWiki\Logger
Definition: ConsoleLogger.php:3
MediaWiki\Logger\MonologSpi\$config
$config
Configuration for creating new loggers.
Definition: MonologSpi.php:126
MediaWiki\Logger\MonologSpi\__construct
__construct(array $config)
Definition: MonologSpi.php:131
$value
$value
Definition: styleTest.css.php:45
MediaWiki\Logger\MonologSpi\getLogger
getLogger( $channel)
Get a logger instance.
Definition: MonologSpi.php:178
ObjectFactory\getObjectFromSpec
static getObjectFromSpec( $spec)
Instantiate an object based on a specification array.
Definition: ObjectFactory.php:58
$handler
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:781
MediaWiki\Logger\MonologSpi\getHandler
getHandler( $name)
Create or return cached handler.
Definition: MonologSpi.php:241
MediaWiki\Logger\MonologSpi\reset
reset()
Reset internal caches.
Definition: MonologSpi.php:159
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
MediaWiki\Logger\Monolog\BufferHandler
Updates \Monolog\Handler\BufferHandler to use DeferredUpdates rather than register_shutdown_function.
Definition: BufferHandler.php:35
ObjectFactory
Construct objects from configuration instructions.
Definition: ObjectFactory.php:26
MediaWiki\Logger\Spi
Service provider interface for \Psr\Log\LoggerInterface implementation libraries.
Definition: Spi.php:36
MediaWiki\Logger\MonologSpi\mergeConfig
mergeConfig(array $config)
Merge additional configuration data into the configuration.
Definition: MonologSpi.php:142
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MediaWiki\Logger\MonologSpi\createLogger
createLogger( $channel, $spec)
Create a logger.
Definition: MonologSpi.php:199