A logger that may be configured to either buffer logs or to print them to the output where PHPUnit will complain about them. More...
Public Member Functions | |
| __construct ( $collect=false, $filter=null, $collectContext=false) | |
| clearBuffer () | |
| Clear the collected log buffer. | |
| getBuffer () | |
| Return the collected logs. | |
| log ( $level, $message, array $context=[]) | |
| setCollect ( $collect) | |
| Set the "collect" flag. | |
| setCollectContext ( $collectContext) | |
| Set the collectContext flag. | |
Private Attributes | |
| $buffer = [] | |
| $collect = false | |
| $collectContext = false | |
| $filter = null | |
Detailed Description
A logger that may be configured to either buffer logs or to print them to the output where PHPUnit will complain about them.
- Since
- 1.27
Definition at line 33 of file TestLogger.php.
Constructor & Destructor Documentation
◆ __construct()
| TestLogger::__construct | ( | $collect = false, | |
| $filter = null, | |||
| $collectContext = false ) |
- Parameters
-
bool $collect Whether to collect logs.
- See also
- setCollect()
- Parameters
-
callable $filter Filter logs before collecting/printing. Signature is string|null function ( string $message, string $level, array $context ); bool $collectContext Whether to keep the context passed to log.
- Since
- 1.29
- See also
- setCollectContext()
Definition at line 46 of file TestLogger.php.
References $collect, $collectContext, and $filter.
Member Function Documentation
◆ clearBuffer()
| TestLogger::clearBuffer | ( | ) |
Clear the collected log buffer.
Definition at line 86 of file TestLogger.php.
Referenced by MediaWiki\Session\SessionManagerTest\testLoadSessionInfoFromStore().
◆ getBuffer()
| TestLogger::getBuffer | ( | ) |
Return the collected logs.
- Returns
- array Array of array( string $level, string $message ), or array( string $level, string $message, array $context ) if $collectContext was true.
Definition at line 79 of file TestLogger.php.
References $buffer.
Referenced by MediaWiki\Session\SessionManagerTest\testLoadSessionInfoFromStore().
◆ log()
| TestLogger::log | ( | $level, | |
| $message, | |||
| array | $context = [] ) |
Definition at line 90 of file TestLogger.php.
References $context.
◆ setCollect()
| TestLogger::setCollect | ( | $collect | ) |
Set the "collect" flag.
- Parameters
-
bool $collect
- Returns
- TestLogger $this
Definition at line 57 of file TestLogger.php.
References $collect.
◆ setCollectContext()
| TestLogger::setCollectContext | ( | $collectContext | ) |
Set the collectContext flag.
- Parameters
-
bool $collectContext
- Since
- 1.29
- Returns
- TestLogger $this
Definition at line 69 of file TestLogger.php.
References $collectContext.
Member Data Documentation
◆ $buffer
|
private |
Definition at line 36 of file TestLogger.php.
Referenced by getBuffer().
◆ $collect
|
private |
Definition at line 34 of file TestLogger.php.
Referenced by __construct(), and setCollect().
◆ $collectContext
|
private |
Definition at line 35 of file TestLogger.php.
Referenced by __construct(), and setCollectContext().
◆ $filter
|
private |
Definition at line 37 of file TestLogger.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- tests/phpunit/includes/TestLogger.php
