1 | <?php |
---|
2 | |
---|
3 | /* |
---|
4 | * $Id: BasicLogger.php 521 2007-01-05 13:29:36Z heltem $ |
---|
5 | * |
---|
6 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
---|
7 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
---|
8 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
---|
9 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
---|
10 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
---|
11 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
---|
12 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
---|
13 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
---|
14 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
---|
15 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
---|
16 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
17 | * |
---|
18 | * This software consists of voluntary contributions made by many individuals |
---|
19 | * and is licensed under the LGPL. For more information please see |
---|
20 | * <http://propel.phpdb.org>. |
---|
21 | */ |
---|
22 | |
---|
23 | |
---|
24 | /** |
---|
25 | * This is a minimalistic interface that any logging class must implement for Propel. |
---|
26 | * |
---|
27 | * The API for this interface is based on the PEAR::Log interface. It provides a simple |
---|
28 | * API that can be used by Propel independently of Log backend. |
---|
29 | * |
---|
30 | * PEAR::Log and perhaps the Log API was developed by Chuck Hagenbuch <chuck@horde.org> |
---|
31 | * and Jon Parise <jon@php.net>. |
---|
32 | * |
---|
33 | * @author Hans Lellelid <hans@xmpl.org> |
---|
34 | * @version $Revision: 521 $ |
---|
35 | * @package propel.logger |
---|
36 | */ |
---|
37 | interface BasicLogger { |
---|
38 | |
---|
39 | /** |
---|
40 | * A convenience function for logging an alert event. |
---|
41 | * |
---|
42 | * @param mixed $message String or Exception object containing the message |
---|
43 | * to log. |
---|
44 | */ |
---|
45 | public function alert($message); |
---|
46 | |
---|
47 | /** |
---|
48 | * A convenience function for logging a critical event. |
---|
49 | * |
---|
50 | * @param mixed $message String or Exception object containing the message |
---|
51 | * to log. |
---|
52 | */ |
---|
53 | public function crit($message); |
---|
54 | |
---|
55 | /** |
---|
56 | * A convenience function for logging an error event. |
---|
57 | * |
---|
58 | * @param mixed $message String or Exception object containing the message |
---|
59 | * to log. |
---|
60 | */ |
---|
61 | public function err($message); |
---|
62 | |
---|
63 | /** |
---|
64 | * A convenience function for logging a warning event. |
---|
65 | * |
---|
66 | * @param mixed $message String or Exception object containing the message |
---|
67 | * to log. |
---|
68 | */ |
---|
69 | public function warning($message); |
---|
70 | /** |
---|
71 | * A convenience function for logging an critical event. |
---|
72 | * |
---|
73 | * @param mixed $message String or Exception object containing the message |
---|
74 | * to log. |
---|
75 | */ |
---|
76 | public function notice($message); |
---|
77 | /** |
---|
78 | * A convenience function for logging an critical event. |
---|
79 | * |
---|
80 | * @param mixed $message String or Exception object containing the message |
---|
81 | * to log. |
---|
82 | */ |
---|
83 | public function info($message); |
---|
84 | |
---|
85 | /** |
---|
86 | * A convenience function for logging a debug event. |
---|
87 | * |
---|
88 | * @param mixed $message String or Exception object containing the message |
---|
89 | * to log. |
---|
90 | */ |
---|
91 | public function debug($message); |
---|
92 | |
---|
93 | /** |
---|
94 | * Primary method to handle logging. |
---|
95 | * |
---|
96 | * @param mixed $message String or Exception object containing the message |
---|
97 | * to log. |
---|
98 | * @param int $severity The numeric severity. Defaults to null so that no |
---|
99 | * assumptions are made about the logging backend. |
---|
100 | */ |
---|
101 | public function log($message, $severity = null); |
---|
102 | |
---|
103 | } |
---|