LoggerAppender.php
5.42 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
172
173
174
175
176
177
178
179
180
181
182
183
184
<?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
*/
/**
* @ignore
*/
if (!defined('LOG4PHP_DIR')) define('LOG4PHP_DIR', dirname(__FILE__));
/**
* Abstract class that defines output logs strategies.
*
* @author Marco Vassura
* @version $Revision: 635069 $
* @package log4php
*/
abstract class LoggerAppender {
/**
* Factory
*
* @param string $name appender name
* @param string $class create an instance of this appender class
* @return LoggerAppender
*/
public static function factory($name, $class)
{
$class = basename($class);
if (!empty($class)) {
if (!class_exists($class))
include_once(LOG4PHP_DIR . "/appenders/{$class}.php");
if (class_exists($class))
return new $class($name);
}
return null;
}
/**
* Singleton
*
* @param string $name appender name
* @param string $class create or get a reference instance of this class
* @return LoggerAppender
*/
public static function singleton($name, $class = '')
{
static $instances;
if (!empty($name)) {
if (!isset($instances[$name])) {
if (!empty($class)) {
$appender = self::factory($name, $class);
if ($appender !== null) {
$instances[$name] = $appender;
return $instances[$name];
}
}
return null;
}
return $instances[$name];
}
return null;
}
/* --------------------------------------------------------------------------*/
/* --------------------------------------------------------------------------*/
/* --------------------------------------------------------------------------*/
/**
* Add a filter to the end of the filter list.
*
* @param LoggerFilter $newFilter add a new LoggerFilter
* @abstract
*/
abstract public function addFilter($newFilter);
/**
* Clear the list of filters by removing all the filters in it.
* @abstract
*/
abstract function clearFilters();
/**
* Return the first filter in the filter chain for this Appender.
* The return value may be <i>null</i> if no is filter is set.
* @return LoggerFilter
*/
abstract function getFilter();
/**
* Release any resources allocated.
* Subclasses of {@link LoggerAppender} should implement
* this method to perform proper closing procedures.
* @abstract
*/
abstract public function close();
/**
* This method performs threshold checks and invokes filters before
* delegating actual logging to the subclasses specific <i>append()</i> method.
* @param LoggerLoggingEvent $event
* @abstract
*/
abstract public function doAppend($event);
/**
* Get the name of this appender.
* @return string
*/
abstract public function getName();
/**
* Do not use this method.
*
* @param object $errorHandler
*/
abstract public function setErrorHandler($errorHandler);
/**
* Do not use this method.
* @return object Returns the ErrorHandler for this appender.
*/
abstract public function getErrorHandler();
/**
* Set the Layout for this appender.
*
* @param LoggerLayout $layout
*/
abstract public function setLayout($layout);
/**
* Returns this appender layout.
* @return LoggerLayout
*/
abstract public function getLayout();
/**
* Set the name of this appender.
*
* The name is used by other components to identify this appender.
*
* @param string $name
*/
abstract public function setName($name);
/**
* Configurators call this method to determine if the appender
* requires a layout.
*
* <p>If this method returns <i>true</i>, meaning that layout is required,
* then the configurator will configure a layout using the configuration
* information at its disposal. If this method returns <i>false</i>,
* meaning that a layout is not required, then layout configuration will be
* skipped even if there is available layout configuration
* information at the disposal of the configurator.</p>
*
* <p>In the rather exceptional case, where the appender
* implementation admits a layout but can also work without it, then
* the appender should return <i>true</i>.</p>
*
* @return boolean
*/
abstract public function requiresLayout();
}