log/src/LoggerInterface.php at master · php-fig/log · GitHub

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
<?php

namespacePsr\Log;

/**
 * Describes a logger instance.
 *
 * The message MUST be a string or object implementing __toString().
 *
 * The message MAY contain placeholders in the form: {foo} where foo
 * will be replaced by the context data in key "foo".
 *
 * The context array can contain arbitrary data. The only assumption that
 * can be made by implementors is that if an Exception instance is given
 * to produce a stack trace, it MUST be in a key named "exception".
 *
 * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
 * for the full interface specification.
 */
interface LoggerInterface
{
/**
 * System is unusable.
 *
 * @param mixed[] $context
 */
publicfunctionemergency(string|\Stringable$message, array$context = []): void;

/**
 * Action must be taken immediately.
 *
 * Example: Entire website down, database unavailable, etc. This should
 * trigger the SMS alerts and wake you up.
 *
 * @param mixed[] $context
 */
publicfunctionalert(string|\Stringable$message, array$context = []): void;

/**
 * Critical conditions.
 *
 * Example: Application component unavailable, unexpected exception.
 *
 * @param mixed[] $context
 */
publicfunctioncritical(string|\Stringable$message, array$context = []): void;

/**
 * Runtime errors that do not require immediate action but should typically
 * be logged and monitored.
 *
 * @param mixed[] $context
 */
publicfunctionerror(string|\Stringable$message, array$context = []): void;

/**
 * Exceptional occurrences that are not errors.
 *
 * Example: Use of deprecated APIs, poor use of an API, undesirable things
 * that are not necessarily wrong.
 *
 * @param mixed[] $context
 */
publicfunctionwarning(string|\Stringable$message, array$context = []): void;

/**
 * Normal but significant events.
 *
 * @param mixed[] $context
 */
publicfunctionnotice(string|\Stringable$message, array$context = []): void;

/**
 * Interesting events.
 *
 * Example: User logs in, SQL logs.
 *
 * @param mixed[] $context
 */
publicfunctioninfo(string|\Stringable$message, array$context = []): void;

/**
 * Detailed debug information.
 *
 * @param mixed[] $context
 */
publicfunctiondebug(string|\Stringable$message, array$context = []): void;

/**
 * Logs with an arbitrary level.
 *
 * @param mixed $level
 * @param mixed[] $context
 *
 * @throws \Psr\Log\InvalidArgumentException
 */
publicfunctionlog($level, string|\Stringable$message, array$context = []): void;
}