vendor/monolog/monolog/src/Monolog/Processor/WebProcessor.php line 19

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Monolog package.
  5.  *
  6.  * (c) Jordi Boggiano <j.boggiano@seld.be>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Monolog\Processor;
  14. /**
  15.  * Injects url/method and remote IP of the current web request in all records
  16.  *
  17.  * @author Jordi Boggiano <j.boggiano@seld.be>
  18.  */
  19. class WebProcessor implements ProcessorInterface
  20. {
  21.     /**
  22.      * @var array|\ArrayAccess
  23.      */
  24.     protected $serverData;
  26.     /**
  27.      * Default fields
  28.      *
  29.      * Array is structured as [key in record.extra => key in $serverData]
  30.      *
  31.      * @var array
  32.      */
  33.     protected $extraFields = array(
  34.         'url'         => 'REQUEST_URI',
  35.         'ip'          => 'REMOTE_ADDR',
  36.         'http_method' => 'REQUEST_METHOD',
  37.         'server'      => 'SERVER_NAME',
  38.         'referrer'    => 'HTTP_REFERER',
  39.     );
  41.     /**
  42.      * @param array|\ArrayAccess $serverData  Array or object w/ ArrayAccess that provides access to the $_SERVER data
  43.      * @param 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
  44.      */
  45.     public function __construct($serverData = null, array $extraFields = null)
  46.     {
  47.         if (null === $serverData) {
  48.             $this->serverData = &$_SERVER;
  49.         } elseif (is_array($serverData) || $serverData instanceof \ArrayAccess) {
  50.             $this->serverData = $serverData;
  51.         } else {
  52.             throw new \UnexpectedValueException('$serverData must be an array or object implementing ArrayAccess.');
  53.         }
  55.         if (isset($this->serverData['UNIQUE_ID'])) {
  56.             $this->extraFields['unique_id'] = 'UNIQUE_ID';
  57.         }
  59.         if (null !== $extraFields) {
  60.             if (isset($extraFields[0])) {
  61.                 foreach (array_keys($this->extraFields) as $fieldName) {
  62.                     if (!in_array($fieldName, $extraFields)) {
  63.                         unset($this->extraFields[$fieldName]);
  64.                     }
  65.                 }
  66.             } else {
  67.                 $this->extraFields = $extraFields;
  68.             }
  69.         }
  70.     }
  72.     /**
  73.      * @param  array $record
  74.      * @return array
  75.      */
  76.     public function __invoke(array $record)
  77.     {
  78.         // skip processing if for some reason request data
  79.         // is not present (CLI or wonky SAPIs)
  80.         if (!isset($this->serverData['REQUEST_URI'])) {
  81.             return $record;
  82.         }
  84.         $record['extra'] = $this->appendExtraFields($record['extra']);
  86.         return $record;
  87.     }
  89.     /**
  90.      * @param  string $extraName
  91.      * @param  string $serverName
  92.      * @return $this
  93.      */
  94.     public function addExtraField($extraName, $serverName)
  95.     {
  96.         $this->extraFields[$extraName] = $serverName;
  98.         return $this;
  99.     }
  101.     /**
  102.      * @param  array $extra
  103.      * @return array
  104.      */
  105.     private function appendExtraFields(array $extra)
  106.     {
  107.         foreach ($this->extraFields as $extraName => $serverName) {
  108.             $extra[$extraName] = isset($this->serverData[$serverName]) ? $this->serverData[$serverName] : null;
  109.         }
  111.         return $extra;
  112.     }
  113. }