Used for testing purposes. More...

Inheritance diagram for Monolog\Handler\TestHandler:

Collaboration diagram for Monolog\Handler\TestHandler:

Public Member Functions

getRecords ()

clear ()

hasRecords ($level)

hasRecord ($record, $level)

hasRecordThatContains ($message, $level)

hasRecordThatMatches ($regex, $level)

hasRecordThatPasses ($predicate, $level)

__call ($method, $args)

Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

handle (array $record)

{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: bool true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

} More...

Public Member Functions inherited from Monolog\Handler\AbstractHandler

__construct ($level=Logger::DEBUG, $bubble=true)

isHandling (array $record)

{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record Partial log record containing only a level key

Returns: bool

} More...

handleBatch (array $records)

{Handles a set of records at once.

Parameters

array $records The records to handle (an array of record arrays)

} More...

close ()

Closes the handler. More...

pushProcessor ($callback)

{Adds a processor in the stack.

Parameters

callable $callback

Returns: self

} More...

popProcessor ()

{Removes the processor on top of the stack and returns it.

Returns: callable

} More...

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

} More...

getFormatter ()

{Gets the formatter.

Returns: FormatterInterface

} More...

setLevel ($level)

Sets minimum logging level at which this handler will be triggered. More...

getLevel ()

Gets minimum logging level at which this handler will be triggered. More...

setBubble ($bubble)

Sets the bubbling behavior. More...

getBubble ()

Gets the bubbling behavior. More...

__destruct ()

reset ()

isHandling (array $record)

Checks whether the given record will be handled by this handler. More...

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

Removes the processor on top of the stack and returns it. More...

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

reset ()

Protected Member Functions

write (array $record)

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

} More...

Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

write (array $record)

Writes the record down to the log of the implementing handler. More...

processRecord (array $record)

Processes a record. More...

Protected Member Functions inherited from Monolog\Handler\AbstractHandler

getDefaultFormatter ()

Gets the default formatter. More...

Protected Attributes
	$records = array()

	$recordsByLevel = array()

Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Detailed Description

Used for testing purposes.

It records all records and gives you access to them for verification.

Author: Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

@method bool hasEmergency($record) @method bool hasAlert($record) @method bool hasCritical($record) @method bool hasError($record) @method bool hasWarning($record) @method bool hasNotice($record) @method bool hasInfo($record) @method bool hasDebug($record)

@method bool hasEmergencyRecords() @method bool hasAlertRecords() @method bool hasCriticalRecords() @method bool hasErrorRecords() @method bool hasWarningRecords() @method bool hasNoticeRecords() @method bool hasInfoRecords() @method bool hasDebugRecords()

@method bool hasEmergencyThatContains($message) @method bool hasAlertThatContains($message) @method bool hasCriticalThatContains($message) @method bool hasErrorThatContains($message) @method bool hasWarningThatContains($message) @method bool hasNoticeThatContains($message) @method bool hasInfoThatContains($message) @method bool hasDebugThatContains($message)

@method bool hasEmergencyThatMatches($message) @method bool hasAlertThatMatches($message) @method bool hasCriticalThatMatches($message) @method bool hasErrorThatMatches($message) @method bool hasWarningThatMatches($message) @method bool hasNoticeThatMatches($message) @method bool hasInfoThatMatches($message) @method bool hasDebugThatMatches($message)

@method bool hasEmergencyThatPasses($message) @method bool hasAlertThatPasses($message) @method bool hasCriticalThatPasses($message) @method bool hasErrorThatPasses($message) @method bool hasWarningThatPasses($message) @method bool hasNoticeThatPasses($message) @method bool hasInfoThatPasses($message) @method bool hasDebugThatPasses($message)

Definition at line 66 of file TestHandler.php.

Member Function Documentation

◆ __call()

Monolog\Handler\TestHandler::__call	(	$method,
		$args
	)

Definition at line 150 of file TestHandler.php.

    {
        if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) {
            $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3];
            $level = constant('Monolog\Logger::' . strtoupper($matches[2]));
            if (method_exists($this, $genericMethod)) {
                $args[] = $level;
 
                return call_user_func_array(array($this, $genericMethod), $args);
            }
        }
 
        throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()');
    }

