@@ -11,272 +11,272 @@ |
||
11 | 11 | |
12 | 12 | class Translation |
13 | 13 | { |
14 | - const SEARCH_THRESHOLD = 3; |
|
14 | + const SEARCH_THRESHOLD = 3; |
|
15 | 15 | |
16 | - /** |
|
17 | - * @var array |
|
18 | - */ |
|
19 | - protected $entries; |
|
16 | + /** |
|
17 | + * @var array |
|
18 | + */ |
|
19 | + protected $entries; |
|
20 | 20 | |
21 | - /** |
|
22 | - * @var array |
|
23 | - */ |
|
24 | - protected $results; |
|
21 | + /** |
|
22 | + * @var array |
|
23 | + */ |
|
24 | + protected $results; |
|
25 | 25 | |
26 | - /** |
|
27 | - * Returns all saved custom translations with translation context. |
|
28 | - * @return array |
|
29 | - */ |
|
30 | - public function all() |
|
31 | - { |
|
32 | - $translations = $this->translations(); |
|
33 | - $entries = $this->filter($translations, $this->entries())->results(); |
|
34 | - array_walk($translations, function (&$entry) use ($entries) { |
|
35 | - $entry['desc'] = array_key_exists($entry['id'], $entries) |
|
36 | - ? $this->getEntryString($entries[$entry['id']], 'msgctxt') |
|
37 | - : ''; |
|
38 | - }); |
|
39 | - return $translations; |
|
40 | - } |
|
26 | + /** |
|
27 | + * Returns all saved custom translations with translation context. |
|
28 | + * @return array |
|
29 | + */ |
|
30 | + public function all() |
|
31 | + { |
|
32 | + $translations = $this->translations(); |
|
33 | + $entries = $this->filter($translations, $this->entries())->results(); |
|
34 | + array_walk($translations, function (&$entry) use ($entries) { |
|
35 | + $entry['desc'] = array_key_exists($entry['id'], $entries) |
|
36 | + ? $this->getEntryString($entries[$entry['id']], 'msgctxt') |
|
37 | + : ''; |
|
38 | + }); |
|
39 | + return $translations; |
|
40 | + } |
|
41 | 41 | |
42 | - /** |
|
43 | - * @return array |
|
44 | - */ |
|
45 | - public function entries() |
|
46 | - { |
|
47 | - if (!isset($this->entries)) { |
|
48 | - $potFile = glsr()->path(glsr()->languages.'/'.Application::ID.'.pot'); |
|
49 | - $entries = $this->extractEntriesFromPotFile($potFile); |
|
50 | - $entries = apply_filters('site-reviews/translation/entries', $entries); |
|
51 | - $this->entries = $entries; |
|
52 | - } |
|
53 | - return $this->entries; |
|
54 | - } |
|
42 | + /** |
|
43 | + * @return array |
|
44 | + */ |
|
45 | + public function entries() |
|
46 | + { |
|
47 | + if (!isset($this->entries)) { |
|
48 | + $potFile = glsr()->path(glsr()->languages.'/'.Application::ID.'.pot'); |
|
49 | + $entries = $this->extractEntriesFromPotFile($potFile); |
|
50 | + $entries = apply_filters('site-reviews/translation/entries', $entries); |
|
51 | + $this->entries = $entries; |
|
52 | + } |
|
53 | + return $this->entries; |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * @param array|null $entriesToExclude |
|
58 | - * @param array|null $entries |
|
59 | - * @return static |
|
60 | - */ |
|
61 | - public function exclude($entriesToExclude = null, $entries = null) |
|
62 | - { |
|
63 | - return $this->filter($entriesToExclude, $entries, false); |
|
64 | - } |
|
56 | + /** |
|
57 | + * @param array|null $entriesToExclude |
|
58 | + * @param array|null $entries |
|
59 | + * @return static |
|
60 | + */ |
|
61 | + public function exclude($entriesToExclude = null, $entries = null) |
|
62 | + { |
|
63 | + return $this->filter($entriesToExclude, $entries, false); |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * @param string $potFile |
|
68 | - * @return array |
|
69 | - */ |
|
70 | - public function extractEntriesFromPotFile($potFile, array $entries = []) |
|
71 | - { |
|
72 | - try { |
|
73 | - $potEntries = $this->normalize(Parser::parseFile($potFile)->getEntries()); |
|
74 | - foreach ($potEntries as $key => $entry) { |
|
75 | - $entries[html_entity_decode($key, ENT_COMPAT, 'UTF-8')] = $entry; |
|
76 | - } |
|
77 | - } catch (Exception $e) { |
|
78 | - glsr_log()->error($e->getMessage()); |
|
79 | - } |
|
80 | - return $entries; |
|
81 | - } |
|
66 | + /** |
|
67 | + * @param string $potFile |
|
68 | + * @return array |
|
69 | + */ |
|
70 | + public function extractEntriesFromPotFile($potFile, array $entries = []) |
|
71 | + { |
|
72 | + try { |
|
73 | + $potEntries = $this->normalize(Parser::parseFile($potFile)->getEntries()); |
|
74 | + foreach ($potEntries as $key => $entry) { |
|
75 | + $entries[html_entity_decode($key, ENT_COMPAT, 'UTF-8')] = $entry; |
|
76 | + } |
|
77 | + } catch (Exception $e) { |
|
78 | + glsr_log()->error($e->getMessage()); |
|
79 | + } |
|
80 | + return $entries; |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * @param array|null $filterWith |
|
85 | - * @param array|null $entries |
|
86 | - * @param bool $intersect |
|
87 | - * @return static |
|
88 | - */ |
|
89 | - public function filter($filterWith = null, $entries = null, $intersect = true) |
|
90 | - { |
|
91 | - if (!is_array($entries)) { |
|
92 | - $entries = $this->results; |
|
93 | - } |
|
94 | - if (!is_array($filterWith)) { |
|
95 | - $filterWith = $this->translations(); |
|
96 | - } |
|
97 | - $keys = array_flip(glsr_array_column($filterWith, 'id')); |
|
98 | - $this->results = $intersect |
|
99 | - ? array_intersect_key($entries, $keys) |
|
100 | - : array_diff_key($entries, $keys); |
|
101 | - return $this; |
|
102 | - } |
|
83 | + /** |
|
84 | + * @param array|null $filterWith |
|
85 | + * @param array|null $entries |
|
86 | + * @param bool $intersect |
|
87 | + * @return static |
|
88 | + */ |
|
89 | + public function filter($filterWith = null, $entries = null, $intersect = true) |
|
90 | + { |
|
91 | + if (!is_array($entries)) { |
|
92 | + $entries = $this->results; |
|
93 | + } |
|
94 | + if (!is_array($filterWith)) { |
|
95 | + $filterWith = $this->translations(); |
|
96 | + } |
|
97 | + $keys = array_flip(glsr_array_column($filterWith, 'id')); |
|
98 | + $this->results = $intersect |
|
99 | + ? array_intersect_key($entries, $keys) |
|
100 | + : array_diff_key($entries, $keys); |
|
101 | + return $this; |
|
102 | + } |
|
103 | 103 | |
104 | - /** |
|
105 | - * @param string $template |
|
106 | - * @return string |
|
107 | - */ |
|
108 | - public function render($template, array $entry) |
|
109 | - { |
|
110 | - $data = array_combine( |
|
111 | - array_map(function ($key) { return 'data.'.$key; }, array_keys($entry)), |
|
112 | - $entry |
|
113 | - ); |
|
114 | - $data['data.class'] = $data['data.error'] = ''; |
|
115 | - if (false === array_search($entry['s1'], glsr_array_column($this->entries(), 'msgid'))) { |
|
116 | - $data['data.class'] = 'is-invalid'; |
|
117 | - $data['data.error'] = __('This custom translation is no longer valid as the original text has been changed or removed.', 'site-reviews'); |
|
118 | - } |
|
119 | - return glsr(Template::class)->build('partials/translations/'.$template, [ |
|
120 | - 'context' => array_map('esc_html', $data), |
|
121 | - ]); |
|
122 | - } |
|
104 | + /** |
|
105 | + * @param string $template |
|
106 | + * @return string |
|
107 | + */ |
|
108 | + public function render($template, array $entry) |
|
109 | + { |
|
110 | + $data = array_combine( |
|
111 | + array_map(function ($key) { return 'data.'.$key; }, array_keys($entry)), |
|
112 | + $entry |
|
113 | + ); |
|
114 | + $data['data.class'] = $data['data.error'] = ''; |
|
115 | + if (false === array_search($entry['s1'], glsr_array_column($this->entries(), 'msgid'))) { |
|
116 | + $data['data.class'] = 'is-invalid'; |
|
117 | + $data['data.error'] = __('This custom translation is no longer valid as the original text has been changed or removed.', 'site-reviews'); |
|
118 | + } |
|
119 | + return glsr(Template::class)->build('partials/translations/'.$template, [ |
|
120 | + 'context' => array_map('esc_html', $data), |
|
121 | + ]); |
|
122 | + } |
|
123 | 123 | |
124 | - /** |
|
125 | - * Returns a rendered string of all saved custom translations with translation context. |
|
126 | - * @return string |
|
127 | - */ |
|
128 | - public function renderAll() |
|
129 | - { |
|
130 | - $rendered = ''; |
|
131 | - foreach ($this->all() as $index => $entry) { |
|
132 | - $entry['index'] = $index; |
|
133 | - $entry['prefix'] = OptionManager::databaseKey(); |
|
134 | - $rendered.= $this->render($entry['type'], $entry); |
|
135 | - } |
|
136 | - return $rendered; |
|
137 | - } |
|
124 | + /** |
|
125 | + * Returns a rendered string of all saved custom translations with translation context. |
|
126 | + * @return string |
|
127 | + */ |
|
128 | + public function renderAll() |
|
129 | + { |
|
130 | + $rendered = ''; |
|
131 | + foreach ($this->all() as $index => $entry) { |
|
132 | + $entry['index'] = $index; |
|
133 | + $entry['prefix'] = OptionManager::databaseKey(); |
|
134 | + $rendered.= $this->render($entry['type'], $entry); |
|
135 | + } |
|
136 | + return $rendered; |
|
137 | + } |
|
138 | 138 | |
139 | - /** |
|
140 | - * @param bool $resetAfterRender |
|
141 | - * @return string |
|
142 | - */ |
|
143 | - public function renderResults($resetAfterRender = true) |
|
144 | - { |
|
145 | - $rendered = ''; |
|
146 | - foreach ($this->results as $id => $entry) { |
|
147 | - $data = [ |
|
148 | - 'desc' => $this->getEntryString($entry, 'msgctxt'), |
|
149 | - 'id' => $id, |
|
150 | - 'p1' => $this->getEntryString($entry, 'msgid_plural'), |
|
151 | - 's1' => $this->getEntryString($entry, 'msgid'), |
|
152 | - ]; |
|
153 | - $text = !empty($data['p1']) |
|
154 | - ? sprintf('%s | %s', $data['s1'], $data['p1']) |
|
155 | - : $data['s1']; |
|
156 | - $rendered.= $this->render('result', [ |
|
157 | - 'entry' => json_encode($data, JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), |
|
158 | - 'text' => wp_strip_all_tags($text), |
|
159 | - ]); |
|
160 | - } |
|
161 | - if ($resetAfterRender) { |
|
162 | - $this->reset(); |
|
163 | - } |
|
164 | - return $rendered; |
|
165 | - } |
|
139 | + /** |
|
140 | + * @param bool $resetAfterRender |
|
141 | + * @return string |
|
142 | + */ |
|
143 | + public function renderResults($resetAfterRender = true) |
|
144 | + { |
|
145 | + $rendered = ''; |
|
146 | + foreach ($this->results as $id => $entry) { |
|
147 | + $data = [ |
|
148 | + 'desc' => $this->getEntryString($entry, 'msgctxt'), |
|
149 | + 'id' => $id, |
|
150 | + 'p1' => $this->getEntryString($entry, 'msgid_plural'), |
|
151 | + 's1' => $this->getEntryString($entry, 'msgid'), |
|
152 | + ]; |
|
153 | + $text = !empty($data['p1']) |
|
154 | + ? sprintf('%s | %s', $data['s1'], $data['p1']) |
|
155 | + : $data['s1']; |
|
156 | + $rendered.= $this->render('result', [ |
|
157 | + 'entry' => json_encode($data, JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), |
|
158 | + 'text' => wp_strip_all_tags($text), |
|
159 | + ]); |
|
160 | + } |
|
161 | + if ($resetAfterRender) { |
|
162 | + $this->reset(); |
|
163 | + } |
|
164 | + return $rendered; |
|
165 | + } |
|
166 | 166 | |
167 | - /** |
|
168 | - * @return void |
|
169 | - */ |
|
170 | - public function reset() |
|
171 | - { |
|
172 | - $this->results = []; |
|
173 | - } |
|
167 | + /** |
|
168 | + * @return void |
|
169 | + */ |
|
170 | + public function reset() |
|
171 | + { |
|
172 | + $this->results = []; |
|
173 | + } |
|
174 | 174 | |
175 | - /** |
|
176 | - * @return array |
|
177 | - */ |
|
178 | - public function results() |
|
179 | - { |
|
180 | - $results = $this->results; |
|
181 | - $this->reset(); |
|
182 | - return $results; |
|
183 | - } |
|
175 | + /** |
|
176 | + * @return array |
|
177 | + */ |
|
178 | + public function results() |
|
179 | + { |
|
180 | + $results = $this->results; |
|
181 | + $this->reset(); |
|
182 | + return $results; |
|
183 | + } |
|
184 | 184 | |
185 | - /** |
|
186 | - * @param string $needle |
|
187 | - * @return static |
|
188 | - */ |
|
189 | - public function search($needle = '') |
|
190 | - { |
|
191 | - $this->reset(); |
|
192 | - $needle = trim(strtolower($needle)); |
|
193 | - foreach ($this->entries() as $key => $entry) { |
|
194 | - $single = strtolower($this->getEntryString($entry, 'msgid')); |
|
195 | - $plural = strtolower($this->getEntryString($entry, 'msgid_plural')); |
|
196 | - if (strlen($needle) < static::SEARCH_THRESHOLD) { |
|
197 | - if (in_array($needle, [$single, $plural])) { |
|
198 | - $this->results[$key] = $entry; |
|
199 | - } |
|
200 | - } elseif (Str::contains(sprintf('%s %s', $single, $plural), $needle)) { |
|
201 | - $this->results[$key] = $entry; |
|
202 | - } |
|
203 | - } |
|
204 | - return $this; |
|
205 | - } |
|
185 | + /** |
|
186 | + * @param string $needle |
|
187 | + * @return static |
|
188 | + */ |
|
189 | + public function search($needle = '') |
|
190 | + { |
|
191 | + $this->reset(); |
|
192 | + $needle = trim(strtolower($needle)); |
|
193 | + foreach ($this->entries() as $key => $entry) { |
|
194 | + $single = strtolower($this->getEntryString($entry, 'msgid')); |
|
195 | + $plural = strtolower($this->getEntryString($entry, 'msgid_plural')); |
|
196 | + if (strlen($needle) < static::SEARCH_THRESHOLD) { |
|
197 | + if (in_array($needle, [$single, $plural])) { |
|
198 | + $this->results[$key] = $entry; |
|
199 | + } |
|
200 | + } elseif (Str::contains(sprintf('%s %s', $single, $plural), $needle)) { |
|
201 | + $this->results[$key] = $entry; |
|
202 | + } |
|
203 | + } |
|
204 | + return $this; |
|
205 | + } |
|
206 | 206 | |
207 | - /** |
|
208 | - * Store the translations to avoid unnecessary loops. |
|
209 | - * @return array |
|
210 | - */ |
|
211 | - public function translations() |
|
212 | - { |
|
213 | - static $translations; |
|
214 | - if (empty($translations)) { |
|
215 | - $settings = glsr(OptionManager::class)->get('settings'); |
|
216 | - $translations = isset($settings['strings']) |
|
217 | - ? $this->normalizeSettings((array) $settings['strings']) |
|
218 | - : []; |
|
219 | - } |
|
220 | - return $translations; |
|
221 | - } |
|
207 | + /** |
|
208 | + * Store the translations to avoid unnecessary loops. |
|
209 | + * @return array |
|
210 | + */ |
|
211 | + public function translations() |
|
212 | + { |
|
213 | + static $translations; |
|
214 | + if (empty($translations)) { |
|
215 | + $settings = glsr(OptionManager::class)->get('settings'); |
|
216 | + $translations = isset($settings['strings']) |
|
217 | + ? $this->normalizeSettings((array) $settings['strings']) |
|
218 | + : []; |
|
219 | + } |
|
220 | + return $translations; |
|
221 | + } |
|
222 | 222 | |
223 | - /** |
|
224 | - * @param string $key |
|
225 | - * @return string |
|
226 | - */ |
|
227 | - protected function getEntryString(array $entry, $key) |
|
228 | - { |
|
229 | - return isset($entry[$key]) |
|
230 | - ? implode('', (array) $entry[$key]) |
|
231 | - : ''; |
|
232 | - } |
|
223 | + /** |
|
224 | + * @param string $key |
|
225 | + * @return string |
|
226 | + */ |
|
227 | + protected function getEntryString(array $entry, $key) |
|
228 | + { |
|
229 | + return isset($entry[$key]) |
|
230 | + ? implode('', (array) $entry[$key]) |
|
231 | + : ''; |
|
232 | + } |
|
233 | 233 | |
234 | - /** |
|
235 | - * @return array |
|
236 | - */ |
|
237 | - protected function normalize(array $entries) |
|
238 | - { |
|
239 | - $keys = [ |
|
240 | - 'msgctxt', 'msgid', 'msgid_plural', 'msgstr', 'msgstr[0]', 'msgstr[1]', |
|
241 | - ]; |
|
242 | - array_walk($entries, function (&$entry) use ($keys) { |
|
243 | - foreach ($keys as $key) { |
|
244 | - try { |
|
245 | - $entry = $this->normalizeEntryString($entry, $key); |
|
246 | - } catch (\TypeError $error) { |
|
247 | - glsr_log()->once('error', 'Translation/normalize', $error); |
|
248 | - glsr_log()->once('debug', 'Translation/normalize', $entry); |
|
249 | - } |
|
250 | - } |
|
251 | - }); |
|
252 | - return $entries; |
|
253 | - } |
|
234 | + /** |
|
235 | + * @return array |
|
236 | + */ |
|
237 | + protected function normalize(array $entries) |
|
238 | + { |
|
239 | + $keys = [ |
|
240 | + 'msgctxt', 'msgid', 'msgid_plural', 'msgstr', 'msgstr[0]', 'msgstr[1]', |
|
241 | + ]; |
|
242 | + array_walk($entries, function (&$entry) use ($keys) { |
|
243 | + foreach ($keys as $key) { |
|
244 | + try { |
|
245 | + $entry = $this->normalizeEntryString($entry, $key); |
|
246 | + } catch (\TypeError $error) { |
|
247 | + glsr_log()->once('error', 'Translation/normalize', $error); |
|
248 | + glsr_log()->once('debug', 'Translation/normalize', $entry); |
|
249 | + } |
|
250 | + } |
|
251 | + }); |
|
252 | + return $entries; |
|
253 | + } |
|
254 | 254 | |
255 | - /** |
|
256 | - * @param string $key |
|
257 | - * @return array |
|
258 | - */ |
|
259 | - protected function normalizeEntryString(array $entry, $key) |
|
260 | - { |
|
261 | - if (isset($entry[$key])) { |
|
262 | - $entry[$key] = $this->getEntryString($entry, $key); |
|
263 | - } |
|
264 | - return $entry; |
|
265 | - } |
|
255 | + /** |
|
256 | + * @param string $key |
|
257 | + * @return array |
|
258 | + */ |
|
259 | + protected function normalizeEntryString(array $entry, $key) |
|
260 | + { |
|
261 | + if (isset($entry[$key])) { |
|
262 | + $entry[$key] = $this->getEntryString($entry, $key); |
|
263 | + } |
|
264 | + return $entry; |
|
265 | + } |
|
266 | 266 | |
267 | - /** |
|
268 | - * @return array |
|
269 | - */ |
|
270 | - protected function normalizeSettings(array $strings) |
|
271 | - { |
|
272 | - $defaultString = array_fill_keys(['id', 's1', 's2', 'p1', 'p2'], ''); |
|
273 | - $strings = array_filter($strings, 'is_array'); |
|
274 | - foreach ($strings as &$string) { |
|
275 | - $string['type'] = isset($string['p1']) ? 'plural' : 'single'; |
|
276 | - $string = wp_parse_args($string, $defaultString); |
|
277 | - } |
|
278 | - return array_filter($strings, function ($string) { |
|
279 | - return !empty($string['id']); |
|
280 | - }); |
|
281 | - } |
|
267 | + /** |
|
268 | + * @return array |
|
269 | + */ |
|
270 | + protected function normalizeSettings(array $strings) |
|
271 | + { |
|
272 | + $defaultString = array_fill_keys(['id', 's1', 's2', 'p1', 'p2'], ''); |
|
273 | + $strings = array_filter($strings, 'is_array'); |
|
274 | + foreach ($strings as &$string) { |
|
275 | + $string['type'] = isset($string['p1']) ? 'plural' : 'single'; |
|
276 | + $string = wp_parse_args($string, $defaultString); |
|
277 | + } |
|
278 | + return array_filter($strings, function ($string) { |
|
279 | + return !empty($string['id']); |
|
280 | + }); |
|
281 | + } |
|
282 | 282 | } |
@@ -12,302 +12,302 @@ |
||
12 | 12 | */ |
13 | 13 | class Validator |
14 | 14 | { |
15 | - use ValidationRules; |
|
15 | + use ValidationRules; |
|
16 | 16 | |
17 | - /** |
|
18 | - * @var array |
|
19 | - */ |
|
20 | - public $errors = []; |
|
17 | + /** |
|
18 | + * @var array |
|
19 | + */ |
|
20 | + public $errors = []; |
|
21 | 21 | |
22 | - /** |
|
23 | - * The data under validation. |
|
24 | - * @var array |
|
25 | - */ |
|
26 | - protected $data = []; |
|
22 | + /** |
|
23 | + * The data under validation. |
|
24 | + * @var array |
|
25 | + */ |
|
26 | + protected $data = []; |
|
27 | 27 | |
28 | - /** |
|
29 | - * The failed validation rules. |
|
30 | - * @var array |
|
31 | - */ |
|
32 | - protected $failedRules = []; |
|
28 | + /** |
|
29 | + * The failed validation rules. |
|
30 | + * @var array |
|
31 | + */ |
|
32 | + protected $failedRules = []; |
|
33 | 33 | |
34 | - /** |
|
35 | - * The rules to be applied to the data. |
|
36 | - * @var array |
|
37 | - */ |
|
38 | - protected $rules = []; |
|
34 | + /** |
|
35 | + * The rules to be applied to the data. |
|
36 | + * @var array |
|
37 | + */ |
|
38 | + protected $rules = []; |
|
39 | 39 | |
40 | - /** |
|
41 | - * The size related validation rules. |
|
42 | - * @var array |
|
43 | - */ |
|
44 | - protected $sizeRules = [ |
|
45 | - 'Between', 'Max', 'Min', |
|
46 | - ]; |
|
40 | + /** |
|
41 | + * The size related validation rules. |
|
42 | + * @var array |
|
43 | + */ |
|
44 | + protected $sizeRules = [ |
|
45 | + 'Between', 'Max', 'Min', |
|
46 | + ]; |
|
47 | 47 | |
48 | - /** |
|
49 | - * The validation rules that imply the field is required. |
|
50 | - * @var array |
|
51 | - */ |
|
52 | - protected $implicitRules = [ |
|
53 | - 'Required', |
|
54 | - ]; |
|
48 | + /** |
|
49 | + * The validation rules that imply the field is required. |
|
50 | + * @var array |
|
51 | + */ |
|
52 | + protected $implicitRules = [ |
|
53 | + 'Required', |
|
54 | + ]; |
|
55 | 55 | |
56 | - /** |
|
57 | - * The numeric related validation rules. |
|
58 | - * @var array |
|
59 | - */ |
|
60 | - protected $numericRules = [ |
|
61 | - 'Number', |
|
62 | - ]; |
|
56 | + /** |
|
57 | + * The numeric related validation rules. |
|
58 | + * @var array |
|
59 | + */ |
|
60 | + protected $numericRules = [ |
|
61 | + 'Number', |
|
62 | + ]; |
|
63 | 63 | |
64 | - /** |
|
65 | - * Run the validator's rules against its data. |
|
66 | - * @param mixed $data |
|
67 | - * @return array |
|
68 | - */ |
|
69 | - public function validate($data, array $rules = []) |
|
70 | - { |
|
71 | - $this->normalizeData($data); |
|
72 | - $this->setRules($rules); |
|
73 | - foreach ($this->rules as $attribute => $rules) { |
|
74 | - foreach ($rules as $rule) { |
|
75 | - $this->validateAttribute($attribute, $rule); |
|
76 | - if ($this->shouldStopValidating($attribute)) { |
|
77 | - break; |
|
78 | - } |
|
79 | - } |
|
80 | - } |
|
81 | - return $this->errors; |
|
82 | - } |
|
64 | + /** |
|
65 | + * Run the validator's rules against its data. |
|
66 | + * @param mixed $data |
|
67 | + * @return array |
|
68 | + */ |
|
69 | + public function validate($data, array $rules = []) |
|
70 | + { |
|
71 | + $this->normalizeData($data); |
|
72 | + $this->setRules($rules); |
|
73 | + foreach ($this->rules as $attribute => $rules) { |
|
74 | + foreach ($rules as $rule) { |
|
75 | + $this->validateAttribute($attribute, $rule); |
|
76 | + if ($this->shouldStopValidating($attribute)) { |
|
77 | + break; |
|
78 | + } |
|
79 | + } |
|
80 | + } |
|
81 | + return $this->errors; |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * Validate a given attribute against a rule. |
|
86 | - * @param string $attribute |
|
87 | - * @param string $rule |
|
88 | - * @return void |
|
89 | - * @throws BadMethodCallException |
|
90 | - */ |
|
91 | - public function validateAttribute($attribute, $rule) |
|
92 | - { |
|
93 | - list($rule, $parameters) = $this->parseRule($rule); |
|
94 | - if ('' == $rule) { |
|
95 | - return; |
|
96 | - } |
|
97 | - $value = $this->getValue($attribute); |
|
98 | - if (!method_exists($this, $method = 'validate'.$rule)) { |
|
99 | - throw new BadMethodCallException("Method [$method] does not exist."); |
|
100 | - } |
|
101 | - if (!$this->$method($value, $attribute, $parameters)) { |
|
102 | - $this->addFailure($attribute, $rule, $parameters); |
|
103 | - } |
|
104 | - } |
|
84 | + /** |
|
85 | + * Validate a given attribute against a rule. |
|
86 | + * @param string $attribute |
|
87 | + * @param string $rule |
|
88 | + * @return void |
|
89 | + * @throws BadMethodCallException |
|
90 | + */ |
|
91 | + public function validateAttribute($attribute, $rule) |
|
92 | + { |
|
93 | + list($rule, $parameters) = $this->parseRule($rule); |
|
94 | + if ('' == $rule) { |
|
95 | + return; |
|
96 | + } |
|
97 | + $value = $this->getValue($attribute); |
|
98 | + if (!method_exists($this, $method = 'validate'.$rule)) { |
|
99 | + throw new BadMethodCallException("Method [$method] does not exist."); |
|
100 | + } |
|
101 | + if (!$this->$method($value, $attribute, $parameters)) { |
|
102 | + $this->addFailure($attribute, $rule, $parameters); |
|
103 | + } |
|
104 | + } |
|
105 | 105 | |
106 | - /** |
|
107 | - * Add an error message to the validator's collection of errors. |
|
108 | - * @param string $attribute |
|
109 | - * @param string $rule |
|
110 | - * @return void |
|
111 | - */ |
|
112 | - protected function addError($attribute, $rule, array $parameters) |
|
113 | - { |
|
114 | - $message = $this->getMessage($attribute, $rule, $parameters); |
|
115 | - $this->errors[$attribute][] = $message; |
|
116 | - } |
|
106 | + /** |
|
107 | + * Add an error message to the validator's collection of errors. |
|
108 | + * @param string $attribute |
|
109 | + * @param string $rule |
|
110 | + * @return void |
|
111 | + */ |
|
112 | + protected function addError($attribute, $rule, array $parameters) |
|
113 | + { |
|
114 | + $message = $this->getMessage($attribute, $rule, $parameters); |
|
115 | + $this->errors[$attribute][] = $message; |
|
116 | + } |
|
117 | 117 | |
118 | - /** |
|
119 | - * Add a failed rule and error message to the collection. |
|
120 | - * @param string $attribute |
|
121 | - * @param string $rule |
|
122 | - * @return void |
|
123 | - */ |
|
124 | - protected function addFailure($attribute, $rule, array $parameters) |
|
125 | - { |
|
126 | - $this->addError($attribute, $rule, $parameters); |
|
127 | - $this->failedRules[$attribute][$rule] = $parameters; |
|
128 | - } |
|
118 | + /** |
|
119 | + * Add a failed rule and error message to the collection. |
|
120 | + * @param string $attribute |
|
121 | + * @param string $rule |
|
122 | + * @return void |
|
123 | + */ |
|
124 | + protected function addFailure($attribute, $rule, array $parameters) |
|
125 | + { |
|
126 | + $this->addError($attribute, $rule, $parameters); |
|
127 | + $this->failedRules[$attribute][$rule] = $parameters; |
|
128 | + } |
|
129 | 129 | |
130 | - /** |
|
131 | - * Get the data type of the given attribute. |
|
132 | - * @param string $attribute |
|
133 | - * @return string |
|
134 | - */ |
|
135 | - protected function getAttributeType($attribute) |
|
136 | - { |
|
137 | - return !$this->hasRule($attribute, $this->numericRules) |
|
138 | - ? 'length' |
|
139 | - : ''; |
|
140 | - } |
|
130 | + /** |
|
131 | + * Get the data type of the given attribute. |
|
132 | + * @param string $attribute |
|
133 | + * @return string |
|
134 | + */ |
|
135 | + protected function getAttributeType($attribute) |
|
136 | + { |
|
137 | + return !$this->hasRule($attribute, $this->numericRules) |
|
138 | + ? 'length' |
|
139 | + : ''; |
|
140 | + } |
|
141 | 141 | |
142 | - /** |
|
143 | - * Get the validation message for an attribute and rule. |
|
144 | - * @param string $attribute |
|
145 | - * @param string $rule |
|
146 | - * @return string|null |
|
147 | - */ |
|
148 | - protected function getMessage($attribute, $rule, array $parameters) |
|
149 | - { |
|
150 | - if (in_array($rule, $this->sizeRules)) { |
|
151 | - return $this->getSizeMessage($attribute, $rule, $parameters); |
|
152 | - } |
|
153 | - $lowerRule = Str::snakeCase($rule); |
|
154 | - return $this->translator($lowerRule, $parameters); |
|
155 | - } |
|
142 | + /** |
|
143 | + * Get the validation message for an attribute and rule. |
|
144 | + * @param string $attribute |
|
145 | + * @param string $rule |
|
146 | + * @return string|null |
|
147 | + */ |
|
148 | + protected function getMessage($attribute, $rule, array $parameters) |
|
149 | + { |
|
150 | + if (in_array($rule, $this->sizeRules)) { |
|
151 | + return $this->getSizeMessage($attribute, $rule, $parameters); |
|
152 | + } |
|
153 | + $lowerRule = Str::snakeCase($rule); |
|
154 | + return $this->translator($lowerRule, $parameters); |
|
155 | + } |
|
156 | 156 | |
157 | - /** |
|
158 | - * Get a rule and its parameters for a given attribute. |
|
159 | - * @param string $attribute |
|
160 | - * @param string|array $rules |
|
161 | - * @return array|null |
|
162 | - */ |
|
163 | - protected function getRule($attribute, $rules) |
|
164 | - { |
|
165 | - if (!array_key_exists($attribute, $this->rules)) { |
|
166 | - return; |
|
167 | - } |
|
168 | - $rules = (array) $rules; |
|
169 | - foreach ($this->rules[$attribute] as $rule) { |
|
170 | - list($rule, $parameters) = $this->parseRule($rule); |
|
171 | - if (in_array($rule, $rules)) { |
|
172 | - return [$rule, $parameters]; |
|
173 | - } |
|
174 | - } |
|
175 | - } |
|
157 | + /** |
|
158 | + * Get a rule and its parameters for a given attribute. |
|
159 | + * @param string $attribute |
|
160 | + * @param string|array $rules |
|
161 | + * @return array|null |
|
162 | + */ |
|
163 | + protected function getRule($attribute, $rules) |
|
164 | + { |
|
165 | + if (!array_key_exists($attribute, $this->rules)) { |
|
166 | + return; |
|
167 | + } |
|
168 | + $rules = (array) $rules; |
|
169 | + foreach ($this->rules[$attribute] as $rule) { |
|
170 | + list($rule, $parameters) = $this->parseRule($rule); |
|
171 | + if (in_array($rule, $rules)) { |
|
172 | + return [$rule, $parameters]; |
|
173 | + } |
|
174 | + } |
|
175 | + } |
|
176 | 176 | |
177 | - /** |
|
178 | - * Get the size of an attribute. |
|
179 | - * @param string $attribute |
|
180 | - * @param mixed $value |
|
181 | - * @return mixed |
|
182 | - */ |
|
183 | - protected function getSize($attribute, $value) |
|
184 | - { |
|
185 | - $hasNumeric = $this->hasRule($attribute, $this->numericRules); |
|
186 | - if (is_numeric($value) && $hasNumeric) { |
|
187 | - return $value; |
|
188 | - } elseif (is_array($value)) { |
|
189 | - return count($value); |
|
190 | - } |
|
191 | - return function_exists('mb_strlen') |
|
192 | - ? mb_strlen($value) |
|
193 | - : strlen($value); |
|
194 | - } |
|
177 | + /** |
|
178 | + * Get the size of an attribute. |
|
179 | + * @param string $attribute |
|
180 | + * @param mixed $value |
|
181 | + * @return mixed |
|
182 | + */ |
|
183 | + protected function getSize($attribute, $value) |
|
184 | + { |
|
185 | + $hasNumeric = $this->hasRule($attribute, $this->numericRules); |
|
186 | + if (is_numeric($value) && $hasNumeric) { |
|
187 | + return $value; |
|
188 | + } elseif (is_array($value)) { |
|
189 | + return count($value); |
|
190 | + } |
|
191 | + return function_exists('mb_strlen') |
|
192 | + ? mb_strlen($value) |
|
193 | + : strlen($value); |
|
194 | + } |
|
195 | 195 | |
196 | - /** |
|
197 | - * Get the proper error message for an attribute and size rule. |
|
198 | - * @param string $attribute |
|
199 | - * @param string $rule |
|
200 | - * @return string|null |
|
201 | - */ |
|
202 | - protected function getSizeMessage($attribute, $rule, array $parameters) |
|
203 | - { |
|
204 | - $type = $this->getAttributeType($attribute); |
|
205 | - $lowerRule = Str::snakeCase($rule.$type); |
|
206 | - return $this->translator($lowerRule, $parameters); |
|
207 | - } |
|
196 | + /** |
|
197 | + * Get the proper error message for an attribute and size rule. |
|
198 | + * @param string $attribute |
|
199 | + * @param string $rule |
|
200 | + * @return string|null |
|
201 | + */ |
|
202 | + protected function getSizeMessage($attribute, $rule, array $parameters) |
|
203 | + { |
|
204 | + $type = $this->getAttributeType($attribute); |
|
205 | + $lowerRule = Str::snakeCase($rule.$type); |
|
206 | + return $this->translator($lowerRule, $parameters); |
|
207 | + } |
|
208 | 208 | |
209 | - /** |
|
210 | - * Get the value of a given attribute. |
|
211 | - * @param string $attribute |
|
212 | - * @return mixed |
|
213 | - */ |
|
214 | - protected function getValue($attribute) |
|
215 | - { |
|
216 | - if (isset($this->data[$attribute])) { |
|
217 | - return $this->data[$attribute]; |
|
218 | - } |
|
219 | - } |
|
209 | + /** |
|
210 | + * Get the value of a given attribute. |
|
211 | + * @param string $attribute |
|
212 | + * @return mixed |
|
213 | + */ |
|
214 | + protected function getValue($attribute) |
|
215 | + { |
|
216 | + if (isset($this->data[$attribute])) { |
|
217 | + return $this->data[$attribute]; |
|
218 | + } |
|
219 | + } |
|
220 | 220 | |
221 | - /** |
|
222 | - * Determine if the given attribute has a rule in the given set. |
|
223 | - * @param string $attribute |
|
224 | - * @param string|array $rules |
|
225 | - * @return bool |
|
226 | - */ |
|
227 | - protected function hasRule($attribute, $rules) |
|
228 | - { |
|
229 | - return !is_null($this->getRule($attribute, $rules)); |
|
230 | - } |
|
221 | + /** |
|
222 | + * Determine if the given attribute has a rule in the given set. |
|
223 | + * @param string $attribute |
|
224 | + * @param string|array $rules |
|
225 | + * @return bool |
|
226 | + */ |
|
227 | + protected function hasRule($attribute, $rules) |
|
228 | + { |
|
229 | + return !is_null($this->getRule($attribute, $rules)); |
|
230 | + } |
|
231 | 231 | |
232 | - /** |
|
233 | - * Normalize the provided data to an array. |
|
234 | - * @param mixed $data |
|
235 | - * @return void |
|
236 | - */ |
|
237 | - protected function normalizeData($data) |
|
238 | - { |
|
239 | - $this->data = is_object($data) |
|
240 | - ? get_object_vars($data) |
|
241 | - : $data; |
|
242 | - } |
|
232 | + /** |
|
233 | + * Normalize the provided data to an array. |
|
234 | + * @param mixed $data |
|
235 | + * @return void |
|
236 | + */ |
|
237 | + protected function normalizeData($data) |
|
238 | + { |
|
239 | + $this->data = is_object($data) |
|
240 | + ? get_object_vars($data) |
|
241 | + : $data; |
|
242 | + } |
|
243 | 243 | |
244 | - /** |
|
245 | - * Parse a parameter list. |
|
246 | - * @param string $rule |
|
247 | - * @param string $parameter |
|
248 | - * @return array |
|
249 | - */ |
|
250 | - protected function parseParameters($rule, $parameter) |
|
251 | - { |
|
252 | - return 'regex' == strtolower($rule) |
|
253 | - ? [$parameter] |
|
254 | - : str_getcsv($parameter); |
|
255 | - } |
|
244 | + /** |
|
245 | + * Parse a parameter list. |
|
246 | + * @param string $rule |
|
247 | + * @param string $parameter |
|
248 | + * @return array |
|
249 | + */ |
|
250 | + protected function parseParameters($rule, $parameter) |
|
251 | + { |
|
252 | + return 'regex' == strtolower($rule) |
|
253 | + ? [$parameter] |
|
254 | + : str_getcsv($parameter); |
|
255 | + } |
|
256 | 256 | |
257 | - /** |
|
258 | - * Extract the rule name and parameters from a rule. |
|
259 | - * @param string $rule |
|
260 | - * @return array |
|
261 | - */ |
|
262 | - protected function parseRule($rule) |
|
263 | - { |
|
264 | - $parameters = []; |
|
265 | - if (Str::contains($rule, ':')) { |
|
266 | - list($rule, $parameter) = explode(':', $rule, 2); |
|
267 | - $parameters = $this->parseParameters($rule, $parameter); |
|
268 | - } |
|
269 | - $rule = Str::camelCase($rule); |
|
270 | - return [$rule, $parameters]; |
|
271 | - } |
|
257 | + /** |
|
258 | + * Extract the rule name and parameters from a rule. |
|
259 | + * @param string $rule |
|
260 | + * @return array |
|
261 | + */ |
|
262 | + protected function parseRule($rule) |
|
263 | + { |
|
264 | + $parameters = []; |
|
265 | + if (Str::contains($rule, ':')) { |
|
266 | + list($rule, $parameter) = explode(':', $rule, 2); |
|
267 | + $parameters = $this->parseParameters($rule, $parameter); |
|
268 | + } |
|
269 | + $rule = Str::camelCase($rule); |
|
270 | + return [$rule, $parameters]; |
|
271 | + } |
|
272 | 272 | |
273 | - /** |
|
274 | - * Set the validation rules. |
|
275 | - * @return void |
|
276 | - */ |
|
277 | - protected function setRules(array $rules) |
|
278 | - { |
|
279 | - foreach ($rules as $key => $rule) { |
|
280 | - $rules[$key] = is_string($rule) |
|
281 | - ? explode('|', $rule) |
|
282 | - : $rule; |
|
283 | - } |
|
284 | - $this->rules = $rules; |
|
285 | - } |
|
273 | + /** |
|
274 | + * Set the validation rules. |
|
275 | + * @return void |
|
276 | + */ |
|
277 | + protected function setRules(array $rules) |
|
278 | + { |
|
279 | + foreach ($rules as $key => $rule) { |
|
280 | + $rules[$key] = is_string($rule) |
|
281 | + ? explode('|', $rule) |
|
282 | + : $rule; |
|
283 | + } |
|
284 | + $this->rules = $rules; |
|
285 | + } |
|
286 | 286 | |
287 | - /** |
|
288 | - * Check if we should stop further validations on a given attribute. |
|
289 | - * @param string $attribute |
|
290 | - * @return bool |
|
291 | - */ |
|
292 | - protected function shouldStopValidating($attribute) |
|
293 | - { |
|
294 | - return $this->hasRule($attribute, $this->implicitRules) |
|
295 | - && isset($this->failedRules[$attribute]) |
|
296 | - && array_intersect(array_keys($this->failedRules[$attribute]), $this->implicitRules); |
|
297 | - } |
|
287 | + /** |
|
288 | + * Check if we should stop further validations on a given attribute. |
|
289 | + * @param string $attribute |
|
290 | + * @return bool |
|
291 | + */ |
|
292 | + protected function shouldStopValidating($attribute) |
|
293 | + { |
|
294 | + return $this->hasRule($attribute, $this->implicitRules) |
|
295 | + && isset($this->failedRules[$attribute]) |
|
296 | + && array_intersect(array_keys($this->failedRules[$attribute]), $this->implicitRules); |
|
297 | + } |
|
298 | 298 | |
299 | - /** |
|
300 | - * Returns a translated message for the attribute. |
|
301 | - * @param string $key |
|
302 | - * @param string $attribute |
|
303 | - * @return void|string |
|
304 | - */ |
|
305 | - protected function translator($key, array $parameters) |
|
306 | - { |
|
307 | - $strings = glsr(ValidationStringsDefaults::class)->defaults(); |
|
308 | - if (isset($strings[$key])) { |
|
309 | - return $this->replace($strings[$key], $parameters); |
|
310 | - } |
|
311 | - return 'error'; |
|
312 | - } |
|
299 | + /** |
|
300 | + * Returns a translated message for the attribute. |
|
301 | + * @param string $key |
|
302 | + * @param string $attribute |
|
303 | + * @return void|string |
|
304 | + */ |
|
305 | + protected function translator($key, array $parameters) |
|
306 | + { |
|
307 | + $strings = glsr(ValidationStringsDefaults::class)->defaults(); |
|
308 | + if (isset($strings[$key])) { |
|
309 | + return $this->replace($strings[$key], $parameters); |
|
310 | + } |
|
311 | + return 'error'; |
|
312 | + } |
|
313 | 313 | } |
@@ -6,97 +6,97 @@ |
||
6 | 6 | |
7 | 7 | class Translator |
8 | 8 | { |
9 | - /** |
|
10 | - * @param string $original |
|
11 | - * @param string $domain |
|
12 | - * @return string |
|
13 | - */ |
|
14 | - public function translate($original, $domain, array $args) |
|
15 | - { |
|
16 | - $domains = apply_filters('site-reviews/translator/domains', [Application::ID]); |
|
17 | - if (!in_array($domain, $domains)) { |
|
18 | - return $original; |
|
19 | - } |
|
20 | - $args = $this->normalizeTranslationArgs($args); |
|
21 | - $strings = $this->getTranslationStrings($args['single'], $args['plural']); |
|
22 | - if (empty($strings)) { |
|
23 | - return $original; |
|
24 | - } |
|
25 | - $string = current($strings); |
|
26 | - return 'plural' == $string['type'] |
|
27 | - ? $this->translatePlural($domain, $string, $args) |
|
28 | - : $this->translateSingle($domain, $string, $args); |
|
29 | - } |
|
9 | + /** |
|
10 | + * @param string $original |
|
11 | + * @param string $domain |
|
12 | + * @return string |
|
13 | + */ |
|
14 | + public function translate($original, $domain, array $args) |
|
15 | + { |
|
16 | + $domains = apply_filters('site-reviews/translator/domains', [Application::ID]); |
|
17 | + if (!in_array($domain, $domains)) { |
|
18 | + return $original; |
|
19 | + } |
|
20 | + $args = $this->normalizeTranslationArgs($args); |
|
21 | + $strings = $this->getTranslationStrings($args['single'], $args['plural']); |
|
22 | + if (empty($strings)) { |
|
23 | + return $original; |
|
24 | + } |
|
25 | + $string = current($strings); |
|
26 | + return 'plural' == $string['type'] |
|
27 | + ? $this->translatePlural($domain, $string, $args) |
|
28 | + : $this->translateSingle($domain, $string, $args); |
|
29 | + } |
|
30 | 30 | |
31 | - /** |
|
32 | - * Used when search/replacing a default text-domain translation |
|
33 | - * @return string |
|
34 | - */ |
|
35 | - public function getTranslation(array $args) |
|
36 | - { |
|
37 | - $args = $this->normalizeTranslationArgs($args); |
|
38 | - return get_translations_for_domain(Application::ID)->translate_plural($args['single'], $args['plural'], $args['number']); |
|
39 | - } |
|
31 | + /** |
|
32 | + * Used when search/replacing a default text-domain translation |
|
33 | + * @return string |
|
34 | + */ |
|
35 | + public function getTranslation(array $args) |
|
36 | + { |
|
37 | + $args = $this->normalizeTranslationArgs($args); |
|
38 | + return get_translations_for_domain(Application::ID)->translate_plural($args['single'], $args['plural'], $args['number']); |
|
39 | + } |
|
40 | 40 | |
41 | - /** |
|
42 | - * @param string $single |
|
43 | - * @param string $plural |
|
44 | - * @return array |
|
45 | - */ |
|
46 | - protected function getTranslationStrings($single, $plural) |
|
47 | - { |
|
48 | - return array_filter(glsr(Translation::class)->translations(), function ($string) use ($single, $plural) { |
|
49 | - return $string['s1'] == html_entity_decode($single, ENT_COMPAT, 'UTF-8') |
|
50 | - && $string['p1'] == html_entity_decode($plural, ENT_COMPAT, 'UTF-8'); |
|
51 | - }); |
|
52 | - } |
|
41 | + /** |
|
42 | + * @param string $single |
|
43 | + * @param string $plural |
|
44 | + * @return array |
|
45 | + */ |
|
46 | + protected function getTranslationStrings($single, $plural) |
|
47 | + { |
|
48 | + return array_filter(glsr(Translation::class)->translations(), function ($string) use ($single, $plural) { |
|
49 | + return $string['s1'] == html_entity_decode($single, ENT_COMPAT, 'UTF-8') |
|
50 | + && $string['p1'] == html_entity_decode($plural, ENT_COMPAT, 'UTF-8'); |
|
51 | + }); |
|
52 | + } |
|
53 | 53 | |
54 | - /** |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - protected function normalizeTranslationArgs(array $args) |
|
58 | - { |
|
59 | - $defaults = [ |
|
60 | - 'context' => '', |
|
61 | - 'number' => 1, |
|
62 | - 'plural' => '', |
|
63 | - 'single' => '', |
|
64 | - ]; |
|
65 | - return shortcode_atts($defaults, $args); |
|
66 | - } |
|
54 | + /** |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + protected function normalizeTranslationArgs(array $args) |
|
58 | + { |
|
59 | + $defaults = [ |
|
60 | + 'context' => '', |
|
61 | + 'number' => 1, |
|
62 | + 'plural' => '', |
|
63 | + 'single' => '', |
|
64 | + ]; |
|
65 | + return shortcode_atts($defaults, $args); |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * @param string $domain |
|
70 | - * @return string |
|
71 | - */ |
|
72 | - protected function translatePlural($domain, array $string, array $args) |
|
73 | - { |
|
74 | - if (!empty($string['s2'])) { |
|
75 | - $args['single'] = $string['s2']; |
|
76 | - } |
|
77 | - if (!empty($string['p2'])) { |
|
78 | - $args['plural'] = $string['p2']; |
|
79 | - } |
|
80 | - return get_translations_for_domain($domain)->translate_plural( |
|
81 | - $args['single'], |
|
82 | - $args['plural'], |
|
83 | - $args['number'], |
|
84 | - $args['context'] |
|
85 | - ); |
|
86 | - } |
|
68 | + /** |
|
69 | + * @param string $domain |
|
70 | + * @return string |
|
71 | + */ |
|
72 | + protected function translatePlural($domain, array $string, array $args) |
|
73 | + { |
|
74 | + if (!empty($string['s2'])) { |
|
75 | + $args['single'] = $string['s2']; |
|
76 | + } |
|
77 | + if (!empty($string['p2'])) { |
|
78 | + $args['plural'] = $string['p2']; |
|
79 | + } |
|
80 | + return get_translations_for_domain($domain)->translate_plural( |
|
81 | + $args['single'], |
|
82 | + $args['plural'], |
|
83 | + $args['number'], |
|
84 | + $args['context'] |
|
85 | + ); |
|
86 | + } |
|
87 | 87 | |
88 | - /** |
|
89 | - * @param string $domain |
|
90 | - * @return string |
|
91 | - */ |
|
92 | - protected function translateSingle($domain, array $string, array $args) |
|
93 | - { |
|
94 | - if (!empty($string['s2'])) { |
|
95 | - $args['single'] = $string['s2']; |
|
96 | - } |
|
97 | - return get_translations_for_domain($domain)->translate( |
|
98 | - $args['single'], |
|
99 | - $args['context'] |
|
100 | - ); |
|
101 | - } |
|
88 | + /** |
|
89 | + * @param string $domain |
|
90 | + * @return string |
|
91 | + */ |
|
92 | + protected function translateSingle($domain, array $string, array $args) |
|
93 | + { |
|
94 | + if (!empty($string['s2'])) { |
|
95 | + $args['single'] = $string['s2']; |
|
96 | + } |
|
97 | + return get_translations_for_domain($domain)->translate( |
|
98 | + $args['single'], |
|
99 | + $args['context'] |
|
100 | + ); |
|
101 | + } |
|
102 | 102 | } |
@@ -10,228 +10,228 @@ |
||
10 | 10 | |
11 | 11 | class TranslationController |
12 | 12 | { |
13 | - /** |
|
14 | - * @var Translator |
|
15 | - */ |
|
16 | - public $translator; |
|
17 | - |
|
18 | - public function __construct(Translator $translator) |
|
19 | - { |
|
20 | - $this->translator = $translator; |
|
21 | - } |
|
22 | - |
|
23 | - /** |
|
24 | - * @param array $messages |
|
25 | - * @return array |
|
26 | - * @filter bulk_post_updated_messages |
|
27 | - */ |
|
28 | - public function filterBulkUpdateMessages($messages, array $counts) |
|
29 | - { |
|
30 | - $messages = Arr::consolidateArray($messages); |
|
31 | - $messages[Application::POST_TYPE] = [ |
|
32 | - 'updated' => _n('%s review updated.', '%s reviews updated.', $counts['updated'], 'site-reviews'), |
|
33 | - 'locked' => _n('%s review not updated, somebody is editing it.', '%s reviews not updated, somebody is editing them.', $counts['locked'], 'site-reviews'), |
|
34 | - 'deleted' => _n('%s review permanently deleted.', '%s reviews permanently deleted.', $counts['deleted'], 'site-reviews'), |
|
35 | - 'trashed' => _n('%s review moved to the Trash.', '%s reviews moved to the Trash.', $counts['trashed'], 'site-reviews'), |
|
36 | - 'untrashed' => _n('%s review restored from the Trash.', '%s reviews restored from the Trash.', $counts['untrashed'], 'site-reviews'), |
|
37 | - ]; |
|
38 | - return $messages; |
|
39 | - } |
|
40 | - |
|
41 | - /** |
|
42 | - * @param string $translation |
|
43 | - * @param string $text |
|
44 | - * @param string $domain |
|
45 | - * @return string |
|
46 | - * @filter gettext |
|
47 | - */ |
|
48 | - public function filterGettext($translation, $text, $domain) |
|
49 | - { |
|
50 | - return apply_filters('site-reviews/gettext/'.$domain, $translation, $text); |
|
51 | - } |
|
52 | - |
|
53 | - /** |
|
54 | - * @param string $translation |
|
55 | - * @param string $text |
|
56 | - * @return string |
|
57 | - * @filter site-reviews/gettext/site-reviews |
|
58 | - */ |
|
59 | - public function filterGettextSiteReviews($translation, $text) |
|
60 | - { |
|
61 | - return $this->translator->translate($translation, Application::ID, [ |
|
62 | - 'single' => $text, |
|
63 | - ]); |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * @param string $translation |
|
68 | - * @param string $text |
|
69 | - * @param string $context |
|
70 | - * @param string $domain |
|
71 | - * @return string |
|
72 | - * @filter gettext_with_context |
|
73 | - */ |
|
74 | - public function filterGettextWithContext($translation, $text, $context, $domain) |
|
75 | - { |
|
76 | - return apply_filters('site-reviews/gettext_with_context/'.$domain, $translation, $text, $context); |
|
77 | - } |
|
78 | - |
|
79 | - /** |
|
80 | - * @param string $translation |
|
81 | - * @param string $text |
|
82 | - * @param string $context |
|
83 | - * @return string |
|
84 | - * @filter site-reviews/gettext_with_context/site-reviews |
|
85 | - */ |
|
86 | - public function filterGettextWithContextSiteReviews($translation, $text, $context) |
|
87 | - { |
|
88 | - return $this->translator->translate($translation, Application::ID, [ |
|
89 | - 'context' => $context, |
|
90 | - 'single' => $text, |
|
91 | - ]); |
|
92 | - } |
|
93 | - |
|
94 | - /** |
|
95 | - * @param string $translation |
|
96 | - * @param string $single |
|
97 | - * @param string $plural |
|
98 | - * @param int $number |
|
99 | - * @param string $domain |
|
100 | - * @return string |
|
101 | - * @filter ngettext |
|
102 | - */ |
|
103 | - public function filterNgettext($translation, $single, $plural, $number, $domain) |
|
104 | - { |
|
105 | - return apply_filters('site-reviews/ngettext/'.$domain, $translation, $single, $plural, $number); |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * @param string $translation |
|
110 | - * @param string $single |
|
111 | - * @param string $plural |
|
112 | - * @param int $number |
|
113 | - * @return string |
|
114 | - * @filter site-reviews/ngettext/site-reviews |
|
115 | - */ |
|
116 | - public function filterNgettextSiteReviews($translation, $single, $plural, $number) |
|
117 | - { |
|
118 | - return $this->translator->translate($translation, Application::ID, [ |
|
119 | - 'number' => $number, |
|
120 | - 'plural' => $plural, |
|
121 | - 'single' => $single, |
|
122 | - ]); |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * @param string $translation |
|
127 | - * @param string $single |
|
128 | - * @param string $plural |
|
129 | - * @param int $number |
|
130 | - * @param string $context |
|
131 | - * @param string $domain |
|
132 | - * @return string |
|
133 | - * @filter ngettext_with_context |
|
134 | - */ |
|
135 | - public function filterNgettextWithContext($translation, $single, $plural, $number, $context, $domain) |
|
136 | - { |
|
137 | - return apply_filters('site-reviews/ngettext_with_context/'.$domain, $translation, $single, $plural, $number, $context); |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * @param string $translation |
|
142 | - * @param string $single |
|
143 | - * @param string $plural |
|
144 | - * @param int $number |
|
145 | - * @param string $context |
|
146 | - * @return string |
|
147 | - * @filter site-reviews/ngettext_with_context/site-reviews |
|
148 | - */ |
|
149 | - public function filterNgettextWithContextSiteReviews($translation, $single, $plural, $number, $context) |
|
150 | - { |
|
151 | - return $this->translator->translate($translation, Application::ID, [ |
|
152 | - 'context' => $context, |
|
153 | - 'number' => $number, |
|
154 | - 'plural' => $plural, |
|
155 | - 'single' => $single, |
|
156 | - ]); |
|
157 | - } |
|
158 | - |
|
159 | - /** |
|
160 | - * @param array $postStates |
|
161 | - * @param \WP_Post $post |
|
162 | - * @return array |
|
163 | - * @filter display_post_states |
|
164 | - */ |
|
165 | - public function filterPostStates($postStates, $post) |
|
166 | - { |
|
167 | - $postStates = Arr::consolidateArray($postStates); |
|
168 | - if (Application::POST_TYPE == Arr::get($post, 'post_type') && array_key_exists('pending', $postStates)) { |
|
169 | - $postStates['pending'] = __('Unapproved', 'site-reviews'); |
|
170 | - } |
|
171 | - return $postStates; |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * @param string $translation |
|
176 | - * @param string $text |
|
177 | - * @return string |
|
178 | - * @filter site-reviews/gettext/default |
|
179 | - * @filter site-reviews/gettext_with_context/default |
|
180 | - */ |
|
181 | - public function filterPostStatusLabels($translation, $text) |
|
182 | - { |
|
183 | - return $this->canModifyTranslation() |
|
184 | - ? glsr(Labels::class)->filterPostStatusLabels($translation, $text) |
|
185 | - : $translation; |
|
186 | - } |
|
187 | - |
|
188 | - /** |
|
189 | - * @param string $translation |
|
190 | - * @param string $single |
|
191 | - * @param string $plural |
|
192 | - * @param int $number |
|
193 | - * @return string |
|
194 | - * @filter site-reviews/ngettext/default |
|
195 | - */ |
|
196 | - public function filterPostStatusText($translation, $single, $plural, $number) |
|
197 | - { |
|
198 | - if ($this->canModifyTranslation()) { |
|
199 | - $strings = [ |
|
200 | - 'Published' => __('Approved', 'site-reviews'), |
|
201 | - 'Pending' => __('Unapproved', 'site-reviews'), |
|
202 | - ]; |
|
203 | - foreach ($strings as $search => $replace) { |
|
204 | - if (!Str::contains($single, $search)) { |
|
205 | - continue; |
|
206 | - } |
|
207 | - return $this->translator->getTranslation([ |
|
208 | - 'number' => $number, |
|
209 | - 'plural' => str_replace($search, $replace, $plural), |
|
210 | - 'single' => str_replace($search, $replace, $single), |
|
211 | - ]); |
|
212 | - } |
|
213 | - } |
|
214 | - return $translation; |
|
215 | - } |
|
216 | - |
|
217 | - /** |
|
218 | - * @return void |
|
219 | - * @action admin_enqueue_scripts |
|
220 | - */ |
|
221 | - public function translatePostStatusLabels() |
|
222 | - { |
|
223 | - if ($this->canModifyTranslation()) { |
|
224 | - glsr(Labels::class)->translatePostStatusLabels(); |
|
225 | - } |
|
226 | - } |
|
227 | - |
|
228 | - /** |
|
229 | - * @return bool |
|
230 | - */ |
|
231 | - protected function canModifyTranslation() |
|
232 | - { |
|
233 | - $screen = glsr_current_screen(); |
|
234 | - return Application::POST_TYPE == $screen->post_type |
|
235 | - && in_array($screen->base, ['edit', 'post']); |
|
236 | - } |
|
13 | + /** |
|
14 | + * @var Translator |
|
15 | + */ |
|
16 | + public $translator; |
|
17 | + |
|
18 | + public function __construct(Translator $translator) |
|
19 | + { |
|
20 | + $this->translator = $translator; |
|
21 | + } |
|
22 | + |
|
23 | + /** |
|
24 | + * @param array $messages |
|
25 | + * @return array |
|
26 | + * @filter bulk_post_updated_messages |
|
27 | + */ |
|
28 | + public function filterBulkUpdateMessages($messages, array $counts) |
|
29 | + { |
|
30 | + $messages = Arr::consolidateArray($messages); |
|
31 | + $messages[Application::POST_TYPE] = [ |
|
32 | + 'updated' => _n('%s review updated.', '%s reviews updated.', $counts['updated'], 'site-reviews'), |
|
33 | + 'locked' => _n('%s review not updated, somebody is editing it.', '%s reviews not updated, somebody is editing them.', $counts['locked'], 'site-reviews'), |
|
34 | + 'deleted' => _n('%s review permanently deleted.', '%s reviews permanently deleted.', $counts['deleted'], 'site-reviews'), |
|
35 | + 'trashed' => _n('%s review moved to the Trash.', '%s reviews moved to the Trash.', $counts['trashed'], 'site-reviews'), |
|
36 | + 'untrashed' => _n('%s review restored from the Trash.', '%s reviews restored from the Trash.', $counts['untrashed'], 'site-reviews'), |
|
37 | + ]; |
|
38 | + return $messages; |
|
39 | + } |
|
40 | + |
|
41 | + /** |
|
42 | + * @param string $translation |
|
43 | + * @param string $text |
|
44 | + * @param string $domain |
|
45 | + * @return string |
|
46 | + * @filter gettext |
|
47 | + */ |
|
48 | + public function filterGettext($translation, $text, $domain) |
|
49 | + { |
|
50 | + return apply_filters('site-reviews/gettext/'.$domain, $translation, $text); |
|
51 | + } |
|
52 | + |
|
53 | + /** |
|
54 | + * @param string $translation |
|
55 | + * @param string $text |
|
56 | + * @return string |
|
57 | + * @filter site-reviews/gettext/site-reviews |
|
58 | + */ |
|
59 | + public function filterGettextSiteReviews($translation, $text) |
|
60 | + { |
|
61 | + return $this->translator->translate($translation, Application::ID, [ |
|
62 | + 'single' => $text, |
|
63 | + ]); |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * @param string $translation |
|
68 | + * @param string $text |
|
69 | + * @param string $context |
|
70 | + * @param string $domain |
|
71 | + * @return string |
|
72 | + * @filter gettext_with_context |
|
73 | + */ |
|
74 | + public function filterGettextWithContext($translation, $text, $context, $domain) |
|
75 | + { |
|
76 | + return apply_filters('site-reviews/gettext_with_context/'.$domain, $translation, $text, $context); |
|
77 | + } |
|
78 | + |
|
79 | + /** |
|
80 | + * @param string $translation |
|
81 | + * @param string $text |
|
82 | + * @param string $context |
|
83 | + * @return string |
|
84 | + * @filter site-reviews/gettext_with_context/site-reviews |
|
85 | + */ |
|
86 | + public function filterGettextWithContextSiteReviews($translation, $text, $context) |
|
87 | + { |
|
88 | + return $this->translator->translate($translation, Application::ID, [ |
|
89 | + 'context' => $context, |
|
90 | + 'single' => $text, |
|
91 | + ]); |
|
92 | + } |
|
93 | + |
|
94 | + /** |
|
95 | + * @param string $translation |
|
96 | + * @param string $single |
|
97 | + * @param string $plural |
|
98 | + * @param int $number |
|
99 | + * @param string $domain |
|
100 | + * @return string |
|
101 | + * @filter ngettext |
|
102 | + */ |
|
103 | + public function filterNgettext($translation, $single, $plural, $number, $domain) |
|
104 | + { |
|
105 | + return apply_filters('site-reviews/ngettext/'.$domain, $translation, $single, $plural, $number); |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * @param string $translation |
|
110 | + * @param string $single |
|
111 | + * @param string $plural |
|
112 | + * @param int $number |
|
113 | + * @return string |
|
114 | + * @filter site-reviews/ngettext/site-reviews |
|
115 | + */ |
|
116 | + public function filterNgettextSiteReviews($translation, $single, $plural, $number) |
|
117 | + { |
|
118 | + return $this->translator->translate($translation, Application::ID, [ |
|
119 | + 'number' => $number, |
|
120 | + 'plural' => $plural, |
|
121 | + 'single' => $single, |
|
122 | + ]); |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * @param string $translation |
|
127 | + * @param string $single |
|
128 | + * @param string $plural |
|
129 | + * @param int $number |
|
130 | + * @param string $context |
|
131 | + * @param string $domain |
|
132 | + * @return string |
|
133 | + * @filter ngettext_with_context |
|
134 | + */ |
|
135 | + public function filterNgettextWithContext($translation, $single, $plural, $number, $context, $domain) |
|
136 | + { |
|
137 | + return apply_filters('site-reviews/ngettext_with_context/'.$domain, $translation, $single, $plural, $number, $context); |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * @param string $translation |
|
142 | + * @param string $single |
|
143 | + * @param string $plural |
|
144 | + * @param int $number |
|
145 | + * @param string $context |
|
146 | + * @return string |
|
147 | + * @filter site-reviews/ngettext_with_context/site-reviews |
|
148 | + */ |
|
149 | + public function filterNgettextWithContextSiteReviews($translation, $single, $plural, $number, $context) |
|
150 | + { |
|
151 | + return $this->translator->translate($translation, Application::ID, [ |
|
152 | + 'context' => $context, |
|
153 | + 'number' => $number, |
|
154 | + 'plural' => $plural, |
|
155 | + 'single' => $single, |
|
156 | + ]); |
|
157 | + } |
|
158 | + |
|
159 | + /** |
|
160 | + * @param array $postStates |
|
161 | + * @param \WP_Post $post |
|
162 | + * @return array |
|
163 | + * @filter display_post_states |
|
164 | + */ |
|
165 | + public function filterPostStates($postStates, $post) |
|
166 | + { |
|
167 | + $postStates = Arr::consolidateArray($postStates); |
|
168 | + if (Application::POST_TYPE == Arr::get($post, 'post_type') && array_key_exists('pending', $postStates)) { |
|
169 | + $postStates['pending'] = __('Unapproved', 'site-reviews'); |
|
170 | + } |
|
171 | + return $postStates; |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * @param string $translation |
|
176 | + * @param string $text |
|
177 | + * @return string |
|
178 | + * @filter site-reviews/gettext/default |
|
179 | + * @filter site-reviews/gettext_with_context/default |
|
180 | + */ |
|
181 | + public function filterPostStatusLabels($translation, $text) |
|
182 | + { |
|
183 | + return $this->canModifyTranslation() |
|
184 | + ? glsr(Labels::class)->filterPostStatusLabels($translation, $text) |
|
185 | + : $translation; |
|
186 | + } |
|
187 | + |
|
188 | + /** |
|
189 | + * @param string $translation |
|
190 | + * @param string $single |
|
191 | + * @param string $plural |
|
192 | + * @param int $number |
|
193 | + * @return string |
|
194 | + * @filter site-reviews/ngettext/default |
|
195 | + */ |
|
196 | + public function filterPostStatusText($translation, $single, $plural, $number) |
|
197 | + { |
|
198 | + if ($this->canModifyTranslation()) { |
|
199 | + $strings = [ |
|
200 | + 'Published' => __('Approved', 'site-reviews'), |
|
201 | + 'Pending' => __('Unapproved', 'site-reviews'), |
|
202 | + ]; |
|
203 | + foreach ($strings as $search => $replace) { |
|
204 | + if (!Str::contains($single, $search)) { |
|
205 | + continue; |
|
206 | + } |
|
207 | + return $this->translator->getTranslation([ |
|
208 | + 'number' => $number, |
|
209 | + 'plural' => str_replace($search, $replace, $plural), |
|
210 | + 'single' => str_replace($search, $replace, $single), |
|
211 | + ]); |
|
212 | + } |
|
213 | + } |
|
214 | + return $translation; |
|
215 | + } |
|
216 | + |
|
217 | + /** |
|
218 | + * @return void |
|
219 | + * @action admin_enqueue_scripts |
|
220 | + */ |
|
221 | + public function translatePostStatusLabels() |
|
222 | + { |
|
223 | + if ($this->canModifyTranslation()) { |
|
224 | + glsr(Labels::class)->translatePostStatusLabels(); |
|
225 | + } |
|
226 | + } |
|
227 | + |
|
228 | + /** |
|
229 | + * @return bool |
|
230 | + */ |
|
231 | + protected function canModifyTranslation() |
|
232 | + { |
|
233 | + $screen = glsr_current_screen(); |
|
234 | + return Application::POST_TYPE == $screen->post_type |
|
235 | + && in_array($screen->base, ['edit', 'post']); |
|
236 | + } |
|
237 | 237 | } |
@@ -13,81 +13,81 @@ |
||
13 | 13 | |
14 | 14 | class PublicController extends Controller |
15 | 15 | { |
16 | - /** |
|
17 | - * @return void |
|
18 | - * @action wp_enqueue_scripts |
|
19 | - */ |
|
20 | - public function enqueueAssets() |
|
21 | - { |
|
22 | - (new EnqueuePublicAssets())->handle(); |
|
23 | - } |
|
16 | + /** |
|
17 | + * @return void |
|
18 | + * @action wp_enqueue_scripts |
|
19 | + */ |
|
20 | + public function enqueueAssets() |
|
21 | + { |
|
22 | + (new EnqueuePublicAssets())->handle(); |
|
23 | + } |
|
24 | 24 | |
25 | - /** |
|
26 | - * @param string $tag |
|
27 | - * @param string $handle |
|
28 | - * @return string |
|
29 | - * @filter script_loader_tag |
|
30 | - */ |
|
31 | - public function filterEnqueuedScripts($tag, $handle) |
|
32 | - { |
|
33 | - $scripts = [Application::ID.'/google-recaptcha']; |
|
34 | - if (in_array($handle, apply_filters('site-reviews/async-scripts', $scripts))) { |
|
35 | - $tag = str_replace(' src=', ' async src=', $tag); |
|
36 | - } |
|
37 | - if (in_array($handle, apply_filters('site-reviews/defer-scripts', $scripts))) { |
|
38 | - $tag = str_replace(' src=', ' defer src=', $tag); |
|
39 | - } |
|
40 | - return $tag; |
|
41 | - } |
|
25 | + /** |
|
26 | + * @param string $tag |
|
27 | + * @param string $handle |
|
28 | + * @return string |
|
29 | + * @filter script_loader_tag |
|
30 | + */ |
|
31 | + public function filterEnqueuedScripts($tag, $handle) |
|
32 | + { |
|
33 | + $scripts = [Application::ID.'/google-recaptcha']; |
|
34 | + if (in_array($handle, apply_filters('site-reviews/async-scripts', $scripts))) { |
|
35 | + $tag = str_replace(' src=', ' async src=', $tag); |
|
36 | + } |
|
37 | + if (in_array($handle, apply_filters('site-reviews/defer-scripts', $scripts))) { |
|
38 | + $tag = str_replace(' src=', ' defer src=', $tag); |
|
39 | + } |
|
40 | + return $tag; |
|
41 | + } |
|
42 | 42 | |
43 | - /** |
|
44 | - * @return array |
|
45 | - * @filter site-reviews/config/forms/submission-form |
|
46 | - */ |
|
47 | - public function filterFieldOrder(array $config) |
|
48 | - { |
|
49 | - $order = (array) apply_filters('site-reviews/submission-form/order', array_keys($config)); |
|
50 | - return array_intersect_key(array_merge(array_flip($order), $config), $config); |
|
51 | - } |
|
43 | + /** |
|
44 | + * @return array |
|
45 | + * @filter site-reviews/config/forms/submission-form |
|
46 | + */ |
|
47 | + public function filterFieldOrder(array $config) |
|
48 | + { |
|
49 | + $order = (array) apply_filters('site-reviews/submission-form/order', array_keys($config)); |
|
50 | + return array_intersect_key(array_merge(array_flip($order), $config), $config); |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * @param string $view |
|
55 | - * @return string |
|
56 | - * @filter site-reviews/render/view |
|
57 | - */ |
|
58 | - public function filterRenderView($view) |
|
59 | - { |
|
60 | - return glsr(Style::class)->filterView($view); |
|
61 | - } |
|
53 | + /** |
|
54 | + * @param string $view |
|
55 | + * @return string |
|
56 | + * @filter site-reviews/render/view |
|
57 | + */ |
|
58 | + public function filterRenderView($view) |
|
59 | + { |
|
60 | + return glsr(Style::class)->filterView($view); |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return void |
|
65 | - * @action site-reviews/builder |
|
66 | - */ |
|
67 | - public function modifyBuilder(Builder $instance) |
|
68 | - { |
|
69 | - call_user_func_array([glsr(Style::class), 'modifyField'], [$instance]); |
|
70 | - } |
|
63 | + /** |
|
64 | + * @return void |
|
65 | + * @action site-reviews/builder |
|
66 | + */ |
|
67 | + public function modifyBuilder(Builder $instance) |
|
68 | + { |
|
69 | + call_user_func_array([glsr(Style::class), 'modifyField'], [$instance]); |
|
70 | + } |
|
71 | 71 | |
72 | - /** |
|
73 | - * @return void |
|
74 | - * @action wp_footer |
|
75 | - */ |
|
76 | - public function renderSchema() |
|
77 | - { |
|
78 | - glsr(Schema::class)->render(); |
|
79 | - } |
|
72 | + /** |
|
73 | + * @return void |
|
74 | + * @action wp_footer |
|
75 | + */ |
|
76 | + public function renderSchema() |
|
77 | + { |
|
78 | + glsr(Schema::class)->render(); |
|
79 | + } |
|
80 | 80 | |
81 | - /** |
|
82 | - * @return CreateReview |
|
83 | - */ |
|
84 | - public function routerSubmitReview(array $request) |
|
85 | - { |
|
86 | - $validated = glsr(ValidateReview::class)->validate($request); |
|
87 | - $command = new CreateReview($validated->request); |
|
88 | - if (empty($validated->error) && !$validated->recaptchaIsUnset) { |
|
89 | - $this->execute($command); |
|
90 | - } |
|
91 | - return $command; |
|
92 | - } |
|
81 | + /** |
|
82 | + * @return CreateReview |
|
83 | + */ |
|
84 | + public function routerSubmitReview(array $request) |
|
85 | + { |
|
86 | + $validated = glsr(ValidateReview::class)->validate($request); |
|
87 | + $command = new CreateReview($validated->request); |
|
88 | + if (empty($validated->error) && !$validated->recaptchaIsUnset) { |
|
89 | + $this->execute($command); |
|
90 | + } |
|
91 | + return $command; |
|
92 | + } |
|
93 | 93 | } |
@@ -6,63 +6,63 @@ |
||
6 | 6 | |
7 | 7 | class Cache |
8 | 8 | { |
9 | - /** |
|
10 | - * @return array |
|
11 | - */ |
|
12 | - public function getCloudflareIps() |
|
13 | - { |
|
14 | - if (false === ($ipAddresses = get_transient(Application::ID.'_cloudflare_ips'))) { |
|
15 | - $ipAddresses = array_fill_keys(['v4', 'v6'], []); |
|
16 | - foreach (array_keys($ipAddresses) as $version) { |
|
17 | - $url = 'https://www.cloudflare.com/ips-'.$version; |
|
18 | - $response = wp_remote_get($url, ['sslverify' => false]); |
|
19 | - if (is_wp_error($response)) { |
|
20 | - glsr_log()->error($response->get_error_message()); |
|
21 | - continue; |
|
22 | - } |
|
23 | - if ('200' != ($statusCode = wp_remote_retrieve_response_code($response))) { |
|
24 | - glsr_log()->error('Unable to connect to '.$url.' ['.$statusCode.']'); |
|
25 | - continue; |
|
26 | - } |
|
27 | - $ipAddresses[$version] = array_filter( |
|
28 | - (array) preg_split('/\R/', wp_remote_retrieve_body($response)) |
|
29 | - ); |
|
30 | - } |
|
31 | - set_transient(Application::ID.'_cloudflare_ips', $ipAddresses, WEEK_IN_SECONDS); |
|
32 | - } |
|
33 | - return $ipAddresses; |
|
34 | - } |
|
9 | + /** |
|
10 | + * @return array |
|
11 | + */ |
|
12 | + public function getCloudflareIps() |
|
13 | + { |
|
14 | + if (false === ($ipAddresses = get_transient(Application::ID.'_cloudflare_ips'))) { |
|
15 | + $ipAddresses = array_fill_keys(['v4', 'v6'], []); |
|
16 | + foreach (array_keys($ipAddresses) as $version) { |
|
17 | + $url = 'https://www.cloudflare.com/ips-'.$version; |
|
18 | + $response = wp_remote_get($url, ['sslverify' => false]); |
|
19 | + if (is_wp_error($response)) { |
|
20 | + glsr_log()->error($response->get_error_message()); |
|
21 | + continue; |
|
22 | + } |
|
23 | + if ('200' != ($statusCode = wp_remote_retrieve_response_code($response))) { |
|
24 | + glsr_log()->error('Unable to connect to '.$url.' ['.$statusCode.']'); |
|
25 | + continue; |
|
26 | + } |
|
27 | + $ipAddresses[$version] = array_filter( |
|
28 | + (array) preg_split('/\R/', wp_remote_retrieve_body($response)) |
|
29 | + ); |
|
30 | + } |
|
31 | + set_transient(Application::ID.'_cloudflare_ips', $ipAddresses, WEEK_IN_SECONDS); |
|
32 | + } |
|
33 | + return $ipAddresses; |
|
34 | + } |
|
35 | 35 | |
36 | - /** |
|
37 | - * @param string $metaKey |
|
38 | - * @return array |
|
39 | - */ |
|
40 | - public function getReviewCountsFor($metaKey) |
|
41 | - { |
|
42 | - $counts = wp_cache_get(Application::ID, $metaKey.'_count'); |
|
43 | - if (false === $counts) { |
|
44 | - $counts = []; |
|
45 | - $results = glsr(SqlQueries::class)->getReviewCountsFor($metaKey); |
|
46 | - foreach ($results as $result) { |
|
47 | - $counts[$result->name] = $result->num_posts; |
|
48 | - } |
|
49 | - wp_cache_set(Application::ID, $counts, $metaKey.'_count'); |
|
50 | - } |
|
51 | - return $counts; |
|
52 | - } |
|
36 | + /** |
|
37 | + * @param string $metaKey |
|
38 | + * @return array |
|
39 | + */ |
|
40 | + public function getReviewCountsFor($metaKey) |
|
41 | + { |
|
42 | + $counts = wp_cache_get(Application::ID, $metaKey.'_count'); |
|
43 | + if (false === $counts) { |
|
44 | + $counts = []; |
|
45 | + $results = glsr(SqlQueries::class)->getReviewCountsFor($metaKey); |
|
46 | + foreach ($results as $result) { |
|
47 | + $counts[$result->name] = $result->num_posts; |
|
48 | + } |
|
49 | + wp_cache_set(Application::ID, $counts, $metaKey.'_count'); |
|
50 | + } |
|
51 | + return $counts; |
|
52 | + } |
|
53 | 53 | |
54 | - /** |
|
55 | - * @return string |
|
56 | - */ |
|
57 | - public function getRemotePostTest() |
|
58 | - { |
|
59 | - if (false === ($test = get_transient(Application::ID.'_remote_post_test'))) { |
|
60 | - $response = wp_remote_post('https://api.wordpress.org/stats/php/1.0/'); |
|
61 | - $test = !is_wp_error($response) && in_array($response['response']['code'], range(200, 299)) |
|
62 | - ? 'Works' |
|
63 | - : 'Does not work'; |
|
64 | - set_transient(Application::ID.'_remote_post_test', $test, WEEK_IN_SECONDS); |
|
65 | - } |
|
66 | - return $test; |
|
67 | - } |
|
54 | + /** |
|
55 | + * @return string |
|
56 | + */ |
|
57 | + public function getRemotePostTest() |
|
58 | + { |
|
59 | + if (false === ($test = get_transient(Application::ID.'_remote_post_test'))) { |
|
60 | + $response = wp_remote_post('https://api.wordpress.org/stats/php/1.0/'); |
|
61 | + $test = !is_wp_error($response) && in_array($response['response']['code'], range(200, 299)) |
|
62 | + ? 'Works' |
|
63 | + : 'Does not work'; |
|
64 | + set_transient(Application::ID.'_remote_post_test', $test, WEEK_IN_SECONDS); |
|
65 | + } |
|
66 | + return $test; |
|
67 | + } |
|
68 | 68 | } |
@@ -6,41 +6,41 @@ |
||
6 | 6 | |
7 | 7 | class CreateReviewDefaults extends Defaults |
8 | 8 | { |
9 | - /** |
|
10 | - * @var array |
|
11 | - */ |
|
12 | - protected $guarded = [ |
|
13 | - 'assigned_to', |
|
14 | - 'content', |
|
15 | - 'date', |
|
16 | - 'pinned', |
|
17 | - 'response', |
|
18 | - 'review_id', |
|
19 | - 'review_type', |
|
20 | - 'title', |
|
21 | - ]; |
|
9 | + /** |
|
10 | + * @var array |
|
11 | + */ |
|
12 | + protected $guarded = [ |
|
13 | + 'assigned_to', |
|
14 | + 'content', |
|
15 | + 'date', |
|
16 | + 'pinned', |
|
17 | + 'response', |
|
18 | + 'review_id', |
|
19 | + 'review_type', |
|
20 | + 'title', |
|
21 | + ]; |
|
22 | 22 | |
23 | - /** |
|
24 | - * @return array |
|
25 | - */ |
|
26 | - protected function defaults() |
|
27 | - { |
|
28 | - return [ |
|
29 | - 'assigned_to' => '', |
|
30 | - 'author' => '', |
|
31 | - 'avatar' => '', |
|
32 | - 'content' => '', |
|
33 | - 'custom' => '', |
|
34 | - 'date' => '', |
|
35 | - 'email' => '', |
|
36 | - 'ip_address' => '', |
|
37 | - 'pinned' => false, |
|
38 | - 'rating' => '', |
|
39 | - 'response' => '', |
|
40 | - 'review_id' => md5(time().mt_rand()), |
|
41 | - 'review_type' => 'local', |
|
42 | - 'title' => '', |
|
43 | - 'url' => '', |
|
44 | - ]; |
|
45 | - } |
|
23 | + /** |
|
24 | + * @return array |
|
25 | + */ |
|
26 | + protected function defaults() |
|
27 | + { |
|
28 | + return [ |
|
29 | + 'assigned_to' => '', |
|
30 | + 'author' => '', |
|
31 | + 'avatar' => '', |
|
32 | + 'content' => '', |
|
33 | + 'custom' => '', |
|
34 | + 'date' => '', |
|
35 | + 'email' => '', |
|
36 | + 'ip_address' => '', |
|
37 | + 'pinned' => false, |
|
38 | + 'rating' => '', |
|
39 | + 'response' => '', |
|
40 | + 'review_id' => md5(time().mt_rand()), |
|
41 | + 'review_type' => 'local', |
|
42 | + 'title' => '', |
|
43 | + 'url' => '', |
|
44 | + ]; |
|
45 | + } |
|
46 | 46 | } |
@@ -6,22 +6,22 @@ |
||
6 | 6 | |
7 | 7 | class ValidateReviewDefaults extends Defaults |
8 | 8 | { |
9 | - /** |
|
10 | - * @return array |
|
11 | - */ |
|
12 | - protected function defaults() |
|
13 | - { |
|
14 | - return [ |
|
15 | - 'assign_to' => '', |
|
16 | - 'category' => '', |
|
17 | - 'content' => '', |
|
18 | - 'email' => '', |
|
19 | - 'form_id' => '', |
|
20 | - 'ip_address' => '', |
|
21 | - 'name' => '', |
|
22 | - 'rating' => '0', |
|
23 | - 'terms' => '', |
|
24 | - 'title' => '', |
|
25 | - ]; |
|
26 | - } |
|
9 | + /** |
|
10 | + * @return array |
|
11 | + */ |
|
12 | + protected function defaults() |
|
13 | + { |
|
14 | + return [ |
|
15 | + 'assign_to' => '', |
|
16 | + 'category' => '', |
|
17 | + 'content' => '', |
|
18 | + 'email' => '', |
|
19 | + 'form_id' => '', |
|
20 | + 'ip_address' => '', |
|
21 | + 'name' => '', |
|
22 | + 'rating' => '0', |
|
23 | + 'terms' => '', |
|
24 | + 'title' => '', |
|
25 | + ]; |
|
26 | + } |
|
27 | 27 | } |
@@ -10,437 +10,437 @@ |
||
10 | 10 | |
11 | 11 | class Console |
12 | 12 | { |
13 | - const DEBUG = 0; // Detailed debug information |
|
14 | - const INFO = 1; // Interesting events |
|
15 | - const NOTICE = 2; // Normal but significant events |
|
16 | - const WARNING = 4; // Exceptional occurrences that are not errors |
|
17 | - const ERROR = 8; // Runtime errors that do not require immediate action |
|
18 | - const CRITICAL = 16; // Critical conditions |
|
19 | - const ALERT = 32; // Action must be taken immediately |
|
20 | - const EMERGENCY = 64; // System is unusable |
|
21 | - |
|
22 | - protected $file; |
|
23 | - protected $log; |
|
24 | - protected $logOnceKey = 'glsr_log_once'; |
|
25 | - |
|
26 | - public function __construct() |
|
27 | - { |
|
28 | - $this->file = glsr()->path('console.log'); |
|
29 | - $this->log = file_exists($this->file) |
|
30 | - ? file_get_contents($this->file) |
|
31 | - : ''; |
|
32 | - $this->reset(); |
|
33 | - } |
|
34 | - |
|
35 | - /** |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public function __toString() |
|
39 | - { |
|
40 | - return $this->get(); |
|
41 | - } |
|
42 | - |
|
43 | - /** |
|
44 | - * Action must be taken immediately |
|
45 | - * Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up. |
|
46 | - * @param mixed $message |
|
47 | - * @param array $context |
|
48 | - * @return static |
|
49 | - */ |
|
50 | - public function alert($message, array $context = []) |
|
51 | - { |
|
52 | - return $this->log(static::ALERT, $message, $context); |
|
53 | - } |
|
54 | - |
|
55 | - /** |
|
56 | - * @return void |
|
57 | - */ |
|
58 | - public function clear() |
|
59 | - { |
|
60 | - $this->log = ''; |
|
61 | - file_put_contents($this->file, $this->log); |
|
62 | - } |
|
63 | - |
|
64 | - /** |
|
65 | - * Critical conditions |
|
66 | - * Example: Application component unavailable, unexpected exception. |
|
67 | - * @param mixed $message |
|
68 | - * @param array $context |
|
69 | - * @return static |
|
70 | - */ |
|
71 | - public function critical($message, array $context = []) |
|
72 | - { |
|
73 | - return $this->log(static::CRITICAL, $message, $context); |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Detailed debug information. |
|
78 | - * @param mixed $message |
|
79 | - * @param array $context |
|
80 | - * @return static |
|
81 | - */ |
|
82 | - public function debug($message, array $context = []) |
|
83 | - { |
|
84 | - return $this->log(static::DEBUG, $message, $context); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * System is unusable. |
|
89 | - * @param mixed $message |
|
90 | - * @param array $context |
|
91 | - * @return static |
|
92 | - */ |
|
93 | - public function emergency($message, array $context = []) |
|
94 | - { |
|
95 | - return $this->log(static::EMERGENCY, $message, $context); |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Runtime errors that do not require immediate action but should typically be logged and monitored. |
|
100 | - * @param mixed $message |
|
101 | - * @param array $context |
|
102 | - * @return static |
|
103 | - */ |
|
104 | - public function error($message, array $context = []) |
|
105 | - { |
|
106 | - return $this->log(static::ERROR, $message, $context); |
|
107 | - } |
|
108 | - |
|
109 | - /** |
|
110 | - * @return string |
|
111 | - */ |
|
112 | - public function get() |
|
113 | - { |
|
114 | - return empty($this->log) |
|
115 | - ? __('Console is empty', 'site-reviews') |
|
116 | - : $this->log; |
|
117 | - } |
|
118 | - |
|
119 | - /** |
|
120 | - * @return int |
|
121 | - */ |
|
122 | - public function getLevel() |
|
123 | - { |
|
124 | - return intval(apply_filters('site-reviews/console/level', static::INFO)); |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * @return array |
|
129 | - */ |
|
130 | - public function getLevels() |
|
131 | - { |
|
132 | - $constants = (new ReflectionClass(__CLASS__))->getConstants(); |
|
133 | - return array_map('strtolower', array_flip($constants)); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * @return string |
|
138 | - */ |
|
139 | - public function humanLevel() |
|
140 | - { |
|
141 | - $level = $this->getLevel(); |
|
142 | - return sprintf('%s (%d)', strtoupper(Arr::get($this->getLevels(), $level, 'unknown')), $level); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * @param string|null $valueIfEmpty |
|
147 | - * @return string |
|
148 | - */ |
|
149 | - public function humanSize($valueIfEmpty = null) |
|
150 | - { |
|
151 | - $bytes = $this->size(); |
|
152 | - if (empty($bytes) && is_string($valueIfEmpty)) { |
|
153 | - return $valueIfEmpty; |
|
154 | - } |
|
155 | - $exponent = floor(log(max($bytes, 1), 1024)); |
|
156 | - return round($bytes / pow(1024, $exponent), 2).' '.['bytes', 'KB', 'MB', 'GB'][$exponent]; |
|
157 | - } |
|
158 | - |
|
159 | - /** |
|
160 | - * Interesting events |
|
161 | - * Example: User logs in, SQL logs. |
|
162 | - * @param mixed $message |
|
163 | - * @param array $context |
|
164 | - * @return static |
|
165 | - */ |
|
166 | - public function info($message, array $context = []) |
|
167 | - { |
|
168 | - return $this->log(static::INFO, $message, $context); |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * @param int $level |
|
173 | - * @param mixed $message |
|
174 | - * @param array $context |
|
175 | - * @param string $backtraceLine |
|
176 | - * @return static |
|
177 | - */ |
|
178 | - public function log($level, $message, $context = [], $backtraceLine = '') |
|
179 | - { |
|
180 | - if (empty($backtraceLine)) { |
|
181 | - $backtraceLine = $this->getBacktraceLine(); |
|
182 | - } |
|
183 | - if ($this->canLogEntry($level, $backtraceLine)) { |
|
184 | - $levelName = Arr::get($this->getLevels(), $level); |
|
185 | - $context = Arr::consolidateArray($context); |
|
186 | - $backtraceLine = $this->normalizeBacktraceLine($backtraceLine); |
|
187 | - $message = $this->interpolate($message, $context); |
|
188 | - $entry = $this->buildLogEntry($levelName, $message, $backtraceLine); |
|
189 | - file_put_contents($this->file, $entry.PHP_EOL, FILE_APPEND | LOCK_EX); |
|
190 | - apply_filters('console', $message, $levelName, $backtraceLine); // Show in Blackbar plugin if installed |
|
191 | - $this->reset(); |
|
192 | - } |
|
193 | - return $this; |
|
194 | - } |
|
195 | - |
|
196 | - /** |
|
197 | - * @return void |
|
198 | - */ |
|
199 | - public function logOnce() |
|
200 | - { |
|
201 | - $once = Arr::consolidateArray(glsr()->{$this->logOnceKey}); |
|
202 | - $levels = $this->getLevels(); |
|
203 | - foreach ($once as $entry) { |
|
204 | - $levelName = Arr::get($entry, 'level'); |
|
205 | - if (!in_array($levelName, $levels)) { |
|
206 | - continue; |
|
207 | - } |
|
208 | - $level = Arr::get(array_flip($levels), $levelName); |
|
209 | - $message = Arr::get($entry, 'message'); |
|
210 | - $backtraceLine = Arr::get($entry, 'backtrace'); |
|
211 | - $this->log($level, $message, [], $backtraceLine); |
|
212 | - } |
|
213 | - glsr()->{$this->logOnceKey} = []; |
|
214 | - } |
|
215 | - |
|
216 | - /** |
|
217 | - * Normal but significant events. |
|
218 | - * @param mixed $message |
|
219 | - * @param array $context |
|
220 | - * @return static |
|
221 | - */ |
|
222 | - public function notice($message, array $context = []) |
|
223 | - { |
|
224 | - return $this->log(static::NOTICE, $message, $context); |
|
225 | - } |
|
226 | - |
|
227 | - /** |
|
228 | - * @param string $levelName |
|
229 | - * @param string $handle |
|
230 | - * @param mixed $data |
|
231 | - * @return void |
|
232 | - */ |
|
233 | - public function once($levelName, $handle, $data) |
|
234 | - { |
|
235 | - $once = Arr::consolidateArray(glsr()->{$this->logOnceKey}); |
|
236 | - $filtered = array_filter($once, function ($entry) use ($levelName, $handle) { |
|
237 | - return Arr::get($entry, 'level') == $levelName |
|
238 | - && Arr::get($entry, 'handle') == $handle; |
|
239 | - }); |
|
240 | - if (!empty($filtered)) { |
|
241 | - return; |
|
242 | - } |
|
243 | - $once[] = [ |
|
244 | - 'backtrace' => $this->getBacktraceLineFromData($data), |
|
245 | - 'handle' => $handle, |
|
246 | - 'level' => $levelName, |
|
247 | - 'message' => '[RECURRING] '.$this->getMessageFromData($data), |
|
248 | - ]; |
|
249 | - glsr()->{$this->logOnceKey} = $once; |
|
250 | - } |
|
251 | - |
|
252 | - /** |
|
253 | - * @return int |
|
254 | - */ |
|
255 | - public function size() |
|
256 | - { |
|
257 | - return file_exists($this->file) |
|
258 | - ? filesize($this->file) |
|
259 | - : 0; |
|
260 | - } |
|
261 | - |
|
262 | - /** |
|
263 | - * Exceptional occurrences that are not errors |
|
264 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong. |
|
265 | - * @param mixed $message |
|
266 | - * @param array $context |
|
267 | - * @return static |
|
268 | - */ |
|
269 | - public function warning($message, array $context = []) |
|
270 | - { |
|
271 | - return $this->log(static::WARNING, $message, $context); |
|
272 | - } |
|
273 | - |
|
274 | - /** |
|
275 | - * @param array $backtrace |
|
276 | - * @param int $index |
|
277 | - * @return string |
|
278 | - */ |
|
279 | - protected function buildBacktraceLine($backtrace, $index) |
|
280 | - { |
|
281 | - return sprintf('%s:%s', |
|
282 | - Arr::get($backtrace, $index.'.file'), // realpath |
|
283 | - Arr::get($backtrace, $index.'.line') |
|
284 | - ); |
|
285 | - } |
|
286 | - |
|
287 | - /** |
|
288 | - * @param string $levelName |
|
289 | - * @param mixed $message |
|
290 | - * @param string $backtraceLine |
|
291 | - * @return string |
|
292 | - */ |
|
293 | - protected function buildLogEntry($levelName, $message, $backtraceLine = '') |
|
294 | - { |
|
295 | - return sprintf('[%s] %s [%s] %s', |
|
296 | - current_time('mysql'), |
|
297 | - strtoupper($levelName), |
|
298 | - $backtraceLine, |
|
299 | - $message |
|
300 | - ); |
|
301 | - } |
|
302 | - |
|
303 | - /** |
|
304 | - * @param int $level |
|
305 | - * @return bool |
|
306 | - */ |
|
307 | - protected function canLogEntry($level, $backtraceLine) |
|
308 | - { |
|
309 | - $levelExists = array_key_exists($level, $this->getLevels()); |
|
310 | - if (!Str::contains($backtraceLine, glsr()->path())) { |
|
311 | - return $levelExists; // ignore level restriction if triggered outside of the plugin |
|
312 | - } |
|
313 | - return $levelExists && $level >= $this->getLevel(); |
|
314 | - } |
|
315 | - |
|
316 | - /** |
|
317 | - * @return void|string |
|
318 | - */ |
|
319 | - protected function getBacktraceLine() |
|
320 | - { |
|
321 | - $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6); |
|
322 | - $search = array_search('glsr_log', glsr_array_column($backtrace, 'function')); |
|
323 | - if (false !== $search) { |
|
324 | - return $this->buildBacktraceLine($backtrace, (int) $search); |
|
325 | - } |
|
326 | - $search = array_search('log', glsr_array_column($backtrace, 'function')); |
|
327 | - if (false !== $search) { |
|
328 | - $index = '{closure}' == Arr::get($backtrace, ($search + 2).'.function') |
|
329 | - ? $search + 4 |
|
330 | - : $search + 1; |
|
331 | - return $this->buildBacktraceLine($backtrace, $index); |
|
332 | - } |
|
333 | - return 'Unknown'; |
|
334 | - } |
|
335 | - |
|
336 | - /** |
|
337 | - * @param mixed $data |
|
338 | - * @return string |
|
339 | - */ |
|
340 | - protected function getBacktraceLineFromData($data) |
|
341 | - { |
|
342 | - $backtrace = $data instanceof Throwable |
|
343 | - ? $data->getTrace() |
|
344 | - : debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1); |
|
345 | - return $this->buildBacktraceLine($backtrace, 0); |
|
346 | - } |
|
347 | - |
|
348 | - /** |
|
349 | - * @param mixed $data |
|
350 | - * @return string |
|
351 | - */ |
|
352 | - protected function getMessageFromData($data) |
|
353 | - { |
|
354 | - return $data instanceof Throwable |
|
355 | - ? $this->normalizeThrowableMessage($data->getMessage()) |
|
356 | - : print_r($data, 1); |
|
357 | - } |
|
358 | - |
|
359 | - /** |
|
360 | - * Interpolates context values into the message placeholders. |
|
361 | - * @param mixed $message |
|
362 | - * @param array $context |
|
363 | - * @return string |
|
364 | - */ |
|
365 | - protected function interpolate($message, $context = []) |
|
366 | - { |
|
367 | - if ($this->isObjectOrArray($message) || !is_array($context)) { |
|
368 | - return print_r($message, true); |
|
369 | - } |
|
370 | - $replace = []; |
|
371 | - foreach ($context as $key => $value) { |
|
372 | - $replace['{'.$key.'}'] = $this->normalizeValue($value); |
|
373 | - } |
|
374 | - return strtr($message, $replace); |
|
375 | - } |
|
376 | - |
|
377 | - /** |
|
378 | - * @param mixed $value |
|
379 | - * @return bool |
|
380 | - */ |
|
381 | - protected function isObjectOrArray($value) |
|
382 | - { |
|
383 | - return is_object($value) || is_array($value); |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * @param string $backtraceLine |
|
388 | - * @return string |
|
389 | - */ |
|
390 | - protected function normalizeBacktraceLine($backtraceLine) |
|
391 | - { |
|
392 | - $search = [ |
|
393 | - glsr()->path('plugin/'), |
|
394 | - glsr()->path('plugin/', false), |
|
395 | - trailingslashit(glsr()->path()), |
|
396 | - trailingslashit(glsr()->path('', false)), |
|
397 | - WP_CONTENT_DIR, |
|
398 | - ABSPATH, |
|
399 | - ]; |
|
400 | - return str_replace(array_unique($search), '', $backtraceLine); |
|
401 | - } |
|
402 | - |
|
403 | - /** |
|
404 | - * @param string $message |
|
405 | - * @return string |
|
406 | - */ |
|
407 | - protected function normalizeThrowableMessage($message) |
|
408 | - { |
|
409 | - $calledIn = strpos($message, ', called in'); |
|
410 | - return false !== $calledIn |
|
411 | - ? substr($message, 0, $calledIn) |
|
412 | - : $message; |
|
413 | - } |
|
414 | - |
|
415 | - /** |
|
416 | - * @param mixed $value |
|
417 | - * @return string |
|
418 | - */ |
|
419 | - protected function normalizeValue($value) |
|
420 | - { |
|
421 | - if ($value instanceof DateTime) { |
|
422 | - $value = $value->format('Y-m-d H:i:s'); |
|
423 | - } elseif ($this->isObjectOrArray($value)) { |
|
424 | - $value = json_encode($value); |
|
425 | - } |
|
426 | - return (string) $value; |
|
427 | - } |
|
428 | - |
|
429 | - /** |
|
430 | - * @return void |
|
431 | - */ |
|
432 | - protected function reset() |
|
433 | - { |
|
434 | - if ($this->size() <= pow(1024, 2) / 8) { |
|
435 | - return; |
|
436 | - } |
|
437 | - $this->clear(); |
|
438 | - file_put_contents( |
|
439 | - $this->file, |
|
440 | - $this->buildLogEntry( |
|
441 | - static::NOTICE, |
|
442 | - __('Console was automatically cleared (128 KB maximum size)', 'site-reviews') |
|
443 | - ) |
|
444 | - ); |
|
445 | - } |
|
13 | + const DEBUG = 0; // Detailed debug information |
|
14 | + const INFO = 1; // Interesting events |
|
15 | + const NOTICE = 2; // Normal but significant events |
|
16 | + const WARNING = 4; // Exceptional occurrences that are not errors |
|
17 | + const ERROR = 8; // Runtime errors that do not require immediate action |
|
18 | + const CRITICAL = 16; // Critical conditions |
|
19 | + const ALERT = 32; // Action must be taken immediately |
|
20 | + const EMERGENCY = 64; // System is unusable |
|
21 | + |
|
22 | + protected $file; |
|
23 | + protected $log; |
|
24 | + protected $logOnceKey = 'glsr_log_once'; |
|
25 | + |
|
26 | + public function __construct() |
|
27 | + { |
|
28 | + $this->file = glsr()->path('console.log'); |
|
29 | + $this->log = file_exists($this->file) |
|
30 | + ? file_get_contents($this->file) |
|
31 | + : ''; |
|
32 | + $this->reset(); |
|
33 | + } |
|
34 | + |
|
35 | + /** |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public function __toString() |
|
39 | + { |
|
40 | + return $this->get(); |
|
41 | + } |
|
42 | + |
|
43 | + /** |
|
44 | + * Action must be taken immediately |
|
45 | + * Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up. |
|
46 | + * @param mixed $message |
|
47 | + * @param array $context |
|
48 | + * @return static |
|
49 | + */ |
|
50 | + public function alert($message, array $context = []) |
|
51 | + { |
|
52 | + return $this->log(static::ALERT, $message, $context); |
|
53 | + } |
|
54 | + |
|
55 | + /** |
|
56 | + * @return void |
|
57 | + */ |
|
58 | + public function clear() |
|
59 | + { |
|
60 | + $this->log = ''; |
|
61 | + file_put_contents($this->file, $this->log); |
|
62 | + } |
|
63 | + |
|
64 | + /** |
|
65 | + * Critical conditions |
|
66 | + * Example: Application component unavailable, unexpected exception. |
|
67 | + * @param mixed $message |
|
68 | + * @param array $context |
|
69 | + * @return static |
|
70 | + */ |
|
71 | + public function critical($message, array $context = []) |
|
72 | + { |
|
73 | + return $this->log(static::CRITICAL, $message, $context); |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Detailed debug information. |
|
78 | + * @param mixed $message |
|
79 | + * @param array $context |
|
80 | + * @return static |
|
81 | + */ |
|
82 | + public function debug($message, array $context = []) |
|
83 | + { |
|
84 | + return $this->log(static::DEBUG, $message, $context); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * System is unusable. |
|
89 | + * @param mixed $message |
|
90 | + * @param array $context |
|
91 | + * @return static |
|
92 | + */ |
|
93 | + public function emergency($message, array $context = []) |
|
94 | + { |
|
95 | + return $this->log(static::EMERGENCY, $message, $context); |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Runtime errors that do not require immediate action but should typically be logged and monitored. |
|
100 | + * @param mixed $message |
|
101 | + * @param array $context |
|
102 | + * @return static |
|
103 | + */ |
|
104 | + public function error($message, array $context = []) |
|
105 | + { |
|
106 | + return $this->log(static::ERROR, $message, $context); |
|
107 | + } |
|
108 | + |
|
109 | + /** |
|
110 | + * @return string |
|
111 | + */ |
|
112 | + public function get() |
|
113 | + { |
|
114 | + return empty($this->log) |
|
115 | + ? __('Console is empty', 'site-reviews') |
|
116 | + : $this->log; |
|
117 | + } |
|
118 | + |
|
119 | + /** |
|
120 | + * @return int |
|
121 | + */ |
|
122 | + public function getLevel() |
|
123 | + { |
|
124 | + return intval(apply_filters('site-reviews/console/level', static::INFO)); |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * @return array |
|
129 | + */ |
|
130 | + public function getLevels() |
|
131 | + { |
|
132 | + $constants = (new ReflectionClass(__CLASS__))->getConstants(); |
|
133 | + return array_map('strtolower', array_flip($constants)); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * @return string |
|
138 | + */ |
|
139 | + public function humanLevel() |
|
140 | + { |
|
141 | + $level = $this->getLevel(); |
|
142 | + return sprintf('%s (%d)', strtoupper(Arr::get($this->getLevels(), $level, 'unknown')), $level); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * @param string|null $valueIfEmpty |
|
147 | + * @return string |
|
148 | + */ |
|
149 | + public function humanSize($valueIfEmpty = null) |
|
150 | + { |
|
151 | + $bytes = $this->size(); |
|
152 | + if (empty($bytes) && is_string($valueIfEmpty)) { |
|
153 | + return $valueIfEmpty; |
|
154 | + } |
|
155 | + $exponent = floor(log(max($bytes, 1), 1024)); |
|
156 | + return round($bytes / pow(1024, $exponent), 2).' '.['bytes', 'KB', 'MB', 'GB'][$exponent]; |
|
157 | + } |
|
158 | + |
|
159 | + /** |
|
160 | + * Interesting events |
|
161 | + * Example: User logs in, SQL logs. |
|
162 | + * @param mixed $message |
|
163 | + * @param array $context |
|
164 | + * @return static |
|
165 | + */ |
|
166 | + public function info($message, array $context = []) |
|
167 | + { |
|
168 | + return $this->log(static::INFO, $message, $context); |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * @param int $level |
|
173 | + * @param mixed $message |
|
174 | + * @param array $context |
|
175 | + * @param string $backtraceLine |
|
176 | + * @return static |
|
177 | + */ |
|
178 | + public function log($level, $message, $context = [], $backtraceLine = '') |
|
179 | + { |
|
180 | + if (empty($backtraceLine)) { |
|
181 | + $backtraceLine = $this->getBacktraceLine(); |
|
182 | + } |
|
183 | + if ($this->canLogEntry($level, $backtraceLine)) { |
|
184 | + $levelName = Arr::get($this->getLevels(), $level); |
|
185 | + $context = Arr::consolidateArray($context); |
|
186 | + $backtraceLine = $this->normalizeBacktraceLine($backtraceLine); |
|
187 | + $message = $this->interpolate($message, $context); |
|
188 | + $entry = $this->buildLogEntry($levelName, $message, $backtraceLine); |
|
189 | + file_put_contents($this->file, $entry.PHP_EOL, FILE_APPEND | LOCK_EX); |
|
190 | + apply_filters('console', $message, $levelName, $backtraceLine); // Show in Blackbar plugin if installed |
|
191 | + $this->reset(); |
|
192 | + } |
|
193 | + return $this; |
|
194 | + } |
|
195 | + |
|
196 | + /** |
|
197 | + * @return void |
|
198 | + */ |
|
199 | + public function logOnce() |
|
200 | + { |
|
201 | + $once = Arr::consolidateArray(glsr()->{$this->logOnceKey}); |
|
202 | + $levels = $this->getLevels(); |
|
203 | + foreach ($once as $entry) { |
|
204 | + $levelName = Arr::get($entry, 'level'); |
|
205 | + if (!in_array($levelName, $levels)) { |
|
206 | + continue; |
|
207 | + } |
|
208 | + $level = Arr::get(array_flip($levels), $levelName); |
|
209 | + $message = Arr::get($entry, 'message'); |
|
210 | + $backtraceLine = Arr::get($entry, 'backtrace'); |
|
211 | + $this->log($level, $message, [], $backtraceLine); |
|
212 | + } |
|
213 | + glsr()->{$this->logOnceKey} = []; |
|
214 | + } |
|
215 | + |
|
216 | + /** |
|
217 | + * Normal but significant events. |
|
218 | + * @param mixed $message |
|
219 | + * @param array $context |
|
220 | + * @return static |
|
221 | + */ |
|
222 | + public function notice($message, array $context = []) |
|
223 | + { |
|
224 | + return $this->log(static::NOTICE, $message, $context); |
|
225 | + } |
|
226 | + |
|
227 | + /** |
|
228 | + * @param string $levelName |
|
229 | + * @param string $handle |
|
230 | + * @param mixed $data |
|
231 | + * @return void |
|
232 | + */ |
|
233 | + public function once($levelName, $handle, $data) |
|
234 | + { |
|
235 | + $once = Arr::consolidateArray(glsr()->{$this->logOnceKey}); |
|
236 | + $filtered = array_filter($once, function ($entry) use ($levelName, $handle) { |
|
237 | + return Arr::get($entry, 'level') == $levelName |
|
238 | + && Arr::get($entry, 'handle') == $handle; |
|
239 | + }); |
|
240 | + if (!empty($filtered)) { |
|
241 | + return; |
|
242 | + } |
|
243 | + $once[] = [ |
|
244 | + 'backtrace' => $this->getBacktraceLineFromData($data), |
|
245 | + 'handle' => $handle, |
|
246 | + 'level' => $levelName, |
|
247 | + 'message' => '[RECURRING] '.$this->getMessageFromData($data), |
|
248 | + ]; |
|
249 | + glsr()->{$this->logOnceKey} = $once; |
|
250 | + } |
|
251 | + |
|
252 | + /** |
|
253 | + * @return int |
|
254 | + */ |
|
255 | + public function size() |
|
256 | + { |
|
257 | + return file_exists($this->file) |
|
258 | + ? filesize($this->file) |
|
259 | + : 0; |
|
260 | + } |
|
261 | + |
|
262 | + /** |
|
263 | + * Exceptional occurrences that are not errors |
|
264 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong. |
|
265 | + * @param mixed $message |
|
266 | + * @param array $context |
|
267 | + * @return static |
|
268 | + */ |
|
269 | + public function warning($message, array $context = []) |
|
270 | + { |
|
271 | + return $this->log(static::WARNING, $message, $context); |
|
272 | + } |
|
273 | + |
|
274 | + /** |
|
275 | + * @param array $backtrace |
|
276 | + * @param int $index |
|
277 | + * @return string |
|
278 | + */ |
|
279 | + protected function buildBacktraceLine($backtrace, $index) |
|
280 | + { |
|
281 | + return sprintf('%s:%s', |
|
282 | + Arr::get($backtrace, $index.'.file'), // realpath |
|
283 | + Arr::get($backtrace, $index.'.line') |
|
284 | + ); |
|
285 | + } |
|
286 | + |
|
287 | + /** |
|
288 | + * @param string $levelName |
|
289 | + * @param mixed $message |
|
290 | + * @param string $backtraceLine |
|
291 | + * @return string |
|
292 | + */ |
|
293 | + protected function buildLogEntry($levelName, $message, $backtraceLine = '') |
|
294 | + { |
|
295 | + return sprintf('[%s] %s [%s] %s', |
|
296 | + current_time('mysql'), |
|
297 | + strtoupper($levelName), |
|
298 | + $backtraceLine, |
|
299 | + $message |
|
300 | + ); |
|
301 | + } |
|
302 | + |
|
303 | + /** |
|
304 | + * @param int $level |
|
305 | + * @return bool |
|
306 | + */ |
|
307 | + protected function canLogEntry($level, $backtraceLine) |
|
308 | + { |
|
309 | + $levelExists = array_key_exists($level, $this->getLevels()); |
|
310 | + if (!Str::contains($backtraceLine, glsr()->path())) { |
|
311 | + return $levelExists; // ignore level restriction if triggered outside of the plugin |
|
312 | + } |
|
313 | + return $levelExists && $level >= $this->getLevel(); |
|
314 | + } |
|
315 | + |
|
316 | + /** |
|
317 | + * @return void|string |
|
318 | + */ |
|
319 | + protected function getBacktraceLine() |
|
320 | + { |
|
321 | + $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6); |
|
322 | + $search = array_search('glsr_log', glsr_array_column($backtrace, 'function')); |
|
323 | + if (false !== $search) { |
|
324 | + return $this->buildBacktraceLine($backtrace, (int) $search); |
|
325 | + } |
|
326 | + $search = array_search('log', glsr_array_column($backtrace, 'function')); |
|
327 | + if (false !== $search) { |
|
328 | + $index = '{closure}' == Arr::get($backtrace, ($search + 2).'.function') |
|
329 | + ? $search + 4 |
|
330 | + : $search + 1; |
|
331 | + return $this->buildBacktraceLine($backtrace, $index); |
|
332 | + } |
|
333 | + return 'Unknown'; |
|
334 | + } |
|
335 | + |
|
336 | + /** |
|
337 | + * @param mixed $data |
|
338 | + * @return string |
|
339 | + */ |
|
340 | + protected function getBacktraceLineFromData($data) |
|
341 | + { |
|
342 | + $backtrace = $data instanceof Throwable |
|
343 | + ? $data->getTrace() |
|
344 | + : debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1); |
|
345 | + return $this->buildBacktraceLine($backtrace, 0); |
|
346 | + } |
|
347 | + |
|
348 | + /** |
|
349 | + * @param mixed $data |
|
350 | + * @return string |
|
351 | + */ |
|
352 | + protected function getMessageFromData($data) |
|
353 | + { |
|
354 | + return $data instanceof Throwable |
|
355 | + ? $this->normalizeThrowableMessage($data->getMessage()) |
|
356 | + : print_r($data, 1); |
|
357 | + } |
|
358 | + |
|
359 | + /** |
|
360 | + * Interpolates context values into the message placeholders. |
|
361 | + * @param mixed $message |
|
362 | + * @param array $context |
|
363 | + * @return string |
|
364 | + */ |
|
365 | + protected function interpolate($message, $context = []) |
|
366 | + { |
|
367 | + if ($this->isObjectOrArray($message) || !is_array($context)) { |
|
368 | + return print_r($message, true); |
|
369 | + } |
|
370 | + $replace = []; |
|
371 | + foreach ($context as $key => $value) { |
|
372 | + $replace['{'.$key.'}'] = $this->normalizeValue($value); |
|
373 | + } |
|
374 | + return strtr($message, $replace); |
|
375 | + } |
|
376 | + |
|
377 | + /** |
|
378 | + * @param mixed $value |
|
379 | + * @return bool |
|
380 | + */ |
|
381 | + protected function isObjectOrArray($value) |
|
382 | + { |
|
383 | + return is_object($value) || is_array($value); |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * @param string $backtraceLine |
|
388 | + * @return string |
|
389 | + */ |
|
390 | + protected function normalizeBacktraceLine($backtraceLine) |
|
391 | + { |
|
392 | + $search = [ |
|
393 | + glsr()->path('plugin/'), |
|
394 | + glsr()->path('plugin/', false), |
|
395 | + trailingslashit(glsr()->path()), |
|
396 | + trailingslashit(glsr()->path('', false)), |
|
397 | + WP_CONTENT_DIR, |
|
398 | + ABSPATH, |
|
399 | + ]; |
|
400 | + return str_replace(array_unique($search), '', $backtraceLine); |
|
401 | + } |
|
402 | + |
|
403 | + /** |
|
404 | + * @param string $message |
|
405 | + * @return string |
|
406 | + */ |
|
407 | + protected function normalizeThrowableMessage($message) |
|
408 | + { |
|
409 | + $calledIn = strpos($message, ', called in'); |
|
410 | + return false !== $calledIn |
|
411 | + ? substr($message, 0, $calledIn) |
|
412 | + : $message; |
|
413 | + } |
|
414 | + |
|
415 | + /** |
|
416 | + * @param mixed $value |
|
417 | + * @return string |
|
418 | + */ |
|
419 | + protected function normalizeValue($value) |
|
420 | + { |
|
421 | + if ($value instanceof DateTime) { |
|
422 | + $value = $value->format('Y-m-d H:i:s'); |
|
423 | + } elseif ($this->isObjectOrArray($value)) { |
|
424 | + $value = json_encode($value); |
|
425 | + } |
|
426 | + return (string) $value; |
|
427 | + } |
|
428 | + |
|
429 | + /** |
|
430 | + * @return void |
|
431 | + */ |
|
432 | + protected function reset() |
|
433 | + { |
|
434 | + if ($this->size() <= pow(1024, 2) / 8) { |
|
435 | + return; |
|
436 | + } |
|
437 | + $this->clear(); |
|
438 | + file_put_contents( |
|
439 | + $this->file, |
|
440 | + $this->buildLogEntry( |
|
441 | + static::NOTICE, |
|
442 | + __('Console was automatically cleared (128 KB maximum size)', 'site-reviews') |
|
443 | + ) |
|
444 | + ); |
|
445 | + } |
|
446 | 446 | } |