Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 18
0.00% covered (danger)
0.00%
0 / 2
 CRAP
0.00% covered (danger)
0.00%
0 / 1
EnvironmentProcessorAbstract
0.00% covered (danger)
0.00%
0 / 18
0.00% covered (danger)
0.00%
0 / 2
 20
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
 2
 __invoke
0.00% covered (danger)
0.00%
0 / 16
0.00% covered (danger)
0.00%
0 / 1
 12
 getStackId
n/a
0 / 0
n/a
0 / 0
 0
 getStackType
n/a
0 / 0
n/a
0 / 0
 0
 getStackName
n/a
0 / 0
n/a
0 / 0
 0
 getStackHostType
n/a
0 / 0
n/a
0 / 0
 0
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2018 (original work) Open Assessment Technologies SA;
19 *
20 */
21
22namespace oat\oatbox\log\logger\processor;
23
24use Psr\Log\LogLevel;
25
26/**
27 * Processor to add the environment details to the log.
28 *
29 * @package oat\oatbox\log\logger\processor
30 */
31abstract class EnvironmentProcessorAbstract
32{
33    /**
34     * Stack offset name under the log extra offset.
35     */
36    public const LOG_STACK           = 'stack';
37
38    /**
39     * Stack identifier offset name under the stack offset.
40     */
41    public const LOG_STACK_ID        = 'id';
42
43    /**
44     * Stack type offset name under the stack offset.
45     */
46    public const LOG_STACK_TYPE      = 'type';
47
48    /**
49     * Client name offset name under the stack offset.
50     */
51    public const LOG_STACK_NAME      = 'name';
52
53    /**
54     * Host type offset name under the stack offset.
55     */
56    public const LOG_STACK_HOST_TYPE = 'host_type';
57
58    /**
59     * @var string
60     */
61    protected $level;
62
63    /**
64     * EnvironmentProcessor constructor.
65     *
66     * @param string $level
67     */
68    public function __construct($level = LogLevel::DEBUG)
69    {
70        $this->level = $level;
71    }
72
73    /**
74     * Adds the environment specific information to the log.
75     *
76     * @param array $record
77     *
78     * @return array
79     */
80    public function __invoke(array $record)
81    {
82        // No action required when the log level is too low.
83        if ($record['level'] < $this->level) {
84            return $record;
85        }
86
87        // Adds the environment details.
88        $record['extra'][static::LOG_STACK] = isset($record['extra'][static::LOG_STACK])
89            ? $record['extra'][static::LOG_STACK]
90            : []
91        ;
92        $record['extra'][static::LOG_STACK] = array_merge(
93            $record['extra'][static::LOG_STACK],
94            [
95                static::LOG_STACK_ID        => $this->getStackId(),
96                static::LOG_STACK_TYPE      => $this->getStackType(),
97                static::LOG_STACK_NAME      => $this->getStackName(),
98                static::LOG_STACK_HOST_TYPE => $this->getStackHostType(),
99            ]
100        );
101
102        return $record;
103    }
104
105    /**
106     * Returns the current stack id.
107     *
108     * @return string
109     */
110    abstract protected function getStackId();
111
112    /**
113     * Returns the current stack type.
114     *
115     * @return string
116     */
117    abstract protected function getStackType();
118
119    /**
120     * Returns the current stack name.
121     *
122     * @return string
123     */
124    abstract protected function getStackName();
125
126    /**
127     * Returns the current stack host type.
128     *
129     * @return string
130     */
131    abstract protected function getStackHostType();
132}