References Monolog\Handler\AbstractHandler\$level.

◆ clear()

Monolog\Handler\TestHandler::clear ( )

Definition at line 76 of file TestHandler.php.

    {
        $this->records = array();
        $this->recordsByLevel = array();
    }

◆ getRecords()

Monolog\Handler\TestHandler::getRecords ( )

Definition at line 71 of file TestHandler.php.

    {
        return $this->records;
    }

References Monolog\Handler\TestHandler\$records.

◆ hasRecord()

Monolog\Handler\TestHandler::hasRecord	(	$record,
		$level
	)

Parameters

string \| array	$record	Either a message string or an array containing message and optionally context keys that will be checked against all records
int	$level	Logger::LEVEL constant value

Definition at line 91 of file TestHandler.php.

    {
        if (is_string($record)) {
            $record = array('message' => $record);
        }
 
        return $this->hasRecordThatPasses(function ($rec) use ($record) {
            if ($rec['message'] !== $record['message']) {
                return false;
            }
            if (isset($record['context']) && $rec['context'] !== $record['context']) {
                return false;
            }
            return true;
        }, $level);
    }

References Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\TestHandler\hasRecordThatPasses().

Here is the call graph for this function:

◆ hasRecords()

Monolog\Handler\TestHandler::hasRecords ( $level )

Definition at line 82 of file TestHandler.php.

    {
        return isset($this->recordsByLevel[$level]);
    }

References Monolog\Handler\AbstractHandler\$level.

◆ hasRecordThatContains()

Monolog\Handler\TestHandler::hasRecordThatContains	(	$message,
		$level
	)

Definition at line 108 of file TestHandler.php.

    {
        return $this->hasRecordThatPasses(function ($rec) use ($message) {
            return strpos($rec['message'], $message) !== false;
        }, $level);
    }

References Monolog\Handler\AbstractHandler\$level, $message, and Monolog\Handler\TestHandler\hasRecordThatPasses().

Here is the call graph for this function:

◆ hasRecordThatMatches()

Monolog\Handler\TestHandler::hasRecordThatMatches	(	$regex,
		$level
	)

Definition at line 115 of file TestHandler.php.

    {
        return $this->hasRecordThatPasses(function ($rec) use ($regex) {
            return preg_match($regex, $rec['message']) > 0;
        }, $level);
    }

References Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\TestHandler\hasRecordThatPasses().

Here is the call graph for this function:

◆ hasRecordThatPasses()

Monolog\Handler\TestHandler::hasRecordThatPasses	(	$predicate,
		$level
	)

Definition at line 122 of file TestHandler.php.

    {
        if (!is_callable($predicate)) {
            throw new \InvalidArgumentException("Expected a callable for hasRecordThatSucceeds");
        }
 
        if (!isset($this->recordsByLevel[$level])) {
            return false;
        }
 
        foreach ($this->recordsByLevel[$level] as $i => $rec) {
            if (call_user_func($predicate, $rec, $i)) {
                return true;
            }
        }
 
        return false;
    }

References $i, and Monolog\Handler\AbstractHandler\$level.

Referenced by Monolog\Handler\TestHandler\hasRecord(), Monolog\Handler\TestHandler\hasRecordThatContains(), and Monolog\Handler\TestHandler\hasRecordThatMatches().

Here is the caller graph for this function:

◆ write()

Monolog\Handler\TestHandler::write ( array $record )

protected

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

}

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 144 of file TestHandler.php.

    {
        $this->recordsByLevel[$record['level']][] = $record;
        $this->records[] = $record;
    }

Field Documentation

◆ $records

Monolog\Handler\TestHandler::$records = array()

protected

Definition at line 68 of file TestHandler.php.

Referenced by Monolog\Handler\TestHandler\getRecords().

◆ $recordsByLevel

Monolog\Handler\TestHandler::$recordsByLevel = array()

protected

Definition at line 69 of file TestHandler.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/monolog/monolog/src/Monolog/Handler/TestHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ clear()

◆ getRecords()

◆ hasRecord()

◆ hasRecords()

◆ hasRecordThatContains()

◆ hasRecordThatMatches()

◆ hasRecordThatPasses()

◆ write()

Field Documentation

◆ $records

◆ $recordsByLevel