@@ -54,7 +54,7 @@ |
||
54 | 54 | */ |
55 | 55 | private function setMedia($media) |
56 | 56 | { |
57 | - if (! is_string($media)) { |
|
57 | + if ( ! is_string($media)) { |
|
58 | 58 | throw new InvalidDataTypeException( |
59 | 59 | '$media', |
60 | 60 | $media, |
@@ -16,60 +16,60 @@ |
||
16 | 16 | class StylesheetAsset extends BrowserAsset |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var string $media |
|
21 | - */ |
|
22 | - private $media; |
|
19 | + /** |
|
20 | + * @var string $media |
|
21 | + */ |
|
22 | + private $media; |
|
23 | 23 | |
24 | 24 | |
25 | - /** |
|
26 | - * CssFile constructor. |
|
27 | - * |
|
28 | - * @param $handle |
|
29 | - * @param string $source |
|
30 | - * @param array $dependencies |
|
31 | - * @param DomainInterface $domain |
|
32 | - * @param $media |
|
33 | - * @throws InvalidDataTypeException |
|
34 | - */ |
|
35 | - public function __construct($handle, $source, array $dependencies, DomainInterface $domain, $media = 'all') |
|
36 | - { |
|
37 | - parent::__construct(Asset::TYPE_CSS, $handle, $source, $dependencies, $domain); |
|
38 | - $this->setMedia($media); |
|
39 | - } |
|
25 | + /** |
|
26 | + * CssFile constructor. |
|
27 | + * |
|
28 | + * @param $handle |
|
29 | + * @param string $source |
|
30 | + * @param array $dependencies |
|
31 | + * @param DomainInterface $domain |
|
32 | + * @param $media |
|
33 | + * @throws InvalidDataTypeException |
|
34 | + */ |
|
35 | + public function __construct($handle, $source, array $dependencies, DomainInterface $domain, $media = 'all') |
|
36 | + { |
|
37 | + parent::__construct(Asset::TYPE_CSS, $handle, $source, $dependencies, $domain); |
|
38 | + $this->setMedia($media); |
|
39 | + } |
|
40 | 40 | |
41 | 41 | |
42 | - /** |
|
43 | - * @return string |
|
44 | - */ |
|
45 | - public function media() |
|
46 | - { |
|
47 | - return $this->media; |
|
48 | - } |
|
42 | + /** |
|
43 | + * @return string |
|
44 | + */ |
|
45 | + public function media() |
|
46 | + { |
|
47 | + return $this->media; |
|
48 | + } |
|
49 | 49 | |
50 | 50 | |
51 | - /** |
|
52 | - * @param string $media |
|
53 | - * @throws InvalidDataTypeException |
|
54 | - */ |
|
55 | - private function setMedia($media) |
|
56 | - { |
|
57 | - if (! is_string($media)) { |
|
58 | - throw new InvalidDataTypeException( |
|
59 | - '$media', |
|
60 | - $media, |
|
61 | - 'string' |
|
62 | - ); |
|
63 | - } |
|
64 | - $this->media = $media; |
|
65 | - } |
|
51 | + /** |
|
52 | + * @param string $media |
|
53 | + * @throws InvalidDataTypeException |
|
54 | + */ |
|
55 | + private function setMedia($media) |
|
56 | + { |
|
57 | + if (! is_string($media)) { |
|
58 | + throw new InvalidDataTypeException( |
|
59 | + '$media', |
|
60 | + $media, |
|
61 | + 'string' |
|
62 | + ); |
|
63 | + } |
|
64 | + $this->media = $media; |
|
65 | + } |
|
66 | 66 | |
67 | 67 | |
68 | - /** |
|
69 | - * @since $VID:$ |
|
70 | - */ |
|
71 | - public function enqueueAsset() |
|
72 | - { |
|
73 | - wp_enqueue_style($this->handle()); |
|
74 | - } |
|
68 | + /** |
|
69 | + * @since $VID:$ |
|
70 | + */ |
|
71 | + public function enqueueAsset() |
|
72 | + { |
|
73 | + wp_enqueue_style($this->handle()); |
|
74 | + } |
|
75 | 75 | } |
@@ -68,14 +68,14 @@ discard block |
||
68 | 68 | protected function setCollectionIdentifier() |
69 | 69 | { |
70 | 70 | // hash a few collection details |
71 | - $identifier = md5(spl_object_hash($this) . $this->collection_interface . time()); |
|
71 | + $identifier = md5(spl_object_hash($this).$this->collection_interface.time()); |
|
72 | 72 | // grab a few characters from the start, middle, and end of the hash |
73 | 73 | $id = array(); |
74 | 74 | for ($x = 0; $x < 19; $x += 9) { |
75 | 75 | $id[] = substr($identifier, $x, 3); |
76 | 76 | } |
77 | 77 | $identifier = basename(str_replace('\\', '/', get_class($this))); |
78 | - $identifier .= '-' . strtoupper(implode('-', $id)); |
|
78 | + $identifier .= '-'.strtoupper(implode('-', $id)); |
|
79 | 79 | $this->collection_identifier = $identifier; |
80 | 80 | } |
81 | 81 | |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | */ |
90 | 90 | protected function setCollectionInterface($collection_interface) |
91 | 91 | { |
92 | - if (! (interface_exists($collection_interface) || class_exists($collection_interface))) { |
|
92 | + if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) { |
|
93 | 93 | throw new InvalidInterfaceException($collection_interface); |
94 | 94 | } |
95 | 95 | $this->collection_interface = $collection_interface; |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | */ |
112 | 112 | public function add($object, $identifier = null) |
113 | 113 | { |
114 | - if (! $object instanceof $this->collection_interface) { |
|
114 | + if ( ! $object instanceof $this->collection_interface) { |
|
115 | 115 | throw new InvalidEntityException($object, $this->collection_interface); |
116 | 116 | } |
117 | 117 | if ($this->contains($object)) { |
@@ -322,7 +322,7 @@ discard block |
||
322 | 322 | */ |
323 | 323 | public function indexOf($object) |
324 | 324 | { |
325 | - if (! $this->contains($object)) { |
|
325 | + if ( ! $this->contains($object)) { |
|
326 | 326 | return false; |
327 | 327 | } |
328 | 328 | foreach ($this as $index => $obj) { |
@@ -391,9 +391,9 @@ discard block |
||
391 | 391 | $remaining_objects = $this->slice($index, $this->count() - $index); |
392 | 392 | foreach ($remaining_objects as $key => $remaining_object) { |
393 | 393 | // we need to grab the identifiers for each object and use them as keys |
394 | - $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object; |
|
394 | + $remaining_objects[$remaining_object->getInfo()] = $remaining_object; |
|
395 | 395 | // and then remove the object from the current tracking array |
396 | - unset($remaining_objects[ $key ]); |
|
396 | + unset($remaining_objects[$key]); |
|
397 | 397 | // and then remove it from the Collection |
398 | 398 | $this->detach($remaining_object); |
399 | 399 | } |
@@ -417,17 +417,17 @@ discard block |
||
417 | 417 | */ |
418 | 418 | public function insertAt($objects, $index) |
419 | 419 | { |
420 | - if (! is_array($objects)) { |
|
420 | + if ( ! is_array($objects)) { |
|
421 | 421 | $objects = array($objects); |
422 | 422 | } |
423 | 423 | // check to ensure that objects don't already exist in the collection |
424 | 424 | foreach ($objects as $key => $object) { |
425 | 425 | if ($this->contains($object)) { |
426 | - unset($objects[ $key ]); |
|
426 | + unset($objects[$key]); |
|
427 | 427 | } |
428 | 428 | } |
429 | 429 | // do we have any objects left? |
430 | - if (! $objects) { |
|
430 | + if ( ! $objects) { |
|
431 | 431 | return; |
432 | 432 | } |
433 | 433 | // detach any objects at or past this index |
@@ -19,470 +19,470 @@ |
||
19 | 19 | class Collection extends SplObjectStorage implements CollectionInterface |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * a unique string for identifying this collection |
|
24 | - * |
|
25 | - * @type string $collection_identifier |
|
26 | - */ |
|
27 | - protected $collection_identifier; |
|
28 | - |
|
29 | - |
|
30 | - /** |
|
31 | - * an interface (or class) name to be used for restricting the type of objects added to the storage |
|
32 | - * this should be set from within the child class constructor |
|
33 | - * |
|
34 | - * @type string $interface |
|
35 | - */ |
|
36 | - protected $collection_interface; |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * Collection constructor |
|
41 | - * |
|
42 | - * @param string $collection_interface |
|
43 | - * @throws InvalidInterfaceException |
|
44 | - */ |
|
45 | - public function __construct($collection_interface) |
|
46 | - { |
|
47 | - $this->setCollectionInterface($collection_interface); |
|
48 | - $this->setCollectionIdentifier(); |
|
49 | - } |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * @return string |
|
54 | - */ |
|
55 | - public function collectionIdentifier() |
|
56 | - { |
|
57 | - return $this->collection_identifier; |
|
58 | - } |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * creates a very readable unique 9 character identifier like: CF2-532-DAC |
|
63 | - * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC |
|
64 | - * |
|
65 | - * @return void |
|
66 | - */ |
|
67 | - protected function setCollectionIdentifier() |
|
68 | - { |
|
69 | - // hash a few collection details |
|
70 | - $identifier = md5(spl_object_hash($this) . $this->collection_interface . time()); |
|
71 | - // grab a few characters from the start, middle, and end of the hash |
|
72 | - $id = array(); |
|
73 | - for ($x = 0; $x < 19; $x += 9) { |
|
74 | - $id[] = substr($identifier, $x, 3); |
|
75 | - } |
|
76 | - $identifier = basename(str_replace('\\', '/', get_class($this))); |
|
77 | - $identifier .= '-' . strtoupper(implode('-', $id)); |
|
78 | - $this->collection_identifier = $identifier; |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * setCollectionInterface |
|
84 | - * |
|
85 | - * @param string $collection_interface |
|
86 | - * @throws InvalidInterfaceException |
|
87 | - */ |
|
88 | - protected function setCollectionInterface($collection_interface) |
|
89 | - { |
|
90 | - if (! (interface_exists($collection_interface) || class_exists($collection_interface))) { |
|
91 | - throw new InvalidInterfaceException($collection_interface); |
|
92 | - } |
|
93 | - $this->collection_interface = $collection_interface; |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - /** |
|
98 | - * add |
|
99 | - * attaches an object to the Collection |
|
100 | - * and sets any supplied data associated with the current iterator entry |
|
101 | - * by calling EE_Object_Collection::set_identifier() |
|
102 | - * |
|
103 | - * @param $object |
|
104 | - * @param mixed $identifier |
|
105 | - * @return bool |
|
106 | - * @throws InvalidEntityException |
|
107 | - * @throws DuplicateCollectionIdentifierException |
|
108 | - */ |
|
109 | - public function add($object, $identifier = null) |
|
110 | - { |
|
111 | - if (! $object instanceof $this->collection_interface) { |
|
112 | - throw new InvalidEntityException($object, $this->collection_interface); |
|
113 | - } |
|
114 | - if ($this->contains($object)) { |
|
115 | - throw new DuplicateCollectionIdentifierException($identifier); |
|
116 | - } |
|
117 | - $this->attach($object); |
|
118 | - $this->setIdentifier($object, $identifier); |
|
119 | - return $this->contains($object); |
|
120 | - } |
|
121 | - |
|
122 | - |
|
123 | - /** |
|
124 | - * setIdentifier |
|
125 | - * Sets the data associated with an object in the Collection |
|
126 | - * if no $identifier is supplied, then the spl_object_hash() is used |
|
127 | - * |
|
128 | - * @access public |
|
129 | - * @param $object |
|
130 | - * @param mixed $identifier |
|
131 | - * @return bool |
|
132 | - */ |
|
133 | - public function setIdentifier($object, $identifier = null) |
|
134 | - { |
|
135 | - $identifier = ! empty($identifier) |
|
136 | - ? $identifier |
|
137 | - : spl_object_hash($object); |
|
138 | - $this->rewind(); |
|
139 | - while ($this->valid()) { |
|
140 | - if ($object === $this->current()) { |
|
141 | - $this->setInfo($identifier); |
|
142 | - $this->rewind(); |
|
143 | - return true; |
|
144 | - } |
|
145 | - $this->next(); |
|
146 | - } |
|
147 | - return false; |
|
148 | - } |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * get |
|
153 | - * finds and returns an object in the Collection based on the identifier that was set using addObject() |
|
154 | - * PLZ NOTE: the pointer is reset to the beginning of the collection before returning |
|
155 | - * |
|
156 | - * @access public |
|
157 | - * @param mixed $identifier |
|
158 | - * @return mixed |
|
159 | - */ |
|
160 | - public function get($identifier) |
|
161 | - { |
|
162 | - $this->rewind(); |
|
163 | - while ($this->valid()) { |
|
164 | - if ($identifier === $this->getInfo()) { |
|
165 | - $object = $this->current(); |
|
166 | - $this->rewind(); |
|
167 | - return $object; |
|
168 | - } |
|
169 | - $this->next(); |
|
170 | - } |
|
171 | - return null; |
|
172 | - } |
|
173 | - |
|
174 | - |
|
175 | - /** |
|
176 | - * has |
|
177 | - * returns TRUE or FALSE |
|
178 | - * depending on whether the object is within the Collection |
|
179 | - * based on the supplied $identifier |
|
180 | - * |
|
181 | - * @access public |
|
182 | - * @param mixed $identifier |
|
183 | - * @return bool |
|
184 | - */ |
|
185 | - public function has($identifier) |
|
186 | - { |
|
187 | - $this->rewind(); |
|
188 | - while ($this->valid()) { |
|
189 | - if ($identifier === $this->getInfo()) { |
|
190 | - $this->rewind(); |
|
191 | - return true; |
|
192 | - } |
|
193 | - $this->next(); |
|
194 | - } |
|
195 | - return false; |
|
196 | - } |
|
197 | - |
|
198 | - |
|
199 | - /** |
|
200 | - * hasObject |
|
201 | - * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
202 | - * |
|
203 | - * @access public |
|
204 | - * @param $object |
|
205 | - * @return bool |
|
206 | - */ |
|
207 | - public function hasObject($object) |
|
208 | - { |
|
209 | - return $this->contains($object); |
|
210 | - } |
|
211 | - |
|
212 | - |
|
213 | - /** |
|
214 | - * hasObjects |
|
215 | - * returns true if there are objects within the Collection, and false if it is empty |
|
216 | - * |
|
217 | - * @access public |
|
218 | - * @return bool |
|
219 | - */ |
|
220 | - public function hasObjects() |
|
221 | - { |
|
222 | - return $this->count() !== 0; |
|
223 | - } |
|
224 | - |
|
225 | - |
|
226 | - /** |
|
227 | - * isEmpty |
|
228 | - * returns true if there are no objects within the Collection, and false if there are |
|
229 | - * |
|
230 | - * @access public |
|
231 | - * @return bool |
|
232 | - */ |
|
233 | - public function isEmpty() |
|
234 | - { |
|
235 | - return $this->count() === 0; |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * remove |
|
241 | - * detaches an object from the Collection |
|
242 | - * |
|
243 | - * @access public |
|
244 | - * @param $object |
|
245 | - * @return bool |
|
246 | - */ |
|
247 | - public function remove($object) |
|
248 | - { |
|
249 | - $this->detach($object); |
|
250 | - return true; |
|
251 | - } |
|
252 | - |
|
253 | - |
|
254 | - /** |
|
255 | - * setCurrent |
|
256 | - * advances pointer to the object whose identifier matches that which was provided |
|
257 | - * |
|
258 | - * @access public |
|
259 | - * @param mixed $identifier |
|
260 | - * @return boolean |
|
261 | - */ |
|
262 | - public function setCurrent($identifier) |
|
263 | - { |
|
264 | - $this->rewind(); |
|
265 | - while ($this->valid()) { |
|
266 | - if ($identifier === $this->getInfo()) { |
|
267 | - return true; |
|
268 | - } |
|
269 | - $this->next(); |
|
270 | - } |
|
271 | - return false; |
|
272 | - } |
|
273 | - |
|
274 | - |
|
275 | - /** |
|
276 | - * setCurrentUsingObject |
|
277 | - * advances pointer to the provided object |
|
278 | - * |
|
279 | - * @access public |
|
280 | - * @param $object |
|
281 | - * @return boolean |
|
282 | - */ |
|
283 | - public function setCurrentUsingObject($object) |
|
284 | - { |
|
285 | - $this->rewind(); |
|
286 | - while ($this->valid()) { |
|
287 | - if ($this->current() === $object) { |
|
288 | - return true; |
|
289 | - } |
|
290 | - $this->next(); |
|
291 | - } |
|
292 | - return false; |
|
293 | - } |
|
294 | - |
|
295 | - |
|
296 | - /** |
|
297 | - * Returns the object occupying the index before the current object, |
|
298 | - * unless this is already the first object, in which case it just returns the first object |
|
299 | - * |
|
300 | - * @return mixed |
|
301 | - */ |
|
302 | - public function previous() |
|
303 | - { |
|
304 | - $index = $this->indexOf($this->current()); |
|
305 | - if ($index === 0) { |
|
306 | - return $this->current(); |
|
307 | - } |
|
308 | - $index--; |
|
309 | - return $this->objectAtIndex($index); |
|
310 | - } |
|
311 | - |
|
312 | - |
|
313 | - /** |
|
314 | - * Returns the index of a given object, or false if not found |
|
315 | - * |
|
316 | - * @see http://stackoverflow.com/a/8736013 |
|
317 | - * @param $object |
|
318 | - * @return boolean|int|string |
|
319 | - */ |
|
320 | - public function indexOf($object) |
|
321 | - { |
|
322 | - if (! $this->contains($object)) { |
|
323 | - return false; |
|
324 | - } |
|
325 | - foreach ($this as $index => $obj) { |
|
326 | - if ($obj === $object) { |
|
327 | - return $index; |
|
328 | - } |
|
329 | - } |
|
330 | - return false; |
|
331 | - } |
|
332 | - |
|
333 | - |
|
334 | - /** |
|
335 | - * Returns the object at the given index |
|
336 | - * |
|
337 | - * @see http://stackoverflow.com/a/8736013 |
|
338 | - * @param int $index |
|
339 | - * @return mixed |
|
340 | - */ |
|
341 | - public function objectAtIndex($index) |
|
342 | - { |
|
343 | - $iterator = new LimitIterator($this, $index, 1); |
|
344 | - $iterator->rewind(); |
|
345 | - return $iterator->current(); |
|
346 | - } |
|
347 | - |
|
348 | - |
|
349 | - /** |
|
350 | - * Returns the sequence of objects as specified by the offset and length |
|
351 | - * |
|
352 | - * @see http://stackoverflow.com/a/8736013 |
|
353 | - * @param int $offset |
|
354 | - * @param int $length |
|
355 | - * @return array |
|
356 | - */ |
|
357 | - public function slice($offset, $length) |
|
358 | - { |
|
359 | - $slice = array(); |
|
360 | - $iterator = new LimitIterator($this, $offset, $length); |
|
361 | - foreach ($iterator as $object) { |
|
362 | - $slice[] = $object; |
|
363 | - } |
|
364 | - return $slice; |
|
365 | - } |
|
366 | - |
|
367 | - |
|
368 | - /** |
|
369 | - * Inserts an object at a certain point |
|
370 | - * |
|
371 | - * @see http://stackoverflow.com/a/8736013 |
|
372 | - * @param mixed $object A single object |
|
373 | - * @param int $index |
|
374 | - * @param mixed $identifier |
|
375 | - * @return bool |
|
376 | - * @throws DuplicateCollectionIdentifierException |
|
377 | - * @throws InvalidEntityException |
|
378 | - */ |
|
379 | - public function insertObjectAt($object, $index, $identifier = null) |
|
380 | - { |
|
381 | - // check to ensure that objects don't already exist in the collection |
|
382 | - if ($this->has($identifier)) { |
|
383 | - throw new DuplicateCollectionIdentifierException($identifier); |
|
384 | - } |
|
385 | - // detach any objects at or past this index |
|
386 | - $remaining_objects = array(); |
|
387 | - if ($index < $this->count()) { |
|
388 | - $remaining_objects = $this->slice($index, $this->count() - $index); |
|
389 | - foreach ($remaining_objects as $key => $remaining_object) { |
|
390 | - // we need to grab the identifiers for each object and use them as keys |
|
391 | - $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object; |
|
392 | - // and then remove the object from the current tracking array |
|
393 | - unset($remaining_objects[ $key ]); |
|
394 | - // and then remove it from the Collection |
|
395 | - $this->detach($remaining_object); |
|
396 | - } |
|
397 | - } |
|
398 | - // add the new object we're splicing in |
|
399 | - $this->add($object, $identifier); |
|
400 | - // attach the objects we previously detached |
|
401 | - foreach ($remaining_objects as $key => $remaining_object) { |
|
402 | - $this->add($remaining_object, $key); |
|
403 | - } |
|
404 | - return $this->contains($object); |
|
405 | - } |
|
406 | - |
|
407 | - |
|
408 | - /** |
|
409 | - * Inserts an object (or an array of objects) at a certain point |
|
410 | - * |
|
411 | - * @see http://stackoverflow.com/a/8736013 |
|
412 | - * @param mixed $objects A single object or an array of objects |
|
413 | - * @param int $index |
|
414 | - */ |
|
415 | - public function insertAt($objects, $index) |
|
416 | - { |
|
417 | - if (! is_array($objects)) { |
|
418 | - $objects = array($objects); |
|
419 | - } |
|
420 | - // check to ensure that objects don't already exist in the collection |
|
421 | - foreach ($objects as $key => $object) { |
|
422 | - if ($this->contains($object)) { |
|
423 | - unset($objects[ $key ]); |
|
424 | - } |
|
425 | - } |
|
426 | - // do we have any objects left? |
|
427 | - if (! $objects) { |
|
428 | - return; |
|
429 | - } |
|
430 | - // detach any objects at or past this index |
|
431 | - $remaining = array(); |
|
432 | - if ($index < $this->count()) { |
|
433 | - $remaining = $this->slice($index, $this->count() - $index); |
|
434 | - foreach ($remaining as $object) { |
|
435 | - $this->detach($object); |
|
436 | - } |
|
437 | - } |
|
438 | - // add the new objects we're splicing in |
|
439 | - foreach ($objects as $object) { |
|
440 | - $this->attach($object); |
|
441 | - } |
|
442 | - // attach the objects we previously detached |
|
443 | - foreach ($remaining as $object) { |
|
444 | - $this->attach($object); |
|
445 | - } |
|
446 | - } |
|
447 | - |
|
448 | - |
|
449 | - /** |
|
450 | - * Removes the object at the given index |
|
451 | - * |
|
452 | - * @see http://stackoverflow.com/a/8736013 |
|
453 | - * @param int $index |
|
454 | - */ |
|
455 | - public function removeAt($index) |
|
456 | - { |
|
457 | - $this->detach($this->objectAtIndex($index)); |
|
458 | - } |
|
459 | - |
|
460 | - |
|
461 | - /** |
|
462 | - * detaches ALL objects from the Collection |
|
463 | - */ |
|
464 | - public function detachAll() |
|
465 | - { |
|
466 | - $this->rewind(); |
|
467 | - while ($this->valid()) { |
|
468 | - $object = $this->current(); |
|
469 | - $this->next(); |
|
470 | - $this->detach($object); |
|
471 | - } |
|
472 | - } |
|
473 | - |
|
474 | - |
|
475 | - /** |
|
476 | - * unsets and detaches ALL objects from the Collection |
|
477 | - */ |
|
478 | - public function trashAndDetachAll() |
|
479 | - { |
|
480 | - $this->rewind(); |
|
481 | - while ($this->valid()) { |
|
482 | - $object = $this->current(); |
|
483 | - $this->next(); |
|
484 | - $this->detach($object); |
|
485 | - unset($object); |
|
486 | - } |
|
487 | - } |
|
22 | + /** |
|
23 | + * a unique string for identifying this collection |
|
24 | + * |
|
25 | + * @type string $collection_identifier |
|
26 | + */ |
|
27 | + protected $collection_identifier; |
|
28 | + |
|
29 | + |
|
30 | + /** |
|
31 | + * an interface (or class) name to be used for restricting the type of objects added to the storage |
|
32 | + * this should be set from within the child class constructor |
|
33 | + * |
|
34 | + * @type string $interface |
|
35 | + */ |
|
36 | + protected $collection_interface; |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * Collection constructor |
|
41 | + * |
|
42 | + * @param string $collection_interface |
|
43 | + * @throws InvalidInterfaceException |
|
44 | + */ |
|
45 | + public function __construct($collection_interface) |
|
46 | + { |
|
47 | + $this->setCollectionInterface($collection_interface); |
|
48 | + $this->setCollectionIdentifier(); |
|
49 | + } |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * @return string |
|
54 | + */ |
|
55 | + public function collectionIdentifier() |
|
56 | + { |
|
57 | + return $this->collection_identifier; |
|
58 | + } |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * creates a very readable unique 9 character identifier like: CF2-532-DAC |
|
63 | + * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC |
|
64 | + * |
|
65 | + * @return void |
|
66 | + */ |
|
67 | + protected function setCollectionIdentifier() |
|
68 | + { |
|
69 | + // hash a few collection details |
|
70 | + $identifier = md5(spl_object_hash($this) . $this->collection_interface . time()); |
|
71 | + // grab a few characters from the start, middle, and end of the hash |
|
72 | + $id = array(); |
|
73 | + for ($x = 0; $x < 19; $x += 9) { |
|
74 | + $id[] = substr($identifier, $x, 3); |
|
75 | + } |
|
76 | + $identifier = basename(str_replace('\\', '/', get_class($this))); |
|
77 | + $identifier .= '-' . strtoupper(implode('-', $id)); |
|
78 | + $this->collection_identifier = $identifier; |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * setCollectionInterface |
|
84 | + * |
|
85 | + * @param string $collection_interface |
|
86 | + * @throws InvalidInterfaceException |
|
87 | + */ |
|
88 | + protected function setCollectionInterface($collection_interface) |
|
89 | + { |
|
90 | + if (! (interface_exists($collection_interface) || class_exists($collection_interface))) { |
|
91 | + throw new InvalidInterfaceException($collection_interface); |
|
92 | + } |
|
93 | + $this->collection_interface = $collection_interface; |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + /** |
|
98 | + * add |
|
99 | + * attaches an object to the Collection |
|
100 | + * and sets any supplied data associated with the current iterator entry |
|
101 | + * by calling EE_Object_Collection::set_identifier() |
|
102 | + * |
|
103 | + * @param $object |
|
104 | + * @param mixed $identifier |
|
105 | + * @return bool |
|
106 | + * @throws InvalidEntityException |
|
107 | + * @throws DuplicateCollectionIdentifierException |
|
108 | + */ |
|
109 | + public function add($object, $identifier = null) |
|
110 | + { |
|
111 | + if (! $object instanceof $this->collection_interface) { |
|
112 | + throw new InvalidEntityException($object, $this->collection_interface); |
|
113 | + } |
|
114 | + if ($this->contains($object)) { |
|
115 | + throw new DuplicateCollectionIdentifierException($identifier); |
|
116 | + } |
|
117 | + $this->attach($object); |
|
118 | + $this->setIdentifier($object, $identifier); |
|
119 | + return $this->contains($object); |
|
120 | + } |
|
121 | + |
|
122 | + |
|
123 | + /** |
|
124 | + * setIdentifier |
|
125 | + * Sets the data associated with an object in the Collection |
|
126 | + * if no $identifier is supplied, then the spl_object_hash() is used |
|
127 | + * |
|
128 | + * @access public |
|
129 | + * @param $object |
|
130 | + * @param mixed $identifier |
|
131 | + * @return bool |
|
132 | + */ |
|
133 | + public function setIdentifier($object, $identifier = null) |
|
134 | + { |
|
135 | + $identifier = ! empty($identifier) |
|
136 | + ? $identifier |
|
137 | + : spl_object_hash($object); |
|
138 | + $this->rewind(); |
|
139 | + while ($this->valid()) { |
|
140 | + if ($object === $this->current()) { |
|
141 | + $this->setInfo($identifier); |
|
142 | + $this->rewind(); |
|
143 | + return true; |
|
144 | + } |
|
145 | + $this->next(); |
|
146 | + } |
|
147 | + return false; |
|
148 | + } |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * get |
|
153 | + * finds and returns an object in the Collection based on the identifier that was set using addObject() |
|
154 | + * PLZ NOTE: the pointer is reset to the beginning of the collection before returning |
|
155 | + * |
|
156 | + * @access public |
|
157 | + * @param mixed $identifier |
|
158 | + * @return mixed |
|
159 | + */ |
|
160 | + public function get($identifier) |
|
161 | + { |
|
162 | + $this->rewind(); |
|
163 | + while ($this->valid()) { |
|
164 | + if ($identifier === $this->getInfo()) { |
|
165 | + $object = $this->current(); |
|
166 | + $this->rewind(); |
|
167 | + return $object; |
|
168 | + } |
|
169 | + $this->next(); |
|
170 | + } |
|
171 | + return null; |
|
172 | + } |
|
173 | + |
|
174 | + |
|
175 | + /** |
|
176 | + * has |
|
177 | + * returns TRUE or FALSE |
|
178 | + * depending on whether the object is within the Collection |
|
179 | + * based on the supplied $identifier |
|
180 | + * |
|
181 | + * @access public |
|
182 | + * @param mixed $identifier |
|
183 | + * @return bool |
|
184 | + */ |
|
185 | + public function has($identifier) |
|
186 | + { |
|
187 | + $this->rewind(); |
|
188 | + while ($this->valid()) { |
|
189 | + if ($identifier === $this->getInfo()) { |
|
190 | + $this->rewind(); |
|
191 | + return true; |
|
192 | + } |
|
193 | + $this->next(); |
|
194 | + } |
|
195 | + return false; |
|
196 | + } |
|
197 | + |
|
198 | + |
|
199 | + /** |
|
200 | + * hasObject |
|
201 | + * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
202 | + * |
|
203 | + * @access public |
|
204 | + * @param $object |
|
205 | + * @return bool |
|
206 | + */ |
|
207 | + public function hasObject($object) |
|
208 | + { |
|
209 | + return $this->contains($object); |
|
210 | + } |
|
211 | + |
|
212 | + |
|
213 | + /** |
|
214 | + * hasObjects |
|
215 | + * returns true if there are objects within the Collection, and false if it is empty |
|
216 | + * |
|
217 | + * @access public |
|
218 | + * @return bool |
|
219 | + */ |
|
220 | + public function hasObjects() |
|
221 | + { |
|
222 | + return $this->count() !== 0; |
|
223 | + } |
|
224 | + |
|
225 | + |
|
226 | + /** |
|
227 | + * isEmpty |
|
228 | + * returns true if there are no objects within the Collection, and false if there are |
|
229 | + * |
|
230 | + * @access public |
|
231 | + * @return bool |
|
232 | + */ |
|
233 | + public function isEmpty() |
|
234 | + { |
|
235 | + return $this->count() === 0; |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * remove |
|
241 | + * detaches an object from the Collection |
|
242 | + * |
|
243 | + * @access public |
|
244 | + * @param $object |
|
245 | + * @return bool |
|
246 | + */ |
|
247 | + public function remove($object) |
|
248 | + { |
|
249 | + $this->detach($object); |
|
250 | + return true; |
|
251 | + } |
|
252 | + |
|
253 | + |
|
254 | + /** |
|
255 | + * setCurrent |
|
256 | + * advances pointer to the object whose identifier matches that which was provided |
|
257 | + * |
|
258 | + * @access public |
|
259 | + * @param mixed $identifier |
|
260 | + * @return boolean |
|
261 | + */ |
|
262 | + public function setCurrent($identifier) |
|
263 | + { |
|
264 | + $this->rewind(); |
|
265 | + while ($this->valid()) { |
|
266 | + if ($identifier === $this->getInfo()) { |
|
267 | + return true; |
|
268 | + } |
|
269 | + $this->next(); |
|
270 | + } |
|
271 | + return false; |
|
272 | + } |
|
273 | + |
|
274 | + |
|
275 | + /** |
|
276 | + * setCurrentUsingObject |
|
277 | + * advances pointer to the provided object |
|
278 | + * |
|
279 | + * @access public |
|
280 | + * @param $object |
|
281 | + * @return boolean |
|
282 | + */ |
|
283 | + public function setCurrentUsingObject($object) |
|
284 | + { |
|
285 | + $this->rewind(); |
|
286 | + while ($this->valid()) { |
|
287 | + if ($this->current() === $object) { |
|
288 | + return true; |
|
289 | + } |
|
290 | + $this->next(); |
|
291 | + } |
|
292 | + return false; |
|
293 | + } |
|
294 | + |
|
295 | + |
|
296 | + /** |
|
297 | + * Returns the object occupying the index before the current object, |
|
298 | + * unless this is already the first object, in which case it just returns the first object |
|
299 | + * |
|
300 | + * @return mixed |
|
301 | + */ |
|
302 | + public function previous() |
|
303 | + { |
|
304 | + $index = $this->indexOf($this->current()); |
|
305 | + if ($index === 0) { |
|
306 | + return $this->current(); |
|
307 | + } |
|
308 | + $index--; |
|
309 | + return $this->objectAtIndex($index); |
|
310 | + } |
|
311 | + |
|
312 | + |
|
313 | + /** |
|
314 | + * Returns the index of a given object, or false if not found |
|
315 | + * |
|
316 | + * @see http://stackoverflow.com/a/8736013 |
|
317 | + * @param $object |
|
318 | + * @return boolean|int|string |
|
319 | + */ |
|
320 | + public function indexOf($object) |
|
321 | + { |
|
322 | + if (! $this->contains($object)) { |
|
323 | + return false; |
|
324 | + } |
|
325 | + foreach ($this as $index => $obj) { |
|
326 | + if ($obj === $object) { |
|
327 | + return $index; |
|
328 | + } |
|
329 | + } |
|
330 | + return false; |
|
331 | + } |
|
332 | + |
|
333 | + |
|
334 | + /** |
|
335 | + * Returns the object at the given index |
|
336 | + * |
|
337 | + * @see http://stackoverflow.com/a/8736013 |
|
338 | + * @param int $index |
|
339 | + * @return mixed |
|
340 | + */ |
|
341 | + public function objectAtIndex($index) |
|
342 | + { |
|
343 | + $iterator = new LimitIterator($this, $index, 1); |
|
344 | + $iterator->rewind(); |
|
345 | + return $iterator->current(); |
|
346 | + } |
|
347 | + |
|
348 | + |
|
349 | + /** |
|
350 | + * Returns the sequence of objects as specified by the offset and length |
|
351 | + * |
|
352 | + * @see http://stackoverflow.com/a/8736013 |
|
353 | + * @param int $offset |
|
354 | + * @param int $length |
|
355 | + * @return array |
|
356 | + */ |
|
357 | + public function slice($offset, $length) |
|
358 | + { |
|
359 | + $slice = array(); |
|
360 | + $iterator = new LimitIterator($this, $offset, $length); |
|
361 | + foreach ($iterator as $object) { |
|
362 | + $slice[] = $object; |
|
363 | + } |
|
364 | + return $slice; |
|
365 | + } |
|
366 | + |
|
367 | + |
|
368 | + /** |
|
369 | + * Inserts an object at a certain point |
|
370 | + * |
|
371 | + * @see http://stackoverflow.com/a/8736013 |
|
372 | + * @param mixed $object A single object |
|
373 | + * @param int $index |
|
374 | + * @param mixed $identifier |
|
375 | + * @return bool |
|
376 | + * @throws DuplicateCollectionIdentifierException |
|
377 | + * @throws InvalidEntityException |
|
378 | + */ |
|
379 | + public function insertObjectAt($object, $index, $identifier = null) |
|
380 | + { |
|
381 | + // check to ensure that objects don't already exist in the collection |
|
382 | + if ($this->has($identifier)) { |
|
383 | + throw new DuplicateCollectionIdentifierException($identifier); |
|
384 | + } |
|
385 | + // detach any objects at or past this index |
|
386 | + $remaining_objects = array(); |
|
387 | + if ($index < $this->count()) { |
|
388 | + $remaining_objects = $this->slice($index, $this->count() - $index); |
|
389 | + foreach ($remaining_objects as $key => $remaining_object) { |
|
390 | + // we need to grab the identifiers for each object and use them as keys |
|
391 | + $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object; |
|
392 | + // and then remove the object from the current tracking array |
|
393 | + unset($remaining_objects[ $key ]); |
|
394 | + // and then remove it from the Collection |
|
395 | + $this->detach($remaining_object); |
|
396 | + } |
|
397 | + } |
|
398 | + // add the new object we're splicing in |
|
399 | + $this->add($object, $identifier); |
|
400 | + // attach the objects we previously detached |
|
401 | + foreach ($remaining_objects as $key => $remaining_object) { |
|
402 | + $this->add($remaining_object, $key); |
|
403 | + } |
|
404 | + return $this->contains($object); |
|
405 | + } |
|
406 | + |
|
407 | + |
|
408 | + /** |
|
409 | + * Inserts an object (or an array of objects) at a certain point |
|
410 | + * |
|
411 | + * @see http://stackoverflow.com/a/8736013 |
|
412 | + * @param mixed $objects A single object or an array of objects |
|
413 | + * @param int $index |
|
414 | + */ |
|
415 | + public function insertAt($objects, $index) |
|
416 | + { |
|
417 | + if (! is_array($objects)) { |
|
418 | + $objects = array($objects); |
|
419 | + } |
|
420 | + // check to ensure that objects don't already exist in the collection |
|
421 | + foreach ($objects as $key => $object) { |
|
422 | + if ($this->contains($object)) { |
|
423 | + unset($objects[ $key ]); |
|
424 | + } |
|
425 | + } |
|
426 | + // do we have any objects left? |
|
427 | + if (! $objects) { |
|
428 | + return; |
|
429 | + } |
|
430 | + // detach any objects at or past this index |
|
431 | + $remaining = array(); |
|
432 | + if ($index < $this->count()) { |
|
433 | + $remaining = $this->slice($index, $this->count() - $index); |
|
434 | + foreach ($remaining as $object) { |
|
435 | + $this->detach($object); |
|
436 | + } |
|
437 | + } |
|
438 | + // add the new objects we're splicing in |
|
439 | + foreach ($objects as $object) { |
|
440 | + $this->attach($object); |
|
441 | + } |
|
442 | + // attach the objects we previously detached |
|
443 | + foreach ($remaining as $object) { |
|
444 | + $this->attach($object); |
|
445 | + } |
|
446 | + } |
|
447 | + |
|
448 | + |
|
449 | + /** |
|
450 | + * Removes the object at the given index |
|
451 | + * |
|
452 | + * @see http://stackoverflow.com/a/8736013 |
|
453 | + * @param int $index |
|
454 | + */ |
|
455 | + public function removeAt($index) |
|
456 | + { |
|
457 | + $this->detach($this->objectAtIndex($index)); |
|
458 | + } |
|
459 | + |
|
460 | + |
|
461 | + /** |
|
462 | + * detaches ALL objects from the Collection |
|
463 | + */ |
|
464 | + public function detachAll() |
|
465 | + { |
|
466 | + $this->rewind(); |
|
467 | + while ($this->valid()) { |
|
468 | + $object = $this->current(); |
|
469 | + $this->next(); |
|
470 | + $this->detach($object); |
|
471 | + } |
|
472 | + } |
|
473 | + |
|
474 | + |
|
475 | + /** |
|
476 | + * unsets and detaches ALL objects from the Collection |
|
477 | + */ |
|
478 | + public function trashAndDetachAll() |
|
479 | + { |
|
480 | + $this->rewind(); |
|
481 | + while ($this->valid()) { |
|
482 | + $object = $this->current(); |
|
483 | + $this->next(); |
|
484 | + $this->detach($object); |
|
485 | + unset($object); |
|
486 | + } |
|
487 | + } |
|
488 | 488 | } |
@@ -16,24 +16,24 @@ |
||
16 | 16 | */ |
17 | 17 | class AssetRegistrationException extends RuntimeException |
18 | 18 | { |
19 | - /** |
|
20 | - * @param $script_handle |
|
21 | - * @param string $message |
|
22 | - * @param int $code |
|
23 | - * @param Exception|null $previous |
|
24 | - */ |
|
25 | - public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null) |
|
26 | - { |
|
27 | - if (empty($message)) { |
|
28 | - $message = sprintf( |
|
29 | - esc_html_x( |
|
30 | - 'The "%1$s" script could not be registered with WordPress core.', |
|
31 | - 'The "script-handle" script could not be registered with WordPress core.', |
|
32 | - 'event_espresso' |
|
33 | - ), |
|
34 | - $script_handle |
|
35 | - ); |
|
36 | - } |
|
37 | - parent::__construct($message, $code, $previous); |
|
38 | - } |
|
19 | + /** |
|
20 | + * @param $script_handle |
|
21 | + * @param string $message |
|
22 | + * @param int $code |
|
23 | + * @param Exception|null $previous |
|
24 | + */ |
|
25 | + public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null) |
|
26 | + { |
|
27 | + if (empty($message)) { |
|
28 | + $message = sprintf( |
|
29 | + esc_html_x( |
|
30 | + 'The "%1$s" script could not be registered with WordPress core.', |
|
31 | + 'The "script-handle" script could not be registered with WordPress core.', |
|
32 | + 'event_espresso' |
|
33 | + ), |
|
34 | + $script_handle |
|
35 | + ); |
|
36 | + } |
|
37 | + parent::__construct($message, $code, $previous); |
|
38 | + } |
|
39 | 39 | } |
40 | 40 | \ No newline at end of file |
@@ -16,20 +16,20 @@ |
||
16 | 16 | interface PrivacyPolicyInterface |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * Returns the translated name to display in this privacy policy's section's title |
|
21 | - * |
|
22 | - * @return string |
|
23 | - */ |
|
24 | - public function getName(); |
|
19 | + /** |
|
20 | + * Returns the translated name to display in this privacy policy's section's title |
|
21 | + * |
|
22 | + * @return string |
|
23 | + */ |
|
24 | + public function getName(); |
|
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * Returns the suggested privacy policy content for this plugin. May contain HTML |
|
29 | - * |
|
30 | - * @return string |
|
31 | - */ |
|
32 | - public function getContent(); |
|
27 | + /** |
|
28 | + * Returns the suggested privacy policy content for this plugin. May contain HTML |
|
29 | + * |
|
30 | + * @return string |
|
31 | + */ |
|
32 | + public function getContent(); |
|
33 | 33 | } |
34 | 34 | // End of file PrivacyPolicyInterface.php |
35 | 35 | // Location: EventEspresso\core\domain\services\admin/PrivacyPolicyInterface.php |
@@ -10,8 +10,8 @@ discard block |
||
10 | 10 | // if you're a dev and want to receive all errors via email |
11 | 11 | // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE ); |
12 | 12 | if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) { |
13 | - set_error_handler(array('EE_Error', 'error_handler')); |
|
14 | - register_shutdown_function(array('EE_Error', 'fatal_error_handler')); |
|
13 | + set_error_handler(array('EE_Error', 'error_handler')); |
|
14 | + register_shutdown_function(array('EE_Error', 'fatal_error_handler')); |
|
15 | 15 | } |
16 | 16 | |
17 | 17 | |
@@ -25,251 +25,251 @@ discard block |
||
25 | 25 | class EE_Error extends Exception |
26 | 26 | { |
27 | 27 | |
28 | - const OPTIONS_KEY_NOTICES = 'ee_notices'; |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * name of the file to log exceptions to |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - private static $_exception_log_file = 'espresso_error_log.txt'; |
|
37 | - |
|
38 | - /** |
|
39 | - * stores details for all exception |
|
40 | - * |
|
41 | - * @var array |
|
42 | - */ |
|
43 | - private static $_all_exceptions = array(); |
|
44 | - |
|
45 | - /** |
|
46 | - * tracks number of errors |
|
47 | - * |
|
48 | - * @var int |
|
49 | - */ |
|
50 | - private static $_error_count = 0; |
|
51 | - |
|
52 | - /** |
|
53 | - * @var array $_espresso_notices |
|
54 | - */ |
|
55 | - private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false); |
|
56 | - |
|
57 | - |
|
58 | - /** |
|
59 | - * @override default exception handling |
|
60 | - * @param string $message |
|
61 | - * @param int $code |
|
62 | - * @param Exception|null $previous |
|
63 | - */ |
|
64 | - public function __construct($message, $code = 0, Exception $previous = null) |
|
65 | - { |
|
66 | - if (version_compare(PHP_VERSION, '5.3.0', '<')) { |
|
67 | - parent::__construct($message, $code); |
|
68 | - } else { |
|
69 | - parent::__construct($message, $code, $previous); |
|
70 | - } |
|
71 | - } |
|
72 | - |
|
73 | - |
|
74 | - /** |
|
75 | - * error_handler |
|
76 | - * |
|
77 | - * @param $code |
|
78 | - * @param $message |
|
79 | - * @param $file |
|
80 | - * @param $line |
|
81 | - * @return void |
|
82 | - */ |
|
83 | - public static function error_handler($code, $message, $file, $line) |
|
84 | - { |
|
85 | - $type = EE_Error::error_type($code); |
|
86 | - $site = site_url(); |
|
87 | - switch ($site) { |
|
88 | - case 'http://ee4.eventespresso.com/': |
|
89 | - case 'http://ee4decaf.eventespresso.com/': |
|
90 | - case 'http://ee4hf.eventespresso.com/': |
|
91 | - case 'http://ee4a.eventespresso.com/': |
|
92 | - case 'http://ee4ad.eventespresso.com/': |
|
93 | - case 'http://ee4b.eventespresso.com/': |
|
94 | - case 'http://ee4bd.eventespresso.com/': |
|
95 | - case 'http://ee4d.eventespresso.com/': |
|
96 | - case 'http://ee4dd.eventespresso.com/': |
|
97 | - $to = '[email protected]'; |
|
98 | - break; |
|
99 | - default: |
|
100 | - $to = get_option('admin_email'); |
|
101 | - } |
|
102 | - $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url(); |
|
103 | - $msg = EE_Error::_format_error($type, $message, $file, $line); |
|
104 | - if (function_exists('wp_mail')) { |
|
105 | - add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type')); |
|
106 | - wp_mail($to, $subject, $msg); |
|
107 | - } |
|
108 | - echo '<div id="message" class="espresso-notices error"><p>'; |
|
109 | - echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line; |
|
110 | - echo '<br /></p></div>'; |
|
111 | - } |
|
112 | - |
|
113 | - |
|
114 | - /** |
|
115 | - * error_type |
|
116 | - * http://www.php.net/manual/en/errorfunc.constants.php#109430 |
|
117 | - * |
|
118 | - * @param $code |
|
119 | - * @return string |
|
120 | - */ |
|
121 | - public static function error_type($code) |
|
122 | - { |
|
123 | - switch ($code) { |
|
124 | - case E_ERROR: // 1 // |
|
125 | - return 'E_ERROR'; |
|
126 | - case E_WARNING: // 2 // |
|
127 | - return 'E_WARNING'; |
|
128 | - case E_PARSE: // 4 // |
|
129 | - return 'E_PARSE'; |
|
130 | - case E_NOTICE: // 8 // |
|
131 | - return 'E_NOTICE'; |
|
132 | - case E_CORE_ERROR: // 16 // |
|
133 | - return 'E_CORE_ERROR'; |
|
134 | - case E_CORE_WARNING: // 32 // |
|
135 | - return 'E_CORE_WARNING'; |
|
136 | - case E_COMPILE_ERROR: // 64 // |
|
137 | - return 'E_COMPILE_ERROR'; |
|
138 | - case E_COMPILE_WARNING: // 128 // |
|
139 | - return 'E_COMPILE_WARNING'; |
|
140 | - case E_USER_ERROR: // 256 // |
|
141 | - return 'E_USER_ERROR'; |
|
142 | - case E_USER_WARNING: // 512 // |
|
143 | - return 'E_USER_WARNING'; |
|
144 | - case E_USER_NOTICE: // 1024 // |
|
145 | - return 'E_USER_NOTICE'; |
|
146 | - case E_STRICT: // 2048 // |
|
147 | - return 'E_STRICT'; |
|
148 | - case E_RECOVERABLE_ERROR: // 4096 // |
|
149 | - return 'E_RECOVERABLE_ERROR'; |
|
150 | - case E_DEPRECATED: // 8192 // |
|
151 | - return 'E_DEPRECATED'; |
|
152 | - case E_USER_DEPRECATED: // 16384 // |
|
153 | - return 'E_USER_DEPRECATED'; |
|
154 | - case E_ALL: // 16384 // |
|
155 | - return 'E_ALL'; |
|
156 | - } |
|
157 | - return ''; |
|
158 | - } |
|
159 | - |
|
160 | - |
|
161 | - /** |
|
162 | - * fatal_error_handler |
|
163 | - * |
|
164 | - * @return void |
|
165 | - */ |
|
166 | - public static function fatal_error_handler() |
|
167 | - { |
|
168 | - $last_error = error_get_last(); |
|
169 | - if ($last_error['type'] === E_ERROR) { |
|
170 | - EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']); |
|
171 | - } |
|
172 | - } |
|
173 | - |
|
174 | - |
|
175 | - /** |
|
176 | - * _format_error |
|
177 | - * |
|
178 | - * @param $code |
|
179 | - * @param $message |
|
180 | - * @param $file |
|
181 | - * @param $line |
|
182 | - * @return string |
|
183 | - */ |
|
184 | - private static function _format_error($code, $message, $file, $line) |
|
185 | - { |
|
186 | - $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>"; |
|
187 | - $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>"; |
|
188 | - $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>"; |
|
189 | - $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>"; |
|
190 | - $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>"; |
|
191 | - $html .= '</tbody></table>'; |
|
192 | - return $html; |
|
193 | - } |
|
194 | - |
|
195 | - |
|
196 | - /** |
|
197 | - * set_content_type |
|
198 | - * |
|
199 | - * @param $content_type |
|
200 | - * @return string |
|
201 | - */ |
|
202 | - public static function set_content_type($content_type) |
|
203 | - { |
|
204 | - return 'text/html'; |
|
205 | - } |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * @return void |
|
210 | - * @throws EE_Error |
|
211 | - * @throws ReflectionException |
|
212 | - */ |
|
213 | - public function get_error() |
|
214 | - { |
|
215 | - if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) { |
|
216 | - throw $this; |
|
217 | - } |
|
218 | - // get separate user and developer messages if they exist |
|
219 | - $msg = explode('||', $this->getMessage()); |
|
220 | - $user_msg = $msg[0]; |
|
221 | - $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
222 | - $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
223 | - // add details to _all_exceptions array |
|
224 | - $x_time = time(); |
|
225 | - self::$_all_exceptions[ $x_time ]['name'] = get_class($this); |
|
226 | - self::$_all_exceptions[ $x_time ]['file'] = $this->getFile(); |
|
227 | - self::$_all_exceptions[ $x_time ]['line'] = $this->getLine(); |
|
228 | - self::$_all_exceptions[ $x_time ]['msg'] = $msg; |
|
229 | - self::$_all_exceptions[ $x_time ]['code'] = $this->getCode(); |
|
230 | - self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace(); |
|
231 | - self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString(); |
|
232 | - self::$_error_count++; |
|
233 | - // add_action( 'shutdown', array( $this, 'display_errors' )); |
|
234 | - $this->display_errors(); |
|
235 | - } |
|
236 | - |
|
237 | - |
|
238 | - /** |
|
239 | - * @param bool $check_stored |
|
240 | - * @param string $type_to_check |
|
241 | - * @return bool |
|
242 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
243 | - * @throws \InvalidArgumentException |
|
244 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
245 | - * @throws InvalidInterfaceException |
|
246 | - */ |
|
247 | - public static function has_error($check_stored = false, $type_to_check = 'errors') |
|
248 | - { |
|
249 | - $has_error = isset(self::$_espresso_notices[ $type_to_check ]) |
|
250 | - && ! empty(self::$_espresso_notices[ $type_to_check ]) |
|
251 | - ? true |
|
252 | - : false; |
|
253 | - if ($check_stored && ! $has_error) { |
|
254 | - $notices = EE_Error::getStoredNotices(); |
|
255 | - foreach ($notices as $type => $notice) { |
|
256 | - if ($type === $type_to_check && $notice) { |
|
257 | - return true; |
|
258 | - } |
|
259 | - } |
|
260 | - } |
|
261 | - return $has_error; |
|
262 | - } |
|
263 | - |
|
264 | - |
|
265 | - /** |
|
266 | - * @echo string |
|
267 | - * @throws \ReflectionException |
|
268 | - */ |
|
269 | - public function display_errors() |
|
270 | - { |
|
271 | - $trace_details = ''; |
|
272 | - $output = ' |
|
28 | + const OPTIONS_KEY_NOTICES = 'ee_notices'; |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * name of the file to log exceptions to |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + private static $_exception_log_file = 'espresso_error_log.txt'; |
|
37 | + |
|
38 | + /** |
|
39 | + * stores details for all exception |
|
40 | + * |
|
41 | + * @var array |
|
42 | + */ |
|
43 | + private static $_all_exceptions = array(); |
|
44 | + |
|
45 | + /** |
|
46 | + * tracks number of errors |
|
47 | + * |
|
48 | + * @var int |
|
49 | + */ |
|
50 | + private static $_error_count = 0; |
|
51 | + |
|
52 | + /** |
|
53 | + * @var array $_espresso_notices |
|
54 | + */ |
|
55 | + private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false); |
|
56 | + |
|
57 | + |
|
58 | + /** |
|
59 | + * @override default exception handling |
|
60 | + * @param string $message |
|
61 | + * @param int $code |
|
62 | + * @param Exception|null $previous |
|
63 | + */ |
|
64 | + public function __construct($message, $code = 0, Exception $previous = null) |
|
65 | + { |
|
66 | + if (version_compare(PHP_VERSION, '5.3.0', '<')) { |
|
67 | + parent::__construct($message, $code); |
|
68 | + } else { |
|
69 | + parent::__construct($message, $code, $previous); |
|
70 | + } |
|
71 | + } |
|
72 | + |
|
73 | + |
|
74 | + /** |
|
75 | + * error_handler |
|
76 | + * |
|
77 | + * @param $code |
|
78 | + * @param $message |
|
79 | + * @param $file |
|
80 | + * @param $line |
|
81 | + * @return void |
|
82 | + */ |
|
83 | + public static function error_handler($code, $message, $file, $line) |
|
84 | + { |
|
85 | + $type = EE_Error::error_type($code); |
|
86 | + $site = site_url(); |
|
87 | + switch ($site) { |
|
88 | + case 'http://ee4.eventespresso.com/': |
|
89 | + case 'http://ee4decaf.eventespresso.com/': |
|
90 | + case 'http://ee4hf.eventespresso.com/': |
|
91 | + case 'http://ee4a.eventespresso.com/': |
|
92 | + case 'http://ee4ad.eventespresso.com/': |
|
93 | + case 'http://ee4b.eventespresso.com/': |
|
94 | + case 'http://ee4bd.eventespresso.com/': |
|
95 | + case 'http://ee4d.eventespresso.com/': |
|
96 | + case 'http://ee4dd.eventespresso.com/': |
|
97 | + $to = '[email protected]'; |
|
98 | + break; |
|
99 | + default: |
|
100 | + $to = get_option('admin_email'); |
|
101 | + } |
|
102 | + $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url(); |
|
103 | + $msg = EE_Error::_format_error($type, $message, $file, $line); |
|
104 | + if (function_exists('wp_mail')) { |
|
105 | + add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type')); |
|
106 | + wp_mail($to, $subject, $msg); |
|
107 | + } |
|
108 | + echo '<div id="message" class="espresso-notices error"><p>'; |
|
109 | + echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line; |
|
110 | + echo '<br /></p></div>'; |
|
111 | + } |
|
112 | + |
|
113 | + |
|
114 | + /** |
|
115 | + * error_type |
|
116 | + * http://www.php.net/manual/en/errorfunc.constants.php#109430 |
|
117 | + * |
|
118 | + * @param $code |
|
119 | + * @return string |
|
120 | + */ |
|
121 | + public static function error_type($code) |
|
122 | + { |
|
123 | + switch ($code) { |
|
124 | + case E_ERROR: // 1 // |
|
125 | + return 'E_ERROR'; |
|
126 | + case E_WARNING: // 2 // |
|
127 | + return 'E_WARNING'; |
|
128 | + case E_PARSE: // 4 // |
|
129 | + return 'E_PARSE'; |
|
130 | + case E_NOTICE: // 8 // |
|
131 | + return 'E_NOTICE'; |
|
132 | + case E_CORE_ERROR: // 16 // |
|
133 | + return 'E_CORE_ERROR'; |
|
134 | + case E_CORE_WARNING: // 32 // |
|
135 | + return 'E_CORE_WARNING'; |
|
136 | + case E_COMPILE_ERROR: // 64 // |
|
137 | + return 'E_COMPILE_ERROR'; |
|
138 | + case E_COMPILE_WARNING: // 128 // |
|
139 | + return 'E_COMPILE_WARNING'; |
|
140 | + case E_USER_ERROR: // 256 // |
|
141 | + return 'E_USER_ERROR'; |
|
142 | + case E_USER_WARNING: // 512 // |
|
143 | + return 'E_USER_WARNING'; |
|
144 | + case E_USER_NOTICE: // 1024 // |
|
145 | + return 'E_USER_NOTICE'; |
|
146 | + case E_STRICT: // 2048 // |
|
147 | + return 'E_STRICT'; |
|
148 | + case E_RECOVERABLE_ERROR: // 4096 // |
|
149 | + return 'E_RECOVERABLE_ERROR'; |
|
150 | + case E_DEPRECATED: // 8192 // |
|
151 | + return 'E_DEPRECATED'; |
|
152 | + case E_USER_DEPRECATED: // 16384 // |
|
153 | + return 'E_USER_DEPRECATED'; |
|
154 | + case E_ALL: // 16384 // |
|
155 | + return 'E_ALL'; |
|
156 | + } |
|
157 | + return ''; |
|
158 | + } |
|
159 | + |
|
160 | + |
|
161 | + /** |
|
162 | + * fatal_error_handler |
|
163 | + * |
|
164 | + * @return void |
|
165 | + */ |
|
166 | + public static function fatal_error_handler() |
|
167 | + { |
|
168 | + $last_error = error_get_last(); |
|
169 | + if ($last_error['type'] === E_ERROR) { |
|
170 | + EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']); |
|
171 | + } |
|
172 | + } |
|
173 | + |
|
174 | + |
|
175 | + /** |
|
176 | + * _format_error |
|
177 | + * |
|
178 | + * @param $code |
|
179 | + * @param $message |
|
180 | + * @param $file |
|
181 | + * @param $line |
|
182 | + * @return string |
|
183 | + */ |
|
184 | + private static function _format_error($code, $message, $file, $line) |
|
185 | + { |
|
186 | + $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>"; |
|
187 | + $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>"; |
|
188 | + $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>"; |
|
189 | + $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>"; |
|
190 | + $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>"; |
|
191 | + $html .= '</tbody></table>'; |
|
192 | + return $html; |
|
193 | + } |
|
194 | + |
|
195 | + |
|
196 | + /** |
|
197 | + * set_content_type |
|
198 | + * |
|
199 | + * @param $content_type |
|
200 | + * @return string |
|
201 | + */ |
|
202 | + public static function set_content_type($content_type) |
|
203 | + { |
|
204 | + return 'text/html'; |
|
205 | + } |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * @return void |
|
210 | + * @throws EE_Error |
|
211 | + * @throws ReflectionException |
|
212 | + */ |
|
213 | + public function get_error() |
|
214 | + { |
|
215 | + if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) { |
|
216 | + throw $this; |
|
217 | + } |
|
218 | + // get separate user and developer messages if they exist |
|
219 | + $msg = explode('||', $this->getMessage()); |
|
220 | + $user_msg = $msg[0]; |
|
221 | + $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
222 | + $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
223 | + // add details to _all_exceptions array |
|
224 | + $x_time = time(); |
|
225 | + self::$_all_exceptions[ $x_time ]['name'] = get_class($this); |
|
226 | + self::$_all_exceptions[ $x_time ]['file'] = $this->getFile(); |
|
227 | + self::$_all_exceptions[ $x_time ]['line'] = $this->getLine(); |
|
228 | + self::$_all_exceptions[ $x_time ]['msg'] = $msg; |
|
229 | + self::$_all_exceptions[ $x_time ]['code'] = $this->getCode(); |
|
230 | + self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace(); |
|
231 | + self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString(); |
|
232 | + self::$_error_count++; |
|
233 | + // add_action( 'shutdown', array( $this, 'display_errors' )); |
|
234 | + $this->display_errors(); |
|
235 | + } |
|
236 | + |
|
237 | + |
|
238 | + /** |
|
239 | + * @param bool $check_stored |
|
240 | + * @param string $type_to_check |
|
241 | + * @return bool |
|
242 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
243 | + * @throws \InvalidArgumentException |
|
244 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
245 | + * @throws InvalidInterfaceException |
|
246 | + */ |
|
247 | + public static function has_error($check_stored = false, $type_to_check = 'errors') |
|
248 | + { |
|
249 | + $has_error = isset(self::$_espresso_notices[ $type_to_check ]) |
|
250 | + && ! empty(self::$_espresso_notices[ $type_to_check ]) |
|
251 | + ? true |
|
252 | + : false; |
|
253 | + if ($check_stored && ! $has_error) { |
|
254 | + $notices = EE_Error::getStoredNotices(); |
|
255 | + foreach ($notices as $type => $notice) { |
|
256 | + if ($type === $type_to_check && $notice) { |
|
257 | + return true; |
|
258 | + } |
|
259 | + } |
|
260 | + } |
|
261 | + return $has_error; |
|
262 | + } |
|
263 | + |
|
264 | + |
|
265 | + /** |
|
266 | + * @echo string |
|
267 | + * @throws \ReflectionException |
|
268 | + */ |
|
269 | + public function display_errors() |
|
270 | + { |
|
271 | + $trace_details = ''; |
|
272 | + $output = ' |
|
273 | 273 | <style type="text/css"> |
274 | 274 | #ee-error-message { |
275 | 275 | max-width:90% !important; |
@@ -325,21 +325,21 @@ discard block |
||
325 | 325 | } |
326 | 326 | </style> |
327 | 327 | <div id="ee-error-message" class="error">'; |
328 | - if (! WP_DEBUG) { |
|
329 | - $output .= ' |
|
328 | + if (! WP_DEBUG) { |
|
329 | + $output .= ' |
|
330 | 330 | <p>'; |
331 | - } |
|
332 | - // cycle thru errors |
|
333 | - foreach (self::$_all_exceptions as $time => $ex) { |
|
334 | - $error_code = ''; |
|
335 | - // process trace info |
|
336 | - if (empty($ex['trace'])) { |
|
337 | - $trace_details .= __( |
|
338 | - 'Sorry, but no trace information was available for this exception.', |
|
339 | - 'event_espresso' |
|
340 | - ); |
|
341 | - } else { |
|
342 | - $trace_details .= ' |
|
331 | + } |
|
332 | + // cycle thru errors |
|
333 | + foreach (self::$_all_exceptions as $time => $ex) { |
|
334 | + $error_code = ''; |
|
335 | + // process trace info |
|
336 | + if (empty($ex['trace'])) { |
|
337 | + $trace_details .= __( |
|
338 | + 'Sorry, but no trace information was available for this exception.', |
|
339 | + 'event_espresso' |
|
340 | + ); |
|
341 | + } else { |
|
342 | + $trace_details .= ' |
|
343 | 343 | <div id="ee-trace-details"> |
344 | 344 | <table width="100%" border="0" cellpadding="5" cellspacing="0"> |
345 | 345 | <tr> |
@@ -349,43 +349,43 @@ discard block |
||
349 | 349 | <th scope="col" align="left">Class</th> |
350 | 350 | <th scope="col" align="left">Method( arguments )</th> |
351 | 351 | </tr>'; |
352 | - $last_on_stack = count($ex['trace']) - 1; |
|
353 | - // reverse array so that stack is in proper chronological order |
|
354 | - $sorted_trace = array_reverse($ex['trace']); |
|
355 | - foreach ($sorted_trace as $nmbr => $trace) { |
|
356 | - $file = isset($trace['file']) ? $trace['file'] : ''; |
|
357 | - $class = isset($trace['class']) ? $trace['class'] : ''; |
|
358 | - $type = isset($trace['type']) ? $trace['type'] : ''; |
|
359 | - $function = isset($trace['function']) ? $trace['function'] : ''; |
|
360 | - $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : ''; |
|
361 | - $line = isset($trace['line']) ? $trace['line'] : ''; |
|
362 | - $zebra = ($nmbr % 2) ? ' odd' : ''; |
|
363 | - if (empty($file) && ! empty($class)) { |
|
364 | - $a = new ReflectionClass($class); |
|
365 | - $file = $a->getFileName(); |
|
366 | - if (empty($line) && ! empty($function)) { |
|
367 | - try { |
|
368 | - // if $function is a closure, this throws an exception |
|
369 | - $b = new ReflectionMethod($class, $function); |
|
370 | - $line = $b->getStartLine(); |
|
371 | - } catch (Exception $closure_exception) { |
|
372 | - $line = 'unknown'; |
|
373 | - } |
|
374 | - } |
|
375 | - } |
|
376 | - if ($nmbr === $last_on_stack) { |
|
377 | - $file = $ex['file'] !== '' ? $ex['file'] : $file; |
|
378 | - $line = $ex['line'] !== '' ? $ex['line'] : $line; |
|
379 | - $error_code = self::generate_error_code($file, $trace['function'], $line); |
|
380 | - } |
|
381 | - $nmbr_dsply = ! empty($nmbr) ? $nmbr : ' '; |
|
382 | - $line_dsply = ! empty($line) ? $line : ' '; |
|
383 | - $file_dsply = ! empty($file) ? $file : ' '; |
|
384 | - $class_dsply = ! empty($class) ? $class : ' '; |
|
385 | - $type_dsply = ! empty($type) ? $type : ' '; |
|
386 | - $function_dsply = ! empty($function) ? $function : ' '; |
|
387 | - $args_dsply = ! empty($args) ? '( ' . $args . ' )' : ''; |
|
388 | - $trace_details .= ' |
|
352 | + $last_on_stack = count($ex['trace']) - 1; |
|
353 | + // reverse array so that stack is in proper chronological order |
|
354 | + $sorted_trace = array_reverse($ex['trace']); |
|
355 | + foreach ($sorted_trace as $nmbr => $trace) { |
|
356 | + $file = isset($trace['file']) ? $trace['file'] : ''; |
|
357 | + $class = isset($trace['class']) ? $trace['class'] : ''; |
|
358 | + $type = isset($trace['type']) ? $trace['type'] : ''; |
|
359 | + $function = isset($trace['function']) ? $trace['function'] : ''; |
|
360 | + $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : ''; |
|
361 | + $line = isset($trace['line']) ? $trace['line'] : ''; |
|
362 | + $zebra = ($nmbr % 2) ? ' odd' : ''; |
|
363 | + if (empty($file) && ! empty($class)) { |
|
364 | + $a = new ReflectionClass($class); |
|
365 | + $file = $a->getFileName(); |
|
366 | + if (empty($line) && ! empty($function)) { |
|
367 | + try { |
|
368 | + // if $function is a closure, this throws an exception |
|
369 | + $b = new ReflectionMethod($class, $function); |
|
370 | + $line = $b->getStartLine(); |
|
371 | + } catch (Exception $closure_exception) { |
|
372 | + $line = 'unknown'; |
|
373 | + } |
|
374 | + } |
|
375 | + } |
|
376 | + if ($nmbr === $last_on_stack) { |
|
377 | + $file = $ex['file'] !== '' ? $ex['file'] : $file; |
|
378 | + $line = $ex['line'] !== '' ? $ex['line'] : $line; |
|
379 | + $error_code = self::generate_error_code($file, $trace['function'], $line); |
|
380 | + } |
|
381 | + $nmbr_dsply = ! empty($nmbr) ? $nmbr : ' '; |
|
382 | + $line_dsply = ! empty($line) ? $line : ' '; |
|
383 | + $file_dsply = ! empty($file) ? $file : ' '; |
|
384 | + $class_dsply = ! empty($class) ? $class : ' '; |
|
385 | + $type_dsply = ! empty($type) ? $type : ' '; |
|
386 | + $function_dsply = ! empty($function) ? $function : ' '; |
|
387 | + $args_dsply = ! empty($args) ? '( ' . $args . ' )' : ''; |
|
388 | + $trace_details .= ' |
|
389 | 389 | <tr> |
390 | 390 | <td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td> |
391 | 391 | <td align="right" class="' . $zebra . '">' . $line_dsply . '</td> |
@@ -393,626 +393,626 @@ discard block |
||
393 | 393 | <td align="left" class="' . $zebra . '">' . $class_dsply . '</td> |
394 | 394 | <td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td> |
395 | 395 | </tr>'; |
396 | - } |
|
397 | - $trace_details .= ' |
|
396 | + } |
|
397 | + $trace_details .= ' |
|
398 | 398 | </table> |
399 | 399 | </div>'; |
400 | - } |
|
401 | - $ex['code'] = $ex['code'] ? $ex['code'] : $error_code; |
|
402 | - // add generic non-identifying messages for non-privileged users |
|
403 | - if (! WP_DEBUG) { |
|
404 | - $output .= '<span class="ee-error-user-msg-spn">' |
|
405 | - . trim($ex['msg']) |
|
406 | - . '</span> <sup>' |
|
407 | - . $ex['code'] |
|
408 | - . '</sup><br />'; |
|
409 | - } else { |
|
410 | - // or helpful developer messages if debugging is on |
|
411 | - $output .= ' |
|
400 | + } |
|
401 | + $ex['code'] = $ex['code'] ? $ex['code'] : $error_code; |
|
402 | + // add generic non-identifying messages for non-privileged users |
|
403 | + if (! WP_DEBUG) { |
|
404 | + $output .= '<span class="ee-error-user-msg-spn">' |
|
405 | + . trim($ex['msg']) |
|
406 | + . '</span> <sup>' |
|
407 | + . $ex['code'] |
|
408 | + . '</sup><br />'; |
|
409 | + } else { |
|
410 | + // or helpful developer messages if debugging is on |
|
411 | + $output .= ' |
|
412 | 412 | <div class="ee-error-dev-msg-dv"> |
413 | 413 | <p class="ee-error-dev-msg-pg"> |
414 | 414 | <strong class="ee-error-dev-msg-str">An ' |
415 | - . $ex['name'] |
|
416 | - . ' exception was thrown!</strong> <span>code: ' |
|
417 | - . $ex['code'] |
|
418 | - . '</span><br /> |
|
415 | + . $ex['name'] |
|
416 | + . ' exception was thrown!</strong> <span>code: ' |
|
417 | + . $ex['code'] |
|
418 | + . '</span><br /> |
|
419 | 419 | <span class="big-text">"' |
420 | - . trim($ex['msg']) |
|
421 | - . '"</span><br/> |
|
420 | + . trim($ex['msg']) |
|
421 | + . '"</span><br/> |
|
422 | 422 | <a id="display-ee-error-trace-' |
423 | - . self::$_error_count |
|
424 | - . $time |
|
425 | - . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-' |
|
426 | - . self::$_error_count |
|
427 | - . $time |
|
428 | - . '"> |
|
423 | + . self::$_error_count |
|
424 | + . $time |
|
425 | + . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-' |
|
426 | + . self::$_error_count |
|
427 | + . $time |
|
428 | + . '"> |
|
429 | 429 | ' |
430 | - . __('click to view backtrace and class/method details', 'event_espresso') |
|
431 | - . ' |
|
430 | + . __('click to view backtrace and class/method details', 'event_espresso') |
|
431 | + . ' |
|
432 | 432 | </a><br /> |
433 | 433 | <span class="small-text lt-grey-text">' |
434 | - . $ex['file'] |
|
435 | - . ' ( line no: ' |
|
436 | - . $ex['line'] |
|
437 | - . ' )</span> |
|
434 | + . $ex['file'] |
|
435 | + . ' ( line no: ' |
|
436 | + . $ex['line'] |
|
437 | + . ' )</span> |
|
438 | 438 | </p> |
439 | 439 | <div id="ee-error-trace-' |
440 | - . self::$_error_count |
|
441 | - . $time |
|
442 | - . '-dv" class="ee-error-trace-dv" style="display: none;"> |
|
440 | + . self::$_error_count |
|
441 | + . $time |
|
442 | + . '-dv" class="ee-error-trace-dv" style="display: none;"> |
|
443 | 443 | ' |
444 | - . $trace_details; |
|
445 | - if (! empty($class)) { |
|
446 | - $output .= ' |
|
444 | + . $trace_details; |
|
445 | + if (! empty($class)) { |
|
446 | + $output .= ' |
|
447 | 447 | <div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;"> |
448 | 448 | <div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;"> |
449 | 449 | <h3>Class Details</h3>'; |
450 | - $a = new ReflectionClass($class); |
|
451 | - $output .= ' |
|
450 | + $a = new ReflectionClass($class); |
|
451 | + $output .= ' |
|
452 | 452 | <pre>' . $a . '</pre> |
453 | 453 | </div> |
454 | 454 | </div>'; |
455 | - } |
|
456 | - $output .= ' |
|
455 | + } |
|
456 | + $output .= ' |
|
457 | 457 | </div> |
458 | 458 | </div> |
459 | 459 | <br />'; |
460 | - } |
|
461 | - $this->write_to_error_log($time, $ex); |
|
462 | - } |
|
463 | - // remove last linebreak |
|
464 | - $output = substr($output, 0, -6); |
|
465 | - if (! WP_DEBUG) { |
|
466 | - $output .= ' |
|
460 | + } |
|
461 | + $this->write_to_error_log($time, $ex); |
|
462 | + } |
|
463 | + // remove last linebreak |
|
464 | + $output = substr($output, 0, -6); |
|
465 | + if (! WP_DEBUG) { |
|
466 | + $output .= ' |
|
467 | 467 | </p>'; |
468 | - } |
|
469 | - $output .= ' |
|
468 | + } |
|
469 | + $output .= ' |
|
470 | 470 | </div>'; |
471 | - $output .= self::_print_scripts(true); |
|
472 | - if (defined('DOING_AJAX')) { |
|
473 | - echo wp_json_encode(array('error' => $output)); |
|
474 | - exit(); |
|
475 | - } |
|
476 | - echo $output; |
|
477 | - die(); |
|
478 | - } |
|
479 | - |
|
480 | - |
|
481 | - /** |
|
482 | - * generate string from exception trace args |
|
483 | - * |
|
484 | - * @param array $arguments |
|
485 | - * @param bool $array |
|
486 | - * @return string |
|
487 | - */ |
|
488 | - private function _convert_args_to_string($arguments = array(), $array = false) |
|
489 | - { |
|
490 | - $arg_string = ''; |
|
491 | - if (! empty($arguments)) { |
|
492 | - $args = array(); |
|
493 | - foreach ($arguments as $arg) { |
|
494 | - if (! empty($arg)) { |
|
495 | - if (is_string($arg)) { |
|
496 | - $args[] = " '" . $arg . "'"; |
|
497 | - } elseif (is_array($arg)) { |
|
498 | - $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true); |
|
499 | - } elseif ($arg === null) { |
|
500 | - $args[] = ' NULL'; |
|
501 | - } elseif (is_bool($arg)) { |
|
502 | - $args[] = ($arg) ? ' TRUE' : ' FALSE'; |
|
503 | - } elseif (is_object($arg)) { |
|
504 | - $args[] = ' OBJECT ' . get_class($arg); |
|
505 | - } elseif (is_resource($arg)) { |
|
506 | - $args[] = get_resource_type($arg); |
|
507 | - } else { |
|
508 | - $args[] = $arg; |
|
509 | - } |
|
510 | - } |
|
511 | - } |
|
512 | - $arg_string = implode(', ', $args); |
|
513 | - } |
|
514 | - if ($array) { |
|
515 | - $arg_string .= ' )'; |
|
516 | - } |
|
517 | - return $arg_string; |
|
518 | - } |
|
519 | - |
|
520 | - |
|
521 | - /** |
|
522 | - * add error message |
|
523 | - * |
|
524 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
525 | - * separate messages for user || dev |
|
526 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
527 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
528 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
529 | - * @return void |
|
530 | - */ |
|
531 | - public static function add_error($msg = null, $file = null, $func = null, $line = null) |
|
532 | - { |
|
533 | - self::_add_notice('errors', $msg, $file, $func, $line); |
|
534 | - self::$_error_count++; |
|
535 | - } |
|
536 | - |
|
537 | - |
|
538 | - /** |
|
539 | - * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just |
|
540 | - * adds an error |
|
541 | - * |
|
542 | - * @param string $msg |
|
543 | - * @param string $file |
|
544 | - * @param string $func |
|
545 | - * @param string $line |
|
546 | - * @throws EE_Error |
|
547 | - */ |
|
548 | - public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null) |
|
549 | - { |
|
550 | - if (WP_DEBUG) { |
|
551 | - throw new EE_Error($msg); |
|
552 | - } |
|
553 | - EE_Error::add_error($msg, $file, $func, $line); |
|
554 | - } |
|
555 | - |
|
556 | - |
|
557 | - /** |
|
558 | - * add success message |
|
559 | - * |
|
560 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
561 | - * separate messages for user || dev |
|
562 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
563 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
564 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
565 | - * @return void |
|
566 | - */ |
|
567 | - public static function add_success($msg = null, $file = null, $func = null, $line = null) |
|
568 | - { |
|
569 | - self::_add_notice('success', $msg, $file, $func, $line); |
|
570 | - } |
|
571 | - |
|
572 | - |
|
573 | - /** |
|
574 | - * add attention message |
|
575 | - * |
|
576 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
577 | - * separate messages for user || dev |
|
578 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
579 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
580 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
581 | - * @return void |
|
582 | - */ |
|
583 | - public static function add_attention($msg = null, $file = null, $func = null, $line = null) |
|
584 | - { |
|
585 | - self::_add_notice('attention', $msg, $file, $func, $line); |
|
586 | - } |
|
587 | - |
|
588 | - |
|
589 | - /** |
|
590 | - * @param string $type whether the message is for a success or error notification |
|
591 | - * @param string $msg the message to display to users or developers |
|
592 | - * - adding a double pipe || (OR) creates separate messages for user || dev |
|
593 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
594 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
595 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
596 | - * @return void |
|
597 | - */ |
|
598 | - private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '') |
|
599 | - { |
|
600 | - if (empty($msg)) { |
|
601 | - EE_Error::doing_it_wrong( |
|
602 | - 'EE_Error::add_' . $type . '()', |
|
603 | - sprintf( |
|
604 | - __( |
|
605 | - 'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', |
|
606 | - 'event_espresso' |
|
607 | - ), |
|
608 | - $type, |
|
609 | - $file, |
|
610 | - $line |
|
611 | - ), |
|
612 | - EVENT_ESPRESSO_VERSION |
|
613 | - ); |
|
614 | - } |
|
615 | - if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) { |
|
616 | - EE_Error::doing_it_wrong( |
|
617 | - 'EE_Error::add_error()', |
|
618 | - __( |
|
619 | - 'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', |
|
620 | - 'event_espresso' |
|
621 | - ), |
|
622 | - EVENT_ESPRESSO_VERSION |
|
623 | - ); |
|
624 | - } |
|
625 | - // get separate user and developer messages if they exist |
|
626 | - $msg = explode('||', $msg); |
|
627 | - $user_msg = $msg[0]; |
|
628 | - $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
629 | - /** |
|
630 | - * Do an action so other code can be triggered when a notice is created |
|
631 | - * |
|
632 | - * @param string $type can be 'errors', 'attention', or 'success' |
|
633 | - * @param string $user_msg message displayed to user when WP_DEBUG is off |
|
634 | - * @param string $user_msg message displayed to user when WP_DEBUG is on |
|
635 | - * @param string $file file where error was generated |
|
636 | - * @param string $func function where error was generated |
|
637 | - * @param string $line line where error was generated |
|
638 | - */ |
|
639 | - do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line); |
|
640 | - $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
641 | - // add notice if message exists |
|
642 | - if (! empty($msg)) { |
|
643 | - // get error code |
|
644 | - $notice_code = EE_Error::generate_error_code($file, $func, $line); |
|
645 | - if (WP_DEBUG && $type === 'errors') { |
|
646 | - $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>'; |
|
647 | - } |
|
648 | - // add notice. Index by code if it's not blank |
|
649 | - if ($notice_code) { |
|
650 | - self::$_espresso_notices[ $type ][ $notice_code ] = $msg; |
|
651 | - } else { |
|
652 | - self::$_espresso_notices[ $type ][] = $msg; |
|
653 | - } |
|
654 | - add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1); |
|
655 | - } |
|
656 | - } |
|
657 | - |
|
658 | - |
|
659 | - /** |
|
660 | - * in some case it may be necessary to overwrite the existing success messages |
|
661 | - * |
|
662 | - * @return void |
|
663 | - */ |
|
664 | - public static function overwrite_success() |
|
665 | - { |
|
666 | - self::$_espresso_notices['success'] = false; |
|
667 | - } |
|
668 | - |
|
669 | - |
|
670 | - /** |
|
671 | - * in some case it may be necessary to overwrite the existing attention messages |
|
672 | - * |
|
673 | - * @return void |
|
674 | - */ |
|
675 | - public static function overwrite_attention() |
|
676 | - { |
|
677 | - self::$_espresso_notices['attention'] = false; |
|
678 | - } |
|
679 | - |
|
680 | - |
|
681 | - /** |
|
682 | - * in some case it may be necessary to overwrite the existing error messages |
|
683 | - * |
|
684 | - * @return void |
|
685 | - */ |
|
686 | - public static function overwrite_errors() |
|
687 | - { |
|
688 | - self::$_espresso_notices['errors'] = false; |
|
689 | - } |
|
690 | - |
|
691 | - |
|
692 | - /** |
|
693 | - * @return void |
|
694 | - */ |
|
695 | - public static function reset_notices() |
|
696 | - { |
|
697 | - self::$_espresso_notices['success'] = false; |
|
698 | - self::$_espresso_notices['attention'] = false; |
|
699 | - self::$_espresso_notices['errors'] = false; |
|
700 | - } |
|
701 | - |
|
702 | - |
|
703 | - /** |
|
704 | - * @return int |
|
705 | - */ |
|
706 | - public static function has_notices() |
|
707 | - { |
|
708 | - $has_notices = 0; |
|
709 | - // check for success messages |
|
710 | - $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) |
|
711 | - ? 3 |
|
712 | - : $has_notices; |
|
713 | - // check for attention messages |
|
714 | - $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) |
|
715 | - ? 2 |
|
716 | - : $has_notices; |
|
717 | - // check for error messages |
|
718 | - $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) |
|
719 | - ? 1 |
|
720 | - : $has_notices; |
|
721 | - return $has_notices; |
|
722 | - } |
|
723 | - |
|
724 | - |
|
725 | - /** |
|
726 | - * This simply returns non formatted error notices as they were sent into the EE_Error object. |
|
727 | - * |
|
728 | - * @since 4.9.0 |
|
729 | - * @return array |
|
730 | - */ |
|
731 | - public static function get_vanilla_notices() |
|
732 | - { |
|
733 | - return array( |
|
734 | - 'success' => isset(self::$_espresso_notices['success']) |
|
735 | - ? self::$_espresso_notices['success'] |
|
736 | - : array(), |
|
737 | - 'attention' => isset(self::$_espresso_notices['attention']) |
|
738 | - ? self::$_espresso_notices['attention'] |
|
739 | - : array(), |
|
740 | - 'errors' => isset(self::$_espresso_notices['errors']) |
|
741 | - ? self::$_espresso_notices['errors'] |
|
742 | - : array(), |
|
743 | - ); |
|
744 | - } |
|
745 | - |
|
746 | - |
|
747 | - /** |
|
748 | - * @return array |
|
749 | - * @throws InvalidArgumentException |
|
750 | - * @throws InvalidDataTypeException |
|
751 | - * @throws InvalidInterfaceException |
|
752 | - */ |
|
753 | - public static function getStoredNotices() |
|
754 | - { |
|
755 | - if ($user_id = get_current_user_id()) { |
|
756 | - // get notices for logged in user |
|
757 | - $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id); |
|
758 | - return is_array($notices) ? $notices : array(); |
|
759 | - } |
|
760 | - if (EE_Session::isLoadedAndActive()) { |
|
761 | - // get notices for user currently engaged in a session |
|
762 | - $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES); |
|
763 | - return is_array($session_data) ? $session_data : array(); |
|
764 | - } |
|
765 | - // get global notices and hope they apply to the current site visitor |
|
766 | - $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array()); |
|
767 | - return is_array($notices) ? $notices : array(); |
|
768 | - } |
|
769 | - |
|
770 | - |
|
771 | - /** |
|
772 | - * @param array $notices |
|
773 | - * @return bool |
|
774 | - * @throws InvalidArgumentException |
|
775 | - * @throws InvalidDataTypeException |
|
776 | - * @throws InvalidInterfaceException |
|
777 | - */ |
|
778 | - public static function storeNotices(array $notices) |
|
779 | - { |
|
780 | - if ($user_id = get_current_user_id()) { |
|
781 | - // store notices for logged in user |
|
782 | - return (bool) update_user_option( |
|
783 | - $user_id, |
|
784 | - EE_Error::OPTIONS_KEY_NOTICES, |
|
785 | - $notices |
|
786 | - ); |
|
787 | - } |
|
788 | - if (EE_Session::isLoadedAndActive()) { |
|
789 | - // store notices for user currently engaged in a session |
|
790 | - return EE_Session::instance()->set_session_data( |
|
791 | - array(EE_Error::OPTIONS_KEY_NOTICES => $notices) |
|
792 | - ); |
|
793 | - } |
|
794 | - // store global notices and hope they apply to the same site visitor on the next request |
|
795 | - return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices); |
|
796 | - } |
|
797 | - |
|
798 | - |
|
799 | - /** |
|
800 | - * @return bool|TRUE |
|
801 | - * @throws InvalidArgumentException |
|
802 | - * @throws InvalidDataTypeException |
|
803 | - * @throws InvalidInterfaceException |
|
804 | - */ |
|
805 | - public static function clearNotices() |
|
806 | - { |
|
807 | - if ($user_id = get_current_user_id()) { |
|
808 | - // clear notices for logged in user |
|
809 | - return (bool) update_user_option( |
|
810 | - $user_id, |
|
811 | - EE_Error::OPTIONS_KEY_NOTICES, |
|
812 | - array() |
|
813 | - ); |
|
814 | - } |
|
815 | - if (EE_Session::isLoadedAndActive()) { |
|
816 | - // clear notices for user currently engaged in a session |
|
817 | - return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES); |
|
818 | - } |
|
819 | - // clear global notices and hope none belonged to some for some other site visitor |
|
820 | - return update_option(EE_Error::OPTIONS_KEY_NOTICES, array()); |
|
821 | - } |
|
822 | - |
|
823 | - |
|
824 | - /** |
|
825 | - * saves notices to the db for retrieval on next request |
|
826 | - * |
|
827 | - * @return void |
|
828 | - * @throws InvalidArgumentException |
|
829 | - * @throws InvalidDataTypeException |
|
830 | - * @throws InvalidInterfaceException |
|
831 | - */ |
|
832 | - public static function stashNoticesBeforeRedirect() |
|
833 | - { |
|
834 | - EE_Error::get_notices(false, true); |
|
835 | - } |
|
836 | - |
|
837 | - |
|
838 | - /** |
|
839 | - * compile all error or success messages into one string |
|
840 | - * |
|
841 | - * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them |
|
842 | - * @param boolean $format_output whether or not to format the messages for display in the WP admin |
|
843 | - * @param boolean $save_to_transient whether or not to save notices to the db for retrieval on next request |
|
844 | - * - ONLY do this just before redirecting |
|
845 | - * @param boolean $remove_empty whether or not to unset empty messages |
|
846 | - * @return array |
|
847 | - * @throws InvalidArgumentException |
|
848 | - * @throws InvalidDataTypeException |
|
849 | - * @throws InvalidInterfaceException |
|
850 | - */ |
|
851 | - public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true) |
|
852 | - { |
|
853 | - $success_messages = ''; |
|
854 | - $attention_messages = ''; |
|
855 | - $error_messages = ''; |
|
856 | - // either save notices to the db |
|
857 | - if ($save_to_transient || isset($_REQUEST['activate-selected'])) { |
|
858 | - self::$_espresso_notices = array_merge( |
|
859 | - EE_Error::getStoredNotices(), |
|
860 | - self::$_espresso_notices |
|
861 | - ); |
|
862 | - EE_Error::storeNotices(self::$_espresso_notices); |
|
863 | - return array(); |
|
864 | - } |
|
865 | - $print_scripts = EE_Error::combineExistingAndNewNotices(); |
|
866 | - // check for success messages |
|
867 | - if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) { |
|
868 | - // combine messages |
|
869 | - $success_messages .= implode(self::$_espresso_notices['success'], '<br />'); |
|
870 | - $print_scripts = true; |
|
871 | - } |
|
872 | - // check for attention messages |
|
873 | - if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) { |
|
874 | - // combine messages |
|
875 | - $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />'); |
|
876 | - $print_scripts = true; |
|
877 | - } |
|
878 | - // check for error messages |
|
879 | - if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) { |
|
880 | - $error_messages .= count(self::$_espresso_notices['errors']) > 1 |
|
881 | - ? __('The following errors have occurred:<br />', 'event_espresso') |
|
882 | - : __('An error has occurred:<br />', 'event_espresso'); |
|
883 | - // combine messages |
|
884 | - $error_messages .= implode(self::$_espresso_notices['errors'], '<br />'); |
|
885 | - $print_scripts = true; |
|
886 | - } |
|
887 | - if ($format_output) { |
|
888 | - $notices = EE_Error::formatNoticesOutput( |
|
889 | - $success_messages, |
|
890 | - $attention_messages, |
|
891 | - $error_messages |
|
892 | - ); |
|
893 | - } else { |
|
894 | - $notices = array( |
|
895 | - 'success' => $success_messages, |
|
896 | - 'attention' => $attention_messages, |
|
897 | - 'errors' => $error_messages, |
|
898 | - ); |
|
899 | - if ($remove_empty) { |
|
900 | - // remove empty notices |
|
901 | - foreach ($notices as $type => $notice) { |
|
902 | - if (empty($notice)) { |
|
903 | - unset($notices[ $type ]); |
|
904 | - } |
|
905 | - } |
|
906 | - } |
|
907 | - } |
|
908 | - if ($print_scripts) { |
|
909 | - self::_print_scripts(); |
|
910 | - } |
|
911 | - return $notices; |
|
912 | - } |
|
913 | - |
|
914 | - |
|
915 | - /** |
|
916 | - * @return bool |
|
917 | - * @throws InvalidArgumentException |
|
918 | - * @throws InvalidDataTypeException |
|
919 | - * @throws InvalidInterfaceException |
|
920 | - */ |
|
921 | - private static function combineExistingAndNewNotices() |
|
922 | - { |
|
923 | - $print_scripts = false; |
|
924 | - // grab any notices that have been previously saved |
|
925 | - $notices = EE_Error::getStoredNotices(); |
|
926 | - if (! empty($notices)) { |
|
927 | - foreach ($notices as $type => $notice) { |
|
928 | - if (is_array($notice) && ! empty($notice)) { |
|
929 | - // make sure that existing notice type is an array |
|
930 | - self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ]) |
|
931 | - && ! empty(self::$_espresso_notices[ $type ]) |
|
932 | - ? self::$_espresso_notices[ $type ] |
|
933 | - : array(); |
|
934 | - // add newly created notices to existing ones |
|
935 | - self::$_espresso_notices[ $type ] += $notice; |
|
936 | - $print_scripts = true; |
|
937 | - } |
|
938 | - } |
|
939 | - // now clear any stored notices |
|
940 | - EE_Error::clearNotices(); |
|
941 | - } |
|
942 | - return $print_scripts; |
|
943 | - } |
|
944 | - |
|
945 | - |
|
946 | - /** |
|
947 | - * @param string $success_messages |
|
948 | - * @param string $attention_messages |
|
949 | - * @param string $error_messages |
|
950 | - * @return string |
|
951 | - */ |
|
952 | - private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages) |
|
953 | - { |
|
954 | - $notices = '<div id="espresso-notices">'; |
|
955 | - $close = is_admin() |
|
956 | - ? '' |
|
957 | - : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>'; |
|
958 | - if ($success_messages !== '') { |
|
959 | - $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success'; |
|
960 | - $css_class = is_admin() ? 'updated fade' : 'success fade-away'; |
|
961 | - // showMessage( $success_messages ); |
|
962 | - $notices .= '<div id="' . $css_id . '" ' |
|
963 | - . 'class="espresso-notices ' . $css_class . '" ' |
|
964 | - . 'style="display:none;">' |
|
965 | - . '<p>' . $success_messages . '</p>' |
|
966 | - . $close |
|
967 | - . '</div>'; |
|
968 | - } |
|
969 | - if ($attention_messages !== '') { |
|
970 | - $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention'; |
|
971 | - $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away'; |
|
972 | - // showMessage( $error_messages, TRUE ); |
|
973 | - $notices .= '<div id="' . $css_id . '" ' |
|
974 | - . 'class="espresso-notices ' . $css_class . '" ' |
|
975 | - . 'style="display:none;">' |
|
976 | - . '<p>' . $attention_messages . '</p>' |
|
977 | - . $close |
|
978 | - . '</div>'; |
|
979 | - } |
|
980 | - if ($error_messages !== '') { |
|
981 | - $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error'; |
|
982 | - $css_class = is_admin() ? 'error' : 'error fade-away'; |
|
983 | - // showMessage( $error_messages, TRUE ); |
|
984 | - $notices .= '<div id="' . $css_id . '" ' |
|
985 | - . 'class="espresso-notices ' . $css_class . '" ' |
|
986 | - . 'style="display:none;">' |
|
987 | - . '<p>' . $error_messages . '</p>' |
|
988 | - . $close |
|
989 | - . '</div>'; |
|
990 | - } |
|
991 | - $notices .= '</div>'; |
|
992 | - return $notices; |
|
993 | - } |
|
994 | - |
|
995 | - |
|
996 | - /** |
|
997 | - * _print_scripts |
|
998 | - * |
|
999 | - * @param bool $force_print |
|
1000 | - * @return string |
|
1001 | - */ |
|
1002 | - private static function _print_scripts($force_print = false) |
|
1003 | - { |
|
1004 | - if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) { |
|
1005 | - if (wp_script_is('ee_error_js', 'enqueued')) { |
|
1006 | - return ''; |
|
1007 | - } |
|
1008 | - if (wp_script_is('ee_error_js', 'registered')) { |
|
1009 | - wp_enqueue_style('espresso_default'); |
|
1010 | - wp_enqueue_style('espresso_custom_css'); |
|
1011 | - wp_enqueue_script('ee_error_js'); |
|
1012 | - wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG)); |
|
1013 | - } |
|
1014 | - } else { |
|
1015 | - return ' |
|
471 | + $output .= self::_print_scripts(true); |
|
472 | + if (defined('DOING_AJAX')) { |
|
473 | + echo wp_json_encode(array('error' => $output)); |
|
474 | + exit(); |
|
475 | + } |
|
476 | + echo $output; |
|
477 | + die(); |
|
478 | + } |
|
479 | + |
|
480 | + |
|
481 | + /** |
|
482 | + * generate string from exception trace args |
|
483 | + * |
|
484 | + * @param array $arguments |
|
485 | + * @param bool $array |
|
486 | + * @return string |
|
487 | + */ |
|
488 | + private function _convert_args_to_string($arguments = array(), $array = false) |
|
489 | + { |
|
490 | + $arg_string = ''; |
|
491 | + if (! empty($arguments)) { |
|
492 | + $args = array(); |
|
493 | + foreach ($arguments as $arg) { |
|
494 | + if (! empty($arg)) { |
|
495 | + if (is_string($arg)) { |
|
496 | + $args[] = " '" . $arg . "'"; |
|
497 | + } elseif (is_array($arg)) { |
|
498 | + $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true); |
|
499 | + } elseif ($arg === null) { |
|
500 | + $args[] = ' NULL'; |
|
501 | + } elseif (is_bool($arg)) { |
|
502 | + $args[] = ($arg) ? ' TRUE' : ' FALSE'; |
|
503 | + } elseif (is_object($arg)) { |
|
504 | + $args[] = ' OBJECT ' . get_class($arg); |
|
505 | + } elseif (is_resource($arg)) { |
|
506 | + $args[] = get_resource_type($arg); |
|
507 | + } else { |
|
508 | + $args[] = $arg; |
|
509 | + } |
|
510 | + } |
|
511 | + } |
|
512 | + $arg_string = implode(', ', $args); |
|
513 | + } |
|
514 | + if ($array) { |
|
515 | + $arg_string .= ' )'; |
|
516 | + } |
|
517 | + return $arg_string; |
|
518 | + } |
|
519 | + |
|
520 | + |
|
521 | + /** |
|
522 | + * add error message |
|
523 | + * |
|
524 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
525 | + * separate messages for user || dev |
|
526 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
527 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
528 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
529 | + * @return void |
|
530 | + */ |
|
531 | + public static function add_error($msg = null, $file = null, $func = null, $line = null) |
|
532 | + { |
|
533 | + self::_add_notice('errors', $msg, $file, $func, $line); |
|
534 | + self::$_error_count++; |
|
535 | + } |
|
536 | + |
|
537 | + |
|
538 | + /** |
|
539 | + * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just |
|
540 | + * adds an error |
|
541 | + * |
|
542 | + * @param string $msg |
|
543 | + * @param string $file |
|
544 | + * @param string $func |
|
545 | + * @param string $line |
|
546 | + * @throws EE_Error |
|
547 | + */ |
|
548 | + public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null) |
|
549 | + { |
|
550 | + if (WP_DEBUG) { |
|
551 | + throw new EE_Error($msg); |
|
552 | + } |
|
553 | + EE_Error::add_error($msg, $file, $func, $line); |
|
554 | + } |
|
555 | + |
|
556 | + |
|
557 | + /** |
|
558 | + * add success message |
|
559 | + * |
|
560 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
561 | + * separate messages for user || dev |
|
562 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
563 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
564 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
565 | + * @return void |
|
566 | + */ |
|
567 | + public static function add_success($msg = null, $file = null, $func = null, $line = null) |
|
568 | + { |
|
569 | + self::_add_notice('success', $msg, $file, $func, $line); |
|
570 | + } |
|
571 | + |
|
572 | + |
|
573 | + /** |
|
574 | + * add attention message |
|
575 | + * |
|
576 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
577 | + * separate messages for user || dev |
|
578 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
579 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
580 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
581 | + * @return void |
|
582 | + */ |
|
583 | + public static function add_attention($msg = null, $file = null, $func = null, $line = null) |
|
584 | + { |
|
585 | + self::_add_notice('attention', $msg, $file, $func, $line); |
|
586 | + } |
|
587 | + |
|
588 | + |
|
589 | + /** |
|
590 | + * @param string $type whether the message is for a success or error notification |
|
591 | + * @param string $msg the message to display to users or developers |
|
592 | + * - adding a double pipe || (OR) creates separate messages for user || dev |
|
593 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
594 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
595 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
596 | + * @return void |
|
597 | + */ |
|
598 | + private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '') |
|
599 | + { |
|
600 | + if (empty($msg)) { |
|
601 | + EE_Error::doing_it_wrong( |
|
602 | + 'EE_Error::add_' . $type . '()', |
|
603 | + sprintf( |
|
604 | + __( |
|
605 | + 'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', |
|
606 | + 'event_espresso' |
|
607 | + ), |
|
608 | + $type, |
|
609 | + $file, |
|
610 | + $line |
|
611 | + ), |
|
612 | + EVENT_ESPRESSO_VERSION |
|
613 | + ); |
|
614 | + } |
|
615 | + if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) { |
|
616 | + EE_Error::doing_it_wrong( |
|
617 | + 'EE_Error::add_error()', |
|
618 | + __( |
|
619 | + 'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', |
|
620 | + 'event_espresso' |
|
621 | + ), |
|
622 | + EVENT_ESPRESSO_VERSION |
|
623 | + ); |
|
624 | + } |
|
625 | + // get separate user and developer messages if they exist |
|
626 | + $msg = explode('||', $msg); |
|
627 | + $user_msg = $msg[0]; |
|
628 | + $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
629 | + /** |
|
630 | + * Do an action so other code can be triggered when a notice is created |
|
631 | + * |
|
632 | + * @param string $type can be 'errors', 'attention', or 'success' |
|
633 | + * @param string $user_msg message displayed to user when WP_DEBUG is off |
|
634 | + * @param string $user_msg message displayed to user when WP_DEBUG is on |
|
635 | + * @param string $file file where error was generated |
|
636 | + * @param string $func function where error was generated |
|
637 | + * @param string $line line where error was generated |
|
638 | + */ |
|
639 | + do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line); |
|
640 | + $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
641 | + // add notice if message exists |
|
642 | + if (! empty($msg)) { |
|
643 | + // get error code |
|
644 | + $notice_code = EE_Error::generate_error_code($file, $func, $line); |
|
645 | + if (WP_DEBUG && $type === 'errors') { |
|
646 | + $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>'; |
|
647 | + } |
|
648 | + // add notice. Index by code if it's not blank |
|
649 | + if ($notice_code) { |
|
650 | + self::$_espresso_notices[ $type ][ $notice_code ] = $msg; |
|
651 | + } else { |
|
652 | + self::$_espresso_notices[ $type ][] = $msg; |
|
653 | + } |
|
654 | + add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1); |
|
655 | + } |
|
656 | + } |
|
657 | + |
|
658 | + |
|
659 | + /** |
|
660 | + * in some case it may be necessary to overwrite the existing success messages |
|
661 | + * |
|
662 | + * @return void |
|
663 | + */ |
|
664 | + public static function overwrite_success() |
|
665 | + { |
|
666 | + self::$_espresso_notices['success'] = false; |
|
667 | + } |
|
668 | + |
|
669 | + |
|
670 | + /** |
|
671 | + * in some case it may be necessary to overwrite the existing attention messages |
|
672 | + * |
|
673 | + * @return void |
|
674 | + */ |
|
675 | + public static function overwrite_attention() |
|
676 | + { |
|
677 | + self::$_espresso_notices['attention'] = false; |
|
678 | + } |
|
679 | + |
|
680 | + |
|
681 | + /** |
|
682 | + * in some case it may be necessary to overwrite the existing error messages |
|
683 | + * |
|
684 | + * @return void |
|
685 | + */ |
|
686 | + public static function overwrite_errors() |
|
687 | + { |
|
688 | + self::$_espresso_notices['errors'] = false; |
|
689 | + } |
|
690 | + |
|
691 | + |
|
692 | + /** |
|
693 | + * @return void |
|
694 | + */ |
|
695 | + public static function reset_notices() |
|
696 | + { |
|
697 | + self::$_espresso_notices['success'] = false; |
|
698 | + self::$_espresso_notices['attention'] = false; |
|
699 | + self::$_espresso_notices['errors'] = false; |
|
700 | + } |
|
701 | + |
|
702 | + |
|
703 | + /** |
|
704 | + * @return int |
|
705 | + */ |
|
706 | + public static function has_notices() |
|
707 | + { |
|
708 | + $has_notices = 0; |
|
709 | + // check for success messages |
|
710 | + $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) |
|
711 | + ? 3 |
|
712 | + : $has_notices; |
|
713 | + // check for attention messages |
|
714 | + $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) |
|
715 | + ? 2 |
|
716 | + : $has_notices; |
|
717 | + // check for error messages |
|
718 | + $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) |
|
719 | + ? 1 |
|
720 | + : $has_notices; |
|
721 | + return $has_notices; |
|
722 | + } |
|
723 | + |
|
724 | + |
|
725 | + /** |
|
726 | + * This simply returns non formatted error notices as they were sent into the EE_Error object. |
|
727 | + * |
|
728 | + * @since 4.9.0 |
|
729 | + * @return array |
|
730 | + */ |
|
731 | + public static function get_vanilla_notices() |
|
732 | + { |
|
733 | + return array( |
|
734 | + 'success' => isset(self::$_espresso_notices['success']) |
|
735 | + ? self::$_espresso_notices['success'] |
|
736 | + : array(), |
|
737 | + 'attention' => isset(self::$_espresso_notices['attention']) |
|
738 | + ? self::$_espresso_notices['attention'] |
|
739 | + : array(), |
|
740 | + 'errors' => isset(self::$_espresso_notices['errors']) |
|
741 | + ? self::$_espresso_notices['errors'] |
|
742 | + : array(), |
|
743 | + ); |
|
744 | + } |
|
745 | + |
|
746 | + |
|
747 | + /** |
|
748 | + * @return array |
|
749 | + * @throws InvalidArgumentException |
|
750 | + * @throws InvalidDataTypeException |
|
751 | + * @throws InvalidInterfaceException |
|
752 | + */ |
|
753 | + public static function getStoredNotices() |
|
754 | + { |
|
755 | + if ($user_id = get_current_user_id()) { |
|
756 | + // get notices for logged in user |
|
757 | + $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id); |
|
758 | + return is_array($notices) ? $notices : array(); |
|
759 | + } |
|
760 | + if (EE_Session::isLoadedAndActive()) { |
|
761 | + // get notices for user currently engaged in a session |
|
762 | + $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES); |
|
763 | + return is_array($session_data) ? $session_data : array(); |
|
764 | + } |
|
765 | + // get global notices and hope they apply to the current site visitor |
|
766 | + $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array()); |
|
767 | + return is_array($notices) ? $notices : array(); |
|
768 | + } |
|
769 | + |
|
770 | + |
|
771 | + /** |
|
772 | + * @param array $notices |
|
773 | + * @return bool |
|
774 | + * @throws InvalidArgumentException |
|
775 | + * @throws InvalidDataTypeException |
|
776 | + * @throws InvalidInterfaceException |
|
777 | + */ |
|
778 | + public static function storeNotices(array $notices) |
|
779 | + { |
|
780 | + if ($user_id = get_current_user_id()) { |
|
781 | + // store notices for logged in user |
|
782 | + return (bool) update_user_option( |
|
783 | + $user_id, |
|
784 | + EE_Error::OPTIONS_KEY_NOTICES, |
|
785 | + $notices |
|
786 | + ); |
|
787 | + } |
|
788 | + if (EE_Session::isLoadedAndActive()) { |
|
789 | + // store notices for user currently engaged in a session |
|
790 | + return EE_Session::instance()->set_session_data( |
|
791 | + array(EE_Error::OPTIONS_KEY_NOTICES => $notices) |
|
792 | + ); |
|
793 | + } |
|
794 | + // store global notices and hope they apply to the same site visitor on the next request |
|
795 | + return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices); |
|
796 | + } |
|
797 | + |
|
798 | + |
|
799 | + /** |
|
800 | + * @return bool|TRUE |
|
801 | + * @throws InvalidArgumentException |
|
802 | + * @throws InvalidDataTypeException |
|
803 | + * @throws InvalidInterfaceException |
|
804 | + */ |
|
805 | + public static function clearNotices() |
|
806 | + { |
|
807 | + if ($user_id = get_current_user_id()) { |
|
808 | + // clear notices for logged in user |
|
809 | + return (bool) update_user_option( |
|
810 | + $user_id, |
|
811 | + EE_Error::OPTIONS_KEY_NOTICES, |
|
812 | + array() |
|
813 | + ); |
|
814 | + } |
|
815 | + if (EE_Session::isLoadedAndActive()) { |
|
816 | + // clear notices for user currently engaged in a session |
|
817 | + return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES); |
|
818 | + } |
|
819 | + // clear global notices and hope none belonged to some for some other site visitor |
|
820 | + return update_option(EE_Error::OPTIONS_KEY_NOTICES, array()); |
|
821 | + } |
|
822 | + |
|
823 | + |
|
824 | + /** |
|
825 | + * saves notices to the db for retrieval on next request |
|
826 | + * |
|
827 | + * @return void |
|
828 | + * @throws InvalidArgumentException |
|
829 | + * @throws InvalidDataTypeException |
|
830 | + * @throws InvalidInterfaceException |
|
831 | + */ |
|
832 | + public static function stashNoticesBeforeRedirect() |
|
833 | + { |
|
834 | + EE_Error::get_notices(false, true); |
|
835 | + } |
|
836 | + |
|
837 | + |
|
838 | + /** |
|
839 | + * compile all error or success messages into one string |
|
840 | + * |
|
841 | + * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them |
|
842 | + * @param boolean $format_output whether or not to format the messages for display in the WP admin |
|
843 | + * @param boolean $save_to_transient whether or not to save notices to the db for retrieval on next request |
|
844 | + * - ONLY do this just before redirecting |
|
845 | + * @param boolean $remove_empty whether or not to unset empty messages |
|
846 | + * @return array |
|
847 | + * @throws InvalidArgumentException |
|
848 | + * @throws InvalidDataTypeException |
|
849 | + * @throws InvalidInterfaceException |
|
850 | + */ |
|
851 | + public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true) |
|
852 | + { |
|
853 | + $success_messages = ''; |
|
854 | + $attention_messages = ''; |
|
855 | + $error_messages = ''; |
|
856 | + // either save notices to the db |
|
857 | + if ($save_to_transient || isset($_REQUEST['activate-selected'])) { |
|
858 | + self::$_espresso_notices = array_merge( |
|
859 | + EE_Error::getStoredNotices(), |
|
860 | + self::$_espresso_notices |
|
861 | + ); |
|
862 | + EE_Error::storeNotices(self::$_espresso_notices); |
|
863 | + return array(); |
|
864 | + } |
|
865 | + $print_scripts = EE_Error::combineExistingAndNewNotices(); |
|
866 | + // check for success messages |
|
867 | + if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) { |
|
868 | + // combine messages |
|
869 | + $success_messages .= implode(self::$_espresso_notices['success'], '<br />'); |
|
870 | + $print_scripts = true; |
|
871 | + } |
|
872 | + // check for attention messages |
|
873 | + if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) { |
|
874 | + // combine messages |
|
875 | + $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />'); |
|
876 | + $print_scripts = true; |
|
877 | + } |
|
878 | + // check for error messages |
|
879 | + if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) { |
|
880 | + $error_messages .= count(self::$_espresso_notices['errors']) > 1 |
|
881 | + ? __('The following errors have occurred:<br />', 'event_espresso') |
|
882 | + : __('An error has occurred:<br />', 'event_espresso'); |
|
883 | + // combine messages |
|
884 | + $error_messages .= implode(self::$_espresso_notices['errors'], '<br />'); |
|
885 | + $print_scripts = true; |
|
886 | + } |
|
887 | + if ($format_output) { |
|
888 | + $notices = EE_Error::formatNoticesOutput( |
|
889 | + $success_messages, |
|
890 | + $attention_messages, |
|
891 | + $error_messages |
|
892 | + ); |
|
893 | + } else { |
|
894 | + $notices = array( |
|
895 | + 'success' => $success_messages, |
|
896 | + 'attention' => $attention_messages, |
|
897 | + 'errors' => $error_messages, |
|
898 | + ); |
|
899 | + if ($remove_empty) { |
|
900 | + // remove empty notices |
|
901 | + foreach ($notices as $type => $notice) { |
|
902 | + if (empty($notice)) { |
|
903 | + unset($notices[ $type ]); |
|
904 | + } |
|
905 | + } |
|
906 | + } |
|
907 | + } |
|
908 | + if ($print_scripts) { |
|
909 | + self::_print_scripts(); |
|
910 | + } |
|
911 | + return $notices; |
|
912 | + } |
|
913 | + |
|
914 | + |
|
915 | + /** |
|
916 | + * @return bool |
|
917 | + * @throws InvalidArgumentException |
|
918 | + * @throws InvalidDataTypeException |
|
919 | + * @throws InvalidInterfaceException |
|
920 | + */ |
|
921 | + private static function combineExistingAndNewNotices() |
|
922 | + { |
|
923 | + $print_scripts = false; |
|
924 | + // grab any notices that have been previously saved |
|
925 | + $notices = EE_Error::getStoredNotices(); |
|
926 | + if (! empty($notices)) { |
|
927 | + foreach ($notices as $type => $notice) { |
|
928 | + if (is_array($notice) && ! empty($notice)) { |
|
929 | + // make sure that existing notice type is an array |
|
930 | + self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ]) |
|
931 | + && ! empty(self::$_espresso_notices[ $type ]) |
|
932 | + ? self::$_espresso_notices[ $type ] |
|
933 | + : array(); |
|
934 | + // add newly created notices to existing ones |
|
935 | + self::$_espresso_notices[ $type ] += $notice; |
|
936 | + $print_scripts = true; |
|
937 | + } |
|
938 | + } |
|
939 | + // now clear any stored notices |
|
940 | + EE_Error::clearNotices(); |
|
941 | + } |
|
942 | + return $print_scripts; |
|
943 | + } |
|
944 | + |
|
945 | + |
|
946 | + /** |
|
947 | + * @param string $success_messages |
|
948 | + * @param string $attention_messages |
|
949 | + * @param string $error_messages |
|
950 | + * @return string |
|
951 | + */ |
|
952 | + private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages) |
|
953 | + { |
|
954 | + $notices = '<div id="espresso-notices">'; |
|
955 | + $close = is_admin() |
|
956 | + ? '' |
|
957 | + : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>'; |
|
958 | + if ($success_messages !== '') { |
|
959 | + $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success'; |
|
960 | + $css_class = is_admin() ? 'updated fade' : 'success fade-away'; |
|
961 | + // showMessage( $success_messages ); |
|
962 | + $notices .= '<div id="' . $css_id . '" ' |
|
963 | + . 'class="espresso-notices ' . $css_class . '" ' |
|
964 | + . 'style="display:none;">' |
|
965 | + . '<p>' . $success_messages . '</p>' |
|
966 | + . $close |
|
967 | + . '</div>'; |
|
968 | + } |
|
969 | + if ($attention_messages !== '') { |
|
970 | + $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention'; |
|
971 | + $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away'; |
|
972 | + // showMessage( $error_messages, TRUE ); |
|
973 | + $notices .= '<div id="' . $css_id . '" ' |
|
974 | + . 'class="espresso-notices ' . $css_class . '" ' |
|
975 | + . 'style="display:none;">' |
|
976 | + . '<p>' . $attention_messages . '</p>' |
|
977 | + . $close |
|
978 | + . '</div>'; |
|
979 | + } |
|
980 | + if ($error_messages !== '') { |
|
981 | + $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error'; |
|
982 | + $css_class = is_admin() ? 'error' : 'error fade-away'; |
|
983 | + // showMessage( $error_messages, TRUE ); |
|
984 | + $notices .= '<div id="' . $css_id . '" ' |
|
985 | + . 'class="espresso-notices ' . $css_class . '" ' |
|
986 | + . 'style="display:none;">' |
|
987 | + . '<p>' . $error_messages . '</p>' |
|
988 | + . $close |
|
989 | + . '</div>'; |
|
990 | + } |
|
991 | + $notices .= '</div>'; |
|
992 | + return $notices; |
|
993 | + } |
|
994 | + |
|
995 | + |
|
996 | + /** |
|
997 | + * _print_scripts |
|
998 | + * |
|
999 | + * @param bool $force_print |
|
1000 | + * @return string |
|
1001 | + */ |
|
1002 | + private static function _print_scripts($force_print = false) |
|
1003 | + { |
|
1004 | + if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) { |
|
1005 | + if (wp_script_is('ee_error_js', 'enqueued')) { |
|
1006 | + return ''; |
|
1007 | + } |
|
1008 | + if (wp_script_is('ee_error_js', 'registered')) { |
|
1009 | + wp_enqueue_style('espresso_default'); |
|
1010 | + wp_enqueue_style('espresso_custom_css'); |
|
1011 | + wp_enqueue_script('ee_error_js'); |
|
1012 | + wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG)); |
|
1013 | + } |
|
1014 | + } else { |
|
1015 | + return ' |
|
1016 | 1016 | <script> |
1017 | 1017 | /* <![CDATA[ */ |
1018 | 1018 | var ee_settings = {"wp_debug":"' . WP_DEBUG . '"}; |
@@ -1022,221 +1022,221 @@ discard block |
||
1022 | 1022 | <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
1023 | 1023 | <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
1024 | 1024 | '; |
1025 | - } |
|
1026 | - return ''; |
|
1027 | - } |
|
1028 | - |
|
1029 | - |
|
1030 | - /** |
|
1031 | - * @return void |
|
1032 | - */ |
|
1033 | - public static function enqueue_error_scripts() |
|
1034 | - { |
|
1035 | - self::_print_scripts(); |
|
1036 | - } |
|
1037 | - |
|
1038 | - |
|
1039 | - /** |
|
1040 | - * create error code from filepath, function name, |
|
1041 | - * and line number where exception or error was thrown |
|
1042 | - * |
|
1043 | - * @param string $file |
|
1044 | - * @param string $func |
|
1045 | - * @param string $line |
|
1046 | - * @return string |
|
1047 | - */ |
|
1048 | - public static function generate_error_code($file = '', $func = '', $line = '') |
|
1049 | - { |
|
1050 | - $file = explode('.', basename($file)); |
|
1051 | - $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
1052 | - $error_code .= ! empty($func) ? ' - ' . $func : ''; |
|
1053 | - $error_code .= ! empty($line) ? ' - ' . $line : ''; |
|
1054 | - return $error_code; |
|
1055 | - } |
|
1056 | - |
|
1057 | - |
|
1058 | - /** |
|
1059 | - * write exception details to log file |
|
1060 | - * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file |
|
1061 | - * |
|
1062 | - * @param int $time |
|
1063 | - * @param array $ex |
|
1064 | - * @param bool $clear |
|
1065 | - * @return void |
|
1066 | - */ |
|
1067 | - public function write_to_error_log($time = 0, $ex = array(), $clear = false) |
|
1068 | - { |
|
1069 | - if (empty($ex)) { |
|
1070 | - return; |
|
1071 | - } |
|
1072 | - if (! $time) { |
|
1073 | - $time = time(); |
|
1074 | - } |
|
1075 | - $exception_log = '----------------------------------------------------------------------------------------' |
|
1076 | - . PHP_EOL; |
|
1077 | - $exception_log .= '[' . date('Y-m-d H:i:s', $time) . '] Exception Details' . PHP_EOL; |
|
1078 | - $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL; |
|
1079 | - $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL; |
|
1080 | - $exception_log .= 'File: ' . $ex['file'] . PHP_EOL; |
|
1081 | - $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL; |
|
1082 | - $exception_log .= 'Stack trace: ' . PHP_EOL; |
|
1083 | - $exception_log .= $ex['string'] . PHP_EOL; |
|
1084 | - $exception_log .= '----------------------------------------------------------------------------------------' |
|
1085 | - . PHP_EOL; |
|
1086 | - try { |
|
1087 | - error_log($exception_log); |
|
1088 | - } catch (EE_Error $e) { |
|
1089 | - EE_Error::add_error( |
|
1090 | - sprintf( |
|
1091 | - __( |
|
1092 | - 'Event Espresso error logging could not be setup because: %s', |
|
1093 | - 'event_espresso' |
|
1094 | - ), |
|
1095 | - $e->getMessage() |
|
1096 | - ) |
|
1097 | - ); |
|
1098 | - } |
|
1099 | - } |
|
1100 | - |
|
1101 | - |
|
1102 | - /** |
|
1103 | - * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method. |
|
1104 | - * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown, |
|
1105 | - * but the code execution is done in a manner that could lead to unexpected results |
|
1106 | - * (i.e. running to early, or too late in WP or EE loading process). |
|
1107 | - * A good test for knowing whether to use this method is: |
|
1108 | - * 1. Is there going to be a PHP error if something isn't setup/used correctly? |
|
1109 | - * Yes -> use EE_Error::add_error() or throw new EE_Error() |
|
1110 | - * 2. If this is loaded before something else, it won't break anything, |
|
1111 | - * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong() |
|
1112 | - * |
|
1113 | - * @uses constant WP_DEBUG test if wp_debug is on or not |
|
1114 | - * @param string $function The function that was called |
|
1115 | - * @param string $message A message explaining what has been done incorrectly |
|
1116 | - * @param string $version The version of Event Espresso where the error was added |
|
1117 | - * @param string $applies_when a version string for when you want the doing_it_wrong notice to begin appearing |
|
1118 | - * for a deprecated function. This allows deprecation to occur during one version, |
|
1119 | - * but not have any notices appear until a later version. This allows developers |
|
1120 | - * extra time to update their code before notices appear. |
|
1121 | - * @param int $error_type |
|
1122 | - */ |
|
1123 | - public static function doing_it_wrong( |
|
1124 | - $function, |
|
1125 | - $message, |
|
1126 | - $version, |
|
1127 | - $applies_when = '', |
|
1128 | - $error_type = null |
|
1129 | - ) { |
|
1130 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
1131 | - EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type); |
|
1132 | - } |
|
1133 | - } |
|
1134 | - |
|
1135 | - |
|
1136 | - /** |
|
1137 | - * Like get_notices, but returns an array of all the notices of the given type. |
|
1138 | - * |
|
1139 | - * @return array { |
|
1140 | - * @type array $success all the success messages |
|
1141 | - * @type array $errors all the error messages |
|
1142 | - * @type array $attention all the attention messages |
|
1143 | - * } |
|
1144 | - */ |
|
1145 | - public static function get_raw_notices() |
|
1146 | - { |
|
1147 | - return self::$_espresso_notices; |
|
1148 | - } |
|
1149 | - |
|
1150 | - |
|
1151 | - /** |
|
1152 | - * @deprecated 4.9.27 |
|
1153 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
1154 | - * @param string $pan_message the message to be stored persistently until dismissed |
|
1155 | - * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
|
1156 | - * @return void |
|
1157 | - * @throws InvalidDataTypeException |
|
1158 | - */ |
|
1159 | - public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false) |
|
1160 | - { |
|
1161 | - new PersistentAdminNotice( |
|
1162 | - $pan_name, |
|
1163 | - $pan_message, |
|
1164 | - $force_update |
|
1165 | - ); |
|
1166 | - EE_Error::doing_it_wrong( |
|
1167 | - __METHOD__, |
|
1168 | - sprintf( |
|
1169 | - __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1170 | - '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice' |
|
1171 | - ), |
|
1172 | - '4.9.27' |
|
1173 | - ); |
|
1174 | - } |
|
1175 | - |
|
1176 | - |
|
1177 | - /** |
|
1178 | - * @deprecated 4.9.27 |
|
1179 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed |
|
1180 | - * @param bool $purge |
|
1181 | - * @param bool $return |
|
1182 | - * @throws DomainException |
|
1183 | - * @throws InvalidInterfaceException |
|
1184 | - * @throws InvalidDataTypeException |
|
1185 | - * @throws ServiceNotFoundException |
|
1186 | - * @throws InvalidArgumentException |
|
1187 | - */ |
|
1188 | - public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false) |
|
1189 | - { |
|
1190 | - /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */ |
|
1191 | - $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared( |
|
1192 | - 'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1193 | - ); |
|
1194 | - $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return); |
|
1195 | - EE_Error::doing_it_wrong( |
|
1196 | - __METHOD__, |
|
1197 | - sprintf( |
|
1198 | - __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1199 | - '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1200 | - ), |
|
1201 | - '4.9.27' |
|
1202 | - ); |
|
1203 | - } |
|
1204 | - |
|
1205 | - |
|
1206 | - /** |
|
1207 | - * @deprecated 4.9.27 |
|
1208 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
1209 | - * @param string $pan_message the message to be stored persistently until dismissed |
|
1210 | - * @param string $return_url URL to go back to after nag notice is dismissed |
|
1211 | - */ |
|
1212 | - public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '') |
|
1213 | - { |
|
1214 | - EE_Error::doing_it_wrong( |
|
1215 | - __METHOD__, |
|
1216 | - sprintf( |
|
1217 | - __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1218 | - '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1219 | - ), |
|
1220 | - '4.9.27' |
|
1221 | - ); |
|
1222 | - } |
|
1223 | - |
|
1224 | - |
|
1225 | - /** |
|
1226 | - * @deprecated 4.9.27 |
|
1227 | - * @param string $return_url |
|
1228 | - */ |
|
1229 | - public static function get_persistent_admin_notices($return_url = '') |
|
1230 | - { |
|
1231 | - EE_Error::doing_it_wrong( |
|
1232 | - __METHOD__, |
|
1233 | - sprintf( |
|
1234 | - __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1235 | - '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1236 | - ), |
|
1237 | - '4.9.27' |
|
1238 | - ); |
|
1239 | - } |
|
1025 | + } |
|
1026 | + return ''; |
|
1027 | + } |
|
1028 | + |
|
1029 | + |
|
1030 | + /** |
|
1031 | + * @return void |
|
1032 | + */ |
|
1033 | + public static function enqueue_error_scripts() |
|
1034 | + { |
|
1035 | + self::_print_scripts(); |
|
1036 | + } |
|
1037 | + |
|
1038 | + |
|
1039 | + /** |
|
1040 | + * create error code from filepath, function name, |
|
1041 | + * and line number where exception or error was thrown |
|
1042 | + * |
|
1043 | + * @param string $file |
|
1044 | + * @param string $func |
|
1045 | + * @param string $line |
|
1046 | + * @return string |
|
1047 | + */ |
|
1048 | + public static function generate_error_code($file = '', $func = '', $line = '') |
|
1049 | + { |
|
1050 | + $file = explode('.', basename($file)); |
|
1051 | + $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
1052 | + $error_code .= ! empty($func) ? ' - ' . $func : ''; |
|
1053 | + $error_code .= ! empty($line) ? ' - ' . $line : ''; |
|
1054 | + return $error_code; |
|
1055 | + } |
|
1056 | + |
|
1057 | + |
|
1058 | + /** |
|
1059 | + * write exception details to log file |
|
1060 | + * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file |
|
1061 | + * |
|
1062 | + * @param int $time |
|
1063 | + * @param array $ex |
|
1064 | + * @param bool $clear |
|
1065 | + * @return void |
|
1066 | + */ |
|
1067 | + public function write_to_error_log($time = 0, $ex = array(), $clear = false) |
|
1068 | + { |
|
1069 | + if (empty($ex)) { |
|
1070 | + return; |
|
1071 | + } |
|
1072 | + if (! $time) { |
|
1073 | + $time = time(); |
|
1074 | + } |
|
1075 | + $exception_log = '----------------------------------------------------------------------------------------' |
|
1076 | + . PHP_EOL; |
|
1077 | + $exception_log .= '[' . date('Y-m-d H:i:s', $time) . '] Exception Details' . PHP_EOL; |
|
1078 | + $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL; |
|
1079 | + $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL; |
|
1080 | + $exception_log .= 'File: ' . $ex['file'] . PHP_EOL; |
|
1081 | + $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL; |
|
1082 | + $exception_log .= 'Stack trace: ' . PHP_EOL; |
|
1083 | + $exception_log .= $ex['string'] . PHP_EOL; |
|
1084 | + $exception_log .= '----------------------------------------------------------------------------------------' |
|
1085 | + . PHP_EOL; |
|
1086 | + try { |
|
1087 | + error_log($exception_log); |
|
1088 | + } catch (EE_Error $e) { |
|
1089 | + EE_Error::add_error( |
|
1090 | + sprintf( |
|
1091 | + __( |
|
1092 | + 'Event Espresso error logging could not be setup because: %s', |
|
1093 | + 'event_espresso' |
|
1094 | + ), |
|
1095 | + $e->getMessage() |
|
1096 | + ) |
|
1097 | + ); |
|
1098 | + } |
|
1099 | + } |
|
1100 | + |
|
1101 | + |
|
1102 | + /** |
|
1103 | + * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method. |
|
1104 | + * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown, |
|
1105 | + * but the code execution is done in a manner that could lead to unexpected results |
|
1106 | + * (i.e. running to early, or too late in WP or EE loading process). |
|
1107 | + * A good test for knowing whether to use this method is: |
|
1108 | + * 1. Is there going to be a PHP error if something isn't setup/used correctly? |
|
1109 | + * Yes -> use EE_Error::add_error() or throw new EE_Error() |
|
1110 | + * 2. If this is loaded before something else, it won't break anything, |
|
1111 | + * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong() |
|
1112 | + * |
|
1113 | + * @uses constant WP_DEBUG test if wp_debug is on or not |
|
1114 | + * @param string $function The function that was called |
|
1115 | + * @param string $message A message explaining what has been done incorrectly |
|
1116 | + * @param string $version The version of Event Espresso where the error was added |
|
1117 | + * @param string $applies_when a version string for when you want the doing_it_wrong notice to begin appearing |
|
1118 | + * for a deprecated function. This allows deprecation to occur during one version, |
|
1119 | + * but not have any notices appear until a later version. This allows developers |
|
1120 | + * extra time to update their code before notices appear. |
|
1121 | + * @param int $error_type |
|
1122 | + */ |
|
1123 | + public static function doing_it_wrong( |
|
1124 | + $function, |
|
1125 | + $message, |
|
1126 | + $version, |
|
1127 | + $applies_when = '', |
|
1128 | + $error_type = null |
|
1129 | + ) { |
|
1130 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
1131 | + EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type); |
|
1132 | + } |
|
1133 | + } |
|
1134 | + |
|
1135 | + |
|
1136 | + /** |
|
1137 | + * Like get_notices, but returns an array of all the notices of the given type. |
|
1138 | + * |
|
1139 | + * @return array { |
|
1140 | + * @type array $success all the success messages |
|
1141 | + * @type array $errors all the error messages |
|
1142 | + * @type array $attention all the attention messages |
|
1143 | + * } |
|
1144 | + */ |
|
1145 | + public static function get_raw_notices() |
|
1146 | + { |
|
1147 | + return self::$_espresso_notices; |
|
1148 | + } |
|
1149 | + |
|
1150 | + |
|
1151 | + /** |
|
1152 | + * @deprecated 4.9.27 |
|
1153 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
1154 | + * @param string $pan_message the message to be stored persistently until dismissed |
|
1155 | + * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
|
1156 | + * @return void |
|
1157 | + * @throws InvalidDataTypeException |
|
1158 | + */ |
|
1159 | + public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false) |
|
1160 | + { |
|
1161 | + new PersistentAdminNotice( |
|
1162 | + $pan_name, |
|
1163 | + $pan_message, |
|
1164 | + $force_update |
|
1165 | + ); |
|
1166 | + EE_Error::doing_it_wrong( |
|
1167 | + __METHOD__, |
|
1168 | + sprintf( |
|
1169 | + __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1170 | + '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice' |
|
1171 | + ), |
|
1172 | + '4.9.27' |
|
1173 | + ); |
|
1174 | + } |
|
1175 | + |
|
1176 | + |
|
1177 | + /** |
|
1178 | + * @deprecated 4.9.27 |
|
1179 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed |
|
1180 | + * @param bool $purge |
|
1181 | + * @param bool $return |
|
1182 | + * @throws DomainException |
|
1183 | + * @throws InvalidInterfaceException |
|
1184 | + * @throws InvalidDataTypeException |
|
1185 | + * @throws ServiceNotFoundException |
|
1186 | + * @throws InvalidArgumentException |
|
1187 | + */ |
|
1188 | + public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false) |
|
1189 | + { |
|
1190 | + /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */ |
|
1191 | + $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared( |
|
1192 | + 'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1193 | + ); |
|
1194 | + $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return); |
|
1195 | + EE_Error::doing_it_wrong( |
|
1196 | + __METHOD__, |
|
1197 | + sprintf( |
|
1198 | + __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1199 | + '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1200 | + ), |
|
1201 | + '4.9.27' |
|
1202 | + ); |
|
1203 | + } |
|
1204 | + |
|
1205 | + |
|
1206 | + /** |
|
1207 | + * @deprecated 4.9.27 |
|
1208 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
1209 | + * @param string $pan_message the message to be stored persistently until dismissed |
|
1210 | + * @param string $return_url URL to go back to after nag notice is dismissed |
|
1211 | + */ |
|
1212 | + public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '') |
|
1213 | + { |
|
1214 | + EE_Error::doing_it_wrong( |
|
1215 | + __METHOD__, |
|
1216 | + sprintf( |
|
1217 | + __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1218 | + '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1219 | + ), |
|
1220 | + '4.9.27' |
|
1221 | + ); |
|
1222 | + } |
|
1223 | + |
|
1224 | + |
|
1225 | + /** |
|
1226 | + * @deprecated 4.9.27 |
|
1227 | + * @param string $return_url |
|
1228 | + */ |
|
1229 | + public static function get_persistent_admin_notices($return_url = '') |
|
1230 | + { |
|
1231 | + EE_Error::doing_it_wrong( |
|
1232 | + __METHOD__, |
|
1233 | + sprintf( |
|
1234 | + __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'), |
|
1235 | + '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager' |
|
1236 | + ), |
|
1237 | + '4.9.27' |
|
1238 | + ); |
|
1239 | + } |
|
1240 | 1240 | } |
1241 | 1241 | |
1242 | 1242 | // end of Class EE_Exceptions |
@@ -1249,27 +1249,27 @@ discard block |
||
1249 | 1249 | */ |
1250 | 1250 | function espresso_error_enqueue_scripts() |
1251 | 1251 | { |
1252 | - // js for error handling |
|
1253 | - wp_register_script( |
|
1254 | - 'espresso_core', |
|
1255 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
1256 | - array('jquery'), |
|
1257 | - EVENT_ESPRESSO_VERSION, |
|
1258 | - false |
|
1259 | - ); |
|
1260 | - wp_register_script( |
|
1261 | - 'ee_error_js', |
|
1262 | - EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
1263 | - array('espresso_core'), |
|
1264 | - EVENT_ESPRESSO_VERSION, |
|
1265 | - false |
|
1266 | - ); |
|
1252 | + // js for error handling |
|
1253 | + wp_register_script( |
|
1254 | + 'espresso_core', |
|
1255 | + EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
1256 | + array('jquery'), |
|
1257 | + EVENT_ESPRESSO_VERSION, |
|
1258 | + false |
|
1259 | + ); |
|
1260 | + wp_register_script( |
|
1261 | + 'ee_error_js', |
|
1262 | + EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
1263 | + array('espresso_core'), |
|
1264 | + EVENT_ESPRESSO_VERSION, |
|
1265 | + false |
|
1266 | + ); |
|
1267 | 1267 | } |
1268 | 1268 | |
1269 | 1269 | if (is_admin()) { |
1270 | - add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1270 | + add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1271 | 1271 | } else { |
1272 | - add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1272 | + add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1273 | 1273 | } |
1274 | 1274 | |
1275 | 1275 |
@@ -73,7 +73,7 @@ |
||
73 | 73 | } |
74 | 74 | $session_lifespan_in_hours = round($this->session_lifespan->inSeconds() / HOUR_IN_SECONDS); |
75 | 75 | return (string) EEH_Template::display_template( |
76 | - __DIR__ . '/privacy_policy.template.php', |
|
76 | + __DIR__.'/privacy_policy.template.php', |
|
77 | 77 | array( |
78 | 78 | 'active_onsite_payment_methods' => $active_onsite_pms, |
79 | 79 | 'active_offsite_payment_methods' => $active_offsite_pms, |
@@ -20,80 +20,80 @@ |
||
20 | 20 | class PrivacyPolicy implements PrivacyPolicyInterface |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * @var EEM_Payment_Method |
|
25 | - */ |
|
26 | - protected $payment_method_model; |
|
23 | + /** |
|
24 | + * @var EEM_Payment_Method |
|
25 | + */ |
|
26 | + protected $payment_method_model; |
|
27 | 27 | |
28 | - /** |
|
29 | - * @var SessionLifespan |
|
30 | - */ |
|
31 | - protected $session_lifespan; |
|
28 | + /** |
|
29 | + * @var SessionLifespan |
|
30 | + */ |
|
31 | + protected $session_lifespan; |
|
32 | 32 | |
33 | - /** |
|
34 | - * PrivacyPolicy constructor. |
|
35 | - * |
|
36 | - * @param EEM_Payment_Method $payment_method_model |
|
37 | - * @param SessionLifespan $session_lifespan |
|
38 | - */ |
|
39 | - public function __construct(EEM_Payment_Method $payment_method_model, SessionLifespan $session_lifespan) |
|
40 | - { |
|
41 | - $this->payment_method_model = $payment_method_model; |
|
42 | - $this->session_lifespan = $session_lifespan; |
|
43 | - } |
|
33 | + /** |
|
34 | + * PrivacyPolicy constructor. |
|
35 | + * |
|
36 | + * @param EEM_Payment_Method $payment_method_model |
|
37 | + * @param SessionLifespan $session_lifespan |
|
38 | + */ |
|
39 | + public function __construct(EEM_Payment_Method $payment_method_model, SessionLifespan $session_lifespan) |
|
40 | + { |
|
41 | + $this->payment_method_model = $payment_method_model; |
|
42 | + $this->session_lifespan = $session_lifespan; |
|
43 | + } |
|
44 | 44 | |
45 | 45 | |
46 | - /** |
|
47 | - * Returns the name of the plugin and will be shown in the privacy policy's postbox header |
|
48 | - * |
|
49 | - * @return string |
|
50 | - */ |
|
51 | - public function getName() |
|
52 | - { |
|
53 | - return esc_html__('Event Espresso', 'event_espresso'); |
|
54 | - } |
|
46 | + /** |
|
47 | + * Returns the name of the plugin and will be shown in the privacy policy's postbox header |
|
48 | + * |
|
49 | + * @return string |
|
50 | + */ |
|
51 | + public function getName() |
|
52 | + { |
|
53 | + return esc_html__('Event Espresso', 'event_espresso'); |
|
54 | + } |
|
55 | 55 | |
56 | 56 | |
57 | - /** |
|
58 | - * Gets the HTML for the privacy policy. May be dynamic |
|
59 | - * |
|
60 | - * @return string |
|
61 | - */ |
|
62 | - public function getContent() |
|
63 | - { |
|
64 | - // do they have any offsite payment methods? or onsite payment methods? |
|
65 | - $active_payment_methods = $this->payment_method_model->get_all_active(EEM_Payment_Method::scope_cart); |
|
66 | - $active_onsite_pms = array(); |
|
67 | - $active_offsite_pms = array(); |
|
68 | - foreach ($active_payment_methods as $payment_method) { |
|
69 | - if ($payment_method->type_obj() instanceof \EE_PMT_Base) { |
|
70 | - if ($payment_method->type_obj()->get_gateway() instanceof EE_Onsite_Gateway) { |
|
71 | - $active_onsite_pms[] = $payment_method->name(); |
|
72 | - } elseif ($payment_method->type_obj()->get_gateway() instanceof EE_Offsite_Gateway) { |
|
73 | - $active_offsite_pms[] = $payment_method->name(); |
|
74 | - } |
|
75 | - } |
|
76 | - } |
|
77 | - $session_lifespan_in_hours = round($this->session_lifespan->inSeconds() / HOUR_IN_SECONDS); |
|
78 | - return (string) EEH_Template::display_template( |
|
79 | - __DIR__ . '/privacy_policy.template.php', |
|
80 | - array( |
|
81 | - 'active_onsite_payment_methods' => $active_onsite_pms, |
|
82 | - 'active_offsite_payment_methods' => $active_offsite_pms, |
|
83 | - 'session_lifespan' => sprintf( |
|
84 | - _nx( |
|
85 | - '%1$s hour', |
|
86 | - '%1$s hours', |
|
87 | - $session_lifespan_in_hours, |
|
88 | - '2 hours', |
|
89 | - 'event_espresso' |
|
90 | - ), |
|
91 | - $session_lifespan_in_hours |
|
92 | - ) |
|
93 | - ), |
|
94 | - true |
|
95 | - ); |
|
96 | - } |
|
57 | + /** |
|
58 | + * Gets the HTML for the privacy policy. May be dynamic |
|
59 | + * |
|
60 | + * @return string |
|
61 | + */ |
|
62 | + public function getContent() |
|
63 | + { |
|
64 | + // do they have any offsite payment methods? or onsite payment methods? |
|
65 | + $active_payment_methods = $this->payment_method_model->get_all_active(EEM_Payment_Method::scope_cart); |
|
66 | + $active_onsite_pms = array(); |
|
67 | + $active_offsite_pms = array(); |
|
68 | + foreach ($active_payment_methods as $payment_method) { |
|
69 | + if ($payment_method->type_obj() instanceof \EE_PMT_Base) { |
|
70 | + if ($payment_method->type_obj()->get_gateway() instanceof EE_Onsite_Gateway) { |
|
71 | + $active_onsite_pms[] = $payment_method->name(); |
|
72 | + } elseif ($payment_method->type_obj()->get_gateway() instanceof EE_Offsite_Gateway) { |
|
73 | + $active_offsite_pms[] = $payment_method->name(); |
|
74 | + } |
|
75 | + } |
|
76 | + } |
|
77 | + $session_lifespan_in_hours = round($this->session_lifespan->inSeconds() / HOUR_IN_SECONDS); |
|
78 | + return (string) EEH_Template::display_template( |
|
79 | + __DIR__ . '/privacy_policy.template.php', |
|
80 | + array( |
|
81 | + 'active_onsite_payment_methods' => $active_onsite_pms, |
|
82 | + 'active_offsite_payment_methods' => $active_offsite_pms, |
|
83 | + 'session_lifespan' => sprintf( |
|
84 | + _nx( |
|
85 | + '%1$s hour', |
|
86 | + '%1$s hours', |
|
87 | + $session_lifespan_in_hours, |
|
88 | + '2 hours', |
|
89 | + 'event_espresso' |
|
90 | + ), |
|
91 | + $session_lifespan_in_hours |
|
92 | + ) |
|
93 | + ), |
|
94 | + true |
|
95 | + ); |
|
96 | + } |
|
97 | 97 | } |
98 | 98 | // End of file PrivacyPolicy.php |
99 | 99 | // Location: EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy.php |
@@ -17,142 +17,142 @@ |
||
17 | 17 | class JavascriptAsset extends BrowserAsset |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var boolean $load_in_footer |
|
22 | - */ |
|
23 | - private $load_in_footer = false; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var boolean $requires_translation |
|
27 | - */ |
|
28 | - private $requires_translation = false; |
|
29 | - |
|
30 | - /** |
|
31 | - * @var boolean $has_localized_data |
|
32 | - */ |
|
33 | - private $has_localized_data = false; |
|
34 | - |
|
35 | - /** |
|
36 | - * @var Closure $localization_callback |
|
37 | - */ |
|
38 | - private $localization_callback; |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * Asset constructor. |
|
43 | - * |
|
44 | - * @param string $handle |
|
45 | - * @param string $source |
|
46 | - * @param array $dependencies |
|
47 | - * @param bool $load_in_footer |
|
48 | - * @param DomainInterface $domain |
|
49 | - * @throws InvalidDataTypeException |
|
50 | - */ |
|
51 | - public function __construct( |
|
52 | - $handle, |
|
53 | - $source, |
|
54 | - array $dependencies, |
|
55 | - $load_in_footer, |
|
56 | - DomainInterface $domain |
|
57 | - ) { |
|
58 | - parent::__construct(Asset::TYPE_JS, $handle, $source, $dependencies, $domain); |
|
59 | - $this->setLoadInFooter($load_in_footer); |
|
60 | - } |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * @return bool |
|
65 | - */ |
|
66 | - public function loadInFooter() |
|
67 | - { |
|
68 | - return $this->load_in_footer; |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @param bool $load_in_footer |
|
74 | - */ |
|
75 | - private function setLoadInFooter($load_in_footer = true) |
|
76 | - { |
|
77 | - $this->load_in_footer = filter_var($load_in_footer, FILTER_VALIDATE_BOOLEAN); |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * @return bool |
|
83 | - */ |
|
84 | - public function requiresTranslation() |
|
85 | - { |
|
86 | - return $this->requires_translation; |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * @param bool $requires_translation |
|
92 | - * @return JavascriptAsset |
|
93 | - */ |
|
94 | - public function setRequiresTranslation($requires_translation = true) |
|
95 | - { |
|
96 | - $this->requires_translation = filter_var($requires_translation, FILTER_VALIDATE_BOOLEAN); |
|
97 | - return $this; |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * @return bool |
|
103 | - */ |
|
104 | - public function hasLocalizedData() |
|
105 | - { |
|
106 | - return $this->has_localized_data; |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * @param bool $has_localized_data |
|
112 | - * @return JavascriptAsset |
|
113 | - */ |
|
114 | - public function setHasLocalizedData($has_localized_data = true) |
|
115 | - { |
|
116 | - $this->has_localized_data = filter_var($has_localized_data, FILTER_VALIDATE_BOOLEAN); |
|
117 | - return $this; |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * @return Closure |
|
123 | - */ |
|
124 | - public function localizationCallback() |
|
125 | - { |
|
126 | - return $this->localization_callback; |
|
127 | - } |
|
128 | - |
|
129 | - |
|
130 | - /** |
|
131 | - * @return bool |
|
132 | - */ |
|
133 | - public function hasLocalizationCallback() |
|
134 | - { |
|
135 | - return $this->localization_callback instanceof Closure; |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param Closure $localization_callback |
|
141 | - * @return JavascriptAsset |
|
142 | - */ |
|
143 | - public function setLocalizationCallback(Closure $localization_callback) |
|
144 | - { |
|
145 | - $this->localization_callback = $localization_callback; |
|
146 | - $this->setHasLocalizedData(); |
|
147 | - return $this; |
|
148 | - } |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * @since $VID:$ |
|
153 | - */ |
|
154 | - public function enqueueAsset() |
|
155 | - { |
|
156 | - wp_enqueue_script($this->handle()); |
|
157 | - } |
|
20 | + /** |
|
21 | + * @var boolean $load_in_footer |
|
22 | + */ |
|
23 | + private $load_in_footer = false; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var boolean $requires_translation |
|
27 | + */ |
|
28 | + private $requires_translation = false; |
|
29 | + |
|
30 | + /** |
|
31 | + * @var boolean $has_localized_data |
|
32 | + */ |
|
33 | + private $has_localized_data = false; |
|
34 | + |
|
35 | + /** |
|
36 | + * @var Closure $localization_callback |
|
37 | + */ |
|
38 | + private $localization_callback; |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * Asset constructor. |
|
43 | + * |
|
44 | + * @param string $handle |
|
45 | + * @param string $source |
|
46 | + * @param array $dependencies |
|
47 | + * @param bool $load_in_footer |
|
48 | + * @param DomainInterface $domain |
|
49 | + * @throws InvalidDataTypeException |
|
50 | + */ |
|
51 | + public function __construct( |
|
52 | + $handle, |
|
53 | + $source, |
|
54 | + array $dependencies, |
|
55 | + $load_in_footer, |
|
56 | + DomainInterface $domain |
|
57 | + ) { |
|
58 | + parent::__construct(Asset::TYPE_JS, $handle, $source, $dependencies, $domain); |
|
59 | + $this->setLoadInFooter($load_in_footer); |
|
60 | + } |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * @return bool |
|
65 | + */ |
|
66 | + public function loadInFooter() |
|
67 | + { |
|
68 | + return $this->load_in_footer; |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @param bool $load_in_footer |
|
74 | + */ |
|
75 | + private function setLoadInFooter($load_in_footer = true) |
|
76 | + { |
|
77 | + $this->load_in_footer = filter_var($load_in_footer, FILTER_VALIDATE_BOOLEAN); |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * @return bool |
|
83 | + */ |
|
84 | + public function requiresTranslation() |
|
85 | + { |
|
86 | + return $this->requires_translation; |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * @param bool $requires_translation |
|
92 | + * @return JavascriptAsset |
|
93 | + */ |
|
94 | + public function setRequiresTranslation($requires_translation = true) |
|
95 | + { |
|
96 | + $this->requires_translation = filter_var($requires_translation, FILTER_VALIDATE_BOOLEAN); |
|
97 | + return $this; |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * @return bool |
|
103 | + */ |
|
104 | + public function hasLocalizedData() |
|
105 | + { |
|
106 | + return $this->has_localized_data; |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * @param bool $has_localized_data |
|
112 | + * @return JavascriptAsset |
|
113 | + */ |
|
114 | + public function setHasLocalizedData($has_localized_data = true) |
|
115 | + { |
|
116 | + $this->has_localized_data = filter_var($has_localized_data, FILTER_VALIDATE_BOOLEAN); |
|
117 | + return $this; |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * @return Closure |
|
123 | + */ |
|
124 | + public function localizationCallback() |
|
125 | + { |
|
126 | + return $this->localization_callback; |
|
127 | + } |
|
128 | + |
|
129 | + |
|
130 | + /** |
|
131 | + * @return bool |
|
132 | + */ |
|
133 | + public function hasLocalizationCallback() |
|
134 | + { |
|
135 | + return $this->localization_callback instanceof Closure; |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param Closure $localization_callback |
|
141 | + * @return JavascriptAsset |
|
142 | + */ |
|
143 | + public function setLocalizationCallback(Closure $localization_callback) |
|
144 | + { |
|
145 | + $this->localization_callback = $localization_callback; |
|
146 | + $this->setHasLocalizedData(); |
|
147 | + return $this; |
|
148 | + } |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * @since $VID:$ |
|
153 | + */ |
|
154 | + public function enqueueAsset() |
|
155 | + { |
|
156 | + wp_enqueue_script($this->handle()); |
|
157 | + } |
|
158 | 158 | } |
@@ -20,85 +20,85 @@ |
||
20 | 20 | interface AssetManagerInterface |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * @since $VID:$ |
|
25 | - */ |
|
26 | - public function addAssets(); |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * @return ManifestFile |
|
31 | - * @throws DuplicateCollectionIdentifierException |
|
32 | - * @throws InvalidDataTypeException |
|
33 | - * @throws InvalidEntityException |
|
34 | - * @since $VID:$ |
|
35 | - */ |
|
36 | - public function addManifestFile(); |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * @return ManifestFile[] |
|
41 | - * @since $VID:$ |
|
42 | - */ |
|
43 | - public function getManifestFile(); |
|
44 | - |
|
45 | - |
|
46 | - /** |
|
47 | - * @param string $handle |
|
48 | - * @param string $source |
|
49 | - * @param array $dependencies |
|
50 | - * @param bool $load_in_footer |
|
51 | - * @return JavascriptAsset |
|
52 | - * @throws DuplicateCollectionIdentifierException |
|
53 | - * @throws InvalidDataTypeException |
|
54 | - * @throws InvalidEntityException |
|
55 | - * @since $VID:$ |
|
56 | - */ |
|
57 | - public function addJavascript( |
|
58 | - $handle, |
|
59 | - $source, |
|
60 | - array $dependencies = array(), |
|
61 | - $load_in_footer = true |
|
62 | - ); |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * @return JavascriptAsset[] |
|
67 | - * @since $VID:$ |
|
68 | - */ |
|
69 | - public function getJavascriptAssets(); |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @param string $handle |
|
74 | - * @param string $source |
|
75 | - * @param array $dependencies |
|
76 | - * @param string $media |
|
77 | - * @return StylesheetAsset |
|
78 | - * @throws DuplicateCollectionIdentifierException |
|
79 | - * @throws InvalidDataTypeException |
|
80 | - * @throws InvalidEntityException |
|
81 | - * @since $VID:$ |
|
82 | - */ |
|
83 | - public function addStylesheet( |
|
84 | - $handle, |
|
85 | - $source, |
|
86 | - array $dependencies = array(), |
|
87 | - $media = 'all' |
|
88 | - ); |
|
89 | - |
|
90 | - |
|
91 | - /** |
|
92 | - * @return StylesheetAsset[] |
|
93 | - * @since $VID:$ |
|
94 | - */ |
|
95 | - public function getStylesheetAssets(); |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @param string $handle |
|
100 | - * @return bool |
|
101 | - * @since $VID:$ |
|
102 | - */ |
|
103 | - public function enqueueAsset($handle); |
|
23 | + /** |
|
24 | + * @since $VID:$ |
|
25 | + */ |
|
26 | + public function addAssets(); |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * @return ManifestFile |
|
31 | + * @throws DuplicateCollectionIdentifierException |
|
32 | + * @throws InvalidDataTypeException |
|
33 | + * @throws InvalidEntityException |
|
34 | + * @since $VID:$ |
|
35 | + */ |
|
36 | + public function addManifestFile(); |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * @return ManifestFile[] |
|
41 | + * @since $VID:$ |
|
42 | + */ |
|
43 | + public function getManifestFile(); |
|
44 | + |
|
45 | + |
|
46 | + /** |
|
47 | + * @param string $handle |
|
48 | + * @param string $source |
|
49 | + * @param array $dependencies |
|
50 | + * @param bool $load_in_footer |
|
51 | + * @return JavascriptAsset |
|
52 | + * @throws DuplicateCollectionIdentifierException |
|
53 | + * @throws InvalidDataTypeException |
|
54 | + * @throws InvalidEntityException |
|
55 | + * @since $VID:$ |
|
56 | + */ |
|
57 | + public function addJavascript( |
|
58 | + $handle, |
|
59 | + $source, |
|
60 | + array $dependencies = array(), |
|
61 | + $load_in_footer = true |
|
62 | + ); |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * @return JavascriptAsset[] |
|
67 | + * @since $VID:$ |
|
68 | + */ |
|
69 | + public function getJavascriptAssets(); |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @param string $handle |
|
74 | + * @param string $source |
|
75 | + * @param array $dependencies |
|
76 | + * @param string $media |
|
77 | + * @return StylesheetAsset |
|
78 | + * @throws DuplicateCollectionIdentifierException |
|
79 | + * @throws InvalidDataTypeException |
|
80 | + * @throws InvalidEntityException |
|
81 | + * @since $VID:$ |
|
82 | + */ |
|
83 | + public function addStylesheet( |
|
84 | + $handle, |
|
85 | + $source, |
|
86 | + array $dependencies = array(), |
|
87 | + $media = 'all' |
|
88 | + ); |
|
89 | + |
|
90 | + |
|
91 | + /** |
|
92 | + * @return StylesheetAsset[] |
|
93 | + * @since $VID:$ |
|
94 | + */ |
|
95 | + public function getStylesheetAssets(); |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @param string $handle |
|
100 | + * @return bool |
|
101 | + * @since $VID:$ |
|
102 | + */ |
|
103 | + public function enqueueAsset($handle); |
|
104 | 104 | } |
@@ -21,161 +21,161 @@ |
||
21 | 21 | abstract class AssetManager implements AssetManagerInterface |
22 | 22 | { |
23 | 23 | |
24 | - /** |
|
25 | - * @var AssetCollection $assets |
|
26 | - */ |
|
27 | - protected $assets; |
|
28 | - |
|
29 | - /** |
|
30 | - * @var DomainInterface |
|
31 | - */ |
|
32 | - protected $domain; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var Registry $registry |
|
36 | - */ |
|
37 | - protected $registry; |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * AssetRegister constructor. |
|
42 | - * |
|
43 | - * @param DomainInterface $domain |
|
44 | - * @param AssetCollection $assets |
|
45 | - * @param Registry $registry |
|
46 | - */ |
|
47 | - public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry) |
|
48 | - { |
|
49 | - $this->domain = $domain; |
|
50 | - $this->assets = $assets; |
|
51 | - $this->registry = $registry; |
|
52 | - add_action('wp_enqueue_scripts', array($this, 'addManifestFile'), 0); |
|
53 | - add_action('admin_enqueue_scripts', array($this, 'addManifestFile'), 0); |
|
54 | - add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2); |
|
55 | - add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2); |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * @return void |
|
61 | - * @throws DuplicateCollectionIdentifierException |
|
62 | - * @throws InvalidDataTypeException |
|
63 | - * @throws InvalidEntityException |
|
64 | - * @since $VID:$ |
|
65 | - */ |
|
66 | - public function addManifestFile() |
|
67 | - { |
|
68 | - // if a manifest file has already been added for this domain, then just return that one |
|
69 | - if ($this->assets->has($this->domain->assetNamespace())) { |
|
70 | - return; |
|
71 | - } |
|
72 | - $asset = new ManifestFile($this->domain); |
|
73 | - $this->assets->add($asset, $this->domain->assetNamespace()); |
|
74 | - } |
|
75 | - |
|
76 | - |
|
77 | - /** |
|
78 | - * @return ManifestFile[] |
|
79 | - * @since $VID:$ |
|
80 | - */ |
|
81 | - public function getManifestFile() |
|
82 | - { |
|
83 | - return $this->assets->getManifestFiles(); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * @param string $handle |
|
89 | - * @param string $source |
|
90 | - * @param array $dependencies |
|
91 | - * @param bool $load_in_footer |
|
92 | - * @return JavascriptAsset |
|
93 | - * @throws DuplicateCollectionIdentifierException |
|
94 | - * @throws InvalidDataTypeException |
|
95 | - * @throws InvalidEntityException |
|
96 | - * @since $VID:$ |
|
97 | - */ |
|
98 | - public function addJavascript( |
|
99 | - $handle, |
|
100 | - $source, |
|
101 | - array $dependencies = array(), |
|
102 | - $load_in_footer = true |
|
103 | - ) { |
|
104 | - $asset = new JavascriptAsset( |
|
105 | - $handle, |
|
106 | - $source, |
|
107 | - $dependencies, |
|
108 | - $load_in_footer, |
|
109 | - $this->domain |
|
110 | - ); |
|
111 | - $this->assets->add($asset, $handle); |
|
112 | - return $asset; |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * @return JavascriptAsset[] |
|
118 | - * @since $VID:$ |
|
119 | - */ |
|
120 | - public function getJavascriptAssets() |
|
121 | - { |
|
122 | - return $this->assets->getJavascriptAssets(); |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @param string $handle |
|
128 | - * @param string $source |
|
129 | - * @param array $dependencies |
|
130 | - * @param string $media |
|
131 | - * @return StylesheetAsset |
|
132 | - * @throws DuplicateCollectionIdentifierException |
|
133 | - * @throws InvalidDataTypeException |
|
134 | - * @throws InvalidEntityException |
|
135 | - * @since $VID:$ |
|
136 | - */ |
|
137 | - public function addStylesheet( |
|
138 | - $handle, |
|
139 | - $source, |
|
140 | - array $dependencies = array(), |
|
141 | - $media = 'all' |
|
142 | - ) { |
|
143 | - $asset = new StylesheetAsset( |
|
144 | - $handle, |
|
145 | - $source, |
|
146 | - $dependencies, |
|
147 | - $this->domain, |
|
148 | - $media |
|
149 | - ); |
|
150 | - $this->assets->add($asset, $handle); |
|
151 | - return $asset; |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * @return StylesheetAsset[] |
|
157 | - * @since $VID:$ |
|
158 | - */ |
|
159 | - public function getStylesheetAssets() |
|
160 | - { |
|
161 | - return $this->assets->getStylesheetAssets(); |
|
162 | - } |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * @param string $handle |
|
167 | - * @return bool |
|
168 | - * @since $VID:$ |
|
169 | - */ |
|
170 | - public function enqueueAsset($handle) |
|
171 | - { |
|
172 | - if ($this->assets->has($handle)) { |
|
173 | - $asset = $this->assets->get($handle); |
|
174 | - if ($asset->isRegistered()) { |
|
175 | - $asset->enqueueAsset(); |
|
176 | - return true; |
|
177 | - } |
|
178 | - } |
|
179 | - return false; |
|
180 | - } |
|
24 | + /** |
|
25 | + * @var AssetCollection $assets |
|
26 | + */ |
|
27 | + protected $assets; |
|
28 | + |
|
29 | + /** |
|
30 | + * @var DomainInterface |
|
31 | + */ |
|
32 | + protected $domain; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var Registry $registry |
|
36 | + */ |
|
37 | + protected $registry; |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * AssetRegister constructor. |
|
42 | + * |
|
43 | + * @param DomainInterface $domain |
|
44 | + * @param AssetCollection $assets |
|
45 | + * @param Registry $registry |
|
46 | + */ |
|
47 | + public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry) |
|
48 | + { |
|
49 | + $this->domain = $domain; |
|
50 | + $this->assets = $assets; |
|
51 | + $this->registry = $registry; |
|
52 | + add_action('wp_enqueue_scripts', array($this, 'addManifestFile'), 0); |
|
53 | + add_action('admin_enqueue_scripts', array($this, 'addManifestFile'), 0); |
|
54 | + add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2); |
|
55 | + add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2); |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * @return void |
|
61 | + * @throws DuplicateCollectionIdentifierException |
|
62 | + * @throws InvalidDataTypeException |
|
63 | + * @throws InvalidEntityException |
|
64 | + * @since $VID:$ |
|
65 | + */ |
|
66 | + public function addManifestFile() |
|
67 | + { |
|
68 | + // if a manifest file has already been added for this domain, then just return that one |
|
69 | + if ($this->assets->has($this->domain->assetNamespace())) { |
|
70 | + return; |
|
71 | + } |
|
72 | + $asset = new ManifestFile($this->domain); |
|
73 | + $this->assets->add($asset, $this->domain->assetNamespace()); |
|
74 | + } |
|
75 | + |
|
76 | + |
|
77 | + /** |
|
78 | + * @return ManifestFile[] |
|
79 | + * @since $VID:$ |
|
80 | + */ |
|
81 | + public function getManifestFile() |
|
82 | + { |
|
83 | + return $this->assets->getManifestFiles(); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * @param string $handle |
|
89 | + * @param string $source |
|
90 | + * @param array $dependencies |
|
91 | + * @param bool $load_in_footer |
|
92 | + * @return JavascriptAsset |
|
93 | + * @throws DuplicateCollectionIdentifierException |
|
94 | + * @throws InvalidDataTypeException |
|
95 | + * @throws InvalidEntityException |
|
96 | + * @since $VID:$ |
|
97 | + */ |
|
98 | + public function addJavascript( |
|
99 | + $handle, |
|
100 | + $source, |
|
101 | + array $dependencies = array(), |
|
102 | + $load_in_footer = true |
|
103 | + ) { |
|
104 | + $asset = new JavascriptAsset( |
|
105 | + $handle, |
|
106 | + $source, |
|
107 | + $dependencies, |
|
108 | + $load_in_footer, |
|
109 | + $this->domain |
|
110 | + ); |
|
111 | + $this->assets->add($asset, $handle); |
|
112 | + return $asset; |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * @return JavascriptAsset[] |
|
118 | + * @since $VID:$ |
|
119 | + */ |
|
120 | + public function getJavascriptAssets() |
|
121 | + { |
|
122 | + return $this->assets->getJavascriptAssets(); |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @param string $handle |
|
128 | + * @param string $source |
|
129 | + * @param array $dependencies |
|
130 | + * @param string $media |
|
131 | + * @return StylesheetAsset |
|
132 | + * @throws DuplicateCollectionIdentifierException |
|
133 | + * @throws InvalidDataTypeException |
|
134 | + * @throws InvalidEntityException |
|
135 | + * @since $VID:$ |
|
136 | + */ |
|
137 | + public function addStylesheet( |
|
138 | + $handle, |
|
139 | + $source, |
|
140 | + array $dependencies = array(), |
|
141 | + $media = 'all' |
|
142 | + ) { |
|
143 | + $asset = new StylesheetAsset( |
|
144 | + $handle, |
|
145 | + $source, |
|
146 | + $dependencies, |
|
147 | + $this->domain, |
|
148 | + $media |
|
149 | + ); |
|
150 | + $this->assets->add($asset, $handle); |
|
151 | + return $asset; |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * @return StylesheetAsset[] |
|
157 | + * @since $VID:$ |
|
158 | + */ |
|
159 | + public function getStylesheetAssets() |
|
160 | + { |
|
161 | + return $this->assets->getStylesheetAssets(); |
|
162 | + } |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * @param string $handle |
|
167 | + * @return bool |
|
168 | + * @since $VID:$ |
|
169 | + */ |
|
170 | + public function enqueueAsset($handle) |
|
171 | + { |
|
172 | + if ($this->assets->has($handle)) { |
|
173 | + $asset = $this->assets->get($handle); |
|
174 | + if ($asset->isRegistered()) { |
|
175 | + $asset->enqueueAsset(); |
|
176 | + return true; |
|
177 | + } |
|
178 | + } |
|
179 | + return false; |
|
180 | + } |
|
181 | 181 | } |