@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | 3 | if (class_exists('ParagonIE_Sodium_Core_ChaCha20_Ctx', false)) { |
4 | - return; |
|
4 | + return; |
|
5 | 5 | } |
6 | 6 | |
7 | 7 | /** |
@@ -9,122 +9,122 @@ discard block |
||
9 | 9 | */ |
10 | 10 | class ParagonIE_Sodium_Core32_ChaCha20_Ctx extends ParagonIE_Sodium_Core32_Util implements ArrayAccess |
11 | 11 | { |
12 | - /** |
|
13 | - * @var SplFixedArray internally, <int, ParagonIE_Sodium_Core32_Int32> |
|
14 | - */ |
|
15 | - protected $container; |
|
12 | + /** |
|
13 | + * @var SplFixedArray internally, <int, ParagonIE_Sodium_Core32_Int32> |
|
14 | + */ |
|
15 | + protected $container; |
|
16 | 16 | |
17 | - /** |
|
18 | - * ParagonIE_Sodium_Core_ChaCha20_Ctx constructor. |
|
19 | - * |
|
20 | - * @internal You should not use this directly from another application |
|
21 | - * |
|
22 | - * @param string $key ChaCha20 key. |
|
23 | - * @param string $iv Initialization Vector (a.k.a. nonce). |
|
24 | - * @param string $counter The initial counter value. |
|
25 | - * Defaults to 8 0x00 bytes. |
|
26 | - * @throws InvalidArgumentException |
|
27 | - * @throws SodiumException |
|
28 | - * @throws TypeError |
|
29 | - */ |
|
30 | - public function __construct($key = '', $iv = '', $counter = '') |
|
31 | - { |
|
32 | - if (self::strlen($key) !== 32) { |
|
33 | - throw new InvalidArgumentException('ChaCha20 expects a 256-bit key.'); |
|
34 | - } |
|
35 | - if (self::strlen($iv) !== 8) { |
|
36 | - throw new InvalidArgumentException('ChaCha20 expects a 64-bit nonce.'); |
|
37 | - } |
|
38 | - $this->container = new SplFixedArray(16); |
|
17 | + /** |
|
18 | + * ParagonIE_Sodium_Core_ChaCha20_Ctx constructor. |
|
19 | + * |
|
20 | + * @internal You should not use this directly from another application |
|
21 | + * |
|
22 | + * @param string $key ChaCha20 key. |
|
23 | + * @param string $iv Initialization Vector (a.k.a. nonce). |
|
24 | + * @param string $counter The initial counter value. |
|
25 | + * Defaults to 8 0x00 bytes. |
|
26 | + * @throws InvalidArgumentException |
|
27 | + * @throws SodiumException |
|
28 | + * @throws TypeError |
|
29 | + */ |
|
30 | + public function __construct($key = '', $iv = '', $counter = '') |
|
31 | + { |
|
32 | + if (self::strlen($key) !== 32) { |
|
33 | + throw new InvalidArgumentException('ChaCha20 expects a 256-bit key.'); |
|
34 | + } |
|
35 | + if (self::strlen($iv) !== 8) { |
|
36 | + throw new InvalidArgumentException('ChaCha20 expects a 64-bit nonce.'); |
|
37 | + } |
|
38 | + $this->container = new SplFixedArray(16); |
|
39 | 39 | |
40 | - /* "expand 32-byte k" as per ChaCha20 spec */ |
|
41 | - $this->container[0] = new ParagonIE_Sodium_Core32_Int32(array(0x6170, 0x7865)); |
|
42 | - $this->container[1] = new ParagonIE_Sodium_Core32_Int32(array(0x3320, 0x646e)); |
|
43 | - $this->container[2] = new ParagonIE_Sodium_Core32_Int32(array(0x7962, 0x2d32)); |
|
44 | - $this->container[3] = new ParagonIE_Sodium_Core32_Int32(array(0x6b20, 0x6574)); |
|
40 | + /* "expand 32-byte k" as per ChaCha20 spec */ |
|
41 | + $this->container[0] = new ParagonIE_Sodium_Core32_Int32(array(0x6170, 0x7865)); |
|
42 | + $this->container[1] = new ParagonIE_Sodium_Core32_Int32(array(0x3320, 0x646e)); |
|
43 | + $this->container[2] = new ParagonIE_Sodium_Core32_Int32(array(0x7962, 0x2d32)); |
|
44 | + $this->container[3] = new ParagonIE_Sodium_Core32_Int32(array(0x6b20, 0x6574)); |
|
45 | 45 | |
46 | - $this->container[4] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 0, 4)); |
|
47 | - $this->container[5] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 4, 4)); |
|
48 | - $this->container[6] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 8, 4)); |
|
49 | - $this->container[7] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 12, 4)); |
|
50 | - $this->container[8] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 16, 4)); |
|
51 | - $this->container[9] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 20, 4)); |
|
52 | - $this->container[10] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 24, 4)); |
|
53 | - $this->container[11] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 28, 4)); |
|
46 | + $this->container[4] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 0, 4)); |
|
47 | + $this->container[5] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 4, 4)); |
|
48 | + $this->container[6] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 8, 4)); |
|
49 | + $this->container[7] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 12, 4)); |
|
50 | + $this->container[8] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 16, 4)); |
|
51 | + $this->container[9] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 20, 4)); |
|
52 | + $this->container[10] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 24, 4)); |
|
53 | + $this->container[11] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 28, 4)); |
|
54 | 54 | |
55 | - if (empty($counter)) { |
|
56 | - $this->container[12] = new ParagonIE_Sodium_Core32_Int32(); |
|
57 | - $this->container[13] = new ParagonIE_Sodium_Core32_Int32(); |
|
58 | - } else { |
|
59 | - $this->container[12] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($counter, 0, 4)); |
|
60 | - $this->container[13] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($counter, 4, 4)); |
|
61 | - } |
|
62 | - $this->container[14] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 0, 4)); |
|
63 | - $this->container[15] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 4, 4)); |
|
64 | - } |
|
55 | + if (empty($counter)) { |
|
56 | + $this->container[12] = new ParagonIE_Sodium_Core32_Int32(); |
|
57 | + $this->container[13] = new ParagonIE_Sodium_Core32_Int32(); |
|
58 | + } else { |
|
59 | + $this->container[12] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($counter, 0, 4)); |
|
60 | + $this->container[13] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($counter, 4, 4)); |
|
61 | + } |
|
62 | + $this->container[14] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 0, 4)); |
|
63 | + $this->container[15] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 4, 4)); |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * @internal You should not use this directly from another application |
|
68 | - * |
|
69 | - * @param int $offset |
|
70 | - * @param int|ParagonIE_Sodium_Core32_Int32 $value |
|
71 | - * @return void |
|
72 | - */ |
|
73 | - #[ReturnTypeWillChange] |
|
74 | - public function offsetSet($offset, $value) |
|
75 | - { |
|
76 | - if (!is_int($offset)) { |
|
77 | - throw new InvalidArgumentException('Expected an integer'); |
|
78 | - } |
|
79 | - if ($value instanceof ParagonIE_Sodium_Core32_Int32) { |
|
80 | - /* |
|
66 | + /** |
|
67 | + * @internal You should not use this directly from another application |
|
68 | + * |
|
69 | + * @param int $offset |
|
70 | + * @param int|ParagonIE_Sodium_Core32_Int32 $value |
|
71 | + * @return void |
|
72 | + */ |
|
73 | + #[ReturnTypeWillChange] |
|
74 | + public function offsetSet($offset, $value) |
|
75 | + { |
|
76 | + if (!is_int($offset)) { |
|
77 | + throw new InvalidArgumentException('Expected an integer'); |
|
78 | + } |
|
79 | + if ($value instanceof ParagonIE_Sodium_Core32_Int32) { |
|
80 | + /* |
|
81 | 81 | } elseif (is_int($value)) { |
82 | 82 | $value = ParagonIE_Sodium_Core32_Int32::fromInt($value); |
83 | 83 | */ |
84 | - } else { |
|
85 | - throw new InvalidArgumentException('Expected an integer'); |
|
86 | - } |
|
87 | - $this->container[$offset] = $value; |
|
88 | - } |
|
84 | + } else { |
|
85 | + throw new InvalidArgumentException('Expected an integer'); |
|
86 | + } |
|
87 | + $this->container[$offset] = $value; |
|
88 | + } |
|
89 | 89 | |
90 | - /** |
|
91 | - * @internal You should not use this directly from another application |
|
92 | - * |
|
93 | - * @param int $offset |
|
94 | - * @return bool |
|
95 | - * @psalm-suppress MixedArrayOffset |
|
96 | - */ |
|
97 | - #[ReturnTypeWillChange] |
|
98 | - public function offsetExists($offset) |
|
99 | - { |
|
100 | - return isset($this->container[$offset]); |
|
101 | - } |
|
90 | + /** |
|
91 | + * @internal You should not use this directly from another application |
|
92 | + * |
|
93 | + * @param int $offset |
|
94 | + * @return bool |
|
95 | + * @psalm-suppress MixedArrayOffset |
|
96 | + */ |
|
97 | + #[ReturnTypeWillChange] |
|
98 | + public function offsetExists($offset) |
|
99 | + { |
|
100 | + return isset($this->container[$offset]); |
|
101 | + } |
|
102 | 102 | |
103 | - /** |
|
104 | - * @internal You should not use this directly from another application |
|
105 | - * |
|
106 | - * @param int $offset |
|
107 | - * @return void |
|
108 | - * @psalm-suppress MixedArrayOffset |
|
109 | - */ |
|
110 | - #[ReturnTypeWillChange] |
|
111 | - public function offsetUnset($offset) |
|
112 | - { |
|
113 | - unset($this->container[$offset]); |
|
114 | - } |
|
103 | + /** |
|
104 | + * @internal You should not use this directly from another application |
|
105 | + * |
|
106 | + * @param int $offset |
|
107 | + * @return void |
|
108 | + * @psalm-suppress MixedArrayOffset |
|
109 | + */ |
|
110 | + #[ReturnTypeWillChange] |
|
111 | + public function offsetUnset($offset) |
|
112 | + { |
|
113 | + unset($this->container[$offset]); |
|
114 | + } |
|
115 | 115 | |
116 | - /** |
|
117 | - * @internal You should not use this directly from another application |
|
118 | - * |
|
119 | - * @param int $offset |
|
120 | - * @return mixed|null |
|
121 | - * @psalm-suppress MixedArrayOffset |
|
122 | - */ |
|
123 | - #[ReturnTypeWillChange] |
|
124 | - public function offsetGet($offset) |
|
125 | - { |
|
126 | - return isset($this->container[$offset]) |
|
127 | - ? $this->container[$offset] |
|
128 | - : null; |
|
129 | - } |
|
116 | + /** |
|
117 | + * @internal You should not use this directly from another application |
|
118 | + * |
|
119 | + * @param int $offset |
|
120 | + * @return mixed|null |
|
121 | + * @psalm-suppress MixedArrayOffset |
|
122 | + */ |
|
123 | + #[ReturnTypeWillChange] |
|
124 | + public function offsetGet($offset) |
|
125 | + { |
|
126 | + return isset($this->container[$offset]) |
|
127 | + ? $this->container[$offset] |
|
128 | + : null; |
|
129 | + } |
|
130 | 130 | } |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | 3 | if (class_exists('ParagonIE_Sodium_Core_ChaCha20_IetfCtx', false)) { |
4 | - return; |
|
4 | + return; |
|
5 | 5 | } |
6 | 6 | |
7 | 7 | /** |
@@ -9,31 +9,31 @@ discard block |
||
9 | 9 | */ |
10 | 10 | class ParagonIE_Sodium_Core32_ChaCha20_IetfCtx extends ParagonIE_Sodium_Core32_ChaCha20_Ctx |
11 | 11 | { |
12 | - /** |
|
13 | - * ParagonIE_Sodium_Core_ChaCha20_IetfCtx constructor. |
|
14 | - * |
|
15 | - * @internal You should not use this directly from another application |
|
16 | - * |
|
17 | - * @param string $key ChaCha20 key. |
|
18 | - * @param string $iv Initialization Vector (a.k.a. nonce). |
|
19 | - * @param string $counter The initial counter value. |
|
20 | - * Defaults to 4 0x00 bytes. |
|
21 | - * @throws InvalidArgumentException |
|
22 | - * @throws SodiumException |
|
23 | - * @throws TypeError |
|
24 | - */ |
|
25 | - public function __construct($key = '', $iv = '', $counter = '') |
|
26 | - { |
|
27 | - if (self::strlen($iv) !== 12) { |
|
28 | - throw new InvalidArgumentException('ChaCha20 expects a 96-bit nonce in IETF mode.'); |
|
29 | - } |
|
30 | - parent::__construct($key, self::substr($iv, 0, 8), $counter); |
|
12 | + /** |
|
13 | + * ParagonIE_Sodium_Core_ChaCha20_IetfCtx constructor. |
|
14 | + * |
|
15 | + * @internal You should not use this directly from another application |
|
16 | + * |
|
17 | + * @param string $key ChaCha20 key. |
|
18 | + * @param string $iv Initialization Vector (a.k.a. nonce). |
|
19 | + * @param string $counter The initial counter value. |
|
20 | + * Defaults to 4 0x00 bytes. |
|
21 | + * @throws InvalidArgumentException |
|
22 | + * @throws SodiumException |
|
23 | + * @throws TypeError |
|
24 | + */ |
|
25 | + public function __construct($key = '', $iv = '', $counter = '') |
|
26 | + { |
|
27 | + if (self::strlen($iv) !== 12) { |
|
28 | + throw new InvalidArgumentException('ChaCha20 expects a 96-bit nonce in IETF mode.'); |
|
29 | + } |
|
30 | + parent::__construct($key, self::substr($iv, 0, 8), $counter); |
|
31 | 31 | |
32 | - if (!empty($counter)) { |
|
33 | - $this->container[12] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($counter, 0, 4)); |
|
34 | - } |
|
35 | - $this->container[13] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 0, 4)); |
|
36 | - $this->container[14] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 4, 4)); |
|
37 | - $this->container[15] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 8, 4)); |
|
38 | - } |
|
32 | + if (!empty($counter)) { |
|
33 | + $this->container[12] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($counter, 0, 4)); |
|
34 | + } |
|
35 | + $this->container[13] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 0, 4)); |
|
36 | + $this->container[14] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 4, 4)); |
|
37 | + $this->container[15] = ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($iv, 8, 4)); |
|
38 | + } |
|
39 | 39 | } |
@@ -12,19 +12,19 @@ |
||
12 | 12 | */ |
13 | 13 | class NullLogger extends AbstractLogger |
14 | 14 | { |
15 | - /** |
|
16 | - * Logs with an arbitrary level. |
|
17 | - * |
|
18 | - * @param mixed $level |
|
19 | - * @param string $message |
|
20 | - * @param array $context |
|
21 | - * |
|
22 | - * @return void |
|
23 | - * |
|
24 | - * @throws \Psr\Log\InvalidArgumentException |
|
25 | - */ |
|
26 | - public function log($level, $message, array $context = array()) |
|
27 | - { |
|
28 | - // noop |
|
29 | - } |
|
15 | + /** |
|
16 | + * Logs with an arbitrary level. |
|
17 | + * |
|
18 | + * @param mixed $level |
|
19 | + * @param string $message |
|
20 | + * @param array $context |
|
21 | + * |
|
22 | + * @return void |
|
23 | + * |
|
24 | + * @throws \Psr\Log\InvalidArgumentException |
|
25 | + */ |
|
26 | + public function log($level, $message, array $context = array()) |
|
27 | + { |
|
28 | + // noop |
|
29 | + } |
|
30 | 30 | } |
@@ -12,131 +12,131 @@ |
||
12 | 12 | */ |
13 | 13 | trait LoggerTrait |
14 | 14 | { |
15 | - /** |
|
16 | - * System is unusable. |
|
17 | - * |
|
18 | - * @param string $message |
|
19 | - * @param array $context |
|
20 | - * |
|
21 | - * @return void |
|
22 | - */ |
|
23 | - public function emergency($message, array $context = array()) |
|
24 | - { |
|
25 | - $this->log(LogLevel::EMERGENCY, $message, $context); |
|
26 | - } |
|
15 | + /** |
|
16 | + * System is unusable. |
|
17 | + * |
|
18 | + * @param string $message |
|
19 | + * @param array $context |
|
20 | + * |
|
21 | + * @return void |
|
22 | + */ |
|
23 | + public function emergency($message, array $context = array()) |
|
24 | + { |
|
25 | + $this->log(LogLevel::EMERGENCY, $message, $context); |
|
26 | + } |
|
27 | 27 | |
28 | - /** |
|
29 | - * Action must be taken immediately. |
|
30 | - * |
|
31 | - * Example: Entire website down, database unavailable, etc. This should |
|
32 | - * trigger the SMS alerts and wake you up. |
|
33 | - * |
|
34 | - * @param string $message |
|
35 | - * @param array $context |
|
36 | - * |
|
37 | - * @return void |
|
38 | - */ |
|
39 | - public function alert($message, array $context = array()) |
|
40 | - { |
|
41 | - $this->log(LogLevel::ALERT, $message, $context); |
|
42 | - } |
|
28 | + /** |
|
29 | + * Action must be taken immediately. |
|
30 | + * |
|
31 | + * Example: Entire website down, database unavailable, etc. This should |
|
32 | + * trigger the SMS alerts and wake you up. |
|
33 | + * |
|
34 | + * @param string $message |
|
35 | + * @param array $context |
|
36 | + * |
|
37 | + * @return void |
|
38 | + */ |
|
39 | + public function alert($message, array $context = array()) |
|
40 | + { |
|
41 | + $this->log(LogLevel::ALERT, $message, $context); |
|
42 | + } |
|
43 | 43 | |
44 | - /** |
|
45 | - * Critical conditions. |
|
46 | - * |
|
47 | - * Example: Application component unavailable, unexpected exception. |
|
48 | - * |
|
49 | - * @param string $message |
|
50 | - * @param array $context |
|
51 | - * |
|
52 | - * @return void |
|
53 | - */ |
|
54 | - public function critical($message, array $context = array()) |
|
55 | - { |
|
56 | - $this->log(LogLevel::CRITICAL, $message, $context); |
|
57 | - } |
|
44 | + /** |
|
45 | + * Critical conditions. |
|
46 | + * |
|
47 | + * Example: Application component unavailable, unexpected exception. |
|
48 | + * |
|
49 | + * @param string $message |
|
50 | + * @param array $context |
|
51 | + * |
|
52 | + * @return void |
|
53 | + */ |
|
54 | + public function critical($message, array $context = array()) |
|
55 | + { |
|
56 | + $this->log(LogLevel::CRITICAL, $message, $context); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * Runtime errors that do not require immediate action but should typically |
|
61 | - * be logged and monitored. |
|
62 | - * |
|
63 | - * @param string $message |
|
64 | - * @param array $context |
|
65 | - * |
|
66 | - * @return void |
|
67 | - */ |
|
68 | - public function error($message, array $context = array()) |
|
69 | - { |
|
70 | - $this->log(LogLevel::ERROR, $message, $context); |
|
71 | - } |
|
59 | + /** |
|
60 | + * Runtime errors that do not require immediate action but should typically |
|
61 | + * be logged and monitored. |
|
62 | + * |
|
63 | + * @param string $message |
|
64 | + * @param array $context |
|
65 | + * |
|
66 | + * @return void |
|
67 | + */ |
|
68 | + public function error($message, array $context = array()) |
|
69 | + { |
|
70 | + $this->log(LogLevel::ERROR, $message, $context); |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * Exceptional occurrences that are not errors. |
|
75 | - * |
|
76 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
77 | - * that are not necessarily wrong. |
|
78 | - * |
|
79 | - * @param string $message |
|
80 | - * @param array $context |
|
81 | - * |
|
82 | - * @return void |
|
83 | - */ |
|
84 | - public function warning($message, array $context = array()) |
|
85 | - { |
|
86 | - $this->log(LogLevel::WARNING, $message, $context); |
|
87 | - } |
|
73 | + /** |
|
74 | + * Exceptional occurrences that are not errors. |
|
75 | + * |
|
76 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
77 | + * that are not necessarily wrong. |
|
78 | + * |
|
79 | + * @param string $message |
|
80 | + * @param array $context |
|
81 | + * |
|
82 | + * @return void |
|
83 | + */ |
|
84 | + public function warning($message, array $context = array()) |
|
85 | + { |
|
86 | + $this->log(LogLevel::WARNING, $message, $context); |
|
87 | + } |
|
88 | 88 | |
89 | - /** |
|
90 | - * Normal but significant events. |
|
91 | - * |
|
92 | - * @param string $message |
|
93 | - * @param array $context |
|
94 | - * |
|
95 | - * @return void |
|
96 | - */ |
|
97 | - public function notice($message, array $context = array()) |
|
98 | - { |
|
99 | - $this->log(LogLevel::NOTICE, $message, $context); |
|
100 | - } |
|
89 | + /** |
|
90 | + * Normal but significant events. |
|
91 | + * |
|
92 | + * @param string $message |
|
93 | + * @param array $context |
|
94 | + * |
|
95 | + * @return void |
|
96 | + */ |
|
97 | + public function notice($message, array $context = array()) |
|
98 | + { |
|
99 | + $this->log(LogLevel::NOTICE, $message, $context); |
|
100 | + } |
|
101 | 101 | |
102 | - /** |
|
103 | - * Interesting events. |
|
104 | - * |
|
105 | - * Example: User logs in, SQL logs. |
|
106 | - * |
|
107 | - * @param string $message |
|
108 | - * @param array $context |
|
109 | - * |
|
110 | - * @return void |
|
111 | - */ |
|
112 | - public function info($message, array $context = array()) |
|
113 | - { |
|
114 | - $this->log(LogLevel::INFO, $message, $context); |
|
115 | - } |
|
102 | + /** |
|
103 | + * Interesting events. |
|
104 | + * |
|
105 | + * Example: User logs in, SQL logs. |
|
106 | + * |
|
107 | + * @param string $message |
|
108 | + * @param array $context |
|
109 | + * |
|
110 | + * @return void |
|
111 | + */ |
|
112 | + public function info($message, array $context = array()) |
|
113 | + { |
|
114 | + $this->log(LogLevel::INFO, $message, $context); |
|
115 | + } |
|
116 | 116 | |
117 | - /** |
|
118 | - * Detailed debug information. |
|
119 | - * |
|
120 | - * @param string $message |
|
121 | - * @param array $context |
|
122 | - * |
|
123 | - * @return void |
|
124 | - */ |
|
125 | - public function debug($message, array $context = array()) |
|
126 | - { |
|
127 | - $this->log(LogLevel::DEBUG, $message, $context); |
|
128 | - } |
|
117 | + /** |
|
118 | + * Detailed debug information. |
|
119 | + * |
|
120 | + * @param string $message |
|
121 | + * @param array $context |
|
122 | + * |
|
123 | + * @return void |
|
124 | + */ |
|
125 | + public function debug($message, array $context = array()) |
|
126 | + { |
|
127 | + $this->log(LogLevel::DEBUG, $message, $context); |
|
128 | + } |
|
129 | 129 | |
130 | - /** |
|
131 | - * Logs with an arbitrary level. |
|
132 | - * |
|
133 | - * @param mixed $level |
|
134 | - * @param string $message |
|
135 | - * @param array $context |
|
136 | - * |
|
137 | - * @return void |
|
138 | - * |
|
139 | - * @throws \Psr\Log\InvalidArgumentException |
|
140 | - */ |
|
141 | - abstract public function log($level, $message, array $context = array()); |
|
130 | + /** |
|
131 | + * Logs with an arbitrary level. |
|
132 | + * |
|
133 | + * @param mixed $level |
|
134 | + * @param string $message |
|
135 | + * @param array $context |
|
136 | + * |
|
137 | + * @return void |
|
138 | + * |
|
139 | + * @throws \Psr\Log\InvalidArgumentException |
|
140 | + */ |
|
141 | + abstract public function log($level, $message, array $context = array()); |
|
142 | 142 | } |
@@ -14,125 +14,125 @@ |
||
14 | 14 | */ |
15 | 15 | abstract class LoggerInterfaceTest extends TestCase |
16 | 16 | { |
17 | - /** |
|
18 | - * @return LoggerInterface |
|
19 | - */ |
|
20 | - abstract public function getLogger(); |
|
21 | - |
|
22 | - /** |
|
23 | - * This must return the log messages in order. |
|
24 | - * |
|
25 | - * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>". |
|
26 | - * |
|
27 | - * Example ->error('Foo') would yield "error Foo". |
|
28 | - * |
|
29 | - * @return string[] |
|
30 | - */ |
|
31 | - abstract public function getLogs(); |
|
32 | - |
|
33 | - public function testImplements() |
|
34 | - { |
|
35 | - $this->assertInstanceOf('Psr\Log\LoggerInterface', $this->getLogger()); |
|
36 | - } |
|
37 | - |
|
38 | - /** |
|
39 | - * @dataProvider provideLevelsAndMessages |
|
40 | - */ |
|
41 | - public function testLogsAtAllLevels($level, $message) |
|
42 | - { |
|
43 | - $logger = $this->getLogger(); |
|
44 | - $logger->{$level}($message, array('user' => 'Bob')); |
|
45 | - $logger->log($level, $message, array('user' => 'Bob')); |
|
46 | - |
|
47 | - $expected = array( |
|
48 | - $level.' message of level '.$level.' with context: Bob', |
|
49 | - $level.' message of level '.$level.' with context: Bob', |
|
50 | - ); |
|
51 | - $this->assertEquals($expected, $this->getLogs()); |
|
52 | - } |
|
53 | - |
|
54 | - public function provideLevelsAndMessages() |
|
55 | - { |
|
56 | - return array( |
|
57 | - LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
58 | - LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
59 | - LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
60 | - LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
61 | - LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
62 | - LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
63 | - LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
64 | - LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
65 | - ); |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * @expectedException \Psr\Log\InvalidArgumentException |
|
70 | - */ |
|
71 | - public function testThrowsOnInvalidLevel() |
|
72 | - { |
|
73 | - $logger = $this->getLogger(); |
|
74 | - $logger->log('invalid level', 'Foo'); |
|
75 | - } |
|
76 | - |
|
77 | - public function testContextReplacement() |
|
78 | - { |
|
79 | - $logger = $this->getLogger(); |
|
80 | - $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
81 | - |
|
82 | - $expected = array('info {Message {nothing} Bob Bar a}'); |
|
83 | - $this->assertEquals($expected, $this->getLogs()); |
|
84 | - } |
|
85 | - |
|
86 | - public function testObjectCastToString() |
|
87 | - { |
|
88 | - if (method_exists($this, 'createPartialMock')) { |
|
89 | - $dummy = $this->createPartialMock('Psr\Log\Test\DummyTest', array('__toString')); |
|
90 | - } else { |
|
91 | - $dummy = $this->getMock('Psr\Log\Test\DummyTest', array('__toString')); |
|
92 | - } |
|
93 | - $dummy->expects($this->once()) |
|
94 | - ->method('__toString') |
|
95 | - ->will($this->returnValue('DUMMY')); |
|
96 | - |
|
97 | - $this->getLogger()->warning($dummy); |
|
98 | - |
|
99 | - $expected = array('warning DUMMY'); |
|
100 | - $this->assertEquals($expected, $this->getLogs()); |
|
101 | - } |
|
102 | - |
|
103 | - public function testContextCanContainAnything() |
|
104 | - { |
|
105 | - $closed = fopen('php://memory', 'r'); |
|
106 | - fclose($closed); |
|
107 | - |
|
108 | - $context = array( |
|
109 | - 'bool' => true, |
|
110 | - 'null' => null, |
|
111 | - 'string' => 'Foo', |
|
112 | - 'int' => 0, |
|
113 | - 'float' => 0.5, |
|
114 | - 'nested' => array('with object' => new DummyTest), |
|
115 | - 'object' => new \DateTime, |
|
116 | - 'resource' => fopen('php://memory', 'r'), |
|
117 | - 'closed' => $closed, |
|
118 | - ); |
|
119 | - |
|
120 | - $this->getLogger()->warning('Crazy context data', $context); |
|
121 | - |
|
122 | - $expected = array('warning Crazy context data'); |
|
123 | - $this->assertEquals($expected, $this->getLogs()); |
|
124 | - } |
|
125 | - |
|
126 | - public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
127 | - { |
|
128 | - $logger = $this->getLogger(); |
|
129 | - $logger->warning('Random message', array('exception' => 'oops')); |
|
130 | - $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
131 | - |
|
132 | - $expected = array( |
|
133 | - 'warning Random message', |
|
134 | - 'critical Uncaught Exception!' |
|
135 | - ); |
|
136 | - $this->assertEquals($expected, $this->getLogs()); |
|
137 | - } |
|
17 | + /** |
|
18 | + * @return LoggerInterface |
|
19 | + */ |
|
20 | + abstract public function getLogger(); |
|
21 | + |
|
22 | + /** |
|
23 | + * This must return the log messages in order. |
|
24 | + * |
|
25 | + * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>". |
|
26 | + * |
|
27 | + * Example ->error('Foo') would yield "error Foo". |
|
28 | + * |
|
29 | + * @return string[] |
|
30 | + */ |
|
31 | + abstract public function getLogs(); |
|
32 | + |
|
33 | + public function testImplements() |
|
34 | + { |
|
35 | + $this->assertInstanceOf('Psr\Log\LoggerInterface', $this->getLogger()); |
|
36 | + } |
|
37 | + |
|
38 | + /** |
|
39 | + * @dataProvider provideLevelsAndMessages |
|
40 | + */ |
|
41 | + public function testLogsAtAllLevels($level, $message) |
|
42 | + { |
|
43 | + $logger = $this->getLogger(); |
|
44 | + $logger->{$level}($message, array('user' => 'Bob')); |
|
45 | + $logger->log($level, $message, array('user' => 'Bob')); |
|
46 | + |
|
47 | + $expected = array( |
|
48 | + $level.' message of level '.$level.' with context: Bob', |
|
49 | + $level.' message of level '.$level.' with context: Bob', |
|
50 | + ); |
|
51 | + $this->assertEquals($expected, $this->getLogs()); |
|
52 | + } |
|
53 | + |
|
54 | + public function provideLevelsAndMessages() |
|
55 | + { |
|
56 | + return array( |
|
57 | + LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
58 | + LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
59 | + LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
60 | + LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
61 | + LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
62 | + LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
63 | + LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
64 | + LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
65 | + ); |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * @expectedException \Psr\Log\InvalidArgumentException |
|
70 | + */ |
|
71 | + public function testThrowsOnInvalidLevel() |
|
72 | + { |
|
73 | + $logger = $this->getLogger(); |
|
74 | + $logger->log('invalid level', 'Foo'); |
|
75 | + } |
|
76 | + |
|
77 | + public function testContextReplacement() |
|
78 | + { |
|
79 | + $logger = $this->getLogger(); |
|
80 | + $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
81 | + |
|
82 | + $expected = array('info {Message {nothing} Bob Bar a}'); |
|
83 | + $this->assertEquals($expected, $this->getLogs()); |
|
84 | + } |
|
85 | + |
|
86 | + public function testObjectCastToString() |
|
87 | + { |
|
88 | + if (method_exists($this, 'createPartialMock')) { |
|
89 | + $dummy = $this->createPartialMock('Psr\Log\Test\DummyTest', array('__toString')); |
|
90 | + } else { |
|
91 | + $dummy = $this->getMock('Psr\Log\Test\DummyTest', array('__toString')); |
|
92 | + } |
|
93 | + $dummy->expects($this->once()) |
|
94 | + ->method('__toString') |
|
95 | + ->will($this->returnValue('DUMMY')); |
|
96 | + |
|
97 | + $this->getLogger()->warning($dummy); |
|
98 | + |
|
99 | + $expected = array('warning DUMMY'); |
|
100 | + $this->assertEquals($expected, $this->getLogs()); |
|
101 | + } |
|
102 | + |
|
103 | + public function testContextCanContainAnything() |
|
104 | + { |
|
105 | + $closed = fopen('php://memory', 'r'); |
|
106 | + fclose($closed); |
|
107 | + |
|
108 | + $context = array( |
|
109 | + 'bool' => true, |
|
110 | + 'null' => null, |
|
111 | + 'string' => 'Foo', |
|
112 | + 'int' => 0, |
|
113 | + 'float' => 0.5, |
|
114 | + 'nested' => array('with object' => new DummyTest), |
|
115 | + 'object' => new \DateTime, |
|
116 | + 'resource' => fopen('php://memory', 'r'), |
|
117 | + 'closed' => $closed, |
|
118 | + ); |
|
119 | + |
|
120 | + $this->getLogger()->warning('Crazy context data', $context); |
|
121 | + |
|
122 | + $expected = array('warning Crazy context data'); |
|
123 | + $this->assertEquals($expected, $this->getLogs()); |
|
124 | + } |
|
125 | + |
|
126 | + public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
127 | + { |
|
128 | + $logger = $this->getLogger(); |
|
129 | + $logger->warning('Random message', array('exception' => 'oops')); |
|
130 | + $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
131 | + |
|
132 | + $expected = array( |
|
133 | + 'warning Random message', |
|
134 | + 'critical Uncaught Exception!' |
|
135 | + ); |
|
136 | + $this->assertEquals($expected, $this->getLogs()); |
|
137 | + } |
|
138 | 138 | } |
@@ -19,107 +19,107 @@ |
||
19 | 19 | */ |
20 | 20 | interface LoggerInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * System is unusable. |
|
24 | - * |
|
25 | - * @param string $message |
|
26 | - * @param mixed[] $context |
|
27 | - * |
|
28 | - * @return void |
|
29 | - */ |
|
30 | - public function emergency($message, array $context = array()); |
|
22 | + /** |
|
23 | + * System is unusable. |
|
24 | + * |
|
25 | + * @param string $message |
|
26 | + * @param mixed[] $context |
|
27 | + * |
|
28 | + * @return void |
|
29 | + */ |
|
30 | + public function emergency($message, array $context = array()); |
|
31 | 31 | |
32 | - /** |
|
33 | - * Action must be taken immediately. |
|
34 | - * |
|
35 | - * Example: Entire website down, database unavailable, etc. This should |
|
36 | - * trigger the SMS alerts and wake you up. |
|
37 | - * |
|
38 | - * @param string $message |
|
39 | - * @param mixed[] $context |
|
40 | - * |
|
41 | - * @return void |
|
42 | - */ |
|
43 | - public function alert($message, array $context = array()); |
|
32 | + /** |
|
33 | + * Action must be taken immediately. |
|
34 | + * |
|
35 | + * Example: Entire website down, database unavailable, etc. This should |
|
36 | + * trigger the SMS alerts and wake you up. |
|
37 | + * |
|
38 | + * @param string $message |
|
39 | + * @param mixed[] $context |
|
40 | + * |
|
41 | + * @return void |
|
42 | + */ |
|
43 | + public function alert($message, array $context = array()); |
|
44 | 44 | |
45 | - /** |
|
46 | - * Critical conditions. |
|
47 | - * |
|
48 | - * Example: Application component unavailable, unexpected exception. |
|
49 | - * |
|
50 | - * @param string $message |
|
51 | - * @param mixed[] $context |
|
52 | - * |
|
53 | - * @return void |
|
54 | - */ |
|
55 | - public function critical($message, array $context = array()); |
|
45 | + /** |
|
46 | + * Critical conditions. |
|
47 | + * |
|
48 | + * Example: Application component unavailable, unexpected exception. |
|
49 | + * |
|
50 | + * @param string $message |
|
51 | + * @param mixed[] $context |
|
52 | + * |
|
53 | + * @return void |
|
54 | + */ |
|
55 | + public function critical($message, array $context = array()); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Runtime errors that do not require immediate action but should typically |
|
59 | - * be logged and monitored. |
|
60 | - * |
|
61 | - * @param string $message |
|
62 | - * @param mixed[] $context |
|
63 | - * |
|
64 | - * @return void |
|
65 | - */ |
|
66 | - public function error($message, array $context = array()); |
|
57 | + /** |
|
58 | + * Runtime errors that do not require immediate action but should typically |
|
59 | + * be logged and monitored. |
|
60 | + * |
|
61 | + * @param string $message |
|
62 | + * @param mixed[] $context |
|
63 | + * |
|
64 | + * @return void |
|
65 | + */ |
|
66 | + public function error($message, array $context = array()); |
|
67 | 67 | |
68 | - /** |
|
69 | - * Exceptional occurrences that are not errors. |
|
70 | - * |
|
71 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
72 | - * that are not necessarily wrong. |
|
73 | - * |
|
74 | - * @param string $message |
|
75 | - * @param mixed[] $context |
|
76 | - * |
|
77 | - * @return void |
|
78 | - */ |
|
79 | - public function warning($message, array $context = array()); |
|
68 | + /** |
|
69 | + * Exceptional occurrences that are not errors. |
|
70 | + * |
|
71 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
72 | + * that are not necessarily wrong. |
|
73 | + * |
|
74 | + * @param string $message |
|
75 | + * @param mixed[] $context |
|
76 | + * |
|
77 | + * @return void |
|
78 | + */ |
|
79 | + public function warning($message, array $context = array()); |
|
80 | 80 | |
81 | - /** |
|
82 | - * Normal but significant events. |
|
83 | - * |
|
84 | - * @param string $message |
|
85 | - * @param mixed[] $context |
|
86 | - * |
|
87 | - * @return void |
|
88 | - */ |
|
89 | - public function notice($message, array $context = array()); |
|
81 | + /** |
|
82 | + * Normal but significant events. |
|
83 | + * |
|
84 | + * @param string $message |
|
85 | + * @param mixed[] $context |
|
86 | + * |
|
87 | + * @return void |
|
88 | + */ |
|
89 | + public function notice($message, array $context = array()); |
|
90 | 90 | |
91 | - /** |
|
92 | - * Interesting events. |
|
93 | - * |
|
94 | - * Example: User logs in, SQL logs. |
|
95 | - * |
|
96 | - * @param string $message |
|
97 | - * @param mixed[] $context |
|
98 | - * |
|
99 | - * @return void |
|
100 | - */ |
|
101 | - public function info($message, array $context = array()); |
|
91 | + /** |
|
92 | + * Interesting events. |
|
93 | + * |
|
94 | + * Example: User logs in, SQL logs. |
|
95 | + * |
|
96 | + * @param string $message |
|
97 | + * @param mixed[] $context |
|
98 | + * |
|
99 | + * @return void |
|
100 | + */ |
|
101 | + public function info($message, array $context = array()); |
|
102 | 102 | |
103 | - /** |
|
104 | - * Detailed debug information. |
|
105 | - * |
|
106 | - * @param string $message |
|
107 | - * @param mixed[] $context |
|
108 | - * |
|
109 | - * @return void |
|
110 | - */ |
|
111 | - public function debug($message, array $context = array()); |
|
103 | + /** |
|
104 | + * Detailed debug information. |
|
105 | + * |
|
106 | + * @param string $message |
|
107 | + * @param mixed[] $context |
|
108 | + * |
|
109 | + * @return void |
|
110 | + */ |
|
111 | + public function debug($message, array $context = array()); |
|
112 | 112 | |
113 | - /** |
|
114 | - * Logs with an arbitrary level. |
|
115 | - * |
|
116 | - * @param mixed $level |
|
117 | - * @param string $message |
|
118 | - * @param mixed[] $context |
|
119 | - * |
|
120 | - * @return void |
|
121 | - * |
|
122 | - * @throws \Psr\Log\InvalidArgumentException |
|
123 | - */ |
|
124 | - public function log($level, $message, array $context = array()); |
|
113 | + /** |
|
114 | + * Logs with an arbitrary level. |
|
115 | + * |
|
116 | + * @param mixed $level |
|
117 | + * @param string $message |
|
118 | + * @param mixed[] $context |
|
119 | + * |
|
120 | + * @return void |
|
121 | + * |
|
122 | + * @throws \Psr\Log\InvalidArgumentException |
|
123 | + */ |
|
124 | + public function log($level, $message, array $context = array()); |
|
125 | 125 | } |
@@ -5,22 +5,22 @@ |
||
5 | 5 | $issues = array(); |
6 | 6 | |
7 | 7 | if (!(PHP_VERSION_ID >= 50300)) { |
8 | - $issues[] = 'Your Composer dependencies require a PHP version ">= 5.3.0". You are running ' . PHP_VERSION . '.'; |
|
8 | + $issues[] = 'Your Composer dependencies require a PHP version ">= 5.3.0". You are running ' . PHP_VERSION . '.'; |
|
9 | 9 | } |
10 | 10 | |
11 | 11 | if ($issues) { |
12 | - if (!headers_sent()) { |
|
13 | - header('HTTP/1.1 500 Internal Server Error'); |
|
14 | - } |
|
15 | - if (!ini_get('display_errors')) { |
|
16 | - if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') { |
|
17 | - fwrite(STDERR, 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . implode(PHP_EOL, $issues) . PHP_EOL.PHP_EOL); |
|
18 | - } elseif (!headers_sent()) { |
|
19 | - echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL; |
|
20 | - } |
|
21 | - } |
|
22 | - trigger_error( |
|
23 | - 'Composer detected issues in your platform: ' . implode(' ', $issues), |
|
24 | - E_USER_ERROR |
|
25 | - ); |
|
12 | + if (!headers_sent()) { |
|
13 | + header('HTTP/1.1 500 Internal Server Error'); |
|
14 | + } |
|
15 | + if (!ini_get('display_errors')) { |
|
16 | + if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') { |
|
17 | + fwrite(STDERR, 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . implode(PHP_EOL, $issues) . PHP_EOL.PHP_EOL); |
|
18 | + } elseif (!headers_sent()) { |
|
19 | + echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL; |
|
20 | + } |
|
21 | + } |
|
22 | + trigger_error( |
|
23 | + 'Composer detected issues in your platform: ' . implode(' ', $issues), |
|
24 | + E_USER_ERROR |
|
25 | + ); |
|
26 | 26 | } |
@@ -13,20 +13,20 @@ |
||
13 | 13 | */ |
14 | 14 | trait LoggerAwareTrait |
15 | 15 | { |
16 | - /** |
|
17 | - * The logger instance. |
|
18 | - * |
|
19 | - * @var LoggerInterface|null |
|
20 | - */ |
|
21 | - protected $logger; |
|
16 | + /** |
|
17 | + * The logger instance. |
|
18 | + * |
|
19 | + * @var LoggerInterface|null |
|
20 | + */ |
|
21 | + protected $logger; |
|
22 | 22 | |
23 | - /** |
|
24 | - * Sets a logger. |
|
25 | - * |
|
26 | - * @param LoggerInterface $logger |
|
27 | - */ |
|
28 | - public function setLogger(LoggerInterface $logger) |
|
29 | - { |
|
30 | - $this->logger = $logger; |
|
31 | - } |
|
23 | + /** |
|
24 | + * Sets a logger. |
|
25 | + * |
|
26 | + * @param LoggerInterface $logger |
|
27 | + */ |
|
28 | + public function setLogger(LoggerInterface $logger) |
|
29 | + { |
|
30 | + $this->logger = $logger; |
|
31 | + } |
|
32 | 32 | } |
@@ -17,118 +17,118 @@ |
||
17 | 17 | */ |
18 | 18 | abstract class AbstractLogger implements LoggerInterface |
19 | 19 | { |
20 | - /** |
|
21 | - * System is unusable. |
|
22 | - * |
|
23 | - * @param string $message |
|
24 | - * @param mixed[] $context |
|
25 | - * |
|
26 | - * @return void |
|
27 | - */ |
|
28 | - public function emergency($message, array $context = array()) |
|
29 | - { |
|
30 | - $this->log(LogLevel::EMERGENCY, $message, $context); |
|
31 | - } |
|
20 | + /** |
|
21 | + * System is unusable. |
|
22 | + * |
|
23 | + * @param string $message |
|
24 | + * @param mixed[] $context |
|
25 | + * |
|
26 | + * @return void |
|
27 | + */ |
|
28 | + public function emergency($message, array $context = array()) |
|
29 | + { |
|
30 | + $this->log(LogLevel::EMERGENCY, $message, $context); |
|
31 | + } |
|
32 | 32 | |
33 | - /** |
|
34 | - * Action must be taken immediately. |
|
35 | - * |
|
36 | - * Example: Entire website down, database unavailable, etc. This should |
|
37 | - * trigger the SMS alerts and wake you up. |
|
38 | - * |
|
39 | - * @param string $message |
|
40 | - * @param mixed[] $context |
|
41 | - * |
|
42 | - * @return void |
|
43 | - */ |
|
44 | - public function alert($message, array $context = array()) |
|
45 | - { |
|
46 | - $this->log(LogLevel::ALERT, $message, $context); |
|
47 | - } |
|
33 | + /** |
|
34 | + * Action must be taken immediately. |
|
35 | + * |
|
36 | + * Example: Entire website down, database unavailable, etc. This should |
|
37 | + * trigger the SMS alerts and wake you up. |
|
38 | + * |
|
39 | + * @param string $message |
|
40 | + * @param mixed[] $context |
|
41 | + * |
|
42 | + * @return void |
|
43 | + */ |
|
44 | + public function alert($message, array $context = array()) |
|
45 | + { |
|
46 | + $this->log(LogLevel::ALERT, $message, $context); |
|
47 | + } |
|
48 | 48 | |
49 | - /** |
|
50 | - * Critical conditions. |
|
51 | - * |
|
52 | - * Example: Application component unavailable, unexpected exception. |
|
53 | - * |
|
54 | - * @param string $message |
|
55 | - * @param mixed[] $context |
|
56 | - * |
|
57 | - * @return void |
|
58 | - */ |
|
59 | - public function critical($message, array $context = array()) |
|
60 | - { |
|
61 | - $this->log(LogLevel::CRITICAL, $message, $context); |
|
62 | - } |
|
49 | + /** |
|
50 | + * Critical conditions. |
|
51 | + * |
|
52 | + * Example: Application component unavailable, unexpected exception. |
|
53 | + * |
|
54 | + * @param string $message |
|
55 | + * @param mixed[] $context |
|
56 | + * |
|
57 | + * @return void |
|
58 | + */ |
|
59 | + public function critical($message, array $context = array()) |
|
60 | + { |
|
61 | + $this->log(LogLevel::CRITICAL, $message, $context); |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * Runtime errors that do not require immediate action but should typically |
|
66 | - * be logged and monitored. |
|
67 | - * |
|
68 | - * @param string $message |
|
69 | - * @param mixed[] $context |
|
70 | - * |
|
71 | - * @return void |
|
72 | - */ |
|
73 | - public function error($message, array $context = array()) |
|
74 | - { |
|
75 | - $this->log(LogLevel::ERROR, $message, $context); |
|
76 | - } |
|
64 | + /** |
|
65 | + * Runtime errors that do not require immediate action but should typically |
|
66 | + * be logged and monitored. |
|
67 | + * |
|
68 | + * @param string $message |
|
69 | + * @param mixed[] $context |
|
70 | + * |
|
71 | + * @return void |
|
72 | + */ |
|
73 | + public function error($message, array $context = array()) |
|
74 | + { |
|
75 | + $this->log(LogLevel::ERROR, $message, $context); |
|
76 | + } |
|
77 | 77 | |
78 | - /** |
|
79 | - * Exceptional occurrences that are not errors. |
|
80 | - * |
|
81 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
82 | - * that are not necessarily wrong. |
|
83 | - * |
|
84 | - * @param string $message |
|
85 | - * @param mixed[] $context |
|
86 | - * |
|
87 | - * @return void |
|
88 | - */ |
|
89 | - public function warning($message, array $context = array()) |
|
90 | - { |
|
91 | - $this->log(LogLevel::WARNING, $message, $context); |
|
92 | - } |
|
78 | + /** |
|
79 | + * Exceptional occurrences that are not errors. |
|
80 | + * |
|
81 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
82 | + * that are not necessarily wrong. |
|
83 | + * |
|
84 | + * @param string $message |
|
85 | + * @param mixed[] $context |
|
86 | + * |
|
87 | + * @return void |
|
88 | + */ |
|
89 | + public function warning($message, array $context = array()) |
|
90 | + { |
|
91 | + $this->log(LogLevel::WARNING, $message, $context); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Normal but significant events. |
|
96 | - * |
|
97 | - * @param string $message |
|
98 | - * @param mixed[] $context |
|
99 | - * |
|
100 | - * @return void |
|
101 | - */ |
|
102 | - public function notice($message, array $context = array()) |
|
103 | - { |
|
104 | - $this->log(LogLevel::NOTICE, $message, $context); |
|
105 | - } |
|
94 | + /** |
|
95 | + * Normal but significant events. |
|
96 | + * |
|
97 | + * @param string $message |
|
98 | + * @param mixed[] $context |
|
99 | + * |
|
100 | + * @return void |
|
101 | + */ |
|
102 | + public function notice($message, array $context = array()) |
|
103 | + { |
|
104 | + $this->log(LogLevel::NOTICE, $message, $context); |
|
105 | + } |
|
106 | 106 | |
107 | - /** |
|
108 | - * Interesting events. |
|
109 | - * |
|
110 | - * Example: User logs in, SQL logs. |
|
111 | - * |
|
112 | - * @param string $message |
|
113 | - * @param mixed[] $context |
|
114 | - * |
|
115 | - * @return void |
|
116 | - */ |
|
117 | - public function info($message, array $context = array()) |
|
118 | - { |
|
119 | - $this->log(LogLevel::INFO, $message, $context); |
|
120 | - } |
|
107 | + /** |
|
108 | + * Interesting events. |
|
109 | + * |
|
110 | + * Example: User logs in, SQL logs. |
|
111 | + * |
|
112 | + * @param string $message |
|
113 | + * @param mixed[] $context |
|
114 | + * |
|
115 | + * @return void |
|
116 | + */ |
|
117 | + public function info($message, array $context = array()) |
|
118 | + { |
|
119 | + $this->log(LogLevel::INFO, $message, $context); |
|
120 | + } |
|
121 | 121 | |
122 | - /** |
|
123 | - * Detailed debug information. |
|
124 | - * |
|
125 | - * @param string $message |
|
126 | - * @param mixed[] $context |
|
127 | - * |
|
128 | - * @return void |
|
129 | - */ |
|
130 | - public function debug($message, array $context = array()) |
|
131 | - { |
|
132 | - $this->log(LogLevel::DEBUG, $message, $context); |
|
133 | - } |
|
122 | + /** |
|
123 | + * Detailed debug information. |
|
124 | + * |
|
125 | + * @param string $message |
|
126 | + * @param mixed[] $context |
|
127 | + * |
|
128 | + * @return void |
|
129 | + */ |
|
130 | + public function debug($message, array $context = array()) |
|
131 | + { |
|
132 | + $this->log(LogLevel::DEBUG, $message, $context); |
|
133 | + } |
|
134 | 134 | } |