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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Jan-Christoph Borchardt <hey@jancborchardt.net>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP;
/**
* Interface ILogger
* @package OCP
* @since 7.0.0
*
* This logger interface follows the design guidelines of PSR-3
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface
*/
interface ILogger {
/**
* @since 14.0.0
*/
public const DEBUG=0;
/**
* @since 14.0.0
*/
public const INFO=1;
/**
* @since 14.0.0
*/
public const WARN=2;
/**
* @since 14.0.0
*/
public const ERROR=3;
/**
* @since 14.0.0
*/
public const FATAL=4;
/**
* System is unusable.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function emergency(string $message, array $context = []);
/**
* Action must be taken immediately.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function alert(string $message, array $context = []);
/**
* Critical conditions.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function critical(string $message, array $context = []);
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function error(string $message, array $context = []);
/**
* Exceptional occurrences that are not errors.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function warning(string $message, array $context = []);
/**
* Normal but significant events.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function notice(string $message, array $context = []);
/**
* Interesting events.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function info(string $message, array $context = []);
/**
* Detailed debug information.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
*/
public function debug(string $message, array $context = []);
/**
* Logs with an arbitrary level.
*
* @param int $level
* @param string $message
* @param array $context
* @return mixed
* @since 7.0.0
*/
public function log(int $level, string $message, array $context = []);
/**
* Logs an exception very detailed
* An additional message can we written to the log by adding it to the
* context.
*
* <code>
* $logger->logException($ex, [
* 'message' => 'Exception during background job execution'
* ]);
* </code>
*
* @param \Exception|\Throwable $exception
* @param array $context
* @return void
* @since 8.2.0
*/
public function logException(\Throwable $exception, array $context = []);
}
|
