LoggerLayoutPattern.php
5.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?php
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @package log4php
*/
/**
* A flexible layout configurable with a pattern string.
*
* Configurable parameters:
*
* * converionPattern - A string which controls the formatting of logging
* events. See docs for full specification.
*
* @package log4php
* @subpackage layouts
* @version $Revision: 1395470 $
*/
class LoggerLayoutPattern extends LoggerLayout {
/** Default conversion pattern */
const DEFAULT_CONVERSION_PATTERN = '%date %-5level %logger %message%newline';
/** Default conversion TTCC Pattern */
const TTCC_CONVERSION_PATTERN = '%d [%t] %p %c %x - %m%n';
/** The conversion pattern. */
protected $pattern = self::DEFAULT_CONVERSION_PATTERN;
/** Maps conversion keywords to the relevant converter (default implementation). */
protected static $defaultConverterMap = array(
'c' => 'LoggerPatternConverterLogger',
'lo' => 'LoggerPatternConverterLogger',
'logger' => 'LoggerPatternConverterLogger',
'C' => 'LoggerPatternConverterClass',
'class' => 'LoggerPatternConverterClass',
'cookie' => 'LoggerPatternConverterCookie',
'd' => 'LoggerPatternConverterDate',
'date' => 'LoggerPatternConverterDate',
'e' => 'LoggerPatternConverterEnvironment',
'env' => 'LoggerPatternConverterEnvironment',
'ex' => 'LoggerPatternConverterThrowable',
'exception' => 'LoggerPatternConverterThrowable',
'throwable' => 'LoggerPatternConverterThrowable',
'F' => 'LoggerPatternConverterFile',
'file' => 'LoggerPatternConverterFile',
'l' => 'LoggerPatternConverterLocation',
'location' => 'LoggerPatternConverterLocation',
'L' => 'LoggerPatternConverterLine',
'line' => 'LoggerPatternConverterLine',
'm' => 'LoggerPatternConverterMessage',
'msg' => 'LoggerPatternConverterMessage',
'message' => 'LoggerPatternConverterMessage',
'M' => 'LoggerPatternConverterMethod',
'method' => 'LoggerPatternConverterMethod',
'n' => 'LoggerPatternConverterNewLine',
'newline' => 'LoggerPatternConverterNewLine',
'p' => 'LoggerPatternConverterLevel',
'le' => 'LoggerPatternConverterLevel',
'level' => 'LoggerPatternConverterLevel',
'r' => 'LoggerPatternConverterRelative',
'relative' => 'LoggerPatternConverterRelative',
'req' => 'LoggerPatternConverterRequest',
'request' => 'LoggerPatternConverterRequest',
's' => 'LoggerPatternConverterServer',
'server' => 'LoggerPatternConverterServer',
'ses' => 'LoggerPatternConverterSession',
'session' => 'LoggerPatternConverterSession',
'sid' => 'LoggerPatternConverterSessionID',
'sessionid' => 'LoggerPatternConverterSessionID',
't' => 'LoggerPatternConverterProcess',
'pid' => 'LoggerPatternConverterProcess',
'process' => 'LoggerPatternConverterProcess',
'x' => 'LoggerPatternConverterNDC',
'ndc' => 'LoggerPatternConverterNDC',
'X' => 'LoggerPatternConverterMDC',
'mdc' => 'LoggerPatternConverterMDC',
);
/** Maps conversion keywords to the relevant converter. */
protected $converterMap = array();
/**
* Head of a chain of Converters.
* @var LoggerPatternConverter
*/
private $head;
/** Returns the default converter map. */
public static function getDefaultConverterMap() {
return self::$defaultConverterMap;
}
/** Constructor. Initializes the converter map. */
public function __construct() {
$this->converterMap = self::$defaultConverterMap;
}
/**
* Sets the conversionPattern option. This is the string which
* controls formatting and consists of a mix of literal content and
* conversion specifiers.
* @param array $conversionPattern
*/
public function setConversionPattern($conversionPattern) {
$this->pattern = $conversionPattern;
}
/**
* Processes the conversion pattern and creates a corresponding chain of
* pattern converters which will be used to format logging events.
*/
public function activateOptions() {
if (!isset($this->pattern)) {
throw new LoggerException("Mandatory parameter 'conversionPattern' is not set.");
}
$parser = new LoggerPatternParser($this->pattern, $this->converterMap);
$this->head = $parser->parse();
}
/**
* Produces a formatted string as specified by the conversion pattern.
*
* @param LoggerLoggingEvent $event
* @return string
*/
public function format(LoggerLoggingEvent $event) {
$sbuf = '';
$converter = $this->head;
while ($converter !== null) {
$converter->format($sbuf, $event);
$converter = $converter->next;
}
return $sbuf;
}
}