Page MenuHomeWickedGov Phorge
Files F4133145

LogCapturingSpi.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

LogCapturingSpi.php
View Options

<?php
namespace MediaWiki\Logger;
use Psr\Log\AbstractLogger;
use Psr\Log\LoggerInterface;
/**
* Wrap another Spi and keep a copy of all log messages.
*
* This is developed for use by PHPUnit bootstrapping, to collect logs
* generated during a given unit test, and print them after a failing test.
*
* @internal For use in MediaWiki core only
* @ingroup Debug
*/
class LogCapturingSpi implements Spi {
/** @var array<string,LoggerInterface> */
private array $singletons;
private Spi $inner;
/** @var array[] */
private array $logs = [];
public function __construct( Spi $inner ) {
$this->inner = $inner;
}
/**
* @return array[]
*/
public function getLogs(): array {
return $this->logs;
}
/** @inheritDoc */
public function getLogger( $channel ) {
if ( !isset( $this->singletons[$channel] ) ) {
$this->singletons[$channel] = $this->createLogger( $channel );
}
return $this->singletons[$channel];
}
public function capture( array $log ): void {
$this->logs[] = $log;
}
private function createLogger( string $channel ): LoggerInterface {
$inner = $this->inner->getLogger( $channel );
return new class( $channel, $inner, $this ) extends AbstractLogger {
private string $channel;
private LoggerInterface $logger;
private LogCapturingSpi $parent;
public function __construct( string $channel, LoggerInterface $logger, LogCapturingSpi $parent ) {
$this->channel = $channel;
$this->logger = $logger;
$this->parent = $parent;
}
/** @inheritDoc */
public function log( $level, $message, array $context = [] ): void {
$this->parent->capture( [
'channel' => $this->channel,
'level' => $level,
'message' => $message,
'context' => $context
] );
$this->logger->log( $level, $message, $context );
}
};
}
/**
* @internal For use by MediaWikiIntegrationTestCase
*/
public function getInnerSpi(): Spi {
return $this->inner;
}
/**
* @internal For use by MediaWikiIntegrationTestCase
*/
public function setLoggerForTest( string $channel, ?LoggerInterface $logger = null ): ?LoggerInterface {
$ret = $this->singletons[$channel] ?? null;
if ( $logger ) {
$this->singletons[$channel] = $logger;
} else {
unset( $this->singletons[$channel] );
}
return $ret;
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 11:59 (3 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ae/24/d739e8565f860c9c961a3e788eaa
Default Alt Text
LogCapturingSpi.php (2 KB)

Event Timeline