Monolog\Processor\IntrospectionProcessor Class Reference

Injects line/file:class/function where the log message came from. More...

Inheritance diagram for Monolog\Processor\IntrospectionProcessor:

Collaboration diagram for Monolog\Processor\IntrospectionProcessor:

Public Member Functions
	__construct ($level=Logger::DEBUG, array $skipClassesPartials=array(), $skipStackFramesCount=0)
	__invoke (array $record)

Private Member Functions
	isTraceClassOrSkippedFunction (array $trace, $index)

Private Attributes
	$level
	$skipClassesPartials
	$skipStackFramesCount
	$skipFunctions

Detailed Description

Injects line/file:class/function where the log message came from.

Warning: This only works if the handler processes the logs directly. If you put the processor on a handler that is behind a FingersCrossedHandler for example, the processor will only be called once the trigger level is reached, and all the log records will have the same file/line/.. data from the call that triggered the FingersCrossedHandler.

Author

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

Definition at line 27 of file IntrospectionProcessor.php.

Constructor & Destructor Documentation

__construct()

Monolog\Processor\IntrospectionProcessor::__construct	(		$level = Logger::DEBUG,
		array	$skipClassesPartials = array(),
			$skipStackFramesCount = 0
	)

Definition at line 40 of file IntrospectionProcessor.php.

References Monolog\Processor\IntrospectionProcessor\$level, Monolog\Processor\IntrospectionProcessor\$skipClassesPartials, Monolog\Processor\IntrospectionProcessor\$skipStackFramesCount, and Monolog\Logger\toMonologLevel().

    {
        $this->level = Logger::toMonologLevel($level);
        $this->skipClassesPartials = array_merge(array('Monolog\\'), $skipClassesPartials);
        $this->skipStackFramesCount = $skipStackFramesCount;
    }

Here is the call graph for this function:

Member Function Documentation

__invoke()

Monolog\Processor\IntrospectionProcessor::__invoke

(

array

$record

)

Parameters

array

$record

Returns

array

Implements Monolog\Processor\ProcessorInterface.

Definition at line 51 of file IntrospectionProcessor.php.

References $i, Monolog\Processor\IntrospectionProcessor\$skipStackFramesCount, and Monolog\Processor\IntrospectionProcessor\isTraceClassOrSkippedFunction().

    {
        // return if the level is not high enough
        if ($record['level'] < $this->level) {
            return $record;
        }

        /*
        * http://php.net/manual/en/function.debug-backtrace.php
        * As of 5.3.6, DEBUG_BACKTRACE_IGNORE_ARGS option was added.
        * Any version less than 5.3.6 must use the DEBUG_BACKTRACE_IGNORE_ARGS constant value '2'.
        */
        $trace = debug_backtrace((PHP_VERSION_ID < 50306) ? 2 : DEBUG_BACKTRACE_IGNORE_ARGS);

        // skip first since it's always the current method
        array_shift($trace);
        // the call_user_func call is also skipped
        array_shift($trace);

        $i = 0;

        while ($this->isTraceClassOrSkippedFunction($trace, $i)) {
            if (isset($trace[$i]['class'])) {
                foreach ($this->skipClassesPartials as $part) {
                    if (strpos($trace[$i]['class'], $part) !== false) {
                        $i++;
                        continue 2;
                    }
                }
            } elseif (in_array($trace[$i]['function'], $this->skipFunctions)) {
                $i++;
                continue;
            }

            break;
        }

        $i += $this->skipStackFramesCount;

        // we should have the call source now
        $record['extra'] = array_merge(
            $record['extra'],
            array(
                'file'      => isset($trace[$i - 1]['file']) ? $trace[$i - 1]['file'] : null,
                'line'      => isset($trace[$i - 1]['line']) ? $trace[$i - 1]['line'] : null,
                'class'     => isset($trace[$i]['class']) ? $trace[$i]['class'] : null,
                'function'  => isset($trace[$i]['function']) ? $trace[$i]['function'] : null,
            )
        );

        return $record;
    }

Here is the call graph for this function:

isTraceClassOrSkippedFunction()

Monolog\Processor\IntrospectionProcessor::isTraceClassOrSkippedFunction ( array  $trace,   $index  )

private

Definition at line 104 of file IntrospectionProcessor.php.

References $index.

Referenced by Monolog\Processor\IntrospectionProcessor\__invoke().

    {
        if (!isset($trace[$index])) {
            return false;
        }

        return isset($trace[$index]['class']) || in_array($trace[$index]['function'], $this->skipFunctions);
    }

Here is the caller graph for this function:

Field Documentation

$level

Monolog\Processor\IntrospectionProcessor::$level

private

Definition at line 29 of file IntrospectionProcessor.php.

Referenced by Monolog\Processor\IntrospectionProcessor\__construct().

$skipClassesPartials

Monolog\Processor\IntrospectionProcessor::$skipClassesPartials

private

Definition at line 31 of file IntrospectionProcessor.php.

Referenced by Monolog\Processor\IntrospectionProcessor\__construct().

$skipFunctions

Monolog\Processor\IntrospectionProcessor::$skipFunctions

private

Initial value:

= array(
        'call_user_func',
        'call_user_func_array',
    )

Definition at line 35 of file IntrospectionProcessor.php.

$skipStackFramesCount

Monolog\Processor\IntrospectionProcessor::$skipStackFramesCount

private

Definition at line 33 of file IntrospectionProcessor.php.

Referenced by Monolog\Processor\IntrospectionProcessor\__construct(), and Monolog\Processor\IntrospectionProcessor\__invoke().

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Processor/IntrospectionProcessor.php