@@ -13,12 +13,12 @@ |
||
13 | 13 | */ |
14 | 14 | class LogLevel |
15 | 15 | { |
16 | - const EMERGENCY = 'emergency'; |
|
17 | - const ALERT = 'alert'; |
|
18 | - const CRITICAL = 'critical'; |
|
19 | - const ERROR = 'error'; |
|
20 | - const WARNING = 'warning'; |
|
21 | - const NOTICE = 'notice'; |
|
22 | - const INFO = 'info'; |
|
23 | - const DEBUG = 'debug'; |
|
16 | + const EMERGENCY = 'emergency'; |
|
17 | + const ALERT = 'alert'; |
|
18 | + const CRITICAL = 'critical'; |
|
19 | + const ERROR = 'error'; |
|
20 | + const WARNING = 'warning'; |
|
21 | + const NOTICE = 'notice'; |
|
22 | + const INFO = 'info'; |
|
23 | + const DEBUG = 'debug'; |
|
24 | 24 | } |
@@ -11,8 +11,7 @@ |
||
11 | 11 | /** |
12 | 12 | * Describes log levels. |
13 | 13 | */ |
14 | -class LogLevel |
|
15 | -{ |
|
14 | +class LogLevel { |
|
16 | 15 | const EMERGENCY = 'emergency'; |
17 | 16 | const ALERT = 'alert'; |
18 | 17 | const CRITICAL = 'critical'; |
@@ -18,19 +18,19 @@ |
||
18 | 18 | */ |
19 | 19 | class NullLogger extends AbstractLogger |
20 | 20 | { |
21 | - /** |
|
22 | - * Logs with an arbitrary level. |
|
23 | - * |
|
24 | - * @param mixed $level |
|
25 | - * @param string $message |
|
26 | - * @param array $context |
|
27 | - * |
|
28 | - * @return void |
|
29 | - * |
|
30 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
31 | - */ |
|
32 | - public function log($level, $message, array $context = array()) |
|
33 | - { |
|
34 | - // noop |
|
35 | - } |
|
21 | + /** |
|
22 | + * Logs with an arbitrary level. |
|
23 | + * |
|
24 | + * @param mixed $level |
|
25 | + * @param string $message |
|
26 | + * @param array $context |
|
27 | + * |
|
28 | + * @return void |
|
29 | + * |
|
30 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
31 | + */ |
|
32 | + public function log($level, $message, array $context = array()) |
|
33 | + { |
|
34 | + // noop |
|
35 | + } |
|
36 | 36 | } |
@@ -29,7 +29,7 @@ |
||
29 | 29 | * |
30 | 30 | * @throws \GravityView\Psr\Log\InvalidArgumentException |
31 | 31 | */ |
32 | - public function log($level, $message, array $context = array()) |
|
32 | + public function log( $level, $message, array $context = array() ) |
|
33 | 33 | { |
34 | 34 | // noop |
35 | 35 | } |
@@ -16,8 +16,7 @@ discard block |
||
16 | 16 | * is a good way to avoid littering your code with `if ($this->logger) { }` |
17 | 17 | * blocks. |
18 | 18 | */ |
19 | -class NullLogger extends AbstractLogger |
|
20 | -{ |
|
19 | +class NullLogger extends AbstractLogger { |
|
21 | 20 | /** |
22 | 21 | * Logs with an arbitrary level. |
23 | 22 | * |
@@ -29,8 +28,7 @@ discard block |
||
29 | 28 | * |
30 | 29 | * @throws \GravityView\Psr\Log\InvalidArgumentException |
31 | 30 | */ |
32 | - public function log($level, $message, array $context = array()) |
|
33 | - { |
|
31 | + public function log($level, $message, array $context = array()) { |
|
34 | 32 | // noop |
35 | 33 | } |
36 | 34 | } |
@@ -18,131 +18,131 @@ |
||
18 | 18 | */ |
19 | 19 | trait LoggerTrait |
20 | 20 | { |
21 | - /** |
|
22 | - * System is unusable. |
|
23 | - * |
|
24 | - * @param string $message |
|
25 | - * @param array $context |
|
26 | - * |
|
27 | - * @return void |
|
28 | - */ |
|
29 | - public function emergency($message, array $context = array()) |
|
30 | - { |
|
31 | - $this->log(LogLevel::EMERGENCY, $message, $context); |
|
32 | - } |
|
21 | + /** |
|
22 | + * System is unusable. |
|
23 | + * |
|
24 | + * @param string $message |
|
25 | + * @param array $context |
|
26 | + * |
|
27 | + * @return void |
|
28 | + */ |
|
29 | + public function emergency($message, array $context = array()) |
|
30 | + { |
|
31 | + $this->log(LogLevel::EMERGENCY, $message, $context); |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * Action must be taken immediately. |
|
36 | - * |
|
37 | - * Example: Entire website down, database unavailable, etc. This should |
|
38 | - * trigger the SMS alerts and wake you up. |
|
39 | - * |
|
40 | - * @param string $message |
|
41 | - * @param array $context |
|
42 | - * |
|
43 | - * @return void |
|
44 | - */ |
|
45 | - public function alert($message, array $context = array()) |
|
46 | - { |
|
47 | - $this->log(LogLevel::ALERT, $message, $context); |
|
48 | - } |
|
34 | + /** |
|
35 | + * Action must be taken immediately. |
|
36 | + * |
|
37 | + * Example: Entire website down, database unavailable, etc. This should |
|
38 | + * trigger the SMS alerts and wake you up. |
|
39 | + * |
|
40 | + * @param string $message |
|
41 | + * @param array $context |
|
42 | + * |
|
43 | + * @return void |
|
44 | + */ |
|
45 | + public function alert($message, array $context = array()) |
|
46 | + { |
|
47 | + $this->log(LogLevel::ALERT, $message, $context); |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * Critical conditions. |
|
52 | - * |
|
53 | - * Example: Application component unavailable, unexpected exception. |
|
54 | - * |
|
55 | - * @param string $message |
|
56 | - * @param array $context |
|
57 | - * |
|
58 | - * @return void |
|
59 | - */ |
|
60 | - public function critical($message, array $context = array()) |
|
61 | - { |
|
62 | - $this->log(LogLevel::CRITICAL, $message, $context); |
|
63 | - } |
|
50 | + /** |
|
51 | + * Critical conditions. |
|
52 | + * |
|
53 | + * Example: Application component unavailable, unexpected exception. |
|
54 | + * |
|
55 | + * @param string $message |
|
56 | + * @param array $context |
|
57 | + * |
|
58 | + * @return void |
|
59 | + */ |
|
60 | + public function critical($message, array $context = array()) |
|
61 | + { |
|
62 | + $this->log(LogLevel::CRITICAL, $message, $context); |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * Runtime errors that do not require immediate action but should typically |
|
67 | - * be logged and monitored. |
|
68 | - * |
|
69 | - * @param string $message |
|
70 | - * @param array $context |
|
71 | - * |
|
72 | - * @return void |
|
73 | - */ |
|
74 | - public function error($message, array $context = array()) |
|
75 | - { |
|
76 | - $this->log(LogLevel::ERROR, $message, $context); |
|
77 | - } |
|
65 | + /** |
|
66 | + * Runtime errors that do not require immediate action but should typically |
|
67 | + * be logged and monitored. |
|
68 | + * |
|
69 | + * @param string $message |
|
70 | + * @param array $context |
|
71 | + * |
|
72 | + * @return void |
|
73 | + */ |
|
74 | + public function error($message, array $context = array()) |
|
75 | + { |
|
76 | + $this->log(LogLevel::ERROR, $message, $context); |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * Exceptional occurrences that are not errors. |
|
81 | - * |
|
82 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
83 | - * that are not necessarily wrong. |
|
84 | - * |
|
85 | - * @param string $message |
|
86 | - * @param array $context |
|
87 | - * |
|
88 | - * @return void |
|
89 | - */ |
|
90 | - public function warning($message, array $context = array()) |
|
91 | - { |
|
92 | - $this->log(LogLevel::WARNING, $message, $context); |
|
93 | - } |
|
79 | + /** |
|
80 | + * Exceptional occurrences that are not errors. |
|
81 | + * |
|
82 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
83 | + * that are not necessarily wrong. |
|
84 | + * |
|
85 | + * @param string $message |
|
86 | + * @param array $context |
|
87 | + * |
|
88 | + * @return void |
|
89 | + */ |
|
90 | + public function warning($message, array $context = array()) |
|
91 | + { |
|
92 | + $this->log(LogLevel::WARNING, $message, $context); |
|
93 | + } |
|
94 | 94 | |
95 | - /** |
|
96 | - * Normal but significant events. |
|
97 | - * |
|
98 | - * @param string $message |
|
99 | - * @param array $context |
|
100 | - * |
|
101 | - * @return void |
|
102 | - */ |
|
103 | - public function notice($message, array $context = array()) |
|
104 | - { |
|
105 | - $this->log(LogLevel::NOTICE, $message, $context); |
|
106 | - } |
|
95 | + /** |
|
96 | + * Normal but significant events. |
|
97 | + * |
|
98 | + * @param string $message |
|
99 | + * @param array $context |
|
100 | + * |
|
101 | + * @return void |
|
102 | + */ |
|
103 | + public function notice($message, array $context = array()) |
|
104 | + { |
|
105 | + $this->log(LogLevel::NOTICE, $message, $context); |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * Interesting events. |
|
110 | - * |
|
111 | - * Example: User logs in, SQL logs. |
|
112 | - * |
|
113 | - * @param string $message |
|
114 | - * @param array $context |
|
115 | - * |
|
116 | - * @return void |
|
117 | - */ |
|
118 | - public function info($message, array $context = array()) |
|
119 | - { |
|
120 | - $this->log(LogLevel::INFO, $message, $context); |
|
121 | - } |
|
108 | + /** |
|
109 | + * Interesting events. |
|
110 | + * |
|
111 | + * Example: User logs in, SQL logs. |
|
112 | + * |
|
113 | + * @param string $message |
|
114 | + * @param array $context |
|
115 | + * |
|
116 | + * @return void |
|
117 | + */ |
|
118 | + public function info($message, array $context = array()) |
|
119 | + { |
|
120 | + $this->log(LogLevel::INFO, $message, $context); |
|
121 | + } |
|
122 | 122 | |
123 | - /** |
|
124 | - * Detailed debug information. |
|
125 | - * |
|
126 | - * @param string $message |
|
127 | - * @param array $context |
|
128 | - * |
|
129 | - * @return void |
|
130 | - */ |
|
131 | - public function debug($message, array $context = array()) |
|
132 | - { |
|
133 | - $this->log(LogLevel::DEBUG, $message, $context); |
|
134 | - } |
|
123 | + /** |
|
124 | + * Detailed debug information. |
|
125 | + * |
|
126 | + * @param string $message |
|
127 | + * @param array $context |
|
128 | + * |
|
129 | + * @return void |
|
130 | + */ |
|
131 | + public function debug($message, array $context = array()) |
|
132 | + { |
|
133 | + $this->log(LogLevel::DEBUG, $message, $context); |
|
134 | + } |
|
135 | 135 | |
136 | - /** |
|
137 | - * Logs with an arbitrary level. |
|
138 | - * |
|
139 | - * @param mixed $level |
|
140 | - * @param string $message |
|
141 | - * @param array $context |
|
142 | - * |
|
143 | - * @return void |
|
144 | - * |
|
145 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
146 | - */ |
|
147 | - abstract public function log($level, $message, array $context = array()); |
|
136 | + /** |
|
137 | + * Logs with an arbitrary level. |
|
138 | + * |
|
139 | + * @param mixed $level |
|
140 | + * @param string $message |
|
141 | + * @param array $context |
|
142 | + * |
|
143 | + * @return void |
|
144 | + * |
|
145 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
146 | + */ |
|
147 | + abstract public function log($level, $message, array $context = array()); |
|
148 | 148 | } |
@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | * |
27 | 27 | * @return void |
28 | 28 | */ |
29 | - public function emergency($message, array $context = array()) |
|
29 | + public function emergency( $message, array $context = array() ) |
|
30 | 30 | { |
31 | - $this->log(LogLevel::EMERGENCY, $message, $context); |
|
31 | + $this->log( LogLevel::EMERGENCY, $message, $context ); |
|
32 | 32 | } |
33 | 33 | |
34 | 34 | /** |
@@ -42,9 +42,9 @@ discard block |
||
42 | 42 | * |
43 | 43 | * @return void |
44 | 44 | */ |
45 | - public function alert($message, array $context = array()) |
|
45 | + public function alert( $message, array $context = array() ) |
|
46 | 46 | { |
47 | - $this->log(LogLevel::ALERT, $message, $context); |
|
47 | + $this->log( LogLevel::ALERT, $message, $context ); |
|
48 | 48 | } |
49 | 49 | |
50 | 50 | /** |
@@ -57,9 +57,9 @@ discard block |
||
57 | 57 | * |
58 | 58 | * @return void |
59 | 59 | */ |
60 | - public function critical($message, array $context = array()) |
|
60 | + public function critical( $message, array $context = array() ) |
|
61 | 61 | { |
62 | - $this->log(LogLevel::CRITICAL, $message, $context); |
|
62 | + $this->log( LogLevel::CRITICAL, $message, $context ); |
|
63 | 63 | } |
64 | 64 | |
65 | 65 | /** |
@@ -71,9 +71,9 @@ discard block |
||
71 | 71 | * |
72 | 72 | * @return void |
73 | 73 | */ |
74 | - public function error($message, array $context = array()) |
|
74 | + public function error( $message, array $context = array() ) |
|
75 | 75 | { |
76 | - $this->log(LogLevel::ERROR, $message, $context); |
|
76 | + $this->log( LogLevel::ERROR, $message, $context ); |
|
77 | 77 | } |
78 | 78 | |
79 | 79 | /** |
@@ -87,9 +87,9 @@ discard block |
||
87 | 87 | * |
88 | 88 | * @return void |
89 | 89 | */ |
90 | - public function warning($message, array $context = array()) |
|
90 | + public function warning( $message, array $context = array() ) |
|
91 | 91 | { |
92 | - $this->log(LogLevel::WARNING, $message, $context); |
|
92 | + $this->log( LogLevel::WARNING, $message, $context ); |
|
93 | 93 | } |
94 | 94 | |
95 | 95 | /** |
@@ -100,9 +100,9 @@ discard block |
||
100 | 100 | * |
101 | 101 | * @return void |
102 | 102 | */ |
103 | - public function notice($message, array $context = array()) |
|
103 | + public function notice( $message, array $context = array() ) |
|
104 | 104 | { |
105 | - $this->log(LogLevel::NOTICE, $message, $context); |
|
105 | + $this->log( LogLevel::NOTICE, $message, $context ); |
|
106 | 106 | } |
107 | 107 | |
108 | 108 | /** |
@@ -115,9 +115,9 @@ discard block |
||
115 | 115 | * |
116 | 116 | * @return void |
117 | 117 | */ |
118 | - public function info($message, array $context = array()) |
|
118 | + public function info( $message, array $context = array() ) |
|
119 | 119 | { |
120 | - $this->log(LogLevel::INFO, $message, $context); |
|
120 | + $this->log( LogLevel::INFO, $message, $context ); |
|
121 | 121 | } |
122 | 122 | |
123 | 123 | /** |
@@ -128,9 +128,9 @@ discard block |
||
128 | 128 | * |
129 | 129 | * @return void |
130 | 130 | */ |
131 | - public function debug($message, array $context = array()) |
|
131 | + public function debug( $message, array $context = array() ) |
|
132 | 132 | { |
133 | - $this->log(LogLevel::DEBUG, $message, $context); |
|
133 | + $this->log( LogLevel::DEBUG, $message, $context ); |
|
134 | 134 | } |
135 | 135 | |
136 | 136 | /** |
@@ -144,5 +144,5 @@ discard block |
||
144 | 144 | * |
145 | 145 | * @throws \GravityView\Psr\Log\InvalidArgumentException |
146 | 146 | */ |
147 | - abstract public function log($level, $message, array $context = array()); |
|
147 | + abstract public function log( $level, $message, array $context = array() ); |
|
148 | 148 | } |
@@ -16,8 +16,7 @@ discard block |
||
16 | 16 | * reduce boilerplate code that a simple Logger that does the same thing with |
17 | 17 | * messages regardless of the error level has to implement. |
18 | 18 | */ |
19 | -trait LoggerTrait |
|
20 | -{ |
|
19 | +trait LoggerTrait { |
|
21 | 20 | /** |
22 | 21 | * System is unusable. |
23 | 22 | * |
@@ -26,8 +25,7 @@ discard block |
||
26 | 25 | * |
27 | 26 | * @return void |
28 | 27 | */ |
29 | - public function emergency($message, array $context = array()) |
|
30 | - { |
|
28 | + public function emergency($message, array $context = array()) { |
|
31 | 29 | $this->log(LogLevel::EMERGENCY, $message, $context); |
32 | 30 | } |
33 | 31 | |
@@ -42,8 +40,7 @@ discard block |
||
42 | 40 | * |
43 | 41 | * @return void |
44 | 42 | */ |
45 | - public function alert($message, array $context = array()) |
|
46 | - { |
|
43 | + public function alert($message, array $context = array()) { |
|
47 | 44 | $this->log(LogLevel::ALERT, $message, $context); |
48 | 45 | } |
49 | 46 | |
@@ -57,8 +54,7 @@ discard block |
||
57 | 54 | * |
58 | 55 | * @return void |
59 | 56 | */ |
60 | - public function critical($message, array $context = array()) |
|
61 | - { |
|
57 | + public function critical($message, array $context = array()) { |
|
62 | 58 | $this->log(LogLevel::CRITICAL, $message, $context); |
63 | 59 | } |
64 | 60 | |
@@ -71,8 +67,7 @@ discard block |
||
71 | 67 | * |
72 | 68 | * @return void |
73 | 69 | */ |
74 | - public function error($message, array $context = array()) |
|
75 | - { |
|
70 | + public function error($message, array $context = array()) { |
|
76 | 71 | $this->log(LogLevel::ERROR, $message, $context); |
77 | 72 | } |
78 | 73 | |
@@ -87,8 +82,7 @@ discard block |
||
87 | 82 | * |
88 | 83 | * @return void |
89 | 84 | */ |
90 | - public function warning($message, array $context = array()) |
|
91 | - { |
|
85 | + public function warning($message, array $context = array()) { |
|
92 | 86 | $this->log(LogLevel::WARNING, $message, $context); |
93 | 87 | } |
94 | 88 | |
@@ -100,8 +94,7 @@ discard block |
||
100 | 94 | * |
101 | 95 | * @return void |
102 | 96 | */ |
103 | - public function notice($message, array $context = array()) |
|
104 | - { |
|
97 | + public function notice($message, array $context = array()) { |
|
105 | 98 | $this->log(LogLevel::NOTICE, $message, $context); |
106 | 99 | } |
107 | 100 | |
@@ -115,8 +108,7 @@ discard block |
||
115 | 108 | * |
116 | 109 | * @return void |
117 | 110 | */ |
118 | - public function info($message, array $context = array()) |
|
119 | - { |
|
111 | + public function info($message, array $context = array()) { |
|
120 | 112 | $this->log(LogLevel::INFO, $message, $context); |
121 | 113 | } |
122 | 114 | |
@@ -128,8 +120,7 @@ discard block |
||
128 | 120 | * |
129 | 121 | * @return void |
130 | 122 | */ |
131 | - public function debug($message, array $context = array()) |
|
132 | - { |
|
123 | + public function debug($message, array $context = array()) { |
|
133 | 124 | $this->log(LogLevel::DEBUG, $message, $context); |
134 | 125 | } |
135 | 126 |
@@ -62,92 +62,92 @@ |
||
62 | 62 | */ |
63 | 63 | class TestLogger extends AbstractLogger |
64 | 64 | { |
65 | - /** |
|
66 | - * @var array |
|
67 | - */ |
|
68 | - public $records = []; |
|
65 | + /** |
|
66 | + * @var array |
|
67 | + */ |
|
68 | + public $records = []; |
|
69 | 69 | |
70 | - public $recordsByLevel = []; |
|
70 | + public $recordsByLevel = []; |
|
71 | 71 | |
72 | - /** |
|
73 | - * @inheritdoc |
|
74 | - */ |
|
75 | - public function log($level, $message, array $context = []) |
|
76 | - { |
|
77 | - $record = [ |
|
78 | - 'level' => $level, |
|
79 | - 'message' => $message, |
|
80 | - 'context' => $context, |
|
81 | - ]; |
|
72 | + /** |
|
73 | + * @inheritdoc |
|
74 | + */ |
|
75 | + public function log($level, $message, array $context = []) |
|
76 | + { |
|
77 | + $record = [ |
|
78 | + 'level' => $level, |
|
79 | + 'message' => $message, |
|
80 | + 'context' => $context, |
|
81 | + ]; |
|
82 | 82 | |
83 | - $this->recordsByLevel[$record['level']][] = $record; |
|
84 | - $this->records[] = $record; |
|
85 | - } |
|
83 | + $this->recordsByLevel[$record['level']][] = $record; |
|
84 | + $this->records[] = $record; |
|
85 | + } |
|
86 | 86 | |
87 | - public function hasRecords($level) |
|
88 | - { |
|
89 | - return isset($this->recordsByLevel[$level]); |
|
90 | - } |
|
87 | + public function hasRecords($level) |
|
88 | + { |
|
89 | + return isset($this->recordsByLevel[$level]); |
|
90 | + } |
|
91 | 91 | |
92 | - public function hasRecord($record, $level) |
|
93 | - { |
|
94 | - if (is_string($record)) { |
|
95 | - $record = ['message' => $record]; |
|
96 | - } |
|
97 | - return $this->hasRecordThatPasses(function ($rec) use ($record) { |
|
98 | - if ($rec['message'] !== $record['message']) { |
|
99 | - return false; |
|
100 | - } |
|
101 | - if (isset($record['context']) && $rec['context'] !== $record['context']) { |
|
102 | - return false; |
|
103 | - } |
|
104 | - return true; |
|
105 | - }, $level); |
|
106 | - } |
|
92 | + public function hasRecord($record, $level) |
|
93 | + { |
|
94 | + if (is_string($record)) { |
|
95 | + $record = ['message' => $record]; |
|
96 | + } |
|
97 | + return $this->hasRecordThatPasses(function ($rec) use ($record) { |
|
98 | + if ($rec['message'] !== $record['message']) { |
|
99 | + return false; |
|
100 | + } |
|
101 | + if (isset($record['context']) && $rec['context'] !== $record['context']) { |
|
102 | + return false; |
|
103 | + } |
|
104 | + return true; |
|
105 | + }, $level); |
|
106 | + } |
|
107 | 107 | |
108 | - public function hasRecordThatContains($message, $level) |
|
109 | - { |
|
110 | - return $this->hasRecordThatPasses(function ($rec) use ($message) { |
|
111 | - return strpos($rec['message'], $message) !== false; |
|
112 | - }, $level); |
|
113 | - } |
|
108 | + public function hasRecordThatContains($message, $level) |
|
109 | + { |
|
110 | + return $this->hasRecordThatPasses(function ($rec) use ($message) { |
|
111 | + return strpos($rec['message'], $message) !== false; |
|
112 | + }, $level); |
|
113 | + } |
|
114 | 114 | |
115 | - public function hasRecordThatMatches($regex, $level) |
|
116 | - { |
|
117 | - return $this->hasRecordThatPasses(function ($rec) use ($regex) { |
|
118 | - return preg_match($regex, $rec['message']) > 0; |
|
119 | - }, $level); |
|
120 | - } |
|
115 | + public function hasRecordThatMatches($regex, $level) |
|
116 | + { |
|
117 | + return $this->hasRecordThatPasses(function ($rec) use ($regex) { |
|
118 | + return preg_match($regex, $rec['message']) > 0; |
|
119 | + }, $level); |
|
120 | + } |
|
121 | 121 | |
122 | - public function hasRecordThatPasses(callable $predicate, $level) |
|
123 | - { |
|
124 | - if (!isset($this->recordsByLevel[$level])) { |
|
125 | - return false; |
|
126 | - } |
|
127 | - foreach ($this->recordsByLevel[$level] as $i => $rec) { |
|
128 | - if (call_user_func($predicate, $rec, $i)) { |
|
129 | - return true; |
|
130 | - } |
|
131 | - } |
|
132 | - return false; |
|
133 | - } |
|
122 | + public function hasRecordThatPasses(callable $predicate, $level) |
|
123 | + { |
|
124 | + if (!isset($this->recordsByLevel[$level])) { |
|
125 | + return false; |
|
126 | + } |
|
127 | + foreach ($this->recordsByLevel[$level] as $i => $rec) { |
|
128 | + if (call_user_func($predicate, $rec, $i)) { |
|
129 | + return true; |
|
130 | + } |
|
131 | + } |
|
132 | + return false; |
|
133 | + } |
|
134 | 134 | |
135 | - public function __call($method, $args) |
|
136 | - { |
|
137 | - if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) { |
|
138 | - $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3]; |
|
139 | - $level = strtolower($matches[2]); |
|
140 | - if (method_exists($this, $genericMethod)) { |
|
141 | - $args[] = $level; |
|
142 | - return call_user_func_array([$this, $genericMethod], $args); |
|
143 | - } |
|
144 | - } |
|
145 | - throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()'); |
|
146 | - } |
|
135 | + public function __call($method, $args) |
|
136 | + { |
|
137 | + if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) { |
|
138 | + $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3]; |
|
139 | + $level = strtolower($matches[2]); |
|
140 | + if (method_exists($this, $genericMethod)) { |
|
141 | + $args[] = $level; |
|
142 | + return call_user_func_array([$this, $genericMethod], $args); |
|
143 | + } |
|
144 | + } |
|
145 | + throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()'); |
|
146 | + } |
|
147 | 147 | |
148 | - public function reset() |
|
149 | - { |
|
150 | - $this->records = []; |
|
151 | - $this->recordsByLevel = []; |
|
152 | - } |
|
148 | + public function reset() |
|
149 | + { |
|
150 | + $this->records = []; |
|
151 | + $this->recordsByLevel = []; |
|
152 | + } |
|
153 | 153 | } |
@@ -65,14 +65,14 @@ discard block |
||
65 | 65 | /** |
66 | 66 | * @var array |
67 | 67 | */ |
68 | - public $records = []; |
|
68 | + public $records = [ ]; |
|
69 | 69 | |
70 | - public $recordsByLevel = []; |
|
70 | + public $recordsByLevel = [ ]; |
|
71 | 71 | |
72 | 72 | /** |
73 | 73 | * @inheritdoc |
74 | 74 | */ |
75 | - public function log($level, $message, array $context = []) |
|
75 | + public function log( $level, $message, array $context = [ ] ) |
|
76 | 76 | { |
77 | 77 | $record = [ |
78 | 78 | 'level' => $level, |
@@ -80,74 +80,74 @@ discard block |
||
80 | 80 | 'context' => $context, |
81 | 81 | ]; |
82 | 82 | |
83 | - $this->recordsByLevel[$record['level']][] = $record; |
|
84 | - $this->records[] = $record; |
|
83 | + $this->recordsByLevel[ $record[ 'level' ] ][ ] = $record; |
|
84 | + $this->records[ ] = $record; |
|
85 | 85 | } |
86 | 86 | |
87 | - public function hasRecords($level) |
|
87 | + public function hasRecords( $level ) |
|
88 | 88 | { |
89 | - return isset($this->recordsByLevel[$level]); |
|
89 | + return isset( $this->recordsByLevel[ $level ] ); |
|
90 | 90 | } |
91 | 91 | |
92 | - public function hasRecord($record, $level) |
|
92 | + public function hasRecord( $record, $level ) |
|
93 | 93 | { |
94 | - if (is_string($record)) { |
|
95 | - $record = ['message' => $record]; |
|
94 | + if ( is_string( $record ) ) { |
|
95 | + $record = [ 'message' => $record ]; |
|
96 | 96 | } |
97 | - return $this->hasRecordThatPasses(function ($rec) use ($record) { |
|
98 | - if ($rec['message'] !== $record['message']) { |
|
97 | + return $this->hasRecordThatPasses( function( $rec ) use ( $record ) { |
|
98 | + if ( $rec[ 'message' ] !== $record[ 'message' ] ) { |
|
99 | 99 | return false; |
100 | 100 | } |
101 | - if (isset($record['context']) && $rec['context'] !== $record['context']) { |
|
101 | + if ( isset( $record[ 'context' ] ) && $rec[ 'context' ] !== $record[ 'context' ] ) { |
|
102 | 102 | return false; |
103 | 103 | } |
104 | 104 | return true; |
105 | - }, $level); |
|
105 | + }, $level ); |
|
106 | 106 | } |
107 | 107 | |
108 | - public function hasRecordThatContains($message, $level) |
|
108 | + public function hasRecordThatContains( $message, $level ) |
|
109 | 109 | { |
110 | - return $this->hasRecordThatPasses(function ($rec) use ($message) { |
|
111 | - return strpos($rec['message'], $message) !== false; |
|
112 | - }, $level); |
|
110 | + return $this->hasRecordThatPasses( function( $rec ) use ( $message ) { |
|
111 | + return strpos( $rec[ 'message' ], $message ) !== false; |
|
112 | + }, $level ); |
|
113 | 113 | } |
114 | 114 | |
115 | - public function hasRecordThatMatches($regex, $level) |
|
115 | + public function hasRecordThatMatches( $regex, $level ) |
|
116 | 116 | { |
117 | - return $this->hasRecordThatPasses(function ($rec) use ($regex) { |
|
118 | - return preg_match($regex, $rec['message']) > 0; |
|
119 | - }, $level); |
|
117 | + return $this->hasRecordThatPasses( function( $rec ) use ( $regex ) { |
|
118 | + return preg_match( $regex, $rec[ 'message' ] ) > 0; |
|
119 | + }, $level ); |
|
120 | 120 | } |
121 | 121 | |
122 | - public function hasRecordThatPasses(callable $predicate, $level) |
|
122 | + public function hasRecordThatPasses( callable $predicate, $level ) |
|
123 | 123 | { |
124 | - if (!isset($this->recordsByLevel[$level])) { |
|
124 | + if ( ! isset( $this->recordsByLevel[ $level ] ) ) { |
|
125 | 125 | return false; |
126 | 126 | } |
127 | - foreach ($this->recordsByLevel[$level] as $i => $rec) { |
|
128 | - if (call_user_func($predicate, $rec, $i)) { |
|
127 | + foreach ( $this->recordsByLevel[ $level ] as $i => $rec ) { |
|
128 | + if ( call_user_func( $predicate, $rec, $i ) ) { |
|
129 | 129 | return true; |
130 | 130 | } |
131 | 131 | } |
132 | 132 | return false; |
133 | 133 | } |
134 | 134 | |
135 | - public function __call($method, $args) |
|
135 | + public function __call( $method, $args ) |
|
136 | 136 | { |
137 | - if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) { |
|
138 | - $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3]; |
|
139 | - $level = strtolower($matches[2]); |
|
140 | - if (method_exists($this, $genericMethod)) { |
|
141 | - $args[] = $level; |
|
142 | - return call_user_func_array([$this, $genericMethod], $args); |
|
137 | + if ( preg_match( '/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches ) > 0 ) { |
|
138 | + $genericMethod = $matches[ 1 ] . ( 'Records' !== $matches[ 3 ] ? 'Record' : '' ) . $matches[ 3 ]; |
|
139 | + $level = strtolower( $matches[ 2 ] ); |
|
140 | + if ( method_exists( $this, $genericMethod ) ) { |
|
141 | + $args[ ] = $level; |
|
142 | + return call_user_func_array( [ $this, $genericMethod ], $args ); |
|
143 | 143 | } |
144 | 144 | } |
145 | - throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()'); |
|
145 | + throw new \BadMethodCallException( 'Call to undefined method ' . get_class( $this ) . '::' . $method . '()' ); |
|
146 | 146 | } |
147 | 147 | |
148 | 148 | public function reset() |
149 | 149 | { |
150 | - $this->records = []; |
|
151 | - $this->recordsByLevel = []; |
|
150 | + $this->records = [ ]; |
|
151 | + $this->recordsByLevel = [ ]; |
|
152 | 152 | } |
153 | 153 | } |
@@ -60,8 +60,7 @@ discard block |
||
60 | 60 | * @method bool hasInfoThatPasses($message) |
61 | 61 | * @method bool hasDebugThatPasses($message) |
62 | 62 | */ |
63 | -class TestLogger extends AbstractLogger |
|
64 | -{ |
|
63 | +class TestLogger extends AbstractLogger { |
|
65 | 64 | /** |
66 | 65 | * @var array |
67 | 66 | */ |
@@ -72,8 +71,7 @@ discard block |
||
72 | 71 | /** |
73 | 72 | * @inheritdoc |
74 | 73 | */ |
75 | - public function log($level, $message, array $context = []) |
|
76 | - { |
|
74 | + public function log($level, $message, array $context = []) { |
|
77 | 75 | $record = [ |
78 | 76 | 'level' => $level, |
79 | 77 | 'message' => $message, |
@@ -84,13 +82,11 @@ discard block |
||
84 | 82 | $this->records[] = $record; |
85 | 83 | } |
86 | 84 | |
87 | - public function hasRecords($level) |
|
88 | - { |
|
85 | + public function hasRecords($level) { |
|
89 | 86 | return isset($this->recordsByLevel[$level]); |
90 | 87 | } |
91 | 88 | |
92 | - public function hasRecord($record, $level) |
|
93 | - { |
|
89 | + public function hasRecord($record, $level) { |
|
94 | 90 | if (is_string($record)) { |
95 | 91 | $record = ['message' => $record]; |
96 | 92 | } |
@@ -105,22 +101,19 @@ discard block |
||
105 | 101 | }, $level); |
106 | 102 | } |
107 | 103 | |
108 | - public function hasRecordThatContains($message, $level) |
|
109 | - { |
|
104 | + public function hasRecordThatContains($message, $level) { |
|
110 | 105 | return $this->hasRecordThatPasses(function ($rec) use ($message) { |
111 | 106 | return strpos($rec['message'], $message) !== false; |
112 | 107 | }, $level); |
113 | 108 | } |
114 | 109 | |
115 | - public function hasRecordThatMatches($regex, $level) |
|
116 | - { |
|
110 | + public function hasRecordThatMatches($regex, $level) { |
|
117 | 111 | return $this->hasRecordThatPasses(function ($rec) use ($regex) { |
118 | 112 | return preg_match($regex, $rec['message']) > 0; |
119 | 113 | }, $level); |
120 | 114 | } |
121 | 115 | |
122 | - public function hasRecordThatPasses(callable $predicate, $level) |
|
123 | - { |
|
116 | + public function hasRecordThatPasses(callable $predicate, $level) { |
|
124 | 117 | if (!isset($this->recordsByLevel[$level])) { |
125 | 118 | return false; |
126 | 119 | } |
@@ -132,8 +125,7 @@ discard block |
||
132 | 125 | return false; |
133 | 126 | } |
134 | 127 | |
135 | - public function __call($method, $args) |
|
136 | - { |
|
128 | + public function __call($method, $args) { |
|
137 | 129 | if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) { |
138 | 130 | $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3]; |
139 | 131 | $level = strtolower($matches[2]); |
@@ -145,8 +137,7 @@ discard block |
||
145 | 137 | throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()'); |
146 | 138 | } |
147 | 139 | |
148 | - public function reset() |
|
149 | - { |
|
140 | + public function reset() { |
|
150 | 141 | $this->records = []; |
151 | 142 | $this->recordsByLevel = []; |
152 | 143 | } |
@@ -20,125 +20,125 @@ |
||
20 | 20 | */ |
21 | 21 | abstract class LoggerInterfaceTest extends TestCase |
22 | 22 | { |
23 | - /** |
|
24 | - * @return LoggerInterface |
|
25 | - */ |
|
26 | - abstract public function getLogger(); |
|
27 | - |
|
28 | - /** |
|
29 | - * This must return the log messages in order. |
|
30 | - * |
|
31 | - * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>". |
|
32 | - * |
|
33 | - * Example ->error('Foo') would yield "error Foo". |
|
34 | - * |
|
35 | - * @return string[] |
|
36 | - */ |
|
37 | - abstract public function getLogs(); |
|
38 | - |
|
39 | - public function testImplements() |
|
40 | - { |
|
41 | - $this->assertInstanceOf('GravityView\Psr\Log\LoggerInterface', $this->getLogger()); |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * @dataProvider provideLevelsAndMessages |
|
46 | - */ |
|
47 | - public function testLogsAtAllLevels($level, $message) |
|
48 | - { |
|
49 | - $logger = $this->getLogger(); |
|
50 | - $logger->{$level}($message, array('user' => 'Bob')); |
|
51 | - $logger->log($level, $message, array('user' => 'Bob')); |
|
52 | - |
|
53 | - $expected = array( |
|
54 | - $level.' message of level '.$level.' with context: Bob', |
|
55 | - $level.' message of level '.$level.' with context: Bob', |
|
56 | - ); |
|
57 | - $this->assertEquals($expected, $this->getLogs()); |
|
58 | - } |
|
59 | - |
|
60 | - public function provideLevelsAndMessages() |
|
61 | - { |
|
62 | - return array( |
|
63 | - LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
64 | - LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
65 | - LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
66 | - LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
67 | - LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
68 | - LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
69 | - LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
70 | - LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
71 | - ); |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * @expectedException \GravityView\Psr\Log\InvalidArgumentException |
|
76 | - */ |
|
77 | - public function testThrowsOnInvalidLevel() |
|
78 | - { |
|
79 | - $logger = $this->getLogger(); |
|
80 | - $logger->log('invalid level', 'Foo'); |
|
81 | - } |
|
82 | - |
|
83 | - public function testContextReplacement() |
|
84 | - { |
|
85 | - $logger = $this->getLogger(); |
|
86 | - $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
87 | - |
|
88 | - $expected = array('info {Message {nothing} Bob Bar a}'); |
|
89 | - $this->assertEquals($expected, $this->getLogs()); |
|
90 | - } |
|
91 | - |
|
92 | - public function testObjectCastToString() |
|
93 | - { |
|
94 | - if (method_exists($this, 'createPartialMock')) { |
|
95 | - $dummy = $this->createPartialMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
96 | - } else { |
|
97 | - $dummy = $this->getMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
98 | - } |
|
99 | - $dummy->expects($this->once()) |
|
100 | - ->method('__toString') |
|
101 | - ->will($this->returnValue('DUMMY')); |
|
102 | - |
|
103 | - $this->getLogger()->warning($dummy); |
|
104 | - |
|
105 | - $expected = array('warning DUMMY'); |
|
106 | - $this->assertEquals($expected, $this->getLogs()); |
|
107 | - } |
|
108 | - |
|
109 | - public function testContextCanContainAnything() |
|
110 | - { |
|
111 | - $closed = fopen('php://memory', 'r'); |
|
112 | - fclose($closed); |
|
113 | - |
|
114 | - $context = array( |
|
115 | - 'bool' => true, |
|
116 | - 'null' => null, |
|
117 | - 'string' => 'Foo', |
|
118 | - 'int' => 0, |
|
119 | - 'float' => 0.5, |
|
120 | - 'nested' => array('with object' => new DummyTest), |
|
121 | - 'object' => new \DateTime, |
|
122 | - 'resource' => fopen('php://memory', 'r'), |
|
123 | - 'closed' => $closed, |
|
124 | - ); |
|
125 | - |
|
126 | - $this->getLogger()->warning('Crazy context data', $context); |
|
127 | - |
|
128 | - $expected = array('warning Crazy context data'); |
|
129 | - $this->assertEquals($expected, $this->getLogs()); |
|
130 | - } |
|
131 | - |
|
132 | - public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
133 | - { |
|
134 | - $logger = $this->getLogger(); |
|
135 | - $logger->warning('Random message', array('exception' => 'oops')); |
|
136 | - $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
137 | - |
|
138 | - $expected = array( |
|
139 | - 'warning Random message', |
|
140 | - 'critical Uncaught Exception!' |
|
141 | - ); |
|
142 | - $this->assertEquals($expected, $this->getLogs()); |
|
143 | - } |
|
23 | + /** |
|
24 | + * @return LoggerInterface |
|
25 | + */ |
|
26 | + abstract public function getLogger(); |
|
27 | + |
|
28 | + /** |
|
29 | + * This must return the log messages in order. |
|
30 | + * |
|
31 | + * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>". |
|
32 | + * |
|
33 | + * Example ->error('Foo') would yield "error Foo". |
|
34 | + * |
|
35 | + * @return string[] |
|
36 | + */ |
|
37 | + abstract public function getLogs(); |
|
38 | + |
|
39 | + public function testImplements() |
|
40 | + { |
|
41 | + $this->assertInstanceOf('GravityView\Psr\Log\LoggerInterface', $this->getLogger()); |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * @dataProvider provideLevelsAndMessages |
|
46 | + */ |
|
47 | + public function testLogsAtAllLevels($level, $message) |
|
48 | + { |
|
49 | + $logger = $this->getLogger(); |
|
50 | + $logger->{$level}($message, array('user' => 'Bob')); |
|
51 | + $logger->log($level, $message, array('user' => 'Bob')); |
|
52 | + |
|
53 | + $expected = array( |
|
54 | + $level.' message of level '.$level.' with context: Bob', |
|
55 | + $level.' message of level '.$level.' with context: Bob', |
|
56 | + ); |
|
57 | + $this->assertEquals($expected, $this->getLogs()); |
|
58 | + } |
|
59 | + |
|
60 | + public function provideLevelsAndMessages() |
|
61 | + { |
|
62 | + return array( |
|
63 | + LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
64 | + LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
65 | + LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
66 | + LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
67 | + LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
68 | + LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
69 | + LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
70 | + LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
71 | + ); |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * @expectedException \GravityView\Psr\Log\InvalidArgumentException |
|
76 | + */ |
|
77 | + public function testThrowsOnInvalidLevel() |
|
78 | + { |
|
79 | + $logger = $this->getLogger(); |
|
80 | + $logger->log('invalid level', 'Foo'); |
|
81 | + } |
|
82 | + |
|
83 | + public function testContextReplacement() |
|
84 | + { |
|
85 | + $logger = $this->getLogger(); |
|
86 | + $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
87 | + |
|
88 | + $expected = array('info {Message {nothing} Bob Bar a}'); |
|
89 | + $this->assertEquals($expected, $this->getLogs()); |
|
90 | + } |
|
91 | + |
|
92 | + public function testObjectCastToString() |
|
93 | + { |
|
94 | + if (method_exists($this, 'createPartialMock')) { |
|
95 | + $dummy = $this->createPartialMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
96 | + } else { |
|
97 | + $dummy = $this->getMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
98 | + } |
|
99 | + $dummy->expects($this->once()) |
|
100 | + ->method('__toString') |
|
101 | + ->will($this->returnValue('DUMMY')); |
|
102 | + |
|
103 | + $this->getLogger()->warning($dummy); |
|
104 | + |
|
105 | + $expected = array('warning DUMMY'); |
|
106 | + $this->assertEquals($expected, $this->getLogs()); |
|
107 | + } |
|
108 | + |
|
109 | + public function testContextCanContainAnything() |
|
110 | + { |
|
111 | + $closed = fopen('php://memory', 'r'); |
|
112 | + fclose($closed); |
|
113 | + |
|
114 | + $context = array( |
|
115 | + 'bool' => true, |
|
116 | + 'null' => null, |
|
117 | + 'string' => 'Foo', |
|
118 | + 'int' => 0, |
|
119 | + 'float' => 0.5, |
|
120 | + 'nested' => array('with object' => new DummyTest), |
|
121 | + 'object' => new \DateTime, |
|
122 | + 'resource' => fopen('php://memory', 'r'), |
|
123 | + 'closed' => $closed, |
|
124 | + ); |
|
125 | + |
|
126 | + $this->getLogger()->warning('Crazy context data', $context); |
|
127 | + |
|
128 | + $expected = array('warning Crazy context data'); |
|
129 | + $this->assertEquals($expected, $this->getLogs()); |
|
130 | + } |
|
131 | + |
|
132 | + public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
133 | + { |
|
134 | + $logger = $this->getLogger(); |
|
135 | + $logger->warning('Random message', array('exception' => 'oops')); |
|
136 | + $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
137 | + |
|
138 | + $expected = array( |
|
139 | + 'warning Random message', |
|
140 | + 'critical Uncaught Exception!' |
|
141 | + ); |
|
142 | + $this->assertEquals($expected, $this->getLogs()); |
|
143 | + } |
|
144 | 144 | } |
@@ -38,36 +38,36 @@ discard block |
||
38 | 38 | |
39 | 39 | public function testImplements() |
40 | 40 | { |
41 | - $this->assertInstanceOf('GravityView\Psr\Log\LoggerInterface', $this->getLogger()); |
|
41 | + $this->assertInstanceOf( 'GravityView\Psr\Log\LoggerInterface', $this->getLogger() ); |
|
42 | 42 | } |
43 | 43 | |
44 | 44 | /** |
45 | 45 | * @dataProvider provideLevelsAndMessages |
46 | 46 | */ |
47 | - public function testLogsAtAllLevels($level, $message) |
|
47 | + public function testLogsAtAllLevels( $level, $message ) |
|
48 | 48 | { |
49 | 49 | $logger = $this->getLogger(); |
50 | - $logger->{$level}($message, array('user' => 'Bob')); |
|
51 | - $logger->log($level, $message, array('user' => 'Bob')); |
|
50 | + $logger->{$level}( $message, array( 'user' => 'Bob' ) ); |
|
51 | + $logger->log( $level, $message, array( 'user' => 'Bob' ) ); |
|
52 | 52 | |
53 | 53 | $expected = array( |
54 | - $level.' message of level '.$level.' with context: Bob', |
|
55 | - $level.' message of level '.$level.' with context: Bob', |
|
54 | + $level . ' message of level ' . $level . ' with context: Bob', |
|
55 | + $level . ' message of level ' . $level . ' with context: Bob', |
|
56 | 56 | ); |
57 | - $this->assertEquals($expected, $this->getLogs()); |
|
57 | + $this->assertEquals( $expected, $this->getLogs() ); |
|
58 | 58 | } |
59 | 59 | |
60 | 60 | public function provideLevelsAndMessages() |
61 | 61 | { |
62 | 62 | return array( |
63 | - LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
64 | - LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
65 | - LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
66 | - LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
67 | - LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
68 | - LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
69 | - LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
70 | - LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
63 | + LogLevel::EMERGENCY => array( LogLevel::EMERGENCY, 'message of level emergency with context: {user}' ), |
|
64 | + LogLevel::ALERT => array( LogLevel::ALERT, 'message of level alert with context: {user}' ), |
|
65 | + LogLevel::CRITICAL => array( LogLevel::CRITICAL, 'message of level critical with context: {user}' ), |
|
66 | + LogLevel::ERROR => array( LogLevel::ERROR, 'message of level error with context: {user}' ), |
|
67 | + LogLevel::WARNING => array( LogLevel::WARNING, 'message of level warning with context: {user}' ), |
|
68 | + LogLevel::NOTICE => array( LogLevel::NOTICE, 'message of level notice with context: {user}' ), |
|
69 | + LogLevel::INFO => array( LogLevel::INFO, 'message of level info with context: {user}' ), |
|
70 | + LogLevel::DEBUG => array( LogLevel::DEBUG, 'message of level debug with context: {user}' ), |
|
71 | 71 | ); |
72 | 72 | } |
73 | 73 | |
@@ -77,39 +77,39 @@ discard block |
||
77 | 77 | public function testThrowsOnInvalidLevel() |
78 | 78 | { |
79 | 79 | $logger = $this->getLogger(); |
80 | - $logger->log('invalid level', 'Foo'); |
|
80 | + $logger->log( 'invalid level', 'Foo' ); |
|
81 | 81 | } |
82 | 82 | |
83 | 83 | public function testContextReplacement() |
84 | 84 | { |
85 | 85 | $logger = $this->getLogger(); |
86 | - $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
86 | + $logger->info( '{Message {nothing} {user} {foo.bar} a}', array( 'user' => 'Bob', 'foo.bar' => 'Bar' ) ); |
|
87 | 87 | |
88 | - $expected = array('info {Message {nothing} Bob Bar a}'); |
|
89 | - $this->assertEquals($expected, $this->getLogs()); |
|
88 | + $expected = array( 'info {Message {nothing} Bob Bar a}' ); |
|
89 | + $this->assertEquals( $expected, $this->getLogs() ); |
|
90 | 90 | } |
91 | 91 | |
92 | 92 | public function testObjectCastToString() |
93 | 93 | { |
94 | - if (method_exists($this, 'createPartialMock')) { |
|
95 | - $dummy = $this->createPartialMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
94 | + if ( method_exists( $this, 'createPartialMock' ) ) { |
|
95 | + $dummy = $this->createPartialMock( 'GravityView\GravityView\Psr\Log\Test\DummyTest', array( '__toString' ) ); |
|
96 | 96 | } else { |
97 | - $dummy = $this->getMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
97 | + $dummy = $this->getMock( 'GravityView\GravityView\Psr\Log\Test\DummyTest', array( '__toString' ) ); |
|
98 | 98 | } |
99 | - $dummy->expects($this->once()) |
|
100 | - ->method('__toString') |
|
101 | - ->will($this->returnValue('DUMMY')); |
|
99 | + $dummy->expects( $this->once() ) |
|
100 | + ->method( '__toString' ) |
|
101 | + ->will( $this->returnValue( 'DUMMY' ) ); |
|
102 | 102 | |
103 | - $this->getLogger()->warning($dummy); |
|
103 | + $this->getLogger()->warning( $dummy ); |
|
104 | 104 | |
105 | - $expected = array('warning DUMMY'); |
|
106 | - $this->assertEquals($expected, $this->getLogs()); |
|
105 | + $expected = array( 'warning DUMMY' ); |
|
106 | + $this->assertEquals( $expected, $this->getLogs() ); |
|
107 | 107 | } |
108 | 108 | |
109 | 109 | public function testContextCanContainAnything() |
110 | 110 | { |
111 | - $closed = fopen('php://memory', 'r'); |
|
112 | - fclose($closed); |
|
111 | + $closed = fopen( 'php://memory', 'r' ); |
|
112 | + fclose( $closed ); |
|
113 | 113 | |
114 | 114 | $context = array( |
115 | 115 | 'bool' => true, |
@@ -117,28 +117,28 @@ discard block |
||
117 | 117 | 'string' => 'Foo', |
118 | 118 | 'int' => 0, |
119 | 119 | 'float' => 0.5, |
120 | - 'nested' => array('with object' => new DummyTest), |
|
120 | + 'nested' => array( 'with object' => new DummyTest ), |
|
121 | 121 | 'object' => new \DateTime, |
122 | - 'resource' => fopen('php://memory', 'r'), |
|
122 | + 'resource' => fopen( 'php://memory', 'r' ), |
|
123 | 123 | 'closed' => $closed, |
124 | 124 | ); |
125 | 125 | |
126 | - $this->getLogger()->warning('Crazy context data', $context); |
|
126 | + $this->getLogger()->warning( 'Crazy context data', $context ); |
|
127 | 127 | |
128 | - $expected = array('warning Crazy context data'); |
|
129 | - $this->assertEquals($expected, $this->getLogs()); |
|
128 | + $expected = array( 'warning Crazy context data' ); |
|
129 | + $this->assertEquals( $expected, $this->getLogs() ); |
|
130 | 130 | } |
131 | 131 | |
132 | 132 | public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
133 | 133 | { |
134 | 134 | $logger = $this->getLogger(); |
135 | - $logger->warning('Random message', array('exception' => 'oops')); |
|
136 | - $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
135 | + $logger->warning( 'Random message', array( 'exception' => 'oops' ) ); |
|
136 | + $logger->critical( 'Uncaught Exception!', array( 'exception' => new \LogicException( 'Fail' ) ) ); |
|
137 | 137 | |
138 | 138 | $expected = array( |
139 | 139 | 'warning Random message', |
140 | 140 | 'critical Uncaught Exception!' |
141 | 141 | ); |
142 | - $this->assertEquals($expected, $this->getLogs()); |
|
142 | + $this->assertEquals( $expected, $this->getLogs() ); |
|
143 | 143 | } |
144 | 144 | } |
@@ -18,8 +18,7 @@ discard block |
||
18 | 18 | * Implementors can extend the class and implement abstract methods to run this |
19 | 19 | * as part of their test suite. |
20 | 20 | */ |
21 | -abstract class LoggerInterfaceTest extends TestCase |
|
22 | -{ |
|
21 | +abstract class LoggerInterfaceTest extends TestCase { |
|
23 | 22 | /** |
24 | 23 | * @return LoggerInterface |
25 | 24 | */ |
@@ -36,16 +35,14 @@ discard block |
||
36 | 35 | */ |
37 | 36 | abstract public function getLogs(); |
38 | 37 | |
39 | - public function testImplements() |
|
40 | - { |
|
38 | + public function testImplements() { |
|
41 | 39 | $this->assertInstanceOf('GravityView\Psr\Log\LoggerInterface', $this->getLogger()); |
42 | 40 | } |
43 | 41 | |
44 | 42 | /** |
45 | 43 | * @dataProvider provideLevelsAndMessages |
46 | 44 | */ |
47 | - public function testLogsAtAllLevels($level, $message) |
|
48 | - { |
|
45 | + public function testLogsAtAllLevels($level, $message) { |
|
49 | 46 | $logger = $this->getLogger(); |
50 | 47 | $logger->{$level}($message, array('user' => 'Bob')); |
51 | 48 | $logger->log($level, $message, array('user' => 'Bob')); |
@@ -57,8 +54,7 @@ discard block |
||
57 | 54 | $this->assertEquals($expected, $this->getLogs()); |
58 | 55 | } |
59 | 56 | |
60 | - public function provideLevelsAndMessages() |
|
61 | - { |
|
57 | + public function provideLevelsAndMessages() { |
|
62 | 58 | return array( |
63 | 59 | LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
64 | 60 | LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
@@ -74,14 +70,12 @@ discard block |
||
74 | 70 | /** |
75 | 71 | * @expectedException \GravityView\Psr\Log\InvalidArgumentException |
76 | 72 | */ |
77 | - public function testThrowsOnInvalidLevel() |
|
78 | - { |
|
73 | + public function testThrowsOnInvalidLevel() { |
|
79 | 74 | $logger = $this->getLogger(); |
80 | 75 | $logger->log('invalid level', 'Foo'); |
81 | 76 | } |
82 | 77 | |
83 | - public function testContextReplacement() |
|
84 | - { |
|
78 | + public function testContextReplacement() { |
|
85 | 79 | $logger = $this->getLogger(); |
86 | 80 | $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
87 | 81 | |
@@ -89,8 +83,7 @@ discard block |
||
89 | 83 | $this->assertEquals($expected, $this->getLogs()); |
90 | 84 | } |
91 | 85 | |
92 | - public function testObjectCastToString() |
|
93 | - { |
|
86 | + public function testObjectCastToString() { |
|
94 | 87 | if (method_exists($this, 'createPartialMock')) { |
95 | 88 | $dummy = $this->createPartialMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
96 | 89 | } else { |
@@ -106,8 +99,7 @@ discard block |
||
106 | 99 | $this->assertEquals($expected, $this->getLogs()); |
107 | 100 | } |
108 | 101 | |
109 | - public function testContextCanContainAnything() |
|
110 | - { |
|
102 | + public function testContextCanContainAnything() { |
|
111 | 103 | $closed = fopen('php://memory', 'r'); |
112 | 104 | fclose($closed); |
113 | 105 | |
@@ -129,8 +121,7 @@ discard block |
||
129 | 121 | $this->assertEquals($expected, $this->getLogs()); |
130 | 122 | } |
131 | 123 | |
132 | - public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
133 | - { |
|
124 | + public function testContextExceptionKeyCanBeExceptionOrOtherValues() { |
|
134 | 125 | $logger = $this->getLogger(); |
135 | 126 | $logger->warning('Random message', array('exception' => 'oops')); |
136 | 127 | $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
@@ -17,8 +17,8 @@ |
||
17 | 17 | */ |
18 | 18 | class DummyTest |
19 | 19 | { |
20 | - public function __toString() |
|
21 | - { |
|
22 | - return 'DummyTest'; |
|
23 | - } |
|
20 | + public function __toString() |
|
21 | + { |
|
22 | + return 'DummyTest'; |
|
23 | + } |
|
24 | 24 | } |
@@ -15,10 +15,8 @@ |
||
15 | 15 | * |
16 | 16 | * @internal |
17 | 17 | */ |
18 | -class DummyTest |
|
19 | -{ |
|
20 | - public function __toString() |
|
21 | - { |
|
18 | +class DummyTest { |
|
19 | + public function __toString() { |
|
22 | 20 | return 'DummyTest'; |
23 | 21 | } |
24 | 22 | } |
@@ -25,107 +25,107 @@ |
||
25 | 25 | */ |
26 | 26 | interface LoggerInterface |
27 | 27 | { |
28 | - /** |
|
29 | - * System is unusable. |
|
30 | - * |
|
31 | - * @param string $message |
|
32 | - * @param mixed[] $context |
|
33 | - * |
|
34 | - * @return void |
|
35 | - */ |
|
36 | - public function emergency($message, array $context = array()); |
|
28 | + /** |
|
29 | + * System is unusable. |
|
30 | + * |
|
31 | + * @param string $message |
|
32 | + * @param mixed[] $context |
|
33 | + * |
|
34 | + * @return void |
|
35 | + */ |
|
36 | + public function emergency($message, array $context = array()); |
|
37 | 37 | |
38 | - /** |
|
39 | - * Action must be taken immediately. |
|
40 | - * |
|
41 | - * Example: Entire website down, database unavailable, etc. This should |
|
42 | - * trigger the SMS alerts and wake you up. |
|
43 | - * |
|
44 | - * @param string $message |
|
45 | - * @param mixed[] $context |
|
46 | - * |
|
47 | - * @return void |
|
48 | - */ |
|
49 | - public function alert($message, array $context = array()); |
|
38 | + /** |
|
39 | + * Action must be taken immediately. |
|
40 | + * |
|
41 | + * Example: Entire website down, database unavailable, etc. This should |
|
42 | + * trigger the SMS alerts and wake you up. |
|
43 | + * |
|
44 | + * @param string $message |
|
45 | + * @param mixed[] $context |
|
46 | + * |
|
47 | + * @return void |
|
48 | + */ |
|
49 | + public function alert($message, array $context = array()); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Critical conditions. |
|
53 | - * |
|
54 | - * Example: Application component unavailable, unexpected exception. |
|
55 | - * |
|
56 | - * @param string $message |
|
57 | - * @param mixed[] $context |
|
58 | - * |
|
59 | - * @return void |
|
60 | - */ |
|
61 | - public function critical($message, array $context = array()); |
|
51 | + /** |
|
52 | + * Critical conditions. |
|
53 | + * |
|
54 | + * Example: Application component unavailable, unexpected exception. |
|
55 | + * |
|
56 | + * @param string $message |
|
57 | + * @param mixed[] $context |
|
58 | + * |
|
59 | + * @return void |
|
60 | + */ |
|
61 | + public function critical($message, array $context = array()); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Runtime errors that do not require immediate action but should typically |
|
65 | - * be logged and monitored. |
|
66 | - * |
|
67 | - * @param string $message |
|
68 | - * @param mixed[] $context |
|
69 | - * |
|
70 | - * @return void |
|
71 | - */ |
|
72 | - public function error($message, array $context = array()); |
|
63 | + /** |
|
64 | + * Runtime errors that do not require immediate action but should typically |
|
65 | + * be logged and monitored. |
|
66 | + * |
|
67 | + * @param string $message |
|
68 | + * @param mixed[] $context |
|
69 | + * |
|
70 | + * @return void |
|
71 | + */ |
|
72 | + public function error($message, array $context = array()); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Exceptional occurrences that are not errors. |
|
76 | - * |
|
77 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
78 | - * that are not necessarily wrong. |
|
79 | - * |
|
80 | - * @param string $message |
|
81 | - * @param mixed[] $context |
|
82 | - * |
|
83 | - * @return void |
|
84 | - */ |
|
85 | - public function warning($message, array $context = array()); |
|
74 | + /** |
|
75 | + * Exceptional occurrences that are not errors. |
|
76 | + * |
|
77 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
78 | + * that are not necessarily wrong. |
|
79 | + * |
|
80 | + * @param string $message |
|
81 | + * @param mixed[] $context |
|
82 | + * |
|
83 | + * @return void |
|
84 | + */ |
|
85 | + public function warning($message, array $context = array()); |
|
86 | 86 | |
87 | - /** |
|
88 | - * Normal but significant events. |
|
89 | - * |
|
90 | - * @param string $message |
|
91 | - * @param mixed[] $context |
|
92 | - * |
|
93 | - * @return void |
|
94 | - */ |
|
95 | - public function notice($message, array $context = array()); |
|
87 | + /** |
|
88 | + * Normal but significant events. |
|
89 | + * |
|
90 | + * @param string $message |
|
91 | + * @param mixed[] $context |
|
92 | + * |
|
93 | + * @return void |
|
94 | + */ |
|
95 | + public function notice($message, array $context = array()); |
|
96 | 96 | |
97 | - /** |
|
98 | - * Interesting events. |
|
99 | - * |
|
100 | - * Example: User logs in, SQL logs. |
|
101 | - * |
|
102 | - * @param string $message |
|
103 | - * @param mixed[] $context |
|
104 | - * |
|
105 | - * @return void |
|
106 | - */ |
|
107 | - public function info($message, array $context = array()); |
|
97 | + /** |
|
98 | + * Interesting events. |
|
99 | + * |
|
100 | + * Example: User logs in, SQL logs. |
|
101 | + * |
|
102 | + * @param string $message |
|
103 | + * @param mixed[] $context |
|
104 | + * |
|
105 | + * @return void |
|
106 | + */ |
|
107 | + public function info($message, array $context = array()); |
|
108 | 108 | |
109 | - /** |
|
110 | - * Detailed debug information. |
|
111 | - * |
|
112 | - * @param string $message |
|
113 | - * @param mixed[] $context |
|
114 | - * |
|
115 | - * @return void |
|
116 | - */ |
|
117 | - public function debug($message, array $context = array()); |
|
109 | + /** |
|
110 | + * Detailed debug information. |
|
111 | + * |
|
112 | + * @param string $message |
|
113 | + * @param mixed[] $context |
|
114 | + * |
|
115 | + * @return void |
|
116 | + */ |
|
117 | + public function debug($message, array $context = array()); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Logs with an arbitrary level. |
|
121 | - * |
|
122 | - * @param mixed $level |
|
123 | - * @param string $message |
|
124 | - * @param mixed[] $context |
|
125 | - * |
|
126 | - * @return void |
|
127 | - * |
|
128 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
129 | - */ |
|
130 | - public function log($level, $message, array $context = array()); |
|
119 | + /** |
|
120 | + * Logs with an arbitrary level. |
|
121 | + * |
|
122 | + * @param mixed $level |
|
123 | + * @param string $message |
|
124 | + * @param mixed[] $context |
|
125 | + * |
|
126 | + * @return void |
|
127 | + * |
|
128 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
129 | + */ |
|
130 | + public function log($level, $message, array $context = array()); |
|
131 | 131 | } |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | * |
34 | 34 | * @return void |
35 | 35 | */ |
36 | - public function emergency($message, array $context = array()); |
|
36 | + public function emergency( $message, array $context = array() ); |
|
37 | 37 | |
38 | 38 | /** |
39 | 39 | * Action must be taken immediately. |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | * |
47 | 47 | * @return void |
48 | 48 | */ |
49 | - public function alert($message, array $context = array()); |
|
49 | + public function alert( $message, array $context = array() ); |
|
50 | 50 | |
51 | 51 | /** |
52 | 52 | * Critical conditions. |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | * |
59 | 59 | * @return void |
60 | 60 | */ |
61 | - public function critical($message, array $context = array()); |
|
61 | + public function critical( $message, array $context = array() ); |
|
62 | 62 | |
63 | 63 | /** |
64 | 64 | * Runtime errors that do not require immediate action but should typically |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | * |
70 | 70 | * @return void |
71 | 71 | */ |
72 | - public function error($message, array $context = array()); |
|
72 | + public function error( $message, array $context = array() ); |
|
73 | 73 | |
74 | 74 | /** |
75 | 75 | * Exceptional occurrences that are not errors. |
@@ -82,7 +82,7 @@ discard block |
||
82 | 82 | * |
83 | 83 | * @return void |
84 | 84 | */ |
85 | - public function warning($message, array $context = array()); |
|
85 | + public function warning( $message, array $context = array() ); |
|
86 | 86 | |
87 | 87 | /** |
88 | 88 | * Normal but significant events. |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | * |
93 | 93 | * @return void |
94 | 94 | */ |
95 | - public function notice($message, array $context = array()); |
|
95 | + public function notice( $message, array $context = array() ); |
|
96 | 96 | |
97 | 97 | /** |
98 | 98 | * Interesting events. |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | * |
105 | 105 | * @return void |
106 | 106 | */ |
107 | - public function info($message, array $context = array()); |
|
107 | + public function info( $message, array $context = array() ); |
|
108 | 108 | |
109 | 109 | /** |
110 | 110 | * Detailed debug information. |
@@ -114,7 +114,7 @@ discard block |
||
114 | 114 | * |
115 | 115 | * @return void |
116 | 116 | */ |
117 | - public function debug($message, array $context = array()); |
|
117 | + public function debug( $message, array $context = array() ); |
|
118 | 118 | |
119 | 119 | /** |
120 | 120 | * Logs with an arbitrary level. |
@@ -127,5 +127,5 @@ discard block |
||
127 | 127 | * |
128 | 128 | * @throws \GravityView\Psr\Log\InvalidArgumentException |
129 | 129 | */ |
130 | - public function log($level, $message, array $context = array()); |
|
130 | + public function log( $level, $message, array $context = array() ); |
|
131 | 131 | } |
@@ -23,8 +23,7 @@ |
||
23 | 23 | * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md |
24 | 24 | * for the full interface specification. |
25 | 25 | */ |
26 | -interface LoggerInterface |
|
27 | -{ |
|
26 | +interface LoggerInterface { |
|
28 | 27 | /** |
29 | 28 | * System is unusable. |
30 | 29 | * |
@@ -2,19 +2,19 @@ |
||
2 | 2 | // autoload.php @generated by Strauss |
3 | 3 | |
4 | 4 | if ( file_exists( __DIR__ . '/autoload-classmap.php' ) ) { |
5 | - $class_map = include __DIR__ . '/autoload-classmap.php'; |
|
6 | - if ( is_array( $class_map ) ) { |
|
7 | - spl_autoload_register( |
|
8 | - function ( $classname ) use ( $class_map ) { |
|
9 | - if ( isset( $class_map[ $classname ] ) && file_exists( $class_map[ $classname ] ) ) { |
|
10 | - require_once $class_map[ $classname ]; |
|
11 | - } |
|
12 | - } |
|
13 | - ); |
|
14 | - } |
|
15 | - unset( $class_map ); |
|
5 | + $class_map = include __DIR__ . '/autoload-classmap.php'; |
|
6 | + if ( is_array( $class_map ) ) { |
|
7 | + spl_autoload_register( |
|
8 | + function ( $classname ) use ( $class_map ) { |
|
9 | + if ( isset( $class_map[ $classname ] ) && file_exists( $class_map[ $classname ] ) ) { |
|
10 | + require_once $class_map[ $classname ]; |
|
11 | + } |
|
12 | + } |
|
13 | + ); |
|
14 | + } |
|
15 | + unset( $class_map ); |
|
16 | 16 | } |
17 | 17 | |
18 | 18 | if ( file_exists( __DIR__ . '/autoload-files.php' ) ) { |
19 | - require_once __DIR__ . '/autoload-files.php'; |
|
19 | + require_once __DIR__ . '/autoload-files.php'; |
|
20 | 20 | } |
21 | 21 | \ No newline at end of file |
@@ -5,7 +5,7 @@ |
||
5 | 5 | $class_map = include __DIR__ . '/autoload-classmap.php'; |
6 | 6 | if ( is_array( $class_map ) ) { |
7 | 7 | spl_autoload_register( |
8 | - function ( $classname ) use ( $class_map ) { |
|
8 | + function( $classname ) use ( $class_map ) { |
|
9 | 9 | if ( isset( $class_map[ $classname ] ) && file_exists( $class_map[ $classname ] ) ) { |
10 | 10 | require_once $class_map[ $classname ]; |
11 | 11 | } |
@@ -34,322 +34,322 @@ |
||
34 | 34 | */ |
35 | 35 | class Logger extends AbstractLogger |
36 | 36 | { |
37 | - /** |
|
38 | - * KLogger options |
|
39 | - * Anything options not considered 'core' to the logging library should be |
|
40 | - * settable view the third parameter in the constructor |
|
41 | - * |
|
42 | - * Core options include the log file path and the log threshold |
|
43 | - * |
|
44 | - * @var array |
|
45 | - */ |
|
46 | - protected $options = array ( |
|
47 | - 'extension' => 'txt', |
|
48 | - 'dateFormat' => 'Y-m-d G:i:s.u', |
|
49 | - 'filename' => false, |
|
50 | - 'flushFrequency' => false, |
|
51 | - 'prefix' => 'log_', |
|
52 | - 'logFormat' => false, |
|
53 | - 'appendContext' => true, |
|
54 | - ); |
|
55 | - |
|
56 | - /** |
|
57 | - * Path to the log file |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - private $logFilePath; |
|
61 | - |
|
62 | - /** |
|
63 | - * Current minimum logging threshold |
|
64 | - * @var integer |
|
65 | - */ |
|
66 | - protected $logLevelThreshold = LogLevel::DEBUG; |
|
67 | - |
|
68 | - /** |
|
69 | - * The number of lines logged in this instance's lifetime |
|
70 | - * @var int |
|
71 | - */ |
|
72 | - private $logLineCount = 0; |
|
73 | - |
|
74 | - /** |
|
75 | - * Log Levels |
|
76 | - * @var array |
|
77 | - */ |
|
78 | - protected $logLevels = array( |
|
79 | - LogLevel::EMERGENCY => 0, |
|
80 | - LogLevel::ALERT => 1, |
|
81 | - LogLevel::CRITICAL => 2, |
|
82 | - LogLevel::ERROR => 3, |
|
83 | - LogLevel::WARNING => 4, |
|
84 | - LogLevel::NOTICE => 5, |
|
85 | - LogLevel::INFO => 6, |
|
86 | - LogLevel::DEBUG => 7 |
|
87 | - ); |
|
88 | - |
|
89 | - /** |
|
90 | - * This holds the file handle for this instance's log file |
|
91 | - * @var resource |
|
92 | - */ |
|
93 | - private $fileHandle; |
|
94 | - |
|
95 | - /** |
|
96 | - * This holds the last line logged to the logger |
|
97 | - * Used for unit tests |
|
98 | - * @var string |
|
99 | - */ |
|
100 | - private $lastLine = ''; |
|
101 | - |
|
102 | - /** |
|
103 | - * Octal notation for default permissions of the log file |
|
104 | - * @var integer |
|
105 | - */ |
|
106 | - private $defaultPermissions = 0777; |
|
107 | - |
|
108 | - /** |
|
109 | - * Class constructor |
|
110 | - * |
|
111 | - * @param string $logDirectory File path to the logging directory |
|
112 | - * @param string $logLevelThreshold The LogLevel Threshold |
|
113 | - * @param array $options |
|
114 | - * |
|
115 | - * @internal param string $logFilePrefix The prefix for the log file name |
|
116 | - * @internal param string $logFileExt The extension for the log file |
|
117 | - */ |
|
118 | - public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array()) |
|
119 | - { |
|
120 | - $this->logLevelThreshold = $logLevelThreshold; |
|
121 | - $this->options = array_merge($this->options, $options); |
|
122 | - |
|
123 | - $logDirectory = rtrim($logDirectory, DIRECTORY_SEPARATOR); |
|
124 | - if ( ! file_exists($logDirectory)) { |
|
125 | - mkdir($logDirectory, $this->defaultPermissions, true); |
|
126 | - } |
|
127 | - |
|
128 | - if(strpos($logDirectory, 'php://') === 0) { |
|
129 | - $this->setLogToStdOut($logDirectory); |
|
130 | - $this->setFileHandle('w+'); |
|
131 | - } else { |
|
132 | - $this->setLogFilePath($logDirectory); |
|
133 | - if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) { |
|
134 | - throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
|
135 | - } |
|
136 | - $this->setFileHandle('a'); |
|
137 | - } |
|
138 | - |
|
139 | - if ( ! $this->fileHandle) { |
|
140 | - throw new RuntimeException('The file could not be opened. Check permissions.'); |
|
141 | - } |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * @param string $stdOutPath |
|
146 | - */ |
|
147 | - public function setLogToStdOut($stdOutPath) { |
|
148 | - $this->logFilePath = $stdOutPath; |
|
149 | - } |
|
150 | - |
|
151 | - /** |
|
152 | - * @param string $logDirectory |
|
153 | - */ |
|
154 | - public function setLogFilePath($logDirectory) { |
|
155 | - if ($this->options['filename']) { |
|
156 | - if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) { |
|
157 | - $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename']; |
|
158 | - } |
|
159 | - else { |
|
160 | - $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'].'.'.$this->options['extension']; |
|
161 | - } |
|
162 | - } else { |
|
163 | - $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['prefix'].date('Y-m-d').'.'.$this->options['extension']; |
|
164 | - } |
|
165 | - } |
|
166 | - |
|
167 | - /** |
|
168 | - * @param $writeMode |
|
169 | - * |
|
170 | - * @internal param resource $fileHandle |
|
171 | - */ |
|
172 | - public function setFileHandle($writeMode) { |
|
173 | - $this->fileHandle = fopen($this->logFilePath, $writeMode); |
|
174 | - } |
|
175 | - |
|
176 | - |
|
177 | - /** |
|
178 | - * Class destructor |
|
179 | - */ |
|
180 | - public function __destruct() |
|
181 | - { |
|
182 | - if ($this->fileHandle) { |
|
183 | - fclose($this->fileHandle); |
|
184 | - } |
|
185 | - } |
|
186 | - |
|
187 | - /** |
|
188 | - * Sets the date format used by all instances of KLogger |
|
189 | - * |
|
190 | - * @param string $dateFormat Valid format string for date() |
|
191 | - */ |
|
192 | - public function setDateFormat($dateFormat) |
|
193 | - { |
|
194 | - $this->options['dateFormat'] = $dateFormat; |
|
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * Sets the Log Level Threshold |
|
199 | - * |
|
200 | - * @param string $logLevelThreshold The log level threshold |
|
201 | - */ |
|
202 | - public function setLogLevelThreshold($logLevelThreshold) |
|
203 | - { |
|
204 | - $this->logLevelThreshold = $logLevelThreshold; |
|
205 | - } |
|
206 | - |
|
207 | - /** |
|
208 | - * Logs with an arbitrary level. |
|
209 | - * |
|
210 | - * @param mixed $level |
|
211 | - * @param string $message |
|
212 | - * @param array $context |
|
213 | - * @return null |
|
214 | - */ |
|
215 | - public function log($level, $message, array $context = array()) |
|
216 | - { |
|
217 | - if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) { |
|
218 | - return; |
|
219 | - } |
|
220 | - $message = $this->formatMessage($level, $message, $context); |
|
221 | - $this->write($message); |
|
222 | - } |
|
223 | - |
|
224 | - /** |
|
225 | - * Writes a line to the log without prepending a status or timestamp |
|
226 | - * |
|
227 | - * @param string $message Line to write to the log |
|
228 | - * @return void |
|
229 | - */ |
|
230 | - public function write($message) |
|
231 | - { |
|
232 | - if (null !== $this->fileHandle) { |
|
233 | - if (fwrite($this->fileHandle, $message) === false) { |
|
234 | - throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
|
235 | - } else { |
|
236 | - $this->lastLine = trim($message); |
|
237 | - $this->logLineCount++; |
|
238 | - |
|
239 | - if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) { |
|
240 | - fflush($this->fileHandle); |
|
241 | - } |
|
242 | - } |
|
243 | - } |
|
244 | - } |
|
245 | - |
|
246 | - /** |
|
247 | - * Get the file path that the log is currently writing to |
|
248 | - * |
|
249 | - * @return string |
|
250 | - */ |
|
251 | - public function getLogFilePath() |
|
252 | - { |
|
253 | - return $this->logFilePath; |
|
254 | - } |
|
255 | - |
|
256 | - /** |
|
257 | - * Get the last line logged to the log file |
|
258 | - * |
|
259 | - * @return string |
|
260 | - */ |
|
261 | - public function getLastLogLine() |
|
262 | - { |
|
263 | - return $this->lastLine; |
|
264 | - } |
|
265 | - |
|
266 | - /** |
|
267 | - * Formats the message for logging. |
|
268 | - * |
|
269 | - * @param string $level The Log Level of the message |
|
270 | - * @param string $message The message to log |
|
271 | - * @param array $context The context |
|
272 | - * @return string |
|
273 | - */ |
|
274 | - protected function formatMessage($level, $message, $context) |
|
275 | - { |
|
276 | - if ($this->options['logFormat']) { |
|
277 | - $parts = array( |
|
278 | - 'date' => $this->getTimestamp(), |
|
279 | - 'level' => strtoupper($level), |
|
280 | - 'level-padding' => str_repeat(' ', 9 - strlen($level)), |
|
281 | - 'priority' => $this->logLevels[$level], |
|
282 | - 'message' => $message, |
|
283 | - 'context' => json_encode($context), |
|
284 | - ); |
|
285 | - $message = $this->options['logFormat']; |
|
286 | - foreach ($parts as $part => $value) { |
|
287 | - $message = str_replace('{'.$part.'}', $value, $message); |
|
288 | - } |
|
289 | - |
|
290 | - } else { |
|
291 | - $message = "[{$this->getTimestamp()}] [{$level}] {$message}"; |
|
292 | - } |
|
293 | - |
|
294 | - if ($this->options['appendContext'] && ! empty($context)) { |
|
295 | - $message .= PHP_EOL.$this->indent($this->contextToString($context)); |
|
296 | - } |
|
297 | - |
|
298 | - return $message.PHP_EOL; |
|
299 | - |
|
300 | - } |
|
301 | - |
|
302 | - /** |
|
303 | - * Gets the correctly formatted Date/Time for the log entry. |
|
304 | - * |
|
305 | - * PHP DateTime is dump, and you have to resort to trickery to get microseconds |
|
306 | - * to work correctly, so here it is. |
|
307 | - * |
|
308 | - * @return string |
|
309 | - */ |
|
310 | - private function getTimestamp() |
|
311 | - { |
|
312 | - $originalTime = microtime(true); |
|
313 | - $micro = sprintf("%06d", ($originalTime - floor($originalTime)) * 1000000); |
|
314 | - $date = new DateTime(date('Y-m-d H:i:s.'.$micro, $originalTime)); |
|
315 | - |
|
316 | - return $date->format($this->options['dateFormat']); |
|
317 | - } |
|
318 | - |
|
319 | - /** |
|
320 | - * Takes the given context and coverts it to a string. |
|
321 | - * |
|
322 | - * @param array $context The Context |
|
323 | - * @return string |
|
324 | - */ |
|
325 | - protected function contextToString($context) |
|
326 | - { |
|
327 | - $export = ''; |
|
328 | - foreach ($context as $key => $value) { |
|
329 | - $export .= "{$key}: "; |
|
330 | - $export .= preg_replace(array( |
|
331 | - '/=>\s+([a-zA-Z])/im', |
|
332 | - '/array\(\s+\)/im', |
|
333 | - '/^ |\G /m' |
|
334 | - ), array( |
|
335 | - '=> $1', |
|
336 | - 'array()', |
|
337 | - ' ' |
|
338 | - ), str_replace('array (', 'array(', var_export($value, true))); |
|
339 | - $export .= PHP_EOL; |
|
340 | - } |
|
341 | - return str_replace(array('\\\\', '\\\''), array('\\', '\''), rtrim($export)); |
|
342 | - } |
|
343 | - |
|
344 | - /** |
|
345 | - * Indents the given string with the given indent. |
|
346 | - * |
|
347 | - * @param string $string The string to indent |
|
348 | - * @param string $indent What to use as the indent. |
|
349 | - * @return string |
|
350 | - */ |
|
351 | - protected function indent($string, $indent = ' ') |
|
352 | - { |
|
353 | - return $indent.str_replace("\n", "\n".$indent, $string); |
|
354 | - } |
|
37 | + /** |
|
38 | + * KLogger options |
|
39 | + * Anything options not considered 'core' to the logging library should be |
|
40 | + * settable view the third parameter in the constructor |
|
41 | + * |
|
42 | + * Core options include the log file path and the log threshold |
|
43 | + * |
|
44 | + * @var array |
|
45 | + */ |
|
46 | + protected $options = array ( |
|
47 | + 'extension' => 'txt', |
|
48 | + 'dateFormat' => 'Y-m-d G:i:s.u', |
|
49 | + 'filename' => false, |
|
50 | + 'flushFrequency' => false, |
|
51 | + 'prefix' => 'log_', |
|
52 | + 'logFormat' => false, |
|
53 | + 'appendContext' => true, |
|
54 | + ); |
|
55 | + |
|
56 | + /** |
|
57 | + * Path to the log file |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + private $logFilePath; |
|
61 | + |
|
62 | + /** |
|
63 | + * Current minimum logging threshold |
|
64 | + * @var integer |
|
65 | + */ |
|
66 | + protected $logLevelThreshold = LogLevel::DEBUG; |
|
67 | + |
|
68 | + /** |
|
69 | + * The number of lines logged in this instance's lifetime |
|
70 | + * @var int |
|
71 | + */ |
|
72 | + private $logLineCount = 0; |
|
73 | + |
|
74 | + /** |
|
75 | + * Log Levels |
|
76 | + * @var array |
|
77 | + */ |
|
78 | + protected $logLevels = array( |
|
79 | + LogLevel::EMERGENCY => 0, |
|
80 | + LogLevel::ALERT => 1, |
|
81 | + LogLevel::CRITICAL => 2, |
|
82 | + LogLevel::ERROR => 3, |
|
83 | + LogLevel::WARNING => 4, |
|
84 | + LogLevel::NOTICE => 5, |
|
85 | + LogLevel::INFO => 6, |
|
86 | + LogLevel::DEBUG => 7 |
|
87 | + ); |
|
88 | + |
|
89 | + /** |
|
90 | + * This holds the file handle for this instance's log file |
|
91 | + * @var resource |
|
92 | + */ |
|
93 | + private $fileHandle; |
|
94 | + |
|
95 | + /** |
|
96 | + * This holds the last line logged to the logger |
|
97 | + * Used for unit tests |
|
98 | + * @var string |
|
99 | + */ |
|
100 | + private $lastLine = ''; |
|
101 | + |
|
102 | + /** |
|
103 | + * Octal notation for default permissions of the log file |
|
104 | + * @var integer |
|
105 | + */ |
|
106 | + private $defaultPermissions = 0777; |
|
107 | + |
|
108 | + /** |
|
109 | + * Class constructor |
|
110 | + * |
|
111 | + * @param string $logDirectory File path to the logging directory |
|
112 | + * @param string $logLevelThreshold The LogLevel Threshold |
|
113 | + * @param array $options |
|
114 | + * |
|
115 | + * @internal param string $logFilePrefix The prefix for the log file name |
|
116 | + * @internal param string $logFileExt The extension for the log file |
|
117 | + */ |
|
118 | + public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array()) |
|
119 | + { |
|
120 | + $this->logLevelThreshold = $logLevelThreshold; |
|
121 | + $this->options = array_merge($this->options, $options); |
|
122 | + |
|
123 | + $logDirectory = rtrim($logDirectory, DIRECTORY_SEPARATOR); |
|
124 | + if ( ! file_exists($logDirectory)) { |
|
125 | + mkdir($logDirectory, $this->defaultPermissions, true); |
|
126 | + } |
|
127 | + |
|
128 | + if(strpos($logDirectory, 'php://') === 0) { |
|
129 | + $this->setLogToStdOut($logDirectory); |
|
130 | + $this->setFileHandle('w+'); |
|
131 | + } else { |
|
132 | + $this->setLogFilePath($logDirectory); |
|
133 | + if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) { |
|
134 | + throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
|
135 | + } |
|
136 | + $this->setFileHandle('a'); |
|
137 | + } |
|
138 | + |
|
139 | + if ( ! $this->fileHandle) { |
|
140 | + throw new RuntimeException('The file could not be opened. Check permissions.'); |
|
141 | + } |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * @param string $stdOutPath |
|
146 | + */ |
|
147 | + public function setLogToStdOut($stdOutPath) { |
|
148 | + $this->logFilePath = $stdOutPath; |
|
149 | + } |
|
150 | + |
|
151 | + /** |
|
152 | + * @param string $logDirectory |
|
153 | + */ |
|
154 | + public function setLogFilePath($logDirectory) { |
|
155 | + if ($this->options['filename']) { |
|
156 | + if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) { |
|
157 | + $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename']; |
|
158 | + } |
|
159 | + else { |
|
160 | + $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'].'.'.$this->options['extension']; |
|
161 | + } |
|
162 | + } else { |
|
163 | + $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['prefix'].date('Y-m-d').'.'.$this->options['extension']; |
|
164 | + } |
|
165 | + } |
|
166 | + |
|
167 | + /** |
|
168 | + * @param $writeMode |
|
169 | + * |
|
170 | + * @internal param resource $fileHandle |
|
171 | + */ |
|
172 | + public function setFileHandle($writeMode) { |
|
173 | + $this->fileHandle = fopen($this->logFilePath, $writeMode); |
|
174 | + } |
|
175 | + |
|
176 | + |
|
177 | + /** |
|
178 | + * Class destructor |
|
179 | + */ |
|
180 | + public function __destruct() |
|
181 | + { |
|
182 | + if ($this->fileHandle) { |
|
183 | + fclose($this->fileHandle); |
|
184 | + } |
|
185 | + } |
|
186 | + |
|
187 | + /** |
|
188 | + * Sets the date format used by all instances of KLogger |
|
189 | + * |
|
190 | + * @param string $dateFormat Valid format string for date() |
|
191 | + */ |
|
192 | + public function setDateFormat($dateFormat) |
|
193 | + { |
|
194 | + $this->options['dateFormat'] = $dateFormat; |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * Sets the Log Level Threshold |
|
199 | + * |
|
200 | + * @param string $logLevelThreshold The log level threshold |
|
201 | + */ |
|
202 | + public function setLogLevelThreshold($logLevelThreshold) |
|
203 | + { |
|
204 | + $this->logLevelThreshold = $logLevelThreshold; |
|
205 | + } |
|
206 | + |
|
207 | + /** |
|
208 | + * Logs with an arbitrary level. |
|
209 | + * |
|
210 | + * @param mixed $level |
|
211 | + * @param string $message |
|
212 | + * @param array $context |
|
213 | + * @return null |
|
214 | + */ |
|
215 | + public function log($level, $message, array $context = array()) |
|
216 | + { |
|
217 | + if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) { |
|
218 | + return; |
|
219 | + } |
|
220 | + $message = $this->formatMessage($level, $message, $context); |
|
221 | + $this->write($message); |
|
222 | + } |
|
223 | + |
|
224 | + /** |
|
225 | + * Writes a line to the log without prepending a status or timestamp |
|
226 | + * |
|
227 | + * @param string $message Line to write to the log |
|
228 | + * @return void |
|
229 | + */ |
|
230 | + public function write($message) |
|
231 | + { |
|
232 | + if (null !== $this->fileHandle) { |
|
233 | + if (fwrite($this->fileHandle, $message) === false) { |
|
234 | + throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
|
235 | + } else { |
|
236 | + $this->lastLine = trim($message); |
|
237 | + $this->logLineCount++; |
|
238 | + |
|
239 | + if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) { |
|
240 | + fflush($this->fileHandle); |
|
241 | + } |
|
242 | + } |
|
243 | + } |
|
244 | + } |
|
245 | + |
|
246 | + /** |
|
247 | + * Get the file path that the log is currently writing to |
|
248 | + * |
|
249 | + * @return string |
|
250 | + */ |
|
251 | + public function getLogFilePath() |
|
252 | + { |
|
253 | + return $this->logFilePath; |
|
254 | + } |
|
255 | + |
|
256 | + /** |
|
257 | + * Get the last line logged to the log file |
|
258 | + * |
|
259 | + * @return string |
|
260 | + */ |
|
261 | + public function getLastLogLine() |
|
262 | + { |
|
263 | + return $this->lastLine; |
|
264 | + } |
|
265 | + |
|
266 | + /** |
|
267 | + * Formats the message for logging. |
|
268 | + * |
|
269 | + * @param string $level The Log Level of the message |
|
270 | + * @param string $message The message to log |
|
271 | + * @param array $context The context |
|
272 | + * @return string |
|
273 | + */ |
|
274 | + protected function formatMessage($level, $message, $context) |
|
275 | + { |
|
276 | + if ($this->options['logFormat']) { |
|
277 | + $parts = array( |
|
278 | + 'date' => $this->getTimestamp(), |
|
279 | + 'level' => strtoupper($level), |
|
280 | + 'level-padding' => str_repeat(' ', 9 - strlen($level)), |
|
281 | + 'priority' => $this->logLevels[$level], |
|
282 | + 'message' => $message, |
|
283 | + 'context' => json_encode($context), |
|
284 | + ); |
|
285 | + $message = $this->options['logFormat']; |
|
286 | + foreach ($parts as $part => $value) { |
|
287 | + $message = str_replace('{'.$part.'}', $value, $message); |
|
288 | + } |
|
289 | + |
|
290 | + } else { |
|
291 | + $message = "[{$this->getTimestamp()}] [{$level}] {$message}"; |
|
292 | + } |
|
293 | + |
|
294 | + if ($this->options['appendContext'] && ! empty($context)) { |
|
295 | + $message .= PHP_EOL.$this->indent($this->contextToString($context)); |
|
296 | + } |
|
297 | + |
|
298 | + return $message.PHP_EOL; |
|
299 | + |
|
300 | + } |
|
301 | + |
|
302 | + /** |
|
303 | + * Gets the correctly formatted Date/Time for the log entry. |
|
304 | + * |
|
305 | + * PHP DateTime is dump, and you have to resort to trickery to get microseconds |
|
306 | + * to work correctly, so here it is. |
|
307 | + * |
|
308 | + * @return string |
|
309 | + */ |
|
310 | + private function getTimestamp() |
|
311 | + { |
|
312 | + $originalTime = microtime(true); |
|
313 | + $micro = sprintf("%06d", ($originalTime - floor($originalTime)) * 1000000); |
|
314 | + $date = new DateTime(date('Y-m-d H:i:s.'.$micro, $originalTime)); |
|
315 | + |
|
316 | + return $date->format($this->options['dateFormat']); |
|
317 | + } |
|
318 | + |
|
319 | + /** |
|
320 | + * Takes the given context and coverts it to a string. |
|
321 | + * |
|
322 | + * @param array $context The Context |
|
323 | + * @return string |
|
324 | + */ |
|
325 | + protected function contextToString($context) |
|
326 | + { |
|
327 | + $export = ''; |
|
328 | + foreach ($context as $key => $value) { |
|
329 | + $export .= "{$key}: "; |
|
330 | + $export .= preg_replace(array( |
|
331 | + '/=>\s+([a-zA-Z])/im', |
|
332 | + '/array\(\s+\)/im', |
|
333 | + '/^ |\G /m' |
|
334 | + ), array( |
|
335 | + '=> $1', |
|
336 | + 'array()', |
|
337 | + ' ' |
|
338 | + ), str_replace('array (', 'array(', var_export($value, true))); |
|
339 | + $export .= PHP_EOL; |
|
340 | + } |
|
341 | + return str_replace(array('\\\\', '\\\''), array('\\', '\''), rtrim($export)); |
|
342 | + } |
|
343 | + |
|
344 | + /** |
|
345 | + * Indents the given string with the given indent. |
|
346 | + * |
|
347 | + * @param string $string The string to indent |
|
348 | + * @param string $indent What to use as the indent. |
|
349 | + * @return string |
|
350 | + */ |
|
351 | + protected function indent($string, $indent = ' ') |
|
352 | + { |
|
353 | + return $indent.str_replace("\n", "\n".$indent, $string); |
|
354 | + } |
|
355 | 355 | } |
@@ -43,7 +43,7 @@ discard block |
||
43 | 43 | * |
44 | 44 | * @var array |
45 | 45 | */ |
46 | - protected $options = array ( |
|
46 | + protected $options = array( |
|
47 | 47 | 'extension' => 'txt', |
48 | 48 | 'dateFormat' => 'Y-m-d G:i:s.u', |
49 | 49 | 'filename' => false, |
@@ -115,52 +115,52 @@ discard block |
||
115 | 115 | * @internal param string $logFilePrefix The prefix for the log file name |
116 | 116 | * @internal param string $logFileExt The extension for the log file |
117 | 117 | */ |
118 | - public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array()) |
|
118 | + public function __construct( $logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array() ) |
|
119 | 119 | { |
120 | 120 | $this->logLevelThreshold = $logLevelThreshold; |
121 | - $this->options = array_merge($this->options, $options); |
|
121 | + $this->options = array_merge( $this->options, $options ); |
|
122 | 122 | |
123 | - $logDirectory = rtrim($logDirectory, DIRECTORY_SEPARATOR); |
|
124 | - if ( ! file_exists($logDirectory)) { |
|
125 | - mkdir($logDirectory, $this->defaultPermissions, true); |
|
123 | + $logDirectory = rtrim( $logDirectory, DIRECTORY_SEPARATOR ); |
|
124 | + if ( ! file_exists( $logDirectory ) ) { |
|
125 | + mkdir( $logDirectory, $this->defaultPermissions, true ); |
|
126 | 126 | } |
127 | 127 | |
128 | - if(strpos($logDirectory, 'php://') === 0) { |
|
129 | - $this->setLogToStdOut($logDirectory); |
|
130 | - $this->setFileHandle('w+'); |
|
128 | + if ( strpos( $logDirectory, 'php://' ) === 0 ) { |
|
129 | + $this->setLogToStdOut( $logDirectory ); |
|
130 | + $this->setFileHandle( 'w+' ); |
|
131 | 131 | } else { |
132 | - $this->setLogFilePath($logDirectory); |
|
133 | - if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) { |
|
134 | - throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
|
132 | + $this->setLogFilePath( $logDirectory ); |
|
133 | + if ( file_exists( $this->logFilePath ) && ! is_writable( $this->logFilePath ) ) { |
|
134 | + throw new RuntimeException( 'The file could not be written to. Check that appropriate permissions have been set.' ); |
|
135 | 135 | } |
136 | - $this->setFileHandle('a'); |
|
136 | + $this->setFileHandle( 'a' ); |
|
137 | 137 | } |
138 | 138 | |
139 | - if ( ! $this->fileHandle) { |
|
140 | - throw new RuntimeException('The file could not be opened. Check permissions.'); |
|
139 | + if ( ! $this->fileHandle ) { |
|
140 | + throw new RuntimeException( 'The file could not be opened. Check permissions.' ); |
|
141 | 141 | } |
142 | 142 | } |
143 | 143 | |
144 | 144 | /** |
145 | 145 | * @param string $stdOutPath |
146 | 146 | */ |
147 | - public function setLogToStdOut($stdOutPath) { |
|
147 | + public function setLogToStdOut( $stdOutPath ) { |
|
148 | 148 | $this->logFilePath = $stdOutPath; |
149 | 149 | } |
150 | 150 | |
151 | 151 | /** |
152 | 152 | * @param string $logDirectory |
153 | 153 | */ |
154 | - public function setLogFilePath($logDirectory) { |
|
155 | - if ($this->options['filename']) { |
|
156 | - if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) { |
|
157 | - $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename']; |
|
154 | + public function setLogFilePath( $logDirectory ) { |
|
155 | + if ( $this->options[ 'filename' ] ) { |
|
156 | + if ( strpos( $this->options[ 'filename' ], '.log' ) !== false || strpos( $this->options[ 'filename' ], '.txt' ) !== false ) { |
|
157 | + $this->logFilePath = $logDirectory . DIRECTORY_SEPARATOR . $this->options[ 'filename' ]; |
|
158 | 158 | } |
159 | 159 | else { |
160 | - $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'].'.'.$this->options['extension']; |
|
160 | + $this->logFilePath = $logDirectory . DIRECTORY_SEPARATOR . $this->options[ 'filename' ] . '.' . $this->options[ 'extension' ]; |
|
161 | 161 | } |
162 | 162 | } else { |
163 | - $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['prefix'].date('Y-m-d').'.'.$this->options['extension']; |
|
163 | + $this->logFilePath = $logDirectory . DIRECTORY_SEPARATOR . $this->options[ 'prefix' ] . date( 'Y-m-d' ) . '.' . $this->options[ 'extension' ]; |
|
164 | 164 | } |
165 | 165 | } |
166 | 166 | |
@@ -169,8 +169,8 @@ discard block |
||
169 | 169 | * |
170 | 170 | * @internal param resource $fileHandle |
171 | 171 | */ |
172 | - public function setFileHandle($writeMode) { |
|
173 | - $this->fileHandle = fopen($this->logFilePath, $writeMode); |
|
172 | + public function setFileHandle( $writeMode ) { |
|
173 | + $this->fileHandle = fopen( $this->logFilePath, $writeMode ); |
|
174 | 174 | } |
175 | 175 | |
176 | 176 | |
@@ -179,8 +179,8 @@ discard block |
||
179 | 179 | */ |
180 | 180 | public function __destruct() |
181 | 181 | { |
182 | - if ($this->fileHandle) { |
|
183 | - fclose($this->fileHandle); |
|
182 | + if ( $this->fileHandle ) { |
|
183 | + fclose( $this->fileHandle ); |
|
184 | 184 | } |
185 | 185 | } |
186 | 186 | |
@@ -189,9 +189,9 @@ discard block |
||
189 | 189 | * |
190 | 190 | * @param string $dateFormat Valid format string for date() |
191 | 191 | */ |
192 | - public function setDateFormat($dateFormat) |
|
192 | + public function setDateFormat( $dateFormat ) |
|
193 | 193 | { |
194 | - $this->options['dateFormat'] = $dateFormat; |
|
194 | + $this->options[ 'dateFormat' ] = $dateFormat; |
|
195 | 195 | } |
196 | 196 | |
197 | 197 | /** |
@@ -199,7 +199,7 @@ discard block |
||
199 | 199 | * |
200 | 200 | * @param string $logLevelThreshold The log level threshold |
201 | 201 | */ |
202 | - public function setLogLevelThreshold($logLevelThreshold) |
|
202 | + public function setLogLevelThreshold( $logLevelThreshold ) |
|
203 | 203 | { |
204 | 204 | $this->logLevelThreshold = $logLevelThreshold; |
205 | 205 | } |
@@ -212,13 +212,13 @@ discard block |
||
212 | 212 | * @param array $context |
213 | 213 | * @return null |
214 | 214 | */ |
215 | - public function log($level, $message, array $context = array()) |
|
215 | + public function log( $level, $message, array $context = array() ) |
|
216 | 216 | { |
217 | - if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) { |
|
217 | + if ( $this->logLevels[ $this->logLevelThreshold ] < $this->logLevels[ $level ] ) { |
|
218 | 218 | return; |
219 | 219 | } |
220 | - $message = $this->formatMessage($level, $message, $context); |
|
221 | - $this->write($message); |
|
220 | + $message = $this->formatMessage( $level, $message, $context ); |
|
221 | + $this->write( $message ); |
|
222 | 222 | } |
223 | 223 | |
224 | 224 | /** |
@@ -227,17 +227,17 @@ discard block |
||
227 | 227 | * @param string $message Line to write to the log |
228 | 228 | * @return void |
229 | 229 | */ |
230 | - public function write($message) |
|
230 | + public function write( $message ) |
|
231 | 231 | { |
232 | - if (null !== $this->fileHandle) { |
|
233 | - if (fwrite($this->fileHandle, $message) === false) { |
|
234 | - throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
|
232 | + if ( null !== $this->fileHandle ) { |
|
233 | + if ( fwrite( $this->fileHandle, $message ) === false ) { |
|
234 | + throw new RuntimeException( 'The file could not be written to. Check that appropriate permissions have been set.' ); |
|
235 | 235 | } else { |
236 | - $this->lastLine = trim($message); |
|
236 | + $this->lastLine = trim( $message ); |
|
237 | 237 | $this->logLineCount++; |
238 | 238 | |
239 | - if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) { |
|
240 | - fflush($this->fileHandle); |
|
239 | + if ( $this->options[ 'flushFrequency' ] && $this->logLineCount % $this->options[ 'flushFrequency' ] === 0 ) { |
|
240 | + fflush( $this->fileHandle ); |
|
241 | 241 | } |
242 | 242 | } |
243 | 243 | } |
@@ -271,31 +271,31 @@ discard block |
||
271 | 271 | * @param array $context The context |
272 | 272 | * @return string |
273 | 273 | */ |
274 | - protected function formatMessage($level, $message, $context) |
|
274 | + protected function formatMessage( $level, $message, $context ) |
|
275 | 275 | { |
276 | - if ($this->options['logFormat']) { |
|
276 | + if ( $this->options[ 'logFormat' ] ) { |
|
277 | 277 | $parts = array( |
278 | 278 | 'date' => $this->getTimestamp(), |
279 | - 'level' => strtoupper($level), |
|
280 | - 'level-padding' => str_repeat(' ', 9 - strlen($level)), |
|
281 | - 'priority' => $this->logLevels[$level], |
|
279 | + 'level' => strtoupper( $level ), |
|
280 | + 'level-padding' => str_repeat( ' ', 9 - strlen( $level ) ), |
|
281 | + 'priority' => $this->logLevels[ $level ], |
|
282 | 282 | 'message' => $message, |
283 | - 'context' => json_encode($context), |
|
283 | + 'context' => json_encode( $context ), |
|
284 | 284 | ); |
285 | - $message = $this->options['logFormat']; |
|
286 | - foreach ($parts as $part => $value) { |
|
287 | - $message = str_replace('{'.$part.'}', $value, $message); |
|
285 | + $message = $this->options[ 'logFormat' ]; |
|
286 | + foreach ( $parts as $part => $value ) { |
|
287 | + $message = str_replace( '{' . $part . '}', $value, $message ); |
|
288 | 288 | } |
289 | 289 | |
290 | 290 | } else { |
291 | 291 | $message = "[{$this->getTimestamp()}] [{$level}] {$message}"; |
292 | 292 | } |
293 | 293 | |
294 | - if ($this->options['appendContext'] && ! empty($context)) { |
|
295 | - $message .= PHP_EOL.$this->indent($this->contextToString($context)); |
|
294 | + if ( $this->options[ 'appendContext' ] && ! empty( $context ) ) { |
|
295 | + $message .= PHP_EOL . $this->indent( $this->contextToString( $context ) ); |
|
296 | 296 | } |
297 | 297 | |
298 | - return $message.PHP_EOL; |
|
298 | + return $message . PHP_EOL; |
|
299 | 299 | |
300 | 300 | } |
301 | 301 | |
@@ -309,11 +309,11 @@ discard block |
||
309 | 309 | */ |
310 | 310 | private function getTimestamp() |
311 | 311 | { |
312 | - $originalTime = microtime(true); |
|
313 | - $micro = sprintf("%06d", ($originalTime - floor($originalTime)) * 1000000); |
|
314 | - $date = new DateTime(date('Y-m-d H:i:s.'.$micro, $originalTime)); |
|
312 | + $originalTime = microtime( true ); |
|
313 | + $micro = sprintf( "%06d", ( $originalTime - floor( $originalTime ) ) * 1000000 ); |
|
314 | + $date = new DateTime( date( 'Y-m-d H:i:s.' . $micro, $originalTime ) ); |
|
315 | 315 | |
316 | - return $date->format($this->options['dateFormat']); |
|
316 | + return $date->format( $this->options[ 'dateFormat' ] ); |
|
317 | 317 | } |
318 | 318 | |
319 | 319 | /** |
@@ -322,12 +322,12 @@ discard block |
||
322 | 322 | * @param array $context The Context |
323 | 323 | * @return string |
324 | 324 | */ |
325 | - protected function contextToString($context) |
|
325 | + protected function contextToString( $context ) |
|
326 | 326 | { |
327 | 327 | $export = ''; |
328 | - foreach ($context as $key => $value) { |
|
328 | + foreach ( $context as $key => $value ) { |
|
329 | 329 | $export .= "{$key}: "; |
330 | - $export .= preg_replace(array( |
|
330 | + $export .= preg_replace( array( |
|
331 | 331 | '/=>\s+([a-zA-Z])/im', |
332 | 332 | '/array\(\s+\)/im', |
333 | 333 | '/^ |\G /m' |
@@ -335,10 +335,10 @@ discard block |
||
335 | 335 | '=> $1', |
336 | 336 | 'array()', |
337 | 337 | ' ' |
338 | - ), str_replace('array (', 'array(', var_export($value, true))); |
|
338 | + ), str_replace( 'array (', 'array(', var_export( $value, true ) ) ); |
|
339 | 339 | $export .= PHP_EOL; |
340 | 340 | } |
341 | - return str_replace(array('\\\\', '\\\''), array('\\', '\''), rtrim($export)); |
|
341 | + return str_replace( array( '\\\\', '\\\'' ), array( '\\', '\'' ), rtrim( $export ) ); |
|
342 | 342 | } |
343 | 343 | |
344 | 344 | /** |
@@ -348,8 +348,8 @@ discard block |
||
348 | 348 | * @param string $indent What to use as the indent. |
349 | 349 | * @return string |
350 | 350 | */ |
351 | - protected function indent($string, $indent = ' ') |
|
351 | + protected function indent( $string, $indent = ' ' ) |
|
352 | 352 | { |
353 | - return $indent.str_replace("\n", "\n".$indent, $string); |
|
353 | + return $indent . str_replace( "\n", "\n" . $indent, $string ); |
|
354 | 354 | } |
355 | 355 | } |
@@ -32,8 +32,7 @@ discard block |
||
32 | 32 | /** |
33 | 33 | * Class documentation |
34 | 34 | */ |
35 | -class Logger extends AbstractLogger |
|
36 | -{ |
|
35 | +class Logger extends AbstractLogger { |
|
37 | 36 | /** |
38 | 37 | * KLogger options |
39 | 38 | * Anything options not considered 'core' to the logging library should be |
@@ -115,28 +114,27 @@ discard block |
||
115 | 114 | * @internal param string $logFilePrefix The prefix for the log file name |
116 | 115 | * @internal param string $logFileExt The extension for the log file |
117 | 116 | */ |
118 | - public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array()) |
|
119 | - { |
|
117 | + public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array()) { |
|
120 | 118 | $this->logLevelThreshold = $logLevelThreshold; |
121 | 119 | $this->options = array_merge($this->options, $options); |
122 | 120 | |
123 | 121 | $logDirectory = rtrim($logDirectory, DIRECTORY_SEPARATOR); |
124 | - if ( ! file_exists($logDirectory)) { |
|
122 | + if ( ! file_exists($logDirectory)) { |
|
125 | 123 | mkdir($logDirectory, $this->defaultPermissions, true); |
126 | 124 | } |
127 | 125 | |
128 | - if(strpos($logDirectory, 'php://') === 0) { |
|
126 | + if(strpos($logDirectory, 'php://') === 0) { |
|
129 | 127 | $this->setLogToStdOut($logDirectory); |
130 | 128 | $this->setFileHandle('w+'); |
131 | - } else { |
|
129 | + } else { |
|
132 | 130 | $this->setLogFilePath($logDirectory); |
133 | - if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) { |
|
131 | + if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) { |
|
134 | 132 | throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
135 | 133 | } |
136 | 134 | $this->setFileHandle('a'); |
137 | 135 | } |
138 | 136 | |
139 | - if ( ! $this->fileHandle) { |
|
137 | + if ( ! $this->fileHandle) { |
|
140 | 138 | throw new RuntimeException('The file could not be opened. Check permissions.'); |
141 | 139 | } |
142 | 140 | } |
@@ -144,22 +142,21 @@ discard block |
||
144 | 142 | /** |
145 | 143 | * @param string $stdOutPath |
146 | 144 | */ |
147 | - public function setLogToStdOut($stdOutPath) { |
|
145 | + public function setLogToStdOut($stdOutPath) { |
|
148 | 146 | $this->logFilePath = $stdOutPath; |
149 | 147 | } |
150 | 148 | |
151 | 149 | /** |
152 | 150 | * @param string $logDirectory |
153 | 151 | */ |
154 | - public function setLogFilePath($logDirectory) { |
|
155 | - if ($this->options['filename']) { |
|
156 | - if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) { |
|
152 | + public function setLogFilePath($logDirectory) { |
|
153 | + if ($this->options['filename']) { |
|
154 | + if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) { |
|
157 | 155 | $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename']; |
158 | - } |
|
159 | - else { |
|
156 | + } else { |
|
160 | 157 | $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'].'.'.$this->options['extension']; |
161 | 158 | } |
162 | - } else { |
|
159 | + } else { |
|
163 | 160 | $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['prefix'].date('Y-m-d').'.'.$this->options['extension']; |
164 | 161 | } |
165 | 162 | } |
@@ -169,7 +166,7 @@ discard block |
||
169 | 166 | * |
170 | 167 | * @internal param resource $fileHandle |
171 | 168 | */ |
172 | - public function setFileHandle($writeMode) { |
|
169 | + public function setFileHandle($writeMode) { |
|
173 | 170 | $this->fileHandle = fopen($this->logFilePath, $writeMode); |
174 | 171 | } |
175 | 172 | |
@@ -177,9 +174,8 @@ discard block |
||
177 | 174 | /** |
178 | 175 | * Class destructor |
179 | 176 | */ |
180 | - public function __destruct() |
|
181 | - { |
|
182 | - if ($this->fileHandle) { |
|
177 | + public function __destruct() { |
|
178 | + if ($this->fileHandle) { |
|
183 | 179 | fclose($this->fileHandle); |
184 | 180 | } |
185 | 181 | } |
@@ -189,8 +185,7 @@ discard block |
||
189 | 185 | * |
190 | 186 | * @param string $dateFormat Valid format string for date() |
191 | 187 | */ |
192 | - public function setDateFormat($dateFormat) |
|
193 | - { |
|
188 | + public function setDateFormat($dateFormat) { |
|
194 | 189 | $this->options['dateFormat'] = $dateFormat; |
195 | 190 | } |
196 | 191 | |
@@ -199,8 +194,7 @@ discard block |
||
199 | 194 | * |
200 | 195 | * @param string $logLevelThreshold The log level threshold |
201 | 196 | */ |
202 | - public function setLogLevelThreshold($logLevelThreshold) |
|
203 | - { |
|
197 | + public function setLogLevelThreshold($logLevelThreshold) { |
|
204 | 198 | $this->logLevelThreshold = $logLevelThreshold; |
205 | 199 | } |
206 | 200 | |
@@ -212,9 +206,8 @@ discard block |
||
212 | 206 | * @param array $context |
213 | 207 | * @return null |
214 | 208 | */ |
215 | - public function log($level, $message, array $context = array()) |
|
216 | - { |
|
217 | - if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) { |
|
209 | + public function log($level, $message, array $context = array()) { |
|
210 | + if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) { |
|
218 | 211 | return; |
219 | 212 | } |
220 | 213 | $message = $this->formatMessage($level, $message, $context); |
@@ -227,16 +220,15 @@ discard block |
||
227 | 220 | * @param string $message Line to write to the log |
228 | 221 | * @return void |
229 | 222 | */ |
230 | - public function write($message) |
|
231 | - { |
|
232 | - if (null !== $this->fileHandle) { |
|
233 | - if (fwrite($this->fileHandle, $message) === false) { |
|
223 | + public function write($message) { |
|
224 | + if (null !== $this->fileHandle) { |
|
225 | + if (fwrite($this->fileHandle, $message) === false) { |
|
234 | 226 | throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.'); |
235 | - } else { |
|
227 | + } else { |
|
236 | 228 | $this->lastLine = trim($message); |
237 | 229 | $this->logLineCount++; |
238 | 230 | |
239 | - if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) { |
|
231 | + if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) { |
|
240 | 232 | fflush($this->fileHandle); |
241 | 233 | } |
242 | 234 | } |
@@ -248,8 +240,7 @@ discard block |
||
248 | 240 | * |
249 | 241 | * @return string |
250 | 242 | */ |
251 | - public function getLogFilePath() |
|
252 | - { |
|
243 | + public function getLogFilePath() { |
|
253 | 244 | return $this->logFilePath; |
254 | 245 | } |
255 | 246 | |
@@ -258,8 +249,7 @@ discard block |
||
258 | 249 | * |
259 | 250 | * @return string |
260 | 251 | */ |
261 | - public function getLastLogLine() |
|
262 | - { |
|
252 | + public function getLastLogLine() { |
|
263 | 253 | return $this->lastLine; |
264 | 254 | } |
265 | 255 | |
@@ -271,9 +261,8 @@ discard block |
||
271 | 261 | * @param array $context The context |
272 | 262 | * @return string |
273 | 263 | */ |
274 | - protected function formatMessage($level, $message, $context) |
|
275 | - { |
|
276 | - if ($this->options['logFormat']) { |
|
264 | + protected function formatMessage($level, $message, $context) { |
|
265 | + if ($this->options['logFormat']) { |
|
277 | 266 | $parts = array( |
278 | 267 | 'date' => $this->getTimestamp(), |
279 | 268 | 'level' => strtoupper($level), |
@@ -283,15 +272,15 @@ discard block |
||
283 | 272 | 'context' => json_encode($context), |
284 | 273 | ); |
285 | 274 | $message = $this->options['logFormat']; |
286 | - foreach ($parts as $part => $value) { |
|
275 | + foreach ($parts as $part => $value) { |
|
287 | 276 | $message = str_replace('{'.$part.'}', $value, $message); |
288 | 277 | } |
289 | 278 | |
290 | - } else { |
|
279 | + } else { |
|
291 | 280 | $message = "[{$this->getTimestamp()}] [{$level}] {$message}"; |
292 | 281 | } |
293 | 282 | |
294 | - if ($this->options['appendContext'] && ! empty($context)) { |
|
283 | + if ($this->options['appendContext'] && ! empty($context)) { |
|
295 | 284 | $message .= PHP_EOL.$this->indent($this->contextToString($context)); |
296 | 285 | } |
297 | 286 | |
@@ -307,8 +296,7 @@ discard block |
||
307 | 296 | * |
308 | 297 | * @return string |
309 | 298 | */ |
310 | - private function getTimestamp() |
|
311 | - { |
|
299 | + private function getTimestamp() { |
|
312 | 300 | $originalTime = microtime(true); |
313 | 301 | $micro = sprintf("%06d", ($originalTime - floor($originalTime)) * 1000000); |
314 | 302 | $date = new DateTime(date('Y-m-d H:i:s.'.$micro, $originalTime)); |
@@ -322,10 +310,9 @@ discard block |
||
322 | 310 | * @param array $context The Context |
323 | 311 | * @return string |
324 | 312 | */ |
325 | - protected function contextToString($context) |
|
326 | - { |
|
313 | + protected function contextToString($context) { |
|
327 | 314 | $export = ''; |
328 | - foreach ($context as $key => $value) { |
|
315 | + foreach ($context as $key => $value) { |
|
329 | 316 | $export .= "{$key}: "; |
330 | 317 | $export .= preg_replace(array( |
331 | 318 | '/=>\s+([a-zA-Z])/im', |
@@ -348,8 +335,7 @@ discard block |
||
348 | 335 | * @param string $indent What to use as the indent. |
349 | 336 | * @return string |
350 | 337 | */ |
351 | - protected function indent($string, $indent = ' ') |
|
352 | - { |
|
338 | + protected function indent($string, $indent = ' ') { |
|
353 | 339 | return $indent.str_replace("\n", "\n".$indent, $string); |
354 | 340 | } |
355 | 341 | } |