Monolog\Processor\WebProcessor Class Reference

Injects url/method and remote IP of the current web request in all records. More...

Inheritance diagram for Monolog\Processor\WebProcessor:

Collaboration diagram for Monolog\Processor\WebProcessor:

Public Member Functions
	__construct ($serverData=null, array $extraFields=null)
	__invoke (array $record)
	addExtraField ($extraName, $serverName)

Protected Attributes
	$serverData
	$extraFields

Private Member Functions
	appendExtraFields (array $extra)

Detailed Description

Injects url/method and remote IP of the current web request in all records.

Author

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

Definition at line 19 of file WebProcessor.php.

Constructor & Destructor Documentation

__construct()

Monolog\Processor\WebProcessor::__construct	(		$serverData = null,
		array	$extraFields = null
	)

Parameters

array | \ArrayAccess	$serverData	Array or object w/ ArrayAccess that provides access to the $_SERVER data
array | null	$extraFields	Field names and the related key inside $serverData to be added. If not provided it defaults to: url, ip, http_method, server, referrer

Definition at line 45 of file WebProcessor.php.

References $_SERVER, Monolog\Processor\WebProcessor\$extraFields, and Monolog\Processor\WebProcessor\$serverData.

    {
        if (null === $serverData) {
            $this->serverData = &$_SERVER;
        } elseif (is_array($serverData) || $serverData instanceof \ArrayAccess) {
            $this->serverData = $serverData;
        } else {
            throw new \UnexpectedValueException('$serverData must be an array or object implementing ArrayAccess.');
        }

        if (null !== $extraFields) {
            if (isset($extraFields[0])) {
                foreach (array_keys($this->extraFields) as $fieldName) {
                    if (!in_array($fieldName, $extraFields)) {
                        unset($this->extraFields[$fieldName]);
                    }
                }
            } else {
                $this->extraFields = $extraFields;
            }
        }
    }

Member Function Documentation

__invoke()

Monolog\Processor\WebProcessor::__invoke

(

array

$record

)

Parameters

array

$record

Returns

array

Implements Monolog\Processor\ProcessorInterface.

Definition at line 72 of file WebProcessor.php.

References Monolog\Processor\WebProcessor\appendExtraFields().

    {
        // skip processing if for some reason request data
        // is not present (CLI or wonky SAPIs)
        if (!isset($this->serverData['REQUEST_URI'])) {
            return $record;
        }

        $record['extra'] = $this->appendExtraFields($record['extra']);

        return $record;
    }

Here is the call graph for this function:

addExtraField()

Monolog\Processor\WebProcessor::addExtraField	(		$extraName,
			$serverName
	)

Parameters

string	$extraName
string	$serverName

Returns

$this

Definition at line 90 of file WebProcessor.php.

    {
        $this->extraFields[$extraName] = $serverName;

        return $this;
    }

appendExtraFields()

Monolog\Processor\WebProcessor::appendExtraFields ( array  $extra )

private

Parameters

array

$extra

Returns

array

Definition at line 101 of file WebProcessor.php.

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

    {
        foreach ($this->extraFields as $extraName => $serverName) {
            $extra[$extraName] = isset($this->serverData[$serverName]) ? $this->serverData[$serverName] : null;
        }

        if (isset($this->serverData['UNIQUE_ID'])) {
            $extra['unique_id'] = $this->serverData['UNIQUE_ID'];
        }

        return $extra;
    }

Here is the caller graph for this function:

Field Documentation

$extraFields

Monolog\Processor\WebProcessor::$extraFields

protected

Initial value:

= array(
        'url'         => 'REQUEST_URI',
        'ip'          => 'REMOTE_ADDR',
        'http_method' => 'REQUEST_METHOD',
        'server'      => 'SERVER_NAME',
        'referrer'    => 'HTTP_REFERER',
    )

Definition at line 33 of file WebProcessor.php.

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

$serverData

Monolog\Processor\WebProcessor::$serverData

protected

Definition at line 24 of file WebProcessor.php.

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

---

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

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