@@ -361,7 +361,7 @@ discard block |
||
361 | 361 | * Adds instructions on how to brew objects |
362 | 362 | * |
363 | 363 | * @param RecipeInterface $recipe |
364 | - * @return mixed |
|
364 | + * @return boolean |
|
365 | 365 | * @throws InvalidIdentifierException |
366 | 366 | */ |
367 | 367 | public function addRecipe(RecipeInterface $recipe) |
@@ -461,7 +461,7 @@ discard block |
||
461 | 461 | /** |
462 | 462 | * Adds a service to one of the internal collections |
463 | 463 | * |
464 | - * @param $identifier |
|
464 | + * @param string $identifier |
|
465 | 465 | * @param array $arguments |
466 | 466 | * @param string $type |
467 | 467 | * @return mixed |
@@ -30,569 +30,569 @@ |
||
30 | 30 | { |
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * This was the best coffee related name I could think of to represent class name "aliases" |
|
35 | - * So classes can be found via an alias identifier, |
|
36 | - * that is revealed when it is run through... the filters... eh? get it? |
|
37 | - * |
|
38 | - * @var array $filters |
|
39 | - */ |
|
40 | - private $filters; |
|
41 | - |
|
42 | - /** |
|
43 | - * These are the classes that will actually build the objects (to order of course) |
|
44 | - * |
|
45 | - * @var array $coffee_makers |
|
46 | - */ |
|
47 | - private $coffee_makers; |
|
48 | - |
|
49 | - /** |
|
50 | - * where the instantiated "singleton" objects are stored |
|
51 | - * |
|
52 | - * @var CollectionInterface $carafe |
|
53 | - */ |
|
54 | - private $carafe; |
|
55 | - |
|
56 | - /** |
|
57 | - * collection of Recipes that instruct us how to brew objects |
|
58 | - * |
|
59 | - * @var CollectionInterface $recipes |
|
60 | - */ |
|
61 | - private $recipes; |
|
62 | - |
|
63 | - /** |
|
64 | - * collection of closures for brewing objects |
|
65 | - * |
|
66 | - * @var CollectionInterface $reservoir |
|
67 | - */ |
|
68 | - private $reservoir; |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * CoffeeShop constructor |
|
73 | - * |
|
74 | - * @throws InvalidInterfaceException |
|
75 | - */ |
|
76 | - public function __construct() |
|
77 | - { |
|
78 | - // array for storing class aliases |
|
79 | - $this->filters = array(); |
|
80 | - // create collection for storing shared services |
|
81 | - $this->carafe = new LooseCollection(''); |
|
82 | - // create collection for storing recipes that tell us how to build services and entities |
|
83 | - $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface'); |
|
84 | - // create collection for storing closures for constructing new entities |
|
85 | - $this->reservoir = new Collection('Closure'); |
|
86 | - // create collection for storing the generators that build our services and entity closures |
|
87 | - $this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface'); |
|
88 | - } |
|
89 | - |
|
90 | - |
|
91 | - /** |
|
92 | - * Returns true if the container can return an entry for the given identifier. |
|
93 | - * Returns false otherwise. |
|
94 | - * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception. |
|
95 | - * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`. |
|
96 | - * |
|
97 | - * @param string $identifier Identifier of the entry to look for. |
|
98 | - * Typically a Fully Qualified Class Name |
|
99 | - * @return boolean |
|
100 | - * @throws InvalidIdentifierException |
|
101 | - */ |
|
102 | - public function has($identifier) |
|
103 | - { |
|
104 | - $identifier = $this->filterIdentifier($identifier); |
|
105 | - return $this->carafe->has($identifier); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * finds a previously brewed (SHARED) service and returns it |
|
111 | - * |
|
112 | - * @param string $identifier Identifier for the entity class to be constructed. |
|
113 | - * Typically a Fully Qualified Class Name |
|
114 | - * @return mixed |
|
115 | - * @throws InvalidIdentifierException |
|
116 | - * @throws ServiceNotFoundException No service was found for this identifier. |
|
117 | - */ |
|
118 | - public function get($identifier) |
|
119 | - { |
|
120 | - $identifier = $this->filterIdentifier($identifier); |
|
121 | - if ($this->carafe->has($identifier)) { |
|
122 | - return $this->carafe->get($identifier); |
|
123 | - } |
|
124 | - throw new ServiceNotFoundException($identifier); |
|
125 | - } |
|
126 | - |
|
127 | - |
|
128 | - /** |
|
129 | - * returns an instance of the requested entity type using the supplied arguments. |
|
130 | - * If a shared service is requested and an instance is already in the carafe, then it will be returned. |
|
131 | - * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned |
|
132 | - * If the request is for a new entity and a closure exists in the reservoir for creating it, |
|
133 | - * then a new entity will be instantiated from the closure and returned. |
|
134 | - * If a closure does not exist, then one will be built and added to the reservoir |
|
135 | - * before instantiating the requested entity. |
|
136 | - * |
|
137 | - * @param string $identifier Identifier for the entity class to be constructed. |
|
138 | - * Typically a Fully Qualified Class Name |
|
139 | - * @param array $arguments an array of arguments to be passed to the entity constructor |
|
140 | - * @param string $type |
|
141 | - * @return mixed |
|
142 | - * @throws OutOfBoundsException |
|
143 | - * @throws InstantiationException |
|
144 | - * @throws InvalidDataTypeException |
|
145 | - * @throws InvalidClassException |
|
146 | - * @throws InvalidIdentifierException |
|
147 | - * @throws ServiceExistsException |
|
148 | - * @throws ServiceNotFoundException No service was found for this identifier. |
|
149 | - */ |
|
150 | - public function brew($identifier, $arguments = array(), $type = '') |
|
151 | - { |
|
152 | - // resolve any class aliases that may exist |
|
153 | - $identifier = $this->filterIdentifier($identifier); |
|
154 | - // is a shared service being requested and already exists in the carafe? |
|
155 | - $brewed = $this->getShared($identifier, $type); |
|
156 | - // then return whatever was found |
|
157 | - if ($brewed !== false) { |
|
158 | - return $brewed; |
|
159 | - } |
|
160 | - // if the reservoir doesn't have a closure already for the requested identifier, |
|
161 | - // then neither a shared service nor a closure for making entities has been built yet |
|
162 | - if (! $this->reservoir->has($identifier)) { |
|
163 | - // so let's brew something up and add it to the proper collection |
|
164 | - $brewed = $this->makeCoffee($identifier, $arguments, $type); |
|
165 | - } |
|
166 | - // did the requested class only require loading, and if so, was that successful? |
|
167 | - if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) { |
|
168 | - return true; |
|
169 | - } |
|
170 | - // was the brewed item a callable factory function ? |
|
171 | - if (is_callable($brewed)) { |
|
172 | - // then instantiate a new entity from the cached closure |
|
173 | - return $brewed($arguments); |
|
174 | - } |
|
175 | - if ($brewed) { |
|
176 | - // requested object was a shared entity, so attempt to get it from the carafe again |
|
177 | - // because if it wasn't there before, then it should have just been brewed and added, |
|
178 | - // but if it still isn't there, then this time the thrown ServiceNotFoundException will not be caught |
|
179 | - return $this->get($identifier); |
|
180 | - } |
|
181 | - // if identifier is for a non-shared entity, |
|
182 | - // then either a cached closure already existed, or was just brewed |
|
183 | - return $this->brewedClosure($identifier, $arguments); |
|
184 | - } |
|
185 | - |
|
186 | - |
|
187 | - /** |
|
188 | - * @param string $identifier |
|
189 | - * @param string $type |
|
190 | - * @return bool|mixed |
|
191 | - * @throws InvalidIdentifierException |
|
192 | - */ |
|
193 | - protected function getShared($identifier, $type) |
|
194 | - { |
|
195 | - try { |
|
196 | - if (empty($type) || $type === CoffeeMaker::BREW_SHARED) { |
|
197 | - // if a shared service was requested and an instance is in the carafe, then return it |
|
198 | - return $this->get($identifier); |
|
199 | - } |
|
200 | - } catch (ServiceNotFoundException $e) { |
|
201 | - // if not then we'll just catch the ServiceNotFoundException but not do anything just yet, |
|
202 | - // and instead, attempt to build whatever was requested |
|
203 | - } |
|
204 | - return false; |
|
205 | - } |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * @param mixed $brewed |
|
210 | - * @param string $identifier |
|
211 | - * @param string $type |
|
212 | - * @return bool |
|
213 | - * @throws InvalidClassException |
|
214 | - * @throws InvalidDataTypeException |
|
215 | - * @throws InvalidIdentifierException |
|
216 | - * @throws OutOfBoundsException |
|
217 | - * @throws ServiceExistsException |
|
218 | - * @throws ServiceNotFoundException |
|
219 | - */ |
|
220 | - protected function brewedLoadOnly($brewed, $identifier, $type) |
|
221 | - { |
|
222 | - if ($type === CoffeeMaker::BREW_LOAD_ONLY) { |
|
223 | - if ($brewed !== true) { |
|
224 | - throw new ServiceNotFoundException( |
|
225 | - sprintf( |
|
226 | - esc_html__( |
|
227 | - 'The "%1$s" class could not be loaded.', |
|
228 | - 'event_espresso' |
|
229 | - ), |
|
230 | - $identifier |
|
231 | - ) |
|
232 | - ); |
|
233 | - } |
|
234 | - return true; |
|
235 | - } |
|
236 | - return false; |
|
237 | - } |
|
238 | - |
|
239 | - |
|
240 | - /** |
|
241 | - * @param string $identifier |
|
242 | - * @param array $arguments |
|
243 | - * @return mixed |
|
244 | - * @throws InstantiationException |
|
245 | - */ |
|
246 | - protected function brewedClosure($identifier, array $arguments) |
|
247 | - { |
|
248 | - $closure = $this->reservoir->get($identifier); |
|
249 | - if (empty($closure)) { |
|
250 | - throw new InstantiationException( |
|
251 | - sprintf( |
|
252 | - esc_html__( |
|
253 | - 'Could not brew an instance of "%1$s".', |
|
254 | - 'event_espresso' |
|
255 | - ), |
|
256 | - $identifier |
|
257 | - ) |
|
258 | - ); |
|
259 | - } |
|
260 | - return $closure($arguments); |
|
261 | - } |
|
262 | - |
|
263 | - |
|
264 | - /** |
|
265 | - * @param CoffeeMakerInterface $coffee_maker |
|
266 | - * @param string $type |
|
267 | - * @return bool |
|
268 | - * @throws InvalidIdentifierException |
|
269 | - * @throws InvalidEntityException |
|
270 | - */ |
|
271 | - public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type) |
|
272 | - { |
|
273 | - $type = CoffeeMaker::validateType($type); |
|
274 | - return $this->coffee_makers->add($coffee_maker, $type); |
|
275 | - } |
|
276 | - |
|
277 | - |
|
278 | - /** |
|
279 | - * @param string $identifier |
|
280 | - * @param callable $closure |
|
281 | - * @return callable|null |
|
282 | - * @throws InvalidIdentifierException |
|
283 | - * @throws InvalidDataTypeException |
|
284 | - */ |
|
285 | - public function addClosure($identifier, $closure) |
|
286 | - { |
|
287 | - if (! is_callable($closure)) { |
|
288 | - throw new InvalidDataTypeException('$closure', $closure, 'Closure'); |
|
289 | - } |
|
290 | - $identifier = $this->processIdentifier($identifier); |
|
291 | - if ($this->reservoir->add($closure, $identifier)) { |
|
292 | - return $closure; |
|
293 | - } |
|
294 | - return null; |
|
295 | - } |
|
296 | - |
|
297 | - |
|
298 | - /** |
|
299 | - * @param string $identifier |
|
300 | - * @return boolean |
|
301 | - * @throws InvalidIdentifierException |
|
302 | - */ |
|
303 | - public function removeClosure($identifier) |
|
304 | - { |
|
305 | - $identifier = $this->processIdentifier($identifier); |
|
306 | - if ($this->reservoir->has($identifier)) { |
|
307 | - return $this->reservoir->remove($this->reservoir->get($identifier)); |
|
308 | - } |
|
309 | - return false; |
|
310 | - } |
|
311 | - |
|
312 | - |
|
313 | - /** |
|
314 | - * @param string $identifier Identifier for the entity class that the service applies to |
|
315 | - * Typically a Fully Qualified Class Name |
|
316 | - * @param mixed $service |
|
317 | - * @return bool |
|
318 | - * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException |
|
319 | - * @throws InvalidIdentifierException |
|
320 | - */ |
|
321 | - public function addService($identifier, $service) |
|
322 | - { |
|
323 | - $identifier = $this->processIdentifier($identifier); |
|
324 | - $service = $this->validateService($identifier, $service); |
|
325 | - return $this->carafe->add($service, $identifier); |
|
326 | - } |
|
327 | - |
|
328 | - |
|
329 | - /** |
|
330 | - * @param string $identifier |
|
331 | - * @return boolean |
|
332 | - * @throws InvalidIdentifierException |
|
333 | - */ |
|
334 | - public function removeService($identifier) |
|
335 | - { |
|
336 | - $identifier = $this->processIdentifier($identifier); |
|
337 | - if ($this->carafe->has($identifier)) { |
|
338 | - return $this->carafe->remove($this->carafe->get($identifier)); |
|
339 | - } |
|
340 | - return false; |
|
341 | - } |
|
342 | - |
|
343 | - |
|
344 | - /** |
|
345 | - * Adds instructions on how to brew objects |
|
346 | - * |
|
347 | - * @param RecipeInterface $recipe |
|
348 | - * @return mixed |
|
349 | - * @throws InvalidIdentifierException |
|
350 | - */ |
|
351 | - public function addRecipe(RecipeInterface $recipe) |
|
352 | - { |
|
353 | - $this->addAliases($recipe->identifier(), $recipe->filters()); |
|
354 | - $identifier = $this->processIdentifier($recipe->identifier()); |
|
355 | - return $this->recipes->add($recipe, $identifier); |
|
356 | - } |
|
357 | - |
|
358 | - |
|
359 | - /** |
|
360 | - * @param string $identifier The Recipe's identifier |
|
361 | - * @return boolean |
|
362 | - * @throws InvalidIdentifierException |
|
363 | - */ |
|
364 | - public function removeRecipe($identifier) |
|
365 | - { |
|
366 | - $identifier = $this->processIdentifier($identifier); |
|
367 | - if ($this->recipes->has($identifier)) { |
|
368 | - return $this->recipes->remove($this->recipes->get($identifier)); |
|
369 | - } |
|
370 | - return false; |
|
371 | - } |
|
372 | - |
|
373 | - |
|
374 | - /** |
|
375 | - * Get instructions on how to brew objects |
|
376 | - * |
|
377 | - * @param string $identifier Identifier for the entity class that the recipe applies to |
|
378 | - * Typically a Fully Qualified Class Name |
|
379 | - * @param string $type |
|
380 | - * @return RecipeInterface |
|
381 | - * @throws OutOfBoundsException |
|
382 | - * @throws InvalidIdentifierException |
|
383 | - */ |
|
384 | - public function getRecipe($identifier, $type = '') |
|
385 | - { |
|
386 | - $identifier = $this->processIdentifier($identifier); |
|
387 | - if ($this->recipes->has($identifier)) { |
|
388 | - return $this->recipes->get($identifier); |
|
389 | - } |
|
390 | - $default_recipes = $this->getDefaultRecipes(); |
|
391 | - $matches = array(); |
|
392 | - foreach ($default_recipes as $wildcard => $default_recipe) { |
|
393 | - // is the wildcard recipe prefix in the identifier ? |
|
394 | - if (strpos($identifier, $wildcard) !== false) { |
|
395 | - // track matches and use the number of wildcard characters matched for the key |
|
396 | - $matches[ strlen($wildcard) ] = $default_recipe; |
|
397 | - } |
|
398 | - } |
|
399 | - if (count($matches) > 0) { |
|
400 | - // sort our recipes by the number of wildcard characters matched |
|
401 | - ksort($matches); |
|
402 | - // then grab the last recipe form the list, since it had the most matching characters |
|
403 | - $match = array_pop($matches); |
|
404 | - // since we are using a default recipe, we need to set it's identifier and fqcn |
|
405 | - return $this->copyDefaultRecipe($match, $identifier, $type); |
|
406 | - } |
|
407 | - if ($this->recipes->has(Recipe::DEFAULT_ID)) { |
|
408 | - // since we are using a default recipe, we need to set it's identifier and fqcn |
|
409 | - return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type); |
|
410 | - } |
|
411 | - throw new OutOfBoundsException( |
|
412 | - sprintf( |
|
413 | - __('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'), |
|
414 | - $identifier |
|
415 | - ) |
|
416 | - ); |
|
417 | - } |
|
418 | - |
|
419 | - |
|
420 | - /** |
|
421 | - * adds class name aliases to list of filters |
|
422 | - * |
|
423 | - * @param string $identifier Identifier for the entity class that the alias applies to |
|
424 | - * Typically a Fully Qualified Class Name |
|
425 | - * @param array|string $aliases |
|
426 | - * @return void |
|
427 | - * @throws InvalidIdentifierException |
|
428 | - */ |
|
429 | - public function addAliases($identifier, $aliases) |
|
430 | - { |
|
431 | - if (empty($aliases)) { |
|
432 | - return; |
|
433 | - } |
|
434 | - $identifier = $this->processIdentifier($identifier); |
|
435 | - foreach ((array) $aliases as $alias) { |
|
436 | - $this->filters[ $this->processIdentifier($alias) ] = $identifier; |
|
437 | - } |
|
438 | - } |
|
439 | - |
|
440 | - |
|
441 | - /** |
|
442 | - * Adds a service to one of the internal collections |
|
443 | - * |
|
444 | - * @param $identifier |
|
445 | - * @param array $arguments |
|
446 | - * @param string $type |
|
447 | - * @return mixed |
|
448 | - * @throws InvalidDataTypeException |
|
449 | - * @throws InvalidClassException |
|
450 | - * @throws OutOfBoundsException |
|
451 | - * @throws InvalidIdentifierException |
|
452 | - * @throws ServiceExistsException |
|
453 | - */ |
|
454 | - private function makeCoffee($identifier, $arguments = array(), $type = '') |
|
455 | - { |
|
456 | - if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) { |
|
457 | - throw new ServiceExistsException($identifier); |
|
458 | - } |
|
459 | - $identifier = $this->filterIdentifier($identifier); |
|
460 | - $recipe = $this->getRecipe($identifier, $type); |
|
461 | - $type = ! empty($type) ? $type : $recipe->type(); |
|
462 | - $coffee_maker = $this->getCoffeeMaker($type); |
|
463 | - return $coffee_maker->brew($recipe, $arguments); |
|
464 | - } |
|
465 | - |
|
466 | - |
|
467 | - /** |
|
468 | - * filters alias identifiers to find the real class name |
|
469 | - * |
|
470 | - * @param string $identifier Identifier for the entity class that the filter applies to |
|
471 | - * Typically a Fully Qualified Class Name |
|
472 | - * @return string |
|
473 | - * @throws InvalidIdentifierException |
|
474 | - */ |
|
475 | - private function filterIdentifier($identifier) |
|
476 | - { |
|
477 | - $identifier = $this->processIdentifier($identifier); |
|
478 | - return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ]) |
|
479 | - ? $this->filters[ $identifier ] |
|
480 | - : $identifier; |
|
481 | - } |
|
482 | - |
|
483 | - |
|
484 | - /** |
|
485 | - * verifies and standardizes identifiers |
|
486 | - * |
|
487 | - * @param string $identifier Identifier for the entity class |
|
488 | - * Typically a Fully Qualified Class Name |
|
489 | - * @return string |
|
490 | - * @throws InvalidIdentifierException |
|
491 | - */ |
|
492 | - private function processIdentifier($identifier) |
|
493 | - { |
|
494 | - if (! is_string($identifier)) { |
|
495 | - throw new InvalidIdentifierException( |
|
496 | - is_object($identifier) ? get_class($identifier) : gettype($identifier), |
|
497 | - '\Fully\Qualified\ClassName' |
|
498 | - ); |
|
499 | - } |
|
500 | - return ltrim($identifier, '\\'); |
|
501 | - } |
|
502 | - |
|
503 | - |
|
504 | - /** |
|
505 | - * @param string $type |
|
506 | - * @return CoffeeMakerInterface |
|
507 | - * @throws OutOfBoundsException |
|
508 | - * @throws InvalidDataTypeException |
|
509 | - * @throws InvalidClassException |
|
510 | - */ |
|
511 | - private function getCoffeeMaker($type) |
|
512 | - { |
|
513 | - if (! $this->coffee_makers->has($type)) { |
|
514 | - throw new OutOfBoundsException( |
|
515 | - __('The requested coffee maker is either missing or invalid.', 'event_espresso') |
|
516 | - ); |
|
517 | - } |
|
518 | - return $this->coffee_makers->get($type); |
|
519 | - } |
|
520 | - |
|
521 | - |
|
522 | - /** |
|
523 | - * Retrieves all recipes that use a wildcard "*" in their identifier |
|
524 | - * This allows recipes to be set up for handling |
|
525 | - * legacy classes that do not support PSR-4 autoloading. |
|
526 | - * for example: |
|
527 | - * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee |
|
528 | - * |
|
529 | - * @return array |
|
530 | - */ |
|
531 | - private function getDefaultRecipes() |
|
532 | - { |
|
533 | - $default_recipes = array(); |
|
534 | - $this->recipes->rewind(); |
|
535 | - while ($this->recipes->valid()) { |
|
536 | - $identifier = $this->recipes->getInfo(); |
|
537 | - // does this recipe use a wildcard ? (but is NOT the global default) |
|
538 | - if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) { |
|
539 | - // strip the wildcard and use identifier as key |
|
540 | - $default_recipes[ str_replace('*', '', $identifier) ] = $this->recipes->current(); |
|
541 | - } |
|
542 | - $this->recipes->next(); |
|
543 | - } |
|
544 | - return $default_recipes; |
|
545 | - } |
|
546 | - |
|
547 | - |
|
548 | - /** |
|
549 | - * clones a default recipe and then copies details |
|
550 | - * from the incoming request to it so that it can be used |
|
551 | - * |
|
552 | - * @param RecipeInterface $default_recipe |
|
553 | - * @param string $identifier |
|
554 | - * @param string $type |
|
555 | - * @return RecipeInterface |
|
556 | - */ |
|
557 | - private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '') |
|
558 | - { |
|
559 | - $recipe = clone $default_recipe; |
|
560 | - if (! empty($type)) { |
|
561 | - $recipe->setType($type); |
|
562 | - } |
|
563 | - // is this the base default recipe ? |
|
564 | - if ($default_recipe->identifier() === Recipe::DEFAULT_ID) { |
|
565 | - $recipe->setIdentifier($identifier); |
|
566 | - $recipe->setFqcn($identifier); |
|
567 | - return $recipe; |
|
568 | - } |
|
569 | - $recipe->setIdentifier($identifier); |
|
570 | - foreach ($default_recipe->paths() as $path) { |
|
571 | - $path = str_replace('*', $identifier, $path); |
|
572 | - if (is_readable($path)) { |
|
573 | - $recipe->setPaths($path); |
|
574 | - } |
|
575 | - } |
|
576 | - $recipe->setFqcn($identifier); |
|
577 | - return $recipe; |
|
578 | - } |
|
579 | - |
|
580 | - |
|
581 | - /** |
|
582 | - * @param string $identifier Identifier for the entity class that the service applies to |
|
583 | - * Typically a Fully Qualified Class Name |
|
584 | - * @param mixed $service |
|
585 | - * @return mixed |
|
586 | - * @throws InvalidServiceException |
|
587 | - */ |
|
588 | - private function validateService($identifier, $service) |
|
589 | - { |
|
590 | - if (! is_object($service)) { |
|
591 | - throw new InvalidServiceException( |
|
592 | - $identifier, |
|
593 | - $service |
|
594 | - ); |
|
595 | - } |
|
596 | - return $service; |
|
597 | - } |
|
33 | + /** |
|
34 | + * This was the best coffee related name I could think of to represent class name "aliases" |
|
35 | + * So classes can be found via an alias identifier, |
|
36 | + * that is revealed when it is run through... the filters... eh? get it? |
|
37 | + * |
|
38 | + * @var array $filters |
|
39 | + */ |
|
40 | + private $filters; |
|
41 | + |
|
42 | + /** |
|
43 | + * These are the classes that will actually build the objects (to order of course) |
|
44 | + * |
|
45 | + * @var array $coffee_makers |
|
46 | + */ |
|
47 | + private $coffee_makers; |
|
48 | + |
|
49 | + /** |
|
50 | + * where the instantiated "singleton" objects are stored |
|
51 | + * |
|
52 | + * @var CollectionInterface $carafe |
|
53 | + */ |
|
54 | + private $carafe; |
|
55 | + |
|
56 | + /** |
|
57 | + * collection of Recipes that instruct us how to brew objects |
|
58 | + * |
|
59 | + * @var CollectionInterface $recipes |
|
60 | + */ |
|
61 | + private $recipes; |
|
62 | + |
|
63 | + /** |
|
64 | + * collection of closures for brewing objects |
|
65 | + * |
|
66 | + * @var CollectionInterface $reservoir |
|
67 | + */ |
|
68 | + private $reservoir; |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * CoffeeShop constructor |
|
73 | + * |
|
74 | + * @throws InvalidInterfaceException |
|
75 | + */ |
|
76 | + public function __construct() |
|
77 | + { |
|
78 | + // array for storing class aliases |
|
79 | + $this->filters = array(); |
|
80 | + // create collection for storing shared services |
|
81 | + $this->carafe = new LooseCollection(''); |
|
82 | + // create collection for storing recipes that tell us how to build services and entities |
|
83 | + $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface'); |
|
84 | + // create collection for storing closures for constructing new entities |
|
85 | + $this->reservoir = new Collection('Closure'); |
|
86 | + // create collection for storing the generators that build our services and entity closures |
|
87 | + $this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface'); |
|
88 | + } |
|
89 | + |
|
90 | + |
|
91 | + /** |
|
92 | + * Returns true if the container can return an entry for the given identifier. |
|
93 | + * Returns false otherwise. |
|
94 | + * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception. |
|
95 | + * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`. |
|
96 | + * |
|
97 | + * @param string $identifier Identifier of the entry to look for. |
|
98 | + * Typically a Fully Qualified Class Name |
|
99 | + * @return boolean |
|
100 | + * @throws InvalidIdentifierException |
|
101 | + */ |
|
102 | + public function has($identifier) |
|
103 | + { |
|
104 | + $identifier = $this->filterIdentifier($identifier); |
|
105 | + return $this->carafe->has($identifier); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * finds a previously brewed (SHARED) service and returns it |
|
111 | + * |
|
112 | + * @param string $identifier Identifier for the entity class to be constructed. |
|
113 | + * Typically a Fully Qualified Class Name |
|
114 | + * @return mixed |
|
115 | + * @throws InvalidIdentifierException |
|
116 | + * @throws ServiceNotFoundException No service was found for this identifier. |
|
117 | + */ |
|
118 | + public function get($identifier) |
|
119 | + { |
|
120 | + $identifier = $this->filterIdentifier($identifier); |
|
121 | + if ($this->carafe->has($identifier)) { |
|
122 | + return $this->carafe->get($identifier); |
|
123 | + } |
|
124 | + throw new ServiceNotFoundException($identifier); |
|
125 | + } |
|
126 | + |
|
127 | + |
|
128 | + /** |
|
129 | + * returns an instance of the requested entity type using the supplied arguments. |
|
130 | + * If a shared service is requested and an instance is already in the carafe, then it will be returned. |
|
131 | + * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned |
|
132 | + * If the request is for a new entity and a closure exists in the reservoir for creating it, |
|
133 | + * then a new entity will be instantiated from the closure and returned. |
|
134 | + * If a closure does not exist, then one will be built and added to the reservoir |
|
135 | + * before instantiating the requested entity. |
|
136 | + * |
|
137 | + * @param string $identifier Identifier for the entity class to be constructed. |
|
138 | + * Typically a Fully Qualified Class Name |
|
139 | + * @param array $arguments an array of arguments to be passed to the entity constructor |
|
140 | + * @param string $type |
|
141 | + * @return mixed |
|
142 | + * @throws OutOfBoundsException |
|
143 | + * @throws InstantiationException |
|
144 | + * @throws InvalidDataTypeException |
|
145 | + * @throws InvalidClassException |
|
146 | + * @throws InvalidIdentifierException |
|
147 | + * @throws ServiceExistsException |
|
148 | + * @throws ServiceNotFoundException No service was found for this identifier. |
|
149 | + */ |
|
150 | + public function brew($identifier, $arguments = array(), $type = '') |
|
151 | + { |
|
152 | + // resolve any class aliases that may exist |
|
153 | + $identifier = $this->filterIdentifier($identifier); |
|
154 | + // is a shared service being requested and already exists in the carafe? |
|
155 | + $brewed = $this->getShared($identifier, $type); |
|
156 | + // then return whatever was found |
|
157 | + if ($brewed !== false) { |
|
158 | + return $brewed; |
|
159 | + } |
|
160 | + // if the reservoir doesn't have a closure already for the requested identifier, |
|
161 | + // then neither a shared service nor a closure for making entities has been built yet |
|
162 | + if (! $this->reservoir->has($identifier)) { |
|
163 | + // so let's brew something up and add it to the proper collection |
|
164 | + $brewed = $this->makeCoffee($identifier, $arguments, $type); |
|
165 | + } |
|
166 | + // did the requested class only require loading, and if so, was that successful? |
|
167 | + if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) { |
|
168 | + return true; |
|
169 | + } |
|
170 | + // was the brewed item a callable factory function ? |
|
171 | + if (is_callable($brewed)) { |
|
172 | + // then instantiate a new entity from the cached closure |
|
173 | + return $brewed($arguments); |
|
174 | + } |
|
175 | + if ($brewed) { |
|
176 | + // requested object was a shared entity, so attempt to get it from the carafe again |
|
177 | + // because if it wasn't there before, then it should have just been brewed and added, |
|
178 | + // but if it still isn't there, then this time the thrown ServiceNotFoundException will not be caught |
|
179 | + return $this->get($identifier); |
|
180 | + } |
|
181 | + // if identifier is for a non-shared entity, |
|
182 | + // then either a cached closure already existed, or was just brewed |
|
183 | + return $this->brewedClosure($identifier, $arguments); |
|
184 | + } |
|
185 | + |
|
186 | + |
|
187 | + /** |
|
188 | + * @param string $identifier |
|
189 | + * @param string $type |
|
190 | + * @return bool|mixed |
|
191 | + * @throws InvalidIdentifierException |
|
192 | + */ |
|
193 | + protected function getShared($identifier, $type) |
|
194 | + { |
|
195 | + try { |
|
196 | + if (empty($type) || $type === CoffeeMaker::BREW_SHARED) { |
|
197 | + // if a shared service was requested and an instance is in the carafe, then return it |
|
198 | + return $this->get($identifier); |
|
199 | + } |
|
200 | + } catch (ServiceNotFoundException $e) { |
|
201 | + // if not then we'll just catch the ServiceNotFoundException but not do anything just yet, |
|
202 | + // and instead, attempt to build whatever was requested |
|
203 | + } |
|
204 | + return false; |
|
205 | + } |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * @param mixed $brewed |
|
210 | + * @param string $identifier |
|
211 | + * @param string $type |
|
212 | + * @return bool |
|
213 | + * @throws InvalidClassException |
|
214 | + * @throws InvalidDataTypeException |
|
215 | + * @throws InvalidIdentifierException |
|
216 | + * @throws OutOfBoundsException |
|
217 | + * @throws ServiceExistsException |
|
218 | + * @throws ServiceNotFoundException |
|
219 | + */ |
|
220 | + protected function brewedLoadOnly($brewed, $identifier, $type) |
|
221 | + { |
|
222 | + if ($type === CoffeeMaker::BREW_LOAD_ONLY) { |
|
223 | + if ($brewed !== true) { |
|
224 | + throw new ServiceNotFoundException( |
|
225 | + sprintf( |
|
226 | + esc_html__( |
|
227 | + 'The "%1$s" class could not be loaded.', |
|
228 | + 'event_espresso' |
|
229 | + ), |
|
230 | + $identifier |
|
231 | + ) |
|
232 | + ); |
|
233 | + } |
|
234 | + return true; |
|
235 | + } |
|
236 | + return false; |
|
237 | + } |
|
238 | + |
|
239 | + |
|
240 | + /** |
|
241 | + * @param string $identifier |
|
242 | + * @param array $arguments |
|
243 | + * @return mixed |
|
244 | + * @throws InstantiationException |
|
245 | + */ |
|
246 | + protected function brewedClosure($identifier, array $arguments) |
|
247 | + { |
|
248 | + $closure = $this->reservoir->get($identifier); |
|
249 | + if (empty($closure)) { |
|
250 | + throw new InstantiationException( |
|
251 | + sprintf( |
|
252 | + esc_html__( |
|
253 | + 'Could not brew an instance of "%1$s".', |
|
254 | + 'event_espresso' |
|
255 | + ), |
|
256 | + $identifier |
|
257 | + ) |
|
258 | + ); |
|
259 | + } |
|
260 | + return $closure($arguments); |
|
261 | + } |
|
262 | + |
|
263 | + |
|
264 | + /** |
|
265 | + * @param CoffeeMakerInterface $coffee_maker |
|
266 | + * @param string $type |
|
267 | + * @return bool |
|
268 | + * @throws InvalidIdentifierException |
|
269 | + * @throws InvalidEntityException |
|
270 | + */ |
|
271 | + public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type) |
|
272 | + { |
|
273 | + $type = CoffeeMaker::validateType($type); |
|
274 | + return $this->coffee_makers->add($coffee_maker, $type); |
|
275 | + } |
|
276 | + |
|
277 | + |
|
278 | + /** |
|
279 | + * @param string $identifier |
|
280 | + * @param callable $closure |
|
281 | + * @return callable|null |
|
282 | + * @throws InvalidIdentifierException |
|
283 | + * @throws InvalidDataTypeException |
|
284 | + */ |
|
285 | + public function addClosure($identifier, $closure) |
|
286 | + { |
|
287 | + if (! is_callable($closure)) { |
|
288 | + throw new InvalidDataTypeException('$closure', $closure, 'Closure'); |
|
289 | + } |
|
290 | + $identifier = $this->processIdentifier($identifier); |
|
291 | + if ($this->reservoir->add($closure, $identifier)) { |
|
292 | + return $closure; |
|
293 | + } |
|
294 | + return null; |
|
295 | + } |
|
296 | + |
|
297 | + |
|
298 | + /** |
|
299 | + * @param string $identifier |
|
300 | + * @return boolean |
|
301 | + * @throws InvalidIdentifierException |
|
302 | + */ |
|
303 | + public function removeClosure($identifier) |
|
304 | + { |
|
305 | + $identifier = $this->processIdentifier($identifier); |
|
306 | + if ($this->reservoir->has($identifier)) { |
|
307 | + return $this->reservoir->remove($this->reservoir->get($identifier)); |
|
308 | + } |
|
309 | + return false; |
|
310 | + } |
|
311 | + |
|
312 | + |
|
313 | + /** |
|
314 | + * @param string $identifier Identifier for the entity class that the service applies to |
|
315 | + * Typically a Fully Qualified Class Name |
|
316 | + * @param mixed $service |
|
317 | + * @return bool |
|
318 | + * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException |
|
319 | + * @throws InvalidIdentifierException |
|
320 | + */ |
|
321 | + public function addService($identifier, $service) |
|
322 | + { |
|
323 | + $identifier = $this->processIdentifier($identifier); |
|
324 | + $service = $this->validateService($identifier, $service); |
|
325 | + return $this->carafe->add($service, $identifier); |
|
326 | + } |
|
327 | + |
|
328 | + |
|
329 | + /** |
|
330 | + * @param string $identifier |
|
331 | + * @return boolean |
|
332 | + * @throws InvalidIdentifierException |
|
333 | + */ |
|
334 | + public function removeService($identifier) |
|
335 | + { |
|
336 | + $identifier = $this->processIdentifier($identifier); |
|
337 | + if ($this->carafe->has($identifier)) { |
|
338 | + return $this->carafe->remove($this->carafe->get($identifier)); |
|
339 | + } |
|
340 | + return false; |
|
341 | + } |
|
342 | + |
|
343 | + |
|
344 | + /** |
|
345 | + * Adds instructions on how to brew objects |
|
346 | + * |
|
347 | + * @param RecipeInterface $recipe |
|
348 | + * @return mixed |
|
349 | + * @throws InvalidIdentifierException |
|
350 | + */ |
|
351 | + public function addRecipe(RecipeInterface $recipe) |
|
352 | + { |
|
353 | + $this->addAliases($recipe->identifier(), $recipe->filters()); |
|
354 | + $identifier = $this->processIdentifier($recipe->identifier()); |
|
355 | + return $this->recipes->add($recipe, $identifier); |
|
356 | + } |
|
357 | + |
|
358 | + |
|
359 | + /** |
|
360 | + * @param string $identifier The Recipe's identifier |
|
361 | + * @return boolean |
|
362 | + * @throws InvalidIdentifierException |
|
363 | + */ |
|
364 | + public function removeRecipe($identifier) |
|
365 | + { |
|
366 | + $identifier = $this->processIdentifier($identifier); |
|
367 | + if ($this->recipes->has($identifier)) { |
|
368 | + return $this->recipes->remove($this->recipes->get($identifier)); |
|
369 | + } |
|
370 | + return false; |
|
371 | + } |
|
372 | + |
|
373 | + |
|
374 | + /** |
|
375 | + * Get instructions on how to brew objects |
|
376 | + * |
|
377 | + * @param string $identifier Identifier for the entity class that the recipe applies to |
|
378 | + * Typically a Fully Qualified Class Name |
|
379 | + * @param string $type |
|
380 | + * @return RecipeInterface |
|
381 | + * @throws OutOfBoundsException |
|
382 | + * @throws InvalidIdentifierException |
|
383 | + */ |
|
384 | + public function getRecipe($identifier, $type = '') |
|
385 | + { |
|
386 | + $identifier = $this->processIdentifier($identifier); |
|
387 | + if ($this->recipes->has($identifier)) { |
|
388 | + return $this->recipes->get($identifier); |
|
389 | + } |
|
390 | + $default_recipes = $this->getDefaultRecipes(); |
|
391 | + $matches = array(); |
|
392 | + foreach ($default_recipes as $wildcard => $default_recipe) { |
|
393 | + // is the wildcard recipe prefix in the identifier ? |
|
394 | + if (strpos($identifier, $wildcard) !== false) { |
|
395 | + // track matches and use the number of wildcard characters matched for the key |
|
396 | + $matches[ strlen($wildcard) ] = $default_recipe; |
|
397 | + } |
|
398 | + } |
|
399 | + if (count($matches) > 0) { |
|
400 | + // sort our recipes by the number of wildcard characters matched |
|
401 | + ksort($matches); |
|
402 | + // then grab the last recipe form the list, since it had the most matching characters |
|
403 | + $match = array_pop($matches); |
|
404 | + // since we are using a default recipe, we need to set it's identifier and fqcn |
|
405 | + return $this->copyDefaultRecipe($match, $identifier, $type); |
|
406 | + } |
|
407 | + if ($this->recipes->has(Recipe::DEFAULT_ID)) { |
|
408 | + // since we are using a default recipe, we need to set it's identifier and fqcn |
|
409 | + return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type); |
|
410 | + } |
|
411 | + throw new OutOfBoundsException( |
|
412 | + sprintf( |
|
413 | + __('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'), |
|
414 | + $identifier |
|
415 | + ) |
|
416 | + ); |
|
417 | + } |
|
418 | + |
|
419 | + |
|
420 | + /** |
|
421 | + * adds class name aliases to list of filters |
|
422 | + * |
|
423 | + * @param string $identifier Identifier for the entity class that the alias applies to |
|
424 | + * Typically a Fully Qualified Class Name |
|
425 | + * @param array|string $aliases |
|
426 | + * @return void |
|
427 | + * @throws InvalidIdentifierException |
|
428 | + */ |
|
429 | + public function addAliases($identifier, $aliases) |
|
430 | + { |
|
431 | + if (empty($aliases)) { |
|
432 | + return; |
|
433 | + } |
|
434 | + $identifier = $this->processIdentifier($identifier); |
|
435 | + foreach ((array) $aliases as $alias) { |
|
436 | + $this->filters[ $this->processIdentifier($alias) ] = $identifier; |
|
437 | + } |
|
438 | + } |
|
439 | + |
|
440 | + |
|
441 | + /** |
|
442 | + * Adds a service to one of the internal collections |
|
443 | + * |
|
444 | + * @param $identifier |
|
445 | + * @param array $arguments |
|
446 | + * @param string $type |
|
447 | + * @return mixed |
|
448 | + * @throws InvalidDataTypeException |
|
449 | + * @throws InvalidClassException |
|
450 | + * @throws OutOfBoundsException |
|
451 | + * @throws InvalidIdentifierException |
|
452 | + * @throws ServiceExistsException |
|
453 | + */ |
|
454 | + private function makeCoffee($identifier, $arguments = array(), $type = '') |
|
455 | + { |
|
456 | + if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) { |
|
457 | + throw new ServiceExistsException($identifier); |
|
458 | + } |
|
459 | + $identifier = $this->filterIdentifier($identifier); |
|
460 | + $recipe = $this->getRecipe($identifier, $type); |
|
461 | + $type = ! empty($type) ? $type : $recipe->type(); |
|
462 | + $coffee_maker = $this->getCoffeeMaker($type); |
|
463 | + return $coffee_maker->brew($recipe, $arguments); |
|
464 | + } |
|
465 | + |
|
466 | + |
|
467 | + /** |
|
468 | + * filters alias identifiers to find the real class name |
|
469 | + * |
|
470 | + * @param string $identifier Identifier for the entity class that the filter applies to |
|
471 | + * Typically a Fully Qualified Class Name |
|
472 | + * @return string |
|
473 | + * @throws InvalidIdentifierException |
|
474 | + */ |
|
475 | + private function filterIdentifier($identifier) |
|
476 | + { |
|
477 | + $identifier = $this->processIdentifier($identifier); |
|
478 | + return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ]) |
|
479 | + ? $this->filters[ $identifier ] |
|
480 | + : $identifier; |
|
481 | + } |
|
482 | + |
|
483 | + |
|
484 | + /** |
|
485 | + * verifies and standardizes identifiers |
|
486 | + * |
|
487 | + * @param string $identifier Identifier for the entity class |
|
488 | + * Typically a Fully Qualified Class Name |
|
489 | + * @return string |
|
490 | + * @throws InvalidIdentifierException |
|
491 | + */ |
|
492 | + private function processIdentifier($identifier) |
|
493 | + { |
|
494 | + if (! is_string($identifier)) { |
|
495 | + throw new InvalidIdentifierException( |
|
496 | + is_object($identifier) ? get_class($identifier) : gettype($identifier), |
|
497 | + '\Fully\Qualified\ClassName' |
|
498 | + ); |
|
499 | + } |
|
500 | + return ltrim($identifier, '\\'); |
|
501 | + } |
|
502 | + |
|
503 | + |
|
504 | + /** |
|
505 | + * @param string $type |
|
506 | + * @return CoffeeMakerInterface |
|
507 | + * @throws OutOfBoundsException |
|
508 | + * @throws InvalidDataTypeException |
|
509 | + * @throws InvalidClassException |
|
510 | + */ |
|
511 | + private function getCoffeeMaker($type) |
|
512 | + { |
|
513 | + if (! $this->coffee_makers->has($type)) { |
|
514 | + throw new OutOfBoundsException( |
|
515 | + __('The requested coffee maker is either missing or invalid.', 'event_espresso') |
|
516 | + ); |
|
517 | + } |
|
518 | + return $this->coffee_makers->get($type); |
|
519 | + } |
|
520 | + |
|
521 | + |
|
522 | + /** |
|
523 | + * Retrieves all recipes that use a wildcard "*" in their identifier |
|
524 | + * This allows recipes to be set up for handling |
|
525 | + * legacy classes that do not support PSR-4 autoloading. |
|
526 | + * for example: |
|
527 | + * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee |
|
528 | + * |
|
529 | + * @return array |
|
530 | + */ |
|
531 | + private function getDefaultRecipes() |
|
532 | + { |
|
533 | + $default_recipes = array(); |
|
534 | + $this->recipes->rewind(); |
|
535 | + while ($this->recipes->valid()) { |
|
536 | + $identifier = $this->recipes->getInfo(); |
|
537 | + // does this recipe use a wildcard ? (but is NOT the global default) |
|
538 | + if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) { |
|
539 | + // strip the wildcard and use identifier as key |
|
540 | + $default_recipes[ str_replace('*', '', $identifier) ] = $this->recipes->current(); |
|
541 | + } |
|
542 | + $this->recipes->next(); |
|
543 | + } |
|
544 | + return $default_recipes; |
|
545 | + } |
|
546 | + |
|
547 | + |
|
548 | + /** |
|
549 | + * clones a default recipe and then copies details |
|
550 | + * from the incoming request to it so that it can be used |
|
551 | + * |
|
552 | + * @param RecipeInterface $default_recipe |
|
553 | + * @param string $identifier |
|
554 | + * @param string $type |
|
555 | + * @return RecipeInterface |
|
556 | + */ |
|
557 | + private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '') |
|
558 | + { |
|
559 | + $recipe = clone $default_recipe; |
|
560 | + if (! empty($type)) { |
|
561 | + $recipe->setType($type); |
|
562 | + } |
|
563 | + // is this the base default recipe ? |
|
564 | + if ($default_recipe->identifier() === Recipe::DEFAULT_ID) { |
|
565 | + $recipe->setIdentifier($identifier); |
|
566 | + $recipe->setFqcn($identifier); |
|
567 | + return $recipe; |
|
568 | + } |
|
569 | + $recipe->setIdentifier($identifier); |
|
570 | + foreach ($default_recipe->paths() as $path) { |
|
571 | + $path = str_replace('*', $identifier, $path); |
|
572 | + if (is_readable($path)) { |
|
573 | + $recipe->setPaths($path); |
|
574 | + } |
|
575 | + } |
|
576 | + $recipe->setFqcn($identifier); |
|
577 | + return $recipe; |
|
578 | + } |
|
579 | + |
|
580 | + |
|
581 | + /** |
|
582 | + * @param string $identifier Identifier for the entity class that the service applies to |
|
583 | + * Typically a Fully Qualified Class Name |
|
584 | + * @param mixed $service |
|
585 | + * @return mixed |
|
586 | + * @throws InvalidServiceException |
|
587 | + */ |
|
588 | + private function validateService($identifier, $service) |
|
589 | + { |
|
590 | + if (! is_object($service)) { |
|
591 | + throw new InvalidServiceException( |
|
592 | + $identifier, |
|
593 | + $service |
|
594 | + ); |
|
595 | + } |
|
596 | + return $service; |
|
597 | + } |
|
598 | 598 | } |
@@ -159,7 +159,7 @@ discard block |
||
159 | 159 | } |
160 | 160 | // if the reservoir doesn't have a closure already for the requested identifier, |
161 | 161 | // then neither a shared service nor a closure for making entities has been built yet |
162 | - if (! $this->reservoir->has($identifier)) { |
|
162 | + if ( ! $this->reservoir->has($identifier)) { |
|
163 | 163 | // so let's brew something up and add it to the proper collection |
164 | 164 | $brewed = $this->makeCoffee($identifier, $arguments, $type); |
165 | 165 | } |
@@ -284,7 +284,7 @@ discard block |
||
284 | 284 | */ |
285 | 285 | public function addClosure($identifier, $closure) |
286 | 286 | { |
287 | - if (! is_callable($closure)) { |
|
287 | + if ( ! is_callable($closure)) { |
|
288 | 288 | throw new InvalidDataTypeException('$closure', $closure, 'Closure'); |
289 | 289 | } |
290 | 290 | $identifier = $this->processIdentifier($identifier); |
@@ -393,7 +393,7 @@ discard block |
||
393 | 393 | // is the wildcard recipe prefix in the identifier ? |
394 | 394 | if (strpos($identifier, $wildcard) !== false) { |
395 | 395 | // track matches and use the number of wildcard characters matched for the key |
396 | - $matches[ strlen($wildcard) ] = $default_recipe; |
|
396 | + $matches[strlen($wildcard)] = $default_recipe; |
|
397 | 397 | } |
398 | 398 | } |
399 | 399 | if (count($matches) > 0) { |
@@ -433,7 +433,7 @@ discard block |
||
433 | 433 | } |
434 | 434 | $identifier = $this->processIdentifier($identifier); |
435 | 435 | foreach ((array) $aliases as $alias) { |
436 | - $this->filters[ $this->processIdentifier($alias) ] = $identifier; |
|
436 | + $this->filters[$this->processIdentifier($alias)] = $identifier; |
|
437 | 437 | } |
438 | 438 | } |
439 | 439 | |
@@ -475,8 +475,8 @@ discard block |
||
475 | 475 | private function filterIdentifier($identifier) |
476 | 476 | { |
477 | 477 | $identifier = $this->processIdentifier($identifier); |
478 | - return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ]) |
|
479 | - ? $this->filters[ $identifier ] |
|
478 | + return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier]) |
|
479 | + ? $this->filters[$identifier] |
|
480 | 480 | : $identifier; |
481 | 481 | } |
482 | 482 | |
@@ -491,7 +491,7 @@ discard block |
||
491 | 491 | */ |
492 | 492 | private function processIdentifier($identifier) |
493 | 493 | { |
494 | - if (! is_string($identifier)) { |
|
494 | + if ( ! is_string($identifier)) { |
|
495 | 495 | throw new InvalidIdentifierException( |
496 | 496 | is_object($identifier) ? get_class($identifier) : gettype($identifier), |
497 | 497 | '\Fully\Qualified\ClassName' |
@@ -510,7 +510,7 @@ discard block |
||
510 | 510 | */ |
511 | 511 | private function getCoffeeMaker($type) |
512 | 512 | { |
513 | - if (! $this->coffee_makers->has($type)) { |
|
513 | + if ( ! $this->coffee_makers->has($type)) { |
|
514 | 514 | throw new OutOfBoundsException( |
515 | 515 | __('The requested coffee maker is either missing or invalid.', 'event_espresso') |
516 | 516 | ); |
@@ -537,7 +537,7 @@ discard block |
||
537 | 537 | // does this recipe use a wildcard ? (but is NOT the global default) |
538 | 538 | if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) { |
539 | 539 | // strip the wildcard and use identifier as key |
540 | - $default_recipes[ str_replace('*', '', $identifier) ] = $this->recipes->current(); |
|
540 | + $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current(); |
|
541 | 541 | } |
542 | 542 | $this->recipes->next(); |
543 | 543 | } |
@@ -557,7 +557,7 @@ discard block |
||
557 | 557 | private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '') |
558 | 558 | { |
559 | 559 | $recipe = clone $default_recipe; |
560 | - if (! empty($type)) { |
|
560 | + if ( ! empty($type)) { |
|
561 | 561 | $recipe->setType($type); |
562 | 562 | } |
563 | 563 | // is this the base default recipe ? |
@@ -587,7 +587,7 @@ discard block |
||
587 | 587 | */ |
588 | 588 | private function validateService($identifier, $service) |
589 | 589 | { |
590 | - if (! is_object($service)) { |
|
590 | + if ( ! is_object($service)) { |
|
591 | 591 | throw new InvalidServiceException( |
592 | 592 | $identifier, |
593 | 593 | $service |
@@ -9,12 +9,12 @@ |
||
9 | 9 | interface EEI_Line_Item_Display |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * @param EE_Line_Item $line_item |
|
14 | - * @param array $options |
|
15 | - * @return mixed |
|
16 | - */ |
|
17 | - public function display_line_item(EE_Line_Item $line_item, $options = array()); |
|
12 | + /** |
|
13 | + * @param EE_Line_Item $line_item |
|
14 | + * @param array $options |
|
15 | + * @return mixed |
|
16 | + */ |
|
17 | + public function display_line_item(EE_Line_Item $line_item, $options = array()); |
|
18 | 18 | |
19 | 19 | } |
20 | 20 |
@@ -17,7 +17,7 @@ |
||
17 | 17 | |
18 | 18 | /** |
19 | 19 | * @param string $value_to_normalize |
20 | - * @return int|mixed|string |
|
20 | + * @return null|integer |
|
21 | 21 | * @throws \EE_Validation_Error |
22 | 22 | */ |
23 | 23 | public function normalize($value_to_normalize) |
@@ -10,88 +10,88 @@ |
||
10 | 10 | class EE_Int_Normalization extends EE_Normalization_Strategy_Base |
11 | 11 | { |
12 | 12 | |
13 | - /* |
|
13 | + /* |
|
14 | 14 | * regex pattern that matches for the following: |
15 | 15 | * * optional negative sign |
16 | 16 | * * one or more digits |
17 | 17 | */ |
18 | - const REGEX = '/^(-?)(\d+)(?:\.0+)?$/'; |
|
18 | + const REGEX = '/^(-?)(\d+)(?:\.0+)?$/'; |
|
19 | 19 | |
20 | 20 | |
21 | 21 | |
22 | - /** |
|
23 | - * @param string $value_to_normalize |
|
24 | - * @return int|mixed|string |
|
25 | - * @throws \EE_Validation_Error |
|
26 | - */ |
|
27 | - public function normalize($value_to_normalize) |
|
28 | - { |
|
29 | - if ($value_to_normalize === null) { |
|
30 | - return null; |
|
31 | - } |
|
32 | - if (is_int($value_to_normalize) || is_float($value_to_normalize)) { |
|
33 | - return (int) $value_to_normalize; |
|
34 | - } |
|
35 | - if (! is_string($value_to_normalize)) { |
|
36 | - throw new EE_Validation_Error( |
|
37 | - sprintf( |
|
38 | - __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), |
|
39 | - print_r($value_to_normalize, true), |
|
40 | - gettype($value_to_normalize) |
|
41 | - ) |
|
42 | - ); |
|
43 | - } |
|
44 | - $value_to_normalize = filter_var( |
|
45 | - $value_to_normalize, |
|
46 | - FILTER_SANITIZE_NUMBER_FLOAT, |
|
47 | - FILTER_FLAG_ALLOW_FRACTION |
|
48 | - ); |
|
49 | - if ($value_to_normalize === '') { |
|
50 | - return null; |
|
51 | - } |
|
52 | - $matches = array(); |
|
53 | - if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) { |
|
54 | - if (count($matches) === 3) { |
|
55 | - // if first match is the negative sign, |
|
56 | - // then the number needs to be multiplied by -1 to remain negative |
|
57 | - return $matches[1] === '-' |
|
58 | - ? (int) $matches[2] * -1 |
|
59 | - : (int) $matches[2]; |
|
60 | - } |
|
61 | - } |
|
62 | - // find if this input has a int validation strategy |
|
63 | - // in which case, use its message |
|
64 | - $validation_error_message = null; |
|
65 | - foreach ($this->_input->get_validation_strategies() as $validation_strategy) { |
|
66 | - if ($validation_strategy instanceof EE_Int_Validation_Strategy) { |
|
67 | - $validation_error_message = $validation_strategy->get_validation_error_message(); |
|
68 | - } |
|
69 | - } |
|
70 | - // this really shouldn't ever happen because fields with a int normalization strategy |
|
71 | - // should also have a int validation strategy, but in case it doesn't use the default |
|
72 | - if (! $validation_error_message) { |
|
73 | - $default_validation_strategy = new EE_Int_Validation_Strategy(); |
|
74 | - $validation_error_message = $default_validation_strategy->get_validation_error_message(); |
|
75 | - } |
|
76 | - throw new EE_Validation_Error($validation_error_message, 'numeric_only'); |
|
77 | - } |
|
22 | + /** |
|
23 | + * @param string $value_to_normalize |
|
24 | + * @return int|mixed|string |
|
25 | + * @throws \EE_Validation_Error |
|
26 | + */ |
|
27 | + public function normalize($value_to_normalize) |
|
28 | + { |
|
29 | + if ($value_to_normalize === null) { |
|
30 | + return null; |
|
31 | + } |
|
32 | + if (is_int($value_to_normalize) || is_float($value_to_normalize)) { |
|
33 | + return (int) $value_to_normalize; |
|
34 | + } |
|
35 | + if (! is_string($value_to_normalize)) { |
|
36 | + throw new EE_Validation_Error( |
|
37 | + sprintf( |
|
38 | + __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), |
|
39 | + print_r($value_to_normalize, true), |
|
40 | + gettype($value_to_normalize) |
|
41 | + ) |
|
42 | + ); |
|
43 | + } |
|
44 | + $value_to_normalize = filter_var( |
|
45 | + $value_to_normalize, |
|
46 | + FILTER_SANITIZE_NUMBER_FLOAT, |
|
47 | + FILTER_FLAG_ALLOW_FRACTION |
|
48 | + ); |
|
49 | + if ($value_to_normalize === '') { |
|
50 | + return null; |
|
51 | + } |
|
52 | + $matches = array(); |
|
53 | + if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) { |
|
54 | + if (count($matches) === 3) { |
|
55 | + // if first match is the negative sign, |
|
56 | + // then the number needs to be multiplied by -1 to remain negative |
|
57 | + return $matches[1] === '-' |
|
58 | + ? (int) $matches[2] * -1 |
|
59 | + : (int) $matches[2]; |
|
60 | + } |
|
61 | + } |
|
62 | + // find if this input has a int validation strategy |
|
63 | + // in which case, use its message |
|
64 | + $validation_error_message = null; |
|
65 | + foreach ($this->_input->get_validation_strategies() as $validation_strategy) { |
|
66 | + if ($validation_strategy instanceof EE_Int_Validation_Strategy) { |
|
67 | + $validation_error_message = $validation_strategy->get_validation_error_message(); |
|
68 | + } |
|
69 | + } |
|
70 | + // this really shouldn't ever happen because fields with a int normalization strategy |
|
71 | + // should also have a int validation strategy, but in case it doesn't use the default |
|
72 | + if (! $validation_error_message) { |
|
73 | + $default_validation_strategy = new EE_Int_Validation_Strategy(); |
|
74 | + $validation_error_message = $default_validation_strategy->get_validation_error_message(); |
|
75 | + } |
|
76 | + throw new EE_Validation_Error($validation_error_message, 'numeric_only'); |
|
77 | + } |
|
78 | 78 | |
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * Converts the int into a string for use in teh html form |
|
83 | - * |
|
84 | - * @param int $normalized_value |
|
85 | - * @return string |
|
86 | - */ |
|
87 | - public function unnormalize($normalized_value) |
|
88 | - { |
|
89 | - if ($normalized_value === null || $normalized_value === '') { |
|
90 | - return ''; |
|
91 | - } |
|
92 | - if (empty($normalized_value)) { |
|
93 | - return '0'; |
|
94 | - } |
|
95 | - return "$normalized_value"; |
|
96 | - } |
|
81 | + /** |
|
82 | + * Converts the int into a string for use in teh html form |
|
83 | + * |
|
84 | + * @param int $normalized_value |
|
85 | + * @return string |
|
86 | + */ |
|
87 | + public function unnormalize($normalized_value) |
|
88 | + { |
|
89 | + if ($normalized_value === null || $normalized_value === '') { |
|
90 | + return ''; |
|
91 | + } |
|
92 | + if (empty($normalized_value)) { |
|
93 | + return '0'; |
|
94 | + } |
|
95 | + return "$normalized_value"; |
|
96 | + } |
|
97 | 97 | } |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | if (is_int($value_to_normalize) || is_float($value_to_normalize)) { |
33 | 33 | return (int) $value_to_normalize; |
34 | 34 | } |
35 | - if (! is_string($value_to_normalize)) { |
|
35 | + if ( ! is_string($value_to_normalize)) { |
|
36 | 36 | throw new EE_Validation_Error( |
37 | 37 | sprintf( |
38 | 38 | __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | } |
70 | 70 | // this really shouldn't ever happen because fields with a int normalization strategy |
71 | 71 | // should also have a int validation strategy, but in case it doesn't use the default |
72 | - if (! $validation_error_message) { |
|
72 | + if ( ! $validation_error_message) { |
|
73 | 73 | $default_validation_strategy = new EE_Int_Validation_Strategy(); |
74 | 74 | $validation_error_message = $default_validation_strategy->get_validation_error_message(); |
75 | 75 | } |
@@ -217,7 +217,7 @@ |
||
217 | 217 | |
218 | 218 | /** |
219 | 219 | * Used to override the default for the additional limit field. |
220 | - * @param $additional_limit |
|
220 | + * @param integer $additional_limit |
|
221 | 221 | */ |
222 | 222 | public static function set_default_additional_limit($additional_limit) |
223 | 223 | { |
@@ -2,7 +2,6 @@ |
||
2 | 2 | |
3 | 3 | use EventEspresso\core\exceptions\InvalidDataTypeException; |
4 | 4 | use EventEspresso\core\exceptions\InvalidInterfaceException; |
5 | -use EventEspresso\core\services\orm\ModelFieldFactory; |
|
6 | 5 | |
7 | 6 | /** |
8 | 7 | * EEM_Event Model |
@@ -278,7 +278,7 @@ discard block |
||
278 | 278 | 'WP_User' => new EE_Belongs_To_Relation(), |
279 | 279 | ); |
280 | 280 | // this model is generally available for reading |
281 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
281 | + $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public(); |
|
282 | 282 | $this->model_chain_to_password = ''; |
283 | 283 | parent::__construct($timezone); |
284 | 284 | } |
@@ -371,7 +371,7 @@ discard block |
||
371 | 371 | */ |
372 | 372 | public function get_all_event_question_groups($EVT_ID = 0) |
373 | 373 | { |
374 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
374 | + if ( ! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
375 | 375 | EE_Error::add_error( |
376 | 376 | esc_html__( |
377 | 377 | 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
@@ -405,7 +405,7 @@ discard block |
||
405 | 405 | */ |
406 | 406 | public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
407 | 407 | { |
408 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
408 | + if ( ! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
409 | 409 | EE_Error::add_error( |
410 | 410 | esc_html__( |
411 | 411 | // @codingStandardsIgnoreStart |
@@ -448,7 +448,7 @@ discard block |
||
448 | 448 | */ |
449 | 449 | public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
450 | 450 | { |
451 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
451 | + if ( ! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
452 | 452 | EE_Error::add_error( |
453 | 453 | esc_html__( |
454 | 454 | 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
@@ -861,11 +861,11 @@ discard block |
||
861 | 861 | $questions = array(); |
862 | 862 | // get all question groups for event |
863 | 863 | $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
864 | - if (! empty($qgs)) { |
|
864 | + if ( ! empty($qgs)) { |
|
865 | 865 | foreach ($qgs as $qg) { |
866 | 866 | $qsts = $qg->questions(); |
867 | - $questions[ $qg->ID() ] = $qg->model_field_array(); |
|
868 | - $questions[ $qg->ID() ]['QSG_questions'] = array(); |
|
867 | + $questions[$qg->ID()] = $qg->model_field_array(); |
|
868 | + $questions[$qg->ID()]['QSG_questions'] = array(); |
|
869 | 869 | foreach ($qsts as $qst) { |
870 | 870 | if ($qst->is_system_question()) { |
871 | 871 | continue; |
@@ -879,26 +879,26 @@ discard block |
||
879 | 879 | $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
880 | 880 | $qst_name = $qstn_id = $qst->ID(); |
881 | 881 | $ans_id = $answer->ID(); |
882 | - $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
882 | + $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']'; |
|
883 | 883 | $input_name = ''; |
884 | 884 | $input_id = sanitize_key($qst->display_text()); |
885 | 885 | $input_class = ''; |
886 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array(); |
|
887 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn' |
|
886 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array(); |
|
887 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn' |
|
888 | 888 | . $input_name |
889 | 889 | . $qst_name; |
890 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
891 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class; |
|
892 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array(); |
|
893 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst; |
|
894 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer; |
|
890 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id; |
|
891 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class; |
|
892 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array(); |
|
893 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst; |
|
894 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer; |
|
895 | 895 | // leave responses as-is, don't convert stuff into html entities please! |
896 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false; |
|
896 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false; |
|
897 | 897 | if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
898 | 898 | $QSOs = $qst->options(true, $answer->value()); |
899 | 899 | if (is_array($QSOs)) { |
900 | 900 | foreach ($QSOs as $QSO_ID => $QSO) { |
901 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array(); |
|
901 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array(); |
|
902 | 902 | } |
903 | 903 | } |
904 | 904 | } |
@@ -15,919 +15,919 @@ |
||
15 | 15 | class EEM_Event extends EEM_CPT_Base |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the |
|
20 | - * event |
|
21 | - */ |
|
22 | - const sold_out = 'sold_out'; |
|
23 | - |
|
24 | - /** |
|
25 | - * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later |
|
26 | - * date) |
|
27 | - */ |
|
28 | - const postponed = 'postponed'; |
|
29 | - |
|
30 | - /** |
|
31 | - * constant used by status(), indicating that the event will no longer occur |
|
32 | - */ |
|
33 | - const cancelled = 'cancelled'; |
|
34 | - |
|
35 | - |
|
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
39 | - protected static $_default_reg_status; |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * This is the default for the additional limit field. |
|
44 | - * @var int |
|
45 | - */ |
|
46 | - protected static $_default_additional_limit = 10; |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * private instance of the Event object |
|
51 | - * |
|
52 | - * @var EEM_Event |
|
53 | - */ |
|
54 | - protected static $_instance; |
|
55 | - |
|
56 | - |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
61 | - * |
|
62 | - * @param string $timezone |
|
63 | - * @throws \EE_Error |
|
64 | - */ |
|
65 | - protected function __construct($timezone = null) |
|
66 | - { |
|
67 | - EE_Registry::instance()->load_model('Registration'); |
|
68 | - $this->singular_item = esc_html__('Event', 'event_espresso'); |
|
69 | - $this->plural_item = esc_html__('Events', 'event_espresso'); |
|
70 | - // to remove Cancelled events from the frontend, copy the following filter to your functions.php file |
|
71 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' ); |
|
72 | - // to remove Postponed events from the frontend, copy the following filter to your functions.php file |
|
73 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' ); |
|
74 | - // to remove Sold Out events from the frontend, copy the following filter to your functions.php file |
|
75 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' ); |
|
76 | - $this->_custom_stati = apply_filters( |
|
77 | - 'AFEE__EEM_Event__construct___custom_stati', |
|
78 | - array( |
|
79 | - EEM_Event::cancelled => array( |
|
80 | - 'label' => esc_html__('Cancelled', 'event_espresso'), |
|
81 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true), |
|
82 | - ), |
|
83 | - EEM_Event::postponed => array( |
|
84 | - 'label' => esc_html__('Postponed', 'event_espresso'), |
|
85 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true), |
|
86 | - ), |
|
87 | - EEM_Event::sold_out => array( |
|
88 | - 'label' => esc_html__('Sold Out', 'event_espresso'), |
|
89 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true), |
|
90 | - ), |
|
91 | - ) |
|
92 | - ); |
|
93 | - self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment |
|
94 | - : self::$_default_reg_status; |
|
95 | - $this->_tables = array( |
|
96 | - 'Event_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
97 | - 'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'), |
|
98 | - ); |
|
99 | - $this->_fields = array( |
|
100 | - 'Event_CPT' => array( |
|
101 | - 'EVT_ID' => new EE_Primary_Key_Int_Field( |
|
102 | - 'ID', |
|
103 | - esc_html__('Post ID for Event', 'event_espresso') |
|
104 | - ), |
|
105 | - 'EVT_name' => new EE_Plain_Text_Field( |
|
106 | - 'post_title', |
|
107 | - esc_html__('Event Name', 'event_espresso'), |
|
108 | - false, |
|
109 | - '' |
|
110 | - ), |
|
111 | - 'EVT_desc' => new EE_Post_Content_Field( |
|
112 | - 'post_content', |
|
113 | - esc_html__('Event Description', 'event_espresso'), |
|
114 | - false, |
|
115 | - '' |
|
116 | - ), |
|
117 | - 'EVT_slug' => new EE_Slug_Field( |
|
118 | - 'post_name', |
|
119 | - esc_html__('Event Slug', 'event_espresso'), |
|
120 | - false, |
|
121 | - '' |
|
122 | - ), |
|
123 | - 'EVT_created' => new EE_Datetime_Field( |
|
124 | - 'post_date', |
|
125 | - esc_html__('Date/Time Event Created', 'event_espresso'), |
|
126 | - false, |
|
127 | - EE_Datetime_Field::now |
|
128 | - ), |
|
129 | - 'EVT_short_desc' => new EE_Simple_HTML_Field( |
|
130 | - 'post_excerpt', |
|
131 | - esc_html__('Event Short Description', 'event_espresso'), |
|
132 | - false, |
|
133 | - '' |
|
134 | - ), |
|
135 | - 'EVT_modified' => new EE_Datetime_Field( |
|
136 | - 'post_modified', |
|
137 | - esc_html__('Date/Time Event Modified', 'event_espresso'), |
|
138 | - false, |
|
139 | - EE_Datetime_Field::now |
|
140 | - ), |
|
141 | - 'EVT_wp_user' => new EE_WP_User_Field( |
|
142 | - 'post_author', |
|
143 | - esc_html__('Event Creator ID', 'event_espresso'), |
|
144 | - false |
|
145 | - ), |
|
146 | - 'parent' => new EE_Integer_Field( |
|
147 | - 'post_parent', |
|
148 | - esc_html__('Event Parent ID', 'event_espresso'), |
|
149 | - false, |
|
150 | - 0 |
|
151 | - ), |
|
152 | - 'EVT_order' => new EE_Integer_Field( |
|
153 | - 'menu_order', |
|
154 | - esc_html__('Event Menu Order', 'event_espresso'), |
|
155 | - false, |
|
156 | - 1 |
|
157 | - ), |
|
158 | - 'post_type' => new EE_WP_Post_Type_Field('espresso_events'), |
|
159 | - // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ), |
|
160 | - 'status' => new EE_WP_Post_Status_Field( |
|
161 | - 'post_status', |
|
162 | - esc_html__('Event Status', 'event_espresso'), |
|
163 | - false, |
|
164 | - 'draft', |
|
165 | - $this->_custom_stati |
|
166 | - ), |
|
167 | - 'password' => new EE_Password_Field( |
|
168 | - 'post_password', |
|
169 | - __('Password', 'event_espresso'), |
|
170 | - false, |
|
171 | - '', |
|
172 | - array( |
|
173 | - 'EVT_desc', |
|
174 | - 'EVT_short_desc', |
|
175 | - 'EVT_display_desc', |
|
176 | - 'EVT_display_ticket_selector', |
|
177 | - 'EVT_visible_on', |
|
178 | - 'EVT_additional_limit', |
|
179 | - 'EVT_default_registration_status', |
|
180 | - 'EVT_member_only', |
|
181 | - 'EVT_phone', |
|
182 | - 'EVT_allow_overflow', |
|
183 | - 'EVT_timezone_string', |
|
184 | - 'EVT_external_URL', |
|
185 | - 'EVT_donations' |
|
186 | - ) |
|
187 | - ) |
|
188 | - ), |
|
189 | - 'Event_Meta' => array( |
|
190 | - 'EVTM_ID' => new EE_DB_Only_Float_Field( |
|
191 | - 'EVTM_ID', |
|
192 | - esc_html__('Event Meta Row ID', 'event_espresso'), |
|
193 | - false |
|
194 | - ), |
|
195 | - 'EVT_ID_fk' => new EE_DB_Only_Int_Field( |
|
196 | - 'EVT_ID', |
|
197 | - esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), |
|
198 | - false |
|
199 | - ), |
|
200 | - 'EVT_display_desc' => new EE_Boolean_Field( |
|
201 | - 'EVT_display_desc', |
|
202 | - esc_html__('Display Description Flag', 'event_espresso'), |
|
203 | - false, |
|
204 | - true |
|
205 | - ), |
|
206 | - 'EVT_display_ticket_selector' => new EE_Boolean_Field( |
|
207 | - 'EVT_display_ticket_selector', |
|
208 | - esc_html__('Display Ticket Selector Flag', 'event_espresso'), |
|
209 | - false, |
|
210 | - true |
|
211 | - ), |
|
212 | - 'EVT_visible_on' => new EE_Datetime_Field( |
|
213 | - 'EVT_visible_on', |
|
214 | - esc_html__('Event Visible Date', 'event_espresso'), |
|
215 | - true, |
|
216 | - EE_Datetime_Field::now |
|
217 | - ), |
|
218 | - 'EVT_additional_limit' => new EE_Integer_Field( |
|
219 | - 'EVT_additional_limit', |
|
220 | - esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
221 | - true, |
|
222 | - self::$_default_additional_limit |
|
223 | - ), |
|
224 | - 'EVT_default_registration_status' => new EE_Enum_Text_Field( |
|
225 | - 'EVT_default_registration_status', |
|
226 | - esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
227 | - false, |
|
228 | - EEM_Event::$_default_reg_status, |
|
229 | - EEM_Registration::reg_status_array() |
|
230 | - ), |
|
231 | - 'EVT_member_only' => new EE_Boolean_Field( |
|
232 | - 'EVT_member_only', |
|
233 | - esc_html__('Member-Only Event Flag', 'event_espresso'), |
|
234 | - false, |
|
235 | - false |
|
236 | - ), |
|
237 | - 'EVT_phone' => new EE_Plain_Text_Field( |
|
238 | - 'EVT_phone', |
|
239 | - esc_html__('Event Phone Number', 'event_espresso'), |
|
240 | - false, |
|
241 | - '' |
|
242 | - ), |
|
243 | - 'EVT_allow_overflow' => new EE_Boolean_Field( |
|
244 | - 'EVT_allow_overflow', |
|
245 | - esc_html__('Allow Overflow on Event', 'event_espresso'), |
|
246 | - false, |
|
247 | - false |
|
248 | - ), |
|
249 | - 'EVT_timezone_string' => new EE_Plain_Text_Field( |
|
250 | - 'EVT_timezone_string', |
|
251 | - esc_html__('Timezone (name) for Event times', 'event_espresso'), |
|
252 | - false, |
|
253 | - '' |
|
254 | - ), |
|
255 | - 'EVT_external_URL' => new EE_Plain_Text_Field( |
|
256 | - 'EVT_external_URL', |
|
257 | - esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), |
|
258 | - true |
|
259 | - ), |
|
260 | - 'EVT_donations' => new EE_Boolean_Field( |
|
261 | - 'EVT_donations', |
|
262 | - esc_html__('Accept Donations?', 'event_espresso'), |
|
263 | - false, |
|
264 | - false |
|
265 | - ), |
|
266 | - ), |
|
267 | - ); |
|
268 | - $this->_model_relations = array( |
|
269 | - 'Registration' => new EE_Has_Many_Relation(), |
|
270 | - 'Datetime' => new EE_Has_Many_Relation(), |
|
271 | - 'Question_Group' => new EE_HABTM_Relation('Event_Question_Group'), |
|
272 | - 'Event_Question_Group' => new EE_Has_Many_Relation(), |
|
273 | - 'Venue' => new EE_HABTM_Relation('Event_Venue'), |
|
274 | - 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
275 | - 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
276 | - 'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'), |
|
277 | - 'Attendee' => new EE_HABTM_Relation('Registration'), |
|
278 | - 'WP_User' => new EE_Belongs_To_Relation(), |
|
279 | - ); |
|
280 | - // this model is generally available for reading |
|
281 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
282 | - $this->model_chain_to_password = ''; |
|
283 | - parent::__construct($timezone); |
|
284 | - } |
|
285 | - |
|
286 | - |
|
287 | - |
|
288 | - /** |
|
289 | - * @param string $default_reg_status |
|
290 | - */ |
|
291 | - public static function set_default_reg_status($default_reg_status) |
|
292 | - { |
|
293 | - self::$_default_reg_status = $default_reg_status; |
|
294 | - // if EEM_Event has already been instantiated, |
|
295 | - // then we need to reset the `EVT_default_reg_status` field to use the new default. |
|
296 | - if (self::$_instance instanceof EEM_Event) { |
|
297 | - $default_reg_status = new EE_Enum_Text_Field( |
|
298 | - 'EVT_default_registration_status', |
|
299 | - esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
300 | - false, |
|
301 | - $default_reg_status, |
|
302 | - EEM_Registration::reg_status_array() |
|
303 | - ); |
|
304 | - $default_reg_status->_construct_finalize( |
|
305 | - 'Event_Meta', |
|
306 | - 'EVT_default_registration_status', |
|
307 | - 'EEM_Event' |
|
308 | - ); |
|
309 | - self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status; |
|
310 | - } |
|
311 | - } |
|
312 | - |
|
313 | - |
|
314 | - /** |
|
315 | - * Used to override the default for the additional limit field. |
|
316 | - * @param $additional_limit |
|
317 | - */ |
|
318 | - public static function set_default_additional_limit($additional_limit) |
|
319 | - { |
|
320 | - self::$_default_additional_limit = (int) $additional_limit; |
|
321 | - if (self::$_instance instanceof EEM_Event) { |
|
322 | - self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field( |
|
323 | - 'EVT_additional_limit', |
|
324 | - __('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
325 | - true, |
|
326 | - self::$_default_additional_limit |
|
327 | - ); |
|
328 | - self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize( |
|
329 | - 'Event_Meta', |
|
330 | - 'EVT_additional_limit', |
|
331 | - 'EEM_Event' |
|
332 | - ); |
|
333 | - } |
|
334 | - } |
|
335 | - |
|
336 | - |
|
337 | - /** |
|
338 | - * Return what is currently set as the default additional limit for the event. |
|
339 | - * @return int |
|
340 | - */ |
|
341 | - public static function get_default_additional_limit() |
|
342 | - { |
|
343 | - return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit); |
|
344 | - } |
|
345 | - |
|
346 | - |
|
347 | - /** |
|
348 | - * get_question_groups |
|
349 | - * |
|
350 | - * @return array |
|
351 | - * @throws \EE_Error |
|
352 | - */ |
|
353 | - public function get_all_question_groups() |
|
354 | - { |
|
355 | - return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
356 | - array( |
|
357 | - array('QSG_deleted' => false), |
|
358 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
359 | - ) |
|
360 | - ); |
|
361 | - } |
|
362 | - |
|
363 | - |
|
364 | - |
|
365 | - /** |
|
366 | - * get_question_groups |
|
367 | - * |
|
368 | - * @param int $EVT_ID |
|
369 | - * @return array|bool |
|
370 | - * @throws \EE_Error |
|
371 | - */ |
|
372 | - public function get_all_event_question_groups($EVT_ID = 0) |
|
373 | - { |
|
374 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
375 | - EE_Error::add_error( |
|
376 | - esc_html__( |
|
377 | - 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
378 | - 'event_espresso' |
|
379 | - ), |
|
380 | - __FILE__, |
|
381 | - __FUNCTION__, |
|
382 | - __LINE__ |
|
383 | - ); |
|
384 | - return false; |
|
385 | - } |
|
386 | - return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
387 | - array( |
|
388 | - array('EVT_ID' => $EVT_ID), |
|
389 | - ) |
|
390 | - ); |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * get_question_groups |
|
396 | - * |
|
397 | - * @param int $EVT_ID |
|
398 | - * @param boolean $for_primary_attendee |
|
399 | - * @return array|bool |
|
400 | - * @throws EE_Error |
|
401 | - * @throws InvalidArgumentException |
|
402 | - * @throws ReflectionException |
|
403 | - * @throws InvalidDataTypeException |
|
404 | - * @throws InvalidInterfaceException |
|
405 | - */ |
|
406 | - public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
|
407 | - { |
|
408 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
409 | - EE_Error::add_error( |
|
410 | - esc_html__( |
|
411 | - // @codingStandardsIgnoreStart |
|
412 | - 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
413 | - // @codingStandardsIgnoreEnd |
|
414 | - 'event_espresso' |
|
415 | - ), |
|
416 | - __FILE__, |
|
417 | - __FUNCTION__, |
|
418 | - __LINE__ |
|
419 | - ); |
|
420 | - return false; |
|
421 | - } |
|
422 | - $query_params = [ |
|
423 | - [ |
|
424 | - 'EVT_ID' => $EVT_ID, |
|
425 | - EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true |
|
426 | - ] |
|
427 | - ]; |
|
428 | - if ($for_primary_attendee) { |
|
429 | - $query_params[0]['EQG_primary'] = true; |
|
430 | - } else { |
|
431 | - $query_params[0]['EQG_additional'] = true; |
|
432 | - } |
|
433 | - return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params); |
|
434 | - } |
|
435 | - |
|
436 | - |
|
437 | - /** |
|
438 | - * get_question_groups |
|
439 | - * |
|
440 | - * @param int $EVT_ID |
|
441 | - * @param EE_Registration $registration |
|
442 | - * @return array|bool |
|
443 | - * @throws EE_Error |
|
444 | - * @throws InvalidArgumentException |
|
445 | - * @throws InvalidDataTypeException |
|
446 | - * @throws InvalidInterfaceException |
|
447 | - * @throws ReflectionException |
|
448 | - */ |
|
449 | - public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
|
450 | - { |
|
451 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
452 | - EE_Error::add_error( |
|
453 | - esc_html__( |
|
454 | - 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
|
455 | - 'event_espresso' |
|
456 | - ), |
|
457 | - __FILE__, |
|
458 | - __FUNCTION__, |
|
459 | - __LINE__ |
|
460 | - ); |
|
461 | - return false; |
|
462 | - } |
|
463 | - return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
464 | - [ |
|
465 | - [ |
|
466 | - 'Event_Question_Group.EVT_ID' => $EVT_ID, |
|
467 | - 'Event_Question_Group.' |
|
468 | - . EEM_Event_Question_Group::instance()->fieldNameForContext( |
|
469 | - $registration->is_primary_registrant() |
|
470 | - ) => true |
|
471 | - ], |
|
472 | - 'order_by' => ['QSG_order' => 'ASC'], |
|
473 | - ] |
|
474 | - ); |
|
475 | - } |
|
476 | - |
|
477 | - |
|
478 | - |
|
479 | - /** |
|
480 | - * get_question_target_db_column |
|
481 | - * |
|
482 | - * @param string $QSG_IDs csv list of $QSG IDs |
|
483 | - * @return array|bool |
|
484 | - * @throws \EE_Error |
|
485 | - */ |
|
486 | - public function get_questions_in_groups($QSG_IDs = '') |
|
487 | - { |
|
488 | - if (empty($QSG_IDs)) { |
|
489 | - EE_Error::add_error( |
|
490 | - esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'), |
|
491 | - __FILE__, |
|
492 | - __FUNCTION__, |
|
493 | - __LINE__ |
|
494 | - ); |
|
495 | - return false; |
|
496 | - } |
|
497 | - return EE_Registry::instance()->load_model('Question')->get_all( |
|
498 | - array( |
|
499 | - array( |
|
500 | - 'Question_Group.QSG_ID' => array('IN', $QSG_IDs), |
|
501 | - 'QST_deleted' => false, |
|
502 | - 'QST_admin_only' => is_admin(), |
|
503 | - ), |
|
504 | - 'order_by' => 'QST_order', |
|
505 | - ) |
|
506 | - ); |
|
507 | - } |
|
508 | - |
|
509 | - |
|
510 | - |
|
511 | - /** |
|
512 | - * get_options_for_question |
|
513 | - * |
|
514 | - * @param string $QST_IDs csv list of $QST IDs |
|
515 | - * @return array|bool |
|
516 | - * @throws \EE_Error |
|
517 | - */ |
|
518 | - public function get_options_for_question($QST_IDs) |
|
519 | - { |
|
520 | - if (empty($QST_IDs)) { |
|
521 | - EE_Error::add_error( |
|
522 | - esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'), |
|
523 | - __FILE__, |
|
524 | - __FUNCTION__, |
|
525 | - __LINE__ |
|
526 | - ); |
|
527 | - return false; |
|
528 | - } |
|
529 | - return EE_Registry::instance()->load_model('Question_Option')->get_all( |
|
530 | - array( |
|
531 | - array( |
|
532 | - 'Question.QST_ID' => array('IN', $QST_IDs), |
|
533 | - 'QSO_deleted' => false, |
|
534 | - ), |
|
535 | - 'order_by' => 'QSO_ID', |
|
536 | - ) |
|
537 | - ); |
|
538 | - } |
|
539 | - |
|
540 | - |
|
541 | - |
|
542 | - |
|
543 | - |
|
544 | - |
|
545 | - |
|
546 | - /** |
|
547 | - * Gets all events that are published |
|
548 | - * and have event start time earlier than now and an event end time later than now |
|
549 | - * |
|
550 | - * @param array $query_params An array of query params to further filter on |
|
551 | - * (note that status and DTT_EVT_start and DTT_EVT_end will be overridden) |
|
552 | - * @param bool $count whether to return the count or not (default FALSE) |
|
553 | - * @return EE_Event[]|int |
|
554 | - * @throws \EE_Error |
|
555 | - */ |
|
556 | - public function get_active_events($query_params, $count = false) |
|
557 | - { |
|
558 | - if (array_key_exists(0, $query_params)) { |
|
559 | - $where_params = $query_params[0]; |
|
560 | - unset($query_params[0]); |
|
561 | - } else { |
|
562 | - $where_params = array(); |
|
563 | - } |
|
564 | - // if we have count make sure we don't include group by |
|
565 | - if ($count && isset($query_params['group_by'])) { |
|
566 | - unset($query_params['group_by']); |
|
567 | - } |
|
568 | - // let's add specific query_params for active_events |
|
569 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
570 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
571 | - // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions |
|
572 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
573 | - $where_params['Datetime.DTT_EVT_start******'] = array( |
|
574 | - '<', |
|
575 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
576 | - ); |
|
577 | - } else { |
|
578 | - $where_params['Datetime.DTT_EVT_start'] = array( |
|
579 | - '<', |
|
580 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
581 | - ); |
|
582 | - } |
|
583 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
584 | - $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
585 | - '>', |
|
586 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
587 | - ); |
|
588 | - } else { |
|
589 | - $where_params['Datetime.DTT_EVT_end'] = array( |
|
590 | - '>', |
|
591 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
592 | - ); |
|
593 | - } |
|
594 | - $query_params[0] = $where_params; |
|
595 | - // don't use $query_params with count() |
|
596 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
597 | - return $count |
|
598 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
599 | - : $this->get_all($query_params); |
|
600 | - } |
|
601 | - |
|
602 | - |
|
603 | - |
|
604 | - /** |
|
605 | - * get all events that are published and have an event start time later than now |
|
606 | - * |
|
607 | - * @param array $query_params An array of query params to further filter on |
|
608 | - * (Note that status and DTT_EVT_start will be overridden) |
|
609 | - * @param bool $count whether to return the count or not (default FALSE) |
|
610 | - * @return EE_Event[]|int |
|
611 | - * @throws \EE_Error |
|
612 | - */ |
|
613 | - public function get_upcoming_events($query_params, $count = false) |
|
614 | - { |
|
615 | - if (array_key_exists(0, $query_params)) { |
|
616 | - $where_params = $query_params[0]; |
|
617 | - unset($query_params[0]); |
|
618 | - } else { |
|
619 | - $where_params = array(); |
|
620 | - } |
|
621 | - // if we have count make sure we don't include group by |
|
622 | - if ($count && isset($query_params['group_by'])) { |
|
623 | - unset($query_params['group_by']); |
|
624 | - } |
|
625 | - // let's add specific query_params for active_events |
|
626 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
627 | - // we need to pull events with a status of publish and sold_out |
|
628 | - $event_status = array('publish', EEM_Event::sold_out); |
|
629 | - // check if the user can read private events and if so add the 'private status to the were params' |
|
630 | - if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) { |
|
631 | - $event_status[] = 'private'; |
|
632 | - } |
|
633 | - $where_params['status'] = array('IN', $event_status); |
|
634 | - // if there are already query_params matching DTT_EVT_start then we need to modify that to add them. |
|
635 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
636 | - $where_params['Datetime.DTT_EVT_start*****'] = array( |
|
637 | - '>', |
|
638 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
639 | - ); |
|
640 | - } else { |
|
641 | - $where_params['Datetime.DTT_EVT_start'] = array( |
|
642 | - '>', |
|
643 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
644 | - ); |
|
645 | - } |
|
646 | - $query_params[0] = $where_params; |
|
647 | - // don't use $query_params with count() |
|
648 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
649 | - return $count |
|
650 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
651 | - : $this->get_all($query_params); |
|
652 | - } |
|
653 | - |
|
654 | - |
|
655 | - |
|
656 | - /** |
|
657 | - * Gets all events that are published |
|
658 | - * and have an event end time later than now |
|
659 | - * |
|
660 | - * @param array $query_params An array of query params to further filter on |
|
661 | - * (note that status and DTT_EVT_end will be overridden) |
|
662 | - * @param bool $count whether to return the count or not (default FALSE) |
|
663 | - * @return EE_Event[]|int |
|
664 | - * @throws \EE_Error |
|
665 | - */ |
|
666 | - public function get_active_and_upcoming_events($query_params, $count = false) |
|
667 | - { |
|
668 | - if (array_key_exists(0, $query_params)) { |
|
669 | - $where_params = $query_params[0]; |
|
670 | - unset($query_params[0]); |
|
671 | - } else { |
|
672 | - $where_params = array(); |
|
673 | - } |
|
674 | - // if we have count make sure we don't include group by |
|
675 | - if ($count && isset($query_params['group_by'])) { |
|
676 | - unset($query_params['group_by']); |
|
677 | - } |
|
678 | - // let's add specific query_params for active_events |
|
679 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
680 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
681 | - // add where params for DTT_EVT_end |
|
682 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
683 | - $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
684 | - '>', |
|
685 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
686 | - ); |
|
687 | - } else { |
|
688 | - $where_params['Datetime.DTT_EVT_end'] = array( |
|
689 | - '>', |
|
690 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
691 | - ); |
|
692 | - } |
|
693 | - $query_params[0] = $where_params; |
|
694 | - // don't use $query_params with count() |
|
695 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
696 | - return $count |
|
697 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
698 | - : $this->get_all($query_params); |
|
699 | - } |
|
700 | - |
|
701 | - |
|
702 | - |
|
703 | - /** |
|
704 | - * This only returns events that are expired. |
|
705 | - * They may still be published but all their datetimes have expired. |
|
706 | - * |
|
707 | - * @param array $query_params An array of query params to further filter on |
|
708 | - * (note that status and DTT_EVT_end will be overridden) |
|
709 | - * @param bool $count whether to return the count or not (default FALSE) |
|
710 | - * @return EE_Event[]|int |
|
711 | - * @throws \EE_Error |
|
712 | - */ |
|
713 | - public function get_expired_events($query_params, $count = false) |
|
714 | - { |
|
715 | - $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
716 | - // if we have count make sure we don't include group by |
|
717 | - if ($count && isset($query_params['group_by'])) { |
|
718 | - unset($query_params['group_by']); |
|
719 | - } |
|
720 | - // let's add specific query_params for active_events |
|
721 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
722 | - if (isset($where_params['status'])) { |
|
723 | - unset($where_params['status']); |
|
724 | - } |
|
725 | - $exclude_query = $query_params; |
|
726 | - if (isset($exclude_query[0])) { |
|
727 | - unset($exclude_query[0]); |
|
728 | - } |
|
729 | - $exclude_query[0] = array( |
|
730 | - 'Datetime.DTT_EVT_end' => array( |
|
731 | - '>', |
|
732 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
733 | - ), |
|
734 | - ); |
|
735 | - // first get all events that have datetimes where its not expired. |
|
736 | - $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID'); |
|
737 | - $event_ids = array_keys($event_ids); |
|
738 | - // if we have any additional query_params, let's add them to the 'AND' condition |
|
739 | - $and_condition = array( |
|
740 | - 'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')), |
|
741 | - 'EVT_ID' => array('NOT IN', $event_ids), |
|
742 | - ); |
|
743 | - if (isset($where_params['OR'])) { |
|
744 | - $and_condition['OR'] = $where_params['OR']; |
|
745 | - unset($where_params['OR']); |
|
746 | - } |
|
747 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
748 | - $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
749 | - unset($where_params['Datetime.DTT_EVT_end']); |
|
750 | - } |
|
751 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
752 | - $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
753 | - unset($where_params['Datetime.DTT_EVT_start']); |
|
754 | - } |
|
755 | - // merge remaining $where params with the and conditions. |
|
756 | - $where_params['AND'] = array_merge($and_condition, $where_params); |
|
757 | - $query_params[0] = $where_params; |
|
758 | - // don't use $query_params with count() |
|
759 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
760 | - return $count |
|
761 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
762 | - : $this->get_all($query_params); |
|
763 | - } |
|
764 | - |
|
765 | - |
|
766 | - |
|
767 | - /** |
|
768 | - * This basically just returns the events that do not have the publish status. |
|
769 | - * |
|
770 | - * @param array $query_params An array of query params to further filter on |
|
771 | - * (note that status will be overwritten) |
|
772 | - * @param boolean $count whether to return the count or not (default FALSE) |
|
773 | - * @return EE_Event[]|int |
|
774 | - * @throws \EE_Error |
|
775 | - */ |
|
776 | - public function get_inactive_events($query_params, $count = false) |
|
777 | - { |
|
778 | - $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
779 | - // let's add in specific query_params for inactive events. |
|
780 | - if (isset($where_params['status'])) { |
|
781 | - unset($where_params['status']); |
|
782 | - } |
|
783 | - // if we have count make sure we don't include group by |
|
784 | - if ($count && isset($query_params['group_by'])) { |
|
785 | - unset($query_params['group_by']); |
|
786 | - } |
|
787 | - // if we have any additional query_params, let's add them to the 'AND' condition |
|
788 | - $where_params['AND']['status'] = array('!=', 'publish'); |
|
789 | - if (isset($where_params['OR'])) { |
|
790 | - $where_params['AND']['OR'] = $where_params['OR']; |
|
791 | - unset($where_params['OR']); |
|
792 | - } |
|
793 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
794 | - $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
795 | - unset($where_params['Datetime.DTT_EVT_end']); |
|
796 | - } |
|
797 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
798 | - $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
799 | - unset($where_params['Datetime.DTT_EVT_start']); |
|
800 | - } |
|
801 | - $query_params[0] = $where_params; |
|
802 | - // don't use $query_params with count() |
|
803 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
804 | - return $count |
|
805 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
806 | - : $this->get_all($query_params); |
|
807 | - } |
|
808 | - |
|
809 | - |
|
810 | - |
|
811 | - /** |
|
812 | - * This is just injecting into the parent add_relationship_to so we do special handling on price relationships |
|
813 | - * because we don't want to override any existing global default prices but instead insert NEW prices that get |
|
814 | - * attached to the event. See parent for param descriptions |
|
815 | - * |
|
816 | - * @param $id_or_obj |
|
817 | - * @param $other_model_id_or_obj |
|
818 | - * @param string $relationName |
|
819 | - * @param array $where_query |
|
820 | - * @return EE_Base_Class |
|
821 | - * @throws EE_Error |
|
822 | - */ |
|
823 | - public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array()) |
|
824 | - { |
|
825 | - if ($relationName === 'Price') { |
|
826 | - // let's get the PRC object for the given ID to make sure that we aren't dealing with a default |
|
827 | - $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj); |
|
828 | - // if EVT_ID = 0, then this is a default |
|
829 | - if ((int) $prc_chk->get('EVT_ID') === 0) { |
|
830 | - // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation |
|
831 | - $prc_chk->set('PRC_ID', 0); |
|
832 | - } |
|
833 | - // run parent |
|
834 | - return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query); |
|
835 | - } |
|
836 | - // otherwise carry on as normal |
|
837 | - return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query); |
|
838 | - } |
|
839 | - |
|
840 | - |
|
841 | - |
|
842 | - /******************** DEPRECATED METHODS ********************/ |
|
843 | - |
|
844 | - |
|
845 | - |
|
846 | - /** |
|
847 | - * _get_question_target_db_column |
|
848 | - * |
|
849 | - * @deprecated as of 4.8.32.rc.001. Instead consider using |
|
850 | - * EE_Registration_Custom_Questions_Form located in |
|
851 | - * admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php |
|
852 | - * @access public |
|
853 | - * @param EE_Registration $registration (so existing answers for registration are included) |
|
854 | - * @param int $EVT_ID so all question groups are included for event (not just answers from |
|
855 | - * registration). |
|
856 | - * @throws EE_Error |
|
857 | - * @return array |
|
858 | - */ |
|
859 | - public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0) |
|
860 | - { |
|
861 | - if (empty($EVT_ID)) { |
|
862 | - throw new EE_Error(__( |
|
863 | - 'An error occurred. No EVT_ID is included. Needed to know which question groups to retrieve.', |
|
864 | - 'event_espresso' |
|
865 | - )); |
|
866 | - } |
|
867 | - $questions = array(); |
|
868 | - // get all question groups for event |
|
869 | - $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
|
870 | - if (! empty($qgs)) { |
|
871 | - foreach ($qgs as $qg) { |
|
872 | - $qsts = $qg->questions(); |
|
873 | - $questions[ $qg->ID() ] = $qg->model_field_array(); |
|
874 | - $questions[ $qg->ID() ]['QSG_questions'] = array(); |
|
875 | - foreach ($qsts as $qst) { |
|
876 | - if ($qst->is_system_question()) { |
|
877 | - continue; |
|
878 | - } |
|
879 | - $answer = EEM_Answer::instance()->get_one(array( |
|
880 | - array( |
|
881 | - 'QST_ID' => $qst->ID(), |
|
882 | - 'REG_ID' => $registration->ID(), |
|
883 | - ), |
|
884 | - )); |
|
885 | - $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
|
886 | - $qst_name = $qstn_id = $qst->ID(); |
|
887 | - $ans_id = $answer->ID(); |
|
888 | - $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
889 | - $input_name = ''; |
|
890 | - $input_id = sanitize_key($qst->display_text()); |
|
891 | - $input_class = ''; |
|
892 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array(); |
|
893 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn' |
|
894 | - . $input_name |
|
895 | - . $qst_name; |
|
896 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
897 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class; |
|
898 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array(); |
|
899 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst; |
|
900 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer; |
|
901 | - // leave responses as-is, don't convert stuff into html entities please! |
|
902 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false; |
|
903 | - if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
|
904 | - $QSOs = $qst->options(true, $answer->value()); |
|
905 | - if (is_array($QSOs)) { |
|
906 | - foreach ($QSOs as $QSO_ID => $QSO) { |
|
907 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array(); |
|
908 | - } |
|
909 | - } |
|
910 | - } |
|
911 | - } |
|
912 | - } |
|
913 | - } |
|
914 | - return $questions; |
|
915 | - } |
|
916 | - |
|
917 | - |
|
918 | - /** |
|
919 | - * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value |
|
920 | - * or an stdClass where each property is the name of a column, |
|
921 | - * @return EE_Base_Class |
|
922 | - * @throws \EE_Error |
|
923 | - */ |
|
924 | - public function instantiate_class_from_array_or_object($cols_n_values) |
|
925 | - { |
|
926 | - $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values); |
|
927 | - if ($classInstance instanceof EE_Event) { |
|
928 | - // events have their timezone defined in the DB, so use it immediately |
|
929 | - $this->set_timezone($classInstance->get_timezone()); |
|
930 | - } |
|
931 | - return $classInstance; |
|
932 | - } |
|
18 | + /** |
|
19 | + * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the |
|
20 | + * event |
|
21 | + */ |
|
22 | + const sold_out = 'sold_out'; |
|
23 | + |
|
24 | + /** |
|
25 | + * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later |
|
26 | + * date) |
|
27 | + */ |
|
28 | + const postponed = 'postponed'; |
|
29 | + |
|
30 | + /** |
|
31 | + * constant used by status(), indicating that the event will no longer occur |
|
32 | + */ |
|
33 | + const cancelled = 'cancelled'; |
|
34 | + |
|
35 | + |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | + protected static $_default_reg_status; |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * This is the default for the additional limit field. |
|
44 | + * @var int |
|
45 | + */ |
|
46 | + protected static $_default_additional_limit = 10; |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * private instance of the Event object |
|
51 | + * |
|
52 | + * @var EEM_Event |
|
53 | + */ |
|
54 | + protected static $_instance; |
|
55 | + |
|
56 | + |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
61 | + * |
|
62 | + * @param string $timezone |
|
63 | + * @throws \EE_Error |
|
64 | + */ |
|
65 | + protected function __construct($timezone = null) |
|
66 | + { |
|
67 | + EE_Registry::instance()->load_model('Registration'); |
|
68 | + $this->singular_item = esc_html__('Event', 'event_espresso'); |
|
69 | + $this->plural_item = esc_html__('Events', 'event_espresso'); |
|
70 | + // to remove Cancelled events from the frontend, copy the following filter to your functions.php file |
|
71 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' ); |
|
72 | + // to remove Postponed events from the frontend, copy the following filter to your functions.php file |
|
73 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' ); |
|
74 | + // to remove Sold Out events from the frontend, copy the following filter to your functions.php file |
|
75 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' ); |
|
76 | + $this->_custom_stati = apply_filters( |
|
77 | + 'AFEE__EEM_Event__construct___custom_stati', |
|
78 | + array( |
|
79 | + EEM_Event::cancelled => array( |
|
80 | + 'label' => esc_html__('Cancelled', 'event_espresso'), |
|
81 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true), |
|
82 | + ), |
|
83 | + EEM_Event::postponed => array( |
|
84 | + 'label' => esc_html__('Postponed', 'event_espresso'), |
|
85 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true), |
|
86 | + ), |
|
87 | + EEM_Event::sold_out => array( |
|
88 | + 'label' => esc_html__('Sold Out', 'event_espresso'), |
|
89 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true), |
|
90 | + ), |
|
91 | + ) |
|
92 | + ); |
|
93 | + self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment |
|
94 | + : self::$_default_reg_status; |
|
95 | + $this->_tables = array( |
|
96 | + 'Event_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
97 | + 'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'), |
|
98 | + ); |
|
99 | + $this->_fields = array( |
|
100 | + 'Event_CPT' => array( |
|
101 | + 'EVT_ID' => new EE_Primary_Key_Int_Field( |
|
102 | + 'ID', |
|
103 | + esc_html__('Post ID for Event', 'event_espresso') |
|
104 | + ), |
|
105 | + 'EVT_name' => new EE_Plain_Text_Field( |
|
106 | + 'post_title', |
|
107 | + esc_html__('Event Name', 'event_espresso'), |
|
108 | + false, |
|
109 | + '' |
|
110 | + ), |
|
111 | + 'EVT_desc' => new EE_Post_Content_Field( |
|
112 | + 'post_content', |
|
113 | + esc_html__('Event Description', 'event_espresso'), |
|
114 | + false, |
|
115 | + '' |
|
116 | + ), |
|
117 | + 'EVT_slug' => new EE_Slug_Field( |
|
118 | + 'post_name', |
|
119 | + esc_html__('Event Slug', 'event_espresso'), |
|
120 | + false, |
|
121 | + '' |
|
122 | + ), |
|
123 | + 'EVT_created' => new EE_Datetime_Field( |
|
124 | + 'post_date', |
|
125 | + esc_html__('Date/Time Event Created', 'event_espresso'), |
|
126 | + false, |
|
127 | + EE_Datetime_Field::now |
|
128 | + ), |
|
129 | + 'EVT_short_desc' => new EE_Simple_HTML_Field( |
|
130 | + 'post_excerpt', |
|
131 | + esc_html__('Event Short Description', 'event_espresso'), |
|
132 | + false, |
|
133 | + '' |
|
134 | + ), |
|
135 | + 'EVT_modified' => new EE_Datetime_Field( |
|
136 | + 'post_modified', |
|
137 | + esc_html__('Date/Time Event Modified', 'event_espresso'), |
|
138 | + false, |
|
139 | + EE_Datetime_Field::now |
|
140 | + ), |
|
141 | + 'EVT_wp_user' => new EE_WP_User_Field( |
|
142 | + 'post_author', |
|
143 | + esc_html__('Event Creator ID', 'event_espresso'), |
|
144 | + false |
|
145 | + ), |
|
146 | + 'parent' => new EE_Integer_Field( |
|
147 | + 'post_parent', |
|
148 | + esc_html__('Event Parent ID', 'event_espresso'), |
|
149 | + false, |
|
150 | + 0 |
|
151 | + ), |
|
152 | + 'EVT_order' => new EE_Integer_Field( |
|
153 | + 'menu_order', |
|
154 | + esc_html__('Event Menu Order', 'event_espresso'), |
|
155 | + false, |
|
156 | + 1 |
|
157 | + ), |
|
158 | + 'post_type' => new EE_WP_Post_Type_Field('espresso_events'), |
|
159 | + // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ), |
|
160 | + 'status' => new EE_WP_Post_Status_Field( |
|
161 | + 'post_status', |
|
162 | + esc_html__('Event Status', 'event_espresso'), |
|
163 | + false, |
|
164 | + 'draft', |
|
165 | + $this->_custom_stati |
|
166 | + ), |
|
167 | + 'password' => new EE_Password_Field( |
|
168 | + 'post_password', |
|
169 | + __('Password', 'event_espresso'), |
|
170 | + false, |
|
171 | + '', |
|
172 | + array( |
|
173 | + 'EVT_desc', |
|
174 | + 'EVT_short_desc', |
|
175 | + 'EVT_display_desc', |
|
176 | + 'EVT_display_ticket_selector', |
|
177 | + 'EVT_visible_on', |
|
178 | + 'EVT_additional_limit', |
|
179 | + 'EVT_default_registration_status', |
|
180 | + 'EVT_member_only', |
|
181 | + 'EVT_phone', |
|
182 | + 'EVT_allow_overflow', |
|
183 | + 'EVT_timezone_string', |
|
184 | + 'EVT_external_URL', |
|
185 | + 'EVT_donations' |
|
186 | + ) |
|
187 | + ) |
|
188 | + ), |
|
189 | + 'Event_Meta' => array( |
|
190 | + 'EVTM_ID' => new EE_DB_Only_Float_Field( |
|
191 | + 'EVTM_ID', |
|
192 | + esc_html__('Event Meta Row ID', 'event_espresso'), |
|
193 | + false |
|
194 | + ), |
|
195 | + 'EVT_ID_fk' => new EE_DB_Only_Int_Field( |
|
196 | + 'EVT_ID', |
|
197 | + esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), |
|
198 | + false |
|
199 | + ), |
|
200 | + 'EVT_display_desc' => new EE_Boolean_Field( |
|
201 | + 'EVT_display_desc', |
|
202 | + esc_html__('Display Description Flag', 'event_espresso'), |
|
203 | + false, |
|
204 | + true |
|
205 | + ), |
|
206 | + 'EVT_display_ticket_selector' => new EE_Boolean_Field( |
|
207 | + 'EVT_display_ticket_selector', |
|
208 | + esc_html__('Display Ticket Selector Flag', 'event_espresso'), |
|
209 | + false, |
|
210 | + true |
|
211 | + ), |
|
212 | + 'EVT_visible_on' => new EE_Datetime_Field( |
|
213 | + 'EVT_visible_on', |
|
214 | + esc_html__('Event Visible Date', 'event_espresso'), |
|
215 | + true, |
|
216 | + EE_Datetime_Field::now |
|
217 | + ), |
|
218 | + 'EVT_additional_limit' => new EE_Integer_Field( |
|
219 | + 'EVT_additional_limit', |
|
220 | + esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
221 | + true, |
|
222 | + self::$_default_additional_limit |
|
223 | + ), |
|
224 | + 'EVT_default_registration_status' => new EE_Enum_Text_Field( |
|
225 | + 'EVT_default_registration_status', |
|
226 | + esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
227 | + false, |
|
228 | + EEM_Event::$_default_reg_status, |
|
229 | + EEM_Registration::reg_status_array() |
|
230 | + ), |
|
231 | + 'EVT_member_only' => new EE_Boolean_Field( |
|
232 | + 'EVT_member_only', |
|
233 | + esc_html__('Member-Only Event Flag', 'event_espresso'), |
|
234 | + false, |
|
235 | + false |
|
236 | + ), |
|
237 | + 'EVT_phone' => new EE_Plain_Text_Field( |
|
238 | + 'EVT_phone', |
|
239 | + esc_html__('Event Phone Number', 'event_espresso'), |
|
240 | + false, |
|
241 | + '' |
|
242 | + ), |
|
243 | + 'EVT_allow_overflow' => new EE_Boolean_Field( |
|
244 | + 'EVT_allow_overflow', |
|
245 | + esc_html__('Allow Overflow on Event', 'event_espresso'), |
|
246 | + false, |
|
247 | + false |
|
248 | + ), |
|
249 | + 'EVT_timezone_string' => new EE_Plain_Text_Field( |
|
250 | + 'EVT_timezone_string', |
|
251 | + esc_html__('Timezone (name) for Event times', 'event_espresso'), |
|
252 | + false, |
|
253 | + '' |
|
254 | + ), |
|
255 | + 'EVT_external_URL' => new EE_Plain_Text_Field( |
|
256 | + 'EVT_external_URL', |
|
257 | + esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), |
|
258 | + true |
|
259 | + ), |
|
260 | + 'EVT_donations' => new EE_Boolean_Field( |
|
261 | + 'EVT_donations', |
|
262 | + esc_html__('Accept Donations?', 'event_espresso'), |
|
263 | + false, |
|
264 | + false |
|
265 | + ), |
|
266 | + ), |
|
267 | + ); |
|
268 | + $this->_model_relations = array( |
|
269 | + 'Registration' => new EE_Has_Many_Relation(), |
|
270 | + 'Datetime' => new EE_Has_Many_Relation(), |
|
271 | + 'Question_Group' => new EE_HABTM_Relation('Event_Question_Group'), |
|
272 | + 'Event_Question_Group' => new EE_Has_Many_Relation(), |
|
273 | + 'Venue' => new EE_HABTM_Relation('Event_Venue'), |
|
274 | + 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
275 | + 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
276 | + 'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'), |
|
277 | + 'Attendee' => new EE_HABTM_Relation('Registration'), |
|
278 | + 'WP_User' => new EE_Belongs_To_Relation(), |
|
279 | + ); |
|
280 | + // this model is generally available for reading |
|
281 | + $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
282 | + $this->model_chain_to_password = ''; |
|
283 | + parent::__construct($timezone); |
|
284 | + } |
|
285 | + |
|
286 | + |
|
287 | + |
|
288 | + /** |
|
289 | + * @param string $default_reg_status |
|
290 | + */ |
|
291 | + public static function set_default_reg_status($default_reg_status) |
|
292 | + { |
|
293 | + self::$_default_reg_status = $default_reg_status; |
|
294 | + // if EEM_Event has already been instantiated, |
|
295 | + // then we need to reset the `EVT_default_reg_status` field to use the new default. |
|
296 | + if (self::$_instance instanceof EEM_Event) { |
|
297 | + $default_reg_status = new EE_Enum_Text_Field( |
|
298 | + 'EVT_default_registration_status', |
|
299 | + esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
300 | + false, |
|
301 | + $default_reg_status, |
|
302 | + EEM_Registration::reg_status_array() |
|
303 | + ); |
|
304 | + $default_reg_status->_construct_finalize( |
|
305 | + 'Event_Meta', |
|
306 | + 'EVT_default_registration_status', |
|
307 | + 'EEM_Event' |
|
308 | + ); |
|
309 | + self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status; |
|
310 | + } |
|
311 | + } |
|
312 | + |
|
313 | + |
|
314 | + /** |
|
315 | + * Used to override the default for the additional limit field. |
|
316 | + * @param $additional_limit |
|
317 | + */ |
|
318 | + public static function set_default_additional_limit($additional_limit) |
|
319 | + { |
|
320 | + self::$_default_additional_limit = (int) $additional_limit; |
|
321 | + if (self::$_instance instanceof EEM_Event) { |
|
322 | + self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field( |
|
323 | + 'EVT_additional_limit', |
|
324 | + __('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
325 | + true, |
|
326 | + self::$_default_additional_limit |
|
327 | + ); |
|
328 | + self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize( |
|
329 | + 'Event_Meta', |
|
330 | + 'EVT_additional_limit', |
|
331 | + 'EEM_Event' |
|
332 | + ); |
|
333 | + } |
|
334 | + } |
|
335 | + |
|
336 | + |
|
337 | + /** |
|
338 | + * Return what is currently set as the default additional limit for the event. |
|
339 | + * @return int |
|
340 | + */ |
|
341 | + public static function get_default_additional_limit() |
|
342 | + { |
|
343 | + return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit); |
|
344 | + } |
|
345 | + |
|
346 | + |
|
347 | + /** |
|
348 | + * get_question_groups |
|
349 | + * |
|
350 | + * @return array |
|
351 | + * @throws \EE_Error |
|
352 | + */ |
|
353 | + public function get_all_question_groups() |
|
354 | + { |
|
355 | + return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
356 | + array( |
|
357 | + array('QSG_deleted' => false), |
|
358 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
359 | + ) |
|
360 | + ); |
|
361 | + } |
|
362 | + |
|
363 | + |
|
364 | + |
|
365 | + /** |
|
366 | + * get_question_groups |
|
367 | + * |
|
368 | + * @param int $EVT_ID |
|
369 | + * @return array|bool |
|
370 | + * @throws \EE_Error |
|
371 | + */ |
|
372 | + public function get_all_event_question_groups($EVT_ID = 0) |
|
373 | + { |
|
374 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
375 | + EE_Error::add_error( |
|
376 | + esc_html__( |
|
377 | + 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
378 | + 'event_espresso' |
|
379 | + ), |
|
380 | + __FILE__, |
|
381 | + __FUNCTION__, |
|
382 | + __LINE__ |
|
383 | + ); |
|
384 | + return false; |
|
385 | + } |
|
386 | + return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
387 | + array( |
|
388 | + array('EVT_ID' => $EVT_ID), |
|
389 | + ) |
|
390 | + ); |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * get_question_groups |
|
396 | + * |
|
397 | + * @param int $EVT_ID |
|
398 | + * @param boolean $for_primary_attendee |
|
399 | + * @return array|bool |
|
400 | + * @throws EE_Error |
|
401 | + * @throws InvalidArgumentException |
|
402 | + * @throws ReflectionException |
|
403 | + * @throws InvalidDataTypeException |
|
404 | + * @throws InvalidInterfaceException |
|
405 | + */ |
|
406 | + public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
|
407 | + { |
|
408 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
409 | + EE_Error::add_error( |
|
410 | + esc_html__( |
|
411 | + // @codingStandardsIgnoreStart |
|
412 | + 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
413 | + // @codingStandardsIgnoreEnd |
|
414 | + 'event_espresso' |
|
415 | + ), |
|
416 | + __FILE__, |
|
417 | + __FUNCTION__, |
|
418 | + __LINE__ |
|
419 | + ); |
|
420 | + return false; |
|
421 | + } |
|
422 | + $query_params = [ |
|
423 | + [ |
|
424 | + 'EVT_ID' => $EVT_ID, |
|
425 | + EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true |
|
426 | + ] |
|
427 | + ]; |
|
428 | + if ($for_primary_attendee) { |
|
429 | + $query_params[0]['EQG_primary'] = true; |
|
430 | + } else { |
|
431 | + $query_params[0]['EQG_additional'] = true; |
|
432 | + } |
|
433 | + return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params); |
|
434 | + } |
|
435 | + |
|
436 | + |
|
437 | + /** |
|
438 | + * get_question_groups |
|
439 | + * |
|
440 | + * @param int $EVT_ID |
|
441 | + * @param EE_Registration $registration |
|
442 | + * @return array|bool |
|
443 | + * @throws EE_Error |
|
444 | + * @throws InvalidArgumentException |
|
445 | + * @throws InvalidDataTypeException |
|
446 | + * @throws InvalidInterfaceException |
|
447 | + * @throws ReflectionException |
|
448 | + */ |
|
449 | + public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
|
450 | + { |
|
451 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
452 | + EE_Error::add_error( |
|
453 | + esc_html__( |
|
454 | + 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
|
455 | + 'event_espresso' |
|
456 | + ), |
|
457 | + __FILE__, |
|
458 | + __FUNCTION__, |
|
459 | + __LINE__ |
|
460 | + ); |
|
461 | + return false; |
|
462 | + } |
|
463 | + return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
464 | + [ |
|
465 | + [ |
|
466 | + 'Event_Question_Group.EVT_ID' => $EVT_ID, |
|
467 | + 'Event_Question_Group.' |
|
468 | + . EEM_Event_Question_Group::instance()->fieldNameForContext( |
|
469 | + $registration->is_primary_registrant() |
|
470 | + ) => true |
|
471 | + ], |
|
472 | + 'order_by' => ['QSG_order' => 'ASC'], |
|
473 | + ] |
|
474 | + ); |
|
475 | + } |
|
476 | + |
|
477 | + |
|
478 | + |
|
479 | + /** |
|
480 | + * get_question_target_db_column |
|
481 | + * |
|
482 | + * @param string $QSG_IDs csv list of $QSG IDs |
|
483 | + * @return array|bool |
|
484 | + * @throws \EE_Error |
|
485 | + */ |
|
486 | + public function get_questions_in_groups($QSG_IDs = '') |
|
487 | + { |
|
488 | + if (empty($QSG_IDs)) { |
|
489 | + EE_Error::add_error( |
|
490 | + esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'), |
|
491 | + __FILE__, |
|
492 | + __FUNCTION__, |
|
493 | + __LINE__ |
|
494 | + ); |
|
495 | + return false; |
|
496 | + } |
|
497 | + return EE_Registry::instance()->load_model('Question')->get_all( |
|
498 | + array( |
|
499 | + array( |
|
500 | + 'Question_Group.QSG_ID' => array('IN', $QSG_IDs), |
|
501 | + 'QST_deleted' => false, |
|
502 | + 'QST_admin_only' => is_admin(), |
|
503 | + ), |
|
504 | + 'order_by' => 'QST_order', |
|
505 | + ) |
|
506 | + ); |
|
507 | + } |
|
508 | + |
|
509 | + |
|
510 | + |
|
511 | + /** |
|
512 | + * get_options_for_question |
|
513 | + * |
|
514 | + * @param string $QST_IDs csv list of $QST IDs |
|
515 | + * @return array|bool |
|
516 | + * @throws \EE_Error |
|
517 | + */ |
|
518 | + public function get_options_for_question($QST_IDs) |
|
519 | + { |
|
520 | + if (empty($QST_IDs)) { |
|
521 | + EE_Error::add_error( |
|
522 | + esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'), |
|
523 | + __FILE__, |
|
524 | + __FUNCTION__, |
|
525 | + __LINE__ |
|
526 | + ); |
|
527 | + return false; |
|
528 | + } |
|
529 | + return EE_Registry::instance()->load_model('Question_Option')->get_all( |
|
530 | + array( |
|
531 | + array( |
|
532 | + 'Question.QST_ID' => array('IN', $QST_IDs), |
|
533 | + 'QSO_deleted' => false, |
|
534 | + ), |
|
535 | + 'order_by' => 'QSO_ID', |
|
536 | + ) |
|
537 | + ); |
|
538 | + } |
|
539 | + |
|
540 | + |
|
541 | + |
|
542 | + |
|
543 | + |
|
544 | + |
|
545 | + |
|
546 | + /** |
|
547 | + * Gets all events that are published |
|
548 | + * and have event start time earlier than now and an event end time later than now |
|
549 | + * |
|
550 | + * @param array $query_params An array of query params to further filter on |
|
551 | + * (note that status and DTT_EVT_start and DTT_EVT_end will be overridden) |
|
552 | + * @param bool $count whether to return the count or not (default FALSE) |
|
553 | + * @return EE_Event[]|int |
|
554 | + * @throws \EE_Error |
|
555 | + */ |
|
556 | + public function get_active_events($query_params, $count = false) |
|
557 | + { |
|
558 | + if (array_key_exists(0, $query_params)) { |
|
559 | + $where_params = $query_params[0]; |
|
560 | + unset($query_params[0]); |
|
561 | + } else { |
|
562 | + $where_params = array(); |
|
563 | + } |
|
564 | + // if we have count make sure we don't include group by |
|
565 | + if ($count && isset($query_params['group_by'])) { |
|
566 | + unset($query_params['group_by']); |
|
567 | + } |
|
568 | + // let's add specific query_params for active_events |
|
569 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
570 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
571 | + // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions |
|
572 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
573 | + $where_params['Datetime.DTT_EVT_start******'] = array( |
|
574 | + '<', |
|
575 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
576 | + ); |
|
577 | + } else { |
|
578 | + $where_params['Datetime.DTT_EVT_start'] = array( |
|
579 | + '<', |
|
580 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
581 | + ); |
|
582 | + } |
|
583 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
584 | + $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
585 | + '>', |
|
586 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
587 | + ); |
|
588 | + } else { |
|
589 | + $where_params['Datetime.DTT_EVT_end'] = array( |
|
590 | + '>', |
|
591 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
592 | + ); |
|
593 | + } |
|
594 | + $query_params[0] = $where_params; |
|
595 | + // don't use $query_params with count() |
|
596 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
597 | + return $count |
|
598 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
599 | + : $this->get_all($query_params); |
|
600 | + } |
|
601 | + |
|
602 | + |
|
603 | + |
|
604 | + /** |
|
605 | + * get all events that are published and have an event start time later than now |
|
606 | + * |
|
607 | + * @param array $query_params An array of query params to further filter on |
|
608 | + * (Note that status and DTT_EVT_start will be overridden) |
|
609 | + * @param bool $count whether to return the count or not (default FALSE) |
|
610 | + * @return EE_Event[]|int |
|
611 | + * @throws \EE_Error |
|
612 | + */ |
|
613 | + public function get_upcoming_events($query_params, $count = false) |
|
614 | + { |
|
615 | + if (array_key_exists(0, $query_params)) { |
|
616 | + $where_params = $query_params[0]; |
|
617 | + unset($query_params[0]); |
|
618 | + } else { |
|
619 | + $where_params = array(); |
|
620 | + } |
|
621 | + // if we have count make sure we don't include group by |
|
622 | + if ($count && isset($query_params['group_by'])) { |
|
623 | + unset($query_params['group_by']); |
|
624 | + } |
|
625 | + // let's add specific query_params for active_events |
|
626 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
627 | + // we need to pull events with a status of publish and sold_out |
|
628 | + $event_status = array('publish', EEM_Event::sold_out); |
|
629 | + // check if the user can read private events and if so add the 'private status to the were params' |
|
630 | + if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) { |
|
631 | + $event_status[] = 'private'; |
|
632 | + } |
|
633 | + $where_params['status'] = array('IN', $event_status); |
|
634 | + // if there are already query_params matching DTT_EVT_start then we need to modify that to add them. |
|
635 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
636 | + $where_params['Datetime.DTT_EVT_start*****'] = array( |
|
637 | + '>', |
|
638 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
639 | + ); |
|
640 | + } else { |
|
641 | + $where_params['Datetime.DTT_EVT_start'] = array( |
|
642 | + '>', |
|
643 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
644 | + ); |
|
645 | + } |
|
646 | + $query_params[0] = $where_params; |
|
647 | + // don't use $query_params with count() |
|
648 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
649 | + return $count |
|
650 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
651 | + : $this->get_all($query_params); |
|
652 | + } |
|
653 | + |
|
654 | + |
|
655 | + |
|
656 | + /** |
|
657 | + * Gets all events that are published |
|
658 | + * and have an event end time later than now |
|
659 | + * |
|
660 | + * @param array $query_params An array of query params to further filter on |
|
661 | + * (note that status and DTT_EVT_end will be overridden) |
|
662 | + * @param bool $count whether to return the count or not (default FALSE) |
|
663 | + * @return EE_Event[]|int |
|
664 | + * @throws \EE_Error |
|
665 | + */ |
|
666 | + public function get_active_and_upcoming_events($query_params, $count = false) |
|
667 | + { |
|
668 | + if (array_key_exists(0, $query_params)) { |
|
669 | + $where_params = $query_params[0]; |
|
670 | + unset($query_params[0]); |
|
671 | + } else { |
|
672 | + $where_params = array(); |
|
673 | + } |
|
674 | + // if we have count make sure we don't include group by |
|
675 | + if ($count && isset($query_params['group_by'])) { |
|
676 | + unset($query_params['group_by']); |
|
677 | + } |
|
678 | + // let's add specific query_params for active_events |
|
679 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
680 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
681 | + // add where params for DTT_EVT_end |
|
682 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
683 | + $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
684 | + '>', |
|
685 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
686 | + ); |
|
687 | + } else { |
|
688 | + $where_params['Datetime.DTT_EVT_end'] = array( |
|
689 | + '>', |
|
690 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
691 | + ); |
|
692 | + } |
|
693 | + $query_params[0] = $where_params; |
|
694 | + // don't use $query_params with count() |
|
695 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
696 | + return $count |
|
697 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
698 | + : $this->get_all($query_params); |
|
699 | + } |
|
700 | + |
|
701 | + |
|
702 | + |
|
703 | + /** |
|
704 | + * This only returns events that are expired. |
|
705 | + * They may still be published but all their datetimes have expired. |
|
706 | + * |
|
707 | + * @param array $query_params An array of query params to further filter on |
|
708 | + * (note that status and DTT_EVT_end will be overridden) |
|
709 | + * @param bool $count whether to return the count or not (default FALSE) |
|
710 | + * @return EE_Event[]|int |
|
711 | + * @throws \EE_Error |
|
712 | + */ |
|
713 | + public function get_expired_events($query_params, $count = false) |
|
714 | + { |
|
715 | + $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
716 | + // if we have count make sure we don't include group by |
|
717 | + if ($count && isset($query_params['group_by'])) { |
|
718 | + unset($query_params['group_by']); |
|
719 | + } |
|
720 | + // let's add specific query_params for active_events |
|
721 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
722 | + if (isset($where_params['status'])) { |
|
723 | + unset($where_params['status']); |
|
724 | + } |
|
725 | + $exclude_query = $query_params; |
|
726 | + if (isset($exclude_query[0])) { |
|
727 | + unset($exclude_query[0]); |
|
728 | + } |
|
729 | + $exclude_query[0] = array( |
|
730 | + 'Datetime.DTT_EVT_end' => array( |
|
731 | + '>', |
|
732 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
733 | + ), |
|
734 | + ); |
|
735 | + // first get all events that have datetimes where its not expired. |
|
736 | + $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID'); |
|
737 | + $event_ids = array_keys($event_ids); |
|
738 | + // if we have any additional query_params, let's add them to the 'AND' condition |
|
739 | + $and_condition = array( |
|
740 | + 'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')), |
|
741 | + 'EVT_ID' => array('NOT IN', $event_ids), |
|
742 | + ); |
|
743 | + if (isset($where_params['OR'])) { |
|
744 | + $and_condition['OR'] = $where_params['OR']; |
|
745 | + unset($where_params['OR']); |
|
746 | + } |
|
747 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
748 | + $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
749 | + unset($where_params['Datetime.DTT_EVT_end']); |
|
750 | + } |
|
751 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
752 | + $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
753 | + unset($where_params['Datetime.DTT_EVT_start']); |
|
754 | + } |
|
755 | + // merge remaining $where params with the and conditions. |
|
756 | + $where_params['AND'] = array_merge($and_condition, $where_params); |
|
757 | + $query_params[0] = $where_params; |
|
758 | + // don't use $query_params with count() |
|
759 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
760 | + return $count |
|
761 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
762 | + : $this->get_all($query_params); |
|
763 | + } |
|
764 | + |
|
765 | + |
|
766 | + |
|
767 | + /** |
|
768 | + * This basically just returns the events that do not have the publish status. |
|
769 | + * |
|
770 | + * @param array $query_params An array of query params to further filter on |
|
771 | + * (note that status will be overwritten) |
|
772 | + * @param boolean $count whether to return the count or not (default FALSE) |
|
773 | + * @return EE_Event[]|int |
|
774 | + * @throws \EE_Error |
|
775 | + */ |
|
776 | + public function get_inactive_events($query_params, $count = false) |
|
777 | + { |
|
778 | + $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
779 | + // let's add in specific query_params for inactive events. |
|
780 | + if (isset($where_params['status'])) { |
|
781 | + unset($where_params['status']); |
|
782 | + } |
|
783 | + // if we have count make sure we don't include group by |
|
784 | + if ($count && isset($query_params['group_by'])) { |
|
785 | + unset($query_params['group_by']); |
|
786 | + } |
|
787 | + // if we have any additional query_params, let's add them to the 'AND' condition |
|
788 | + $where_params['AND']['status'] = array('!=', 'publish'); |
|
789 | + if (isset($where_params['OR'])) { |
|
790 | + $where_params['AND']['OR'] = $where_params['OR']; |
|
791 | + unset($where_params['OR']); |
|
792 | + } |
|
793 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
794 | + $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
795 | + unset($where_params['Datetime.DTT_EVT_end']); |
|
796 | + } |
|
797 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
798 | + $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
799 | + unset($where_params['Datetime.DTT_EVT_start']); |
|
800 | + } |
|
801 | + $query_params[0] = $where_params; |
|
802 | + // don't use $query_params with count() |
|
803 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
804 | + return $count |
|
805 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
806 | + : $this->get_all($query_params); |
|
807 | + } |
|
808 | + |
|
809 | + |
|
810 | + |
|
811 | + /** |
|
812 | + * This is just injecting into the parent add_relationship_to so we do special handling on price relationships |
|
813 | + * because we don't want to override any existing global default prices but instead insert NEW prices that get |
|
814 | + * attached to the event. See parent for param descriptions |
|
815 | + * |
|
816 | + * @param $id_or_obj |
|
817 | + * @param $other_model_id_or_obj |
|
818 | + * @param string $relationName |
|
819 | + * @param array $where_query |
|
820 | + * @return EE_Base_Class |
|
821 | + * @throws EE_Error |
|
822 | + */ |
|
823 | + public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array()) |
|
824 | + { |
|
825 | + if ($relationName === 'Price') { |
|
826 | + // let's get the PRC object for the given ID to make sure that we aren't dealing with a default |
|
827 | + $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj); |
|
828 | + // if EVT_ID = 0, then this is a default |
|
829 | + if ((int) $prc_chk->get('EVT_ID') === 0) { |
|
830 | + // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation |
|
831 | + $prc_chk->set('PRC_ID', 0); |
|
832 | + } |
|
833 | + // run parent |
|
834 | + return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query); |
|
835 | + } |
|
836 | + // otherwise carry on as normal |
|
837 | + return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query); |
|
838 | + } |
|
839 | + |
|
840 | + |
|
841 | + |
|
842 | + /******************** DEPRECATED METHODS ********************/ |
|
843 | + |
|
844 | + |
|
845 | + |
|
846 | + /** |
|
847 | + * _get_question_target_db_column |
|
848 | + * |
|
849 | + * @deprecated as of 4.8.32.rc.001. Instead consider using |
|
850 | + * EE_Registration_Custom_Questions_Form located in |
|
851 | + * admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php |
|
852 | + * @access public |
|
853 | + * @param EE_Registration $registration (so existing answers for registration are included) |
|
854 | + * @param int $EVT_ID so all question groups are included for event (not just answers from |
|
855 | + * registration). |
|
856 | + * @throws EE_Error |
|
857 | + * @return array |
|
858 | + */ |
|
859 | + public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0) |
|
860 | + { |
|
861 | + if (empty($EVT_ID)) { |
|
862 | + throw new EE_Error(__( |
|
863 | + 'An error occurred. No EVT_ID is included. Needed to know which question groups to retrieve.', |
|
864 | + 'event_espresso' |
|
865 | + )); |
|
866 | + } |
|
867 | + $questions = array(); |
|
868 | + // get all question groups for event |
|
869 | + $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
|
870 | + if (! empty($qgs)) { |
|
871 | + foreach ($qgs as $qg) { |
|
872 | + $qsts = $qg->questions(); |
|
873 | + $questions[ $qg->ID() ] = $qg->model_field_array(); |
|
874 | + $questions[ $qg->ID() ]['QSG_questions'] = array(); |
|
875 | + foreach ($qsts as $qst) { |
|
876 | + if ($qst->is_system_question()) { |
|
877 | + continue; |
|
878 | + } |
|
879 | + $answer = EEM_Answer::instance()->get_one(array( |
|
880 | + array( |
|
881 | + 'QST_ID' => $qst->ID(), |
|
882 | + 'REG_ID' => $registration->ID(), |
|
883 | + ), |
|
884 | + )); |
|
885 | + $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
|
886 | + $qst_name = $qstn_id = $qst->ID(); |
|
887 | + $ans_id = $answer->ID(); |
|
888 | + $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
889 | + $input_name = ''; |
|
890 | + $input_id = sanitize_key($qst->display_text()); |
|
891 | + $input_class = ''; |
|
892 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array(); |
|
893 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn' |
|
894 | + . $input_name |
|
895 | + . $qst_name; |
|
896 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
897 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class; |
|
898 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array(); |
|
899 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst; |
|
900 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer; |
|
901 | + // leave responses as-is, don't convert stuff into html entities please! |
|
902 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false; |
|
903 | + if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
|
904 | + $QSOs = $qst->options(true, $answer->value()); |
|
905 | + if (is_array($QSOs)) { |
|
906 | + foreach ($QSOs as $QSO_ID => $QSO) { |
|
907 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array(); |
|
908 | + } |
|
909 | + } |
|
910 | + } |
|
911 | + } |
|
912 | + } |
|
913 | + } |
|
914 | + return $questions; |
|
915 | + } |
|
916 | + |
|
917 | + |
|
918 | + /** |
|
919 | + * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value |
|
920 | + * or an stdClass where each property is the name of a column, |
|
921 | + * @return EE_Base_Class |
|
922 | + * @throws \EE_Error |
|
923 | + */ |
|
924 | + public function instantiate_class_from_array_or_object($cols_n_values) |
|
925 | + { |
|
926 | + $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values); |
|
927 | + if ($classInstance instanceof EE_Event) { |
|
928 | + // events have their timezone defined in the DB, so use it immediately |
|
929 | + $this->set_timezone($classInstance->get_timezone()); |
|
930 | + } |
|
931 | + return $classInstance; |
|
932 | + } |
|
933 | 933 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <p> |
2 | 2 | <?php esc_html_e( |
3 | - 'Use this to control what the default will be for maximum tickets on an order when creating a new event.', |
|
4 | - 'event_espresso' |
|
5 | - ); ?> |
|
3 | + 'Use this to control what the default will be for maximum tickets on an order when creating a new event.', |
|
4 | + 'event_espresso' |
|
5 | + ); ?> |
|
6 | 6 | </p> |
7 | 7 | \ No newline at end of file |
@@ -43,7 +43,7 @@ |
||
43 | 43 | $error_string = esc_html__('The following errors occurred:', 'event_espresso'); |
44 | 44 | foreach ($notices->getError() as $notice) { |
45 | 45 | if ($this->getThrowExceptions()) { |
46 | - $error_string .= '<br />' . $notice->message(); |
|
46 | + $error_string .= '<br />'.$notice->message(); |
|
47 | 47 | } else { |
48 | 48 | EE_Error::add_error( |
49 | 49 | $notice->message(), |
@@ -19,56 +19,56 @@ |
||
19 | 19 | class ConvertNoticesToEeErrors extends NoticeConverter |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * Converts Notice objects into EE_Error notifications |
|
24 | - * |
|
25 | - * @param NoticesContainerInterface $notices |
|
26 | - * @throws EE_Error |
|
27 | - */ |
|
28 | - public function process(NoticesContainerInterface $notices) |
|
29 | - { |
|
30 | - $this->setNotices($notices); |
|
31 | - $notices = $this->getNotices(); |
|
32 | - if ($notices->hasAttention()) { |
|
33 | - foreach ($notices->getAttention() as $notice) { |
|
34 | - EE_Error::add_attention( |
|
35 | - $notice->message(), |
|
36 | - $notice->file(), |
|
37 | - $notice->func(), |
|
38 | - $notice->line() |
|
39 | - ); |
|
40 | - } |
|
41 | - } |
|
42 | - if ($notices->hasError()) { |
|
43 | - $error_string = esc_html__('The following errors occurred:', 'event_espresso'); |
|
44 | - foreach ($notices->getError() as $notice) { |
|
45 | - if ($this->getThrowExceptions()) { |
|
46 | - $error_string .= '<br />' . $notice->message(); |
|
47 | - } else { |
|
48 | - EE_Error::add_error( |
|
49 | - $notice->message(), |
|
50 | - $notice->file(), |
|
51 | - $notice->func(), |
|
52 | - $notice->line() |
|
53 | - ); |
|
54 | - } |
|
55 | - } |
|
56 | - if ($this->getThrowExceptions()) { |
|
57 | - throw new EE_Error($error_string); |
|
58 | - } |
|
59 | - } |
|
60 | - if ($notices->hasSuccess()) { |
|
61 | - foreach ($notices->getSuccess() as $notice) { |
|
62 | - EE_Error::add_success( |
|
63 | - $notice->message(), |
|
64 | - $notice->file(), |
|
65 | - $notice->func(), |
|
66 | - $notice->line() |
|
67 | - ); |
|
68 | - } |
|
69 | - } |
|
70 | - $this->clearNotices(); |
|
71 | - } |
|
22 | + /** |
|
23 | + * Converts Notice objects into EE_Error notifications |
|
24 | + * |
|
25 | + * @param NoticesContainerInterface $notices |
|
26 | + * @throws EE_Error |
|
27 | + */ |
|
28 | + public function process(NoticesContainerInterface $notices) |
|
29 | + { |
|
30 | + $this->setNotices($notices); |
|
31 | + $notices = $this->getNotices(); |
|
32 | + if ($notices->hasAttention()) { |
|
33 | + foreach ($notices->getAttention() as $notice) { |
|
34 | + EE_Error::add_attention( |
|
35 | + $notice->message(), |
|
36 | + $notice->file(), |
|
37 | + $notice->func(), |
|
38 | + $notice->line() |
|
39 | + ); |
|
40 | + } |
|
41 | + } |
|
42 | + if ($notices->hasError()) { |
|
43 | + $error_string = esc_html__('The following errors occurred:', 'event_espresso'); |
|
44 | + foreach ($notices->getError() as $notice) { |
|
45 | + if ($this->getThrowExceptions()) { |
|
46 | + $error_string .= '<br />' . $notice->message(); |
|
47 | + } else { |
|
48 | + EE_Error::add_error( |
|
49 | + $notice->message(), |
|
50 | + $notice->file(), |
|
51 | + $notice->func(), |
|
52 | + $notice->line() |
|
53 | + ); |
|
54 | + } |
|
55 | + } |
|
56 | + if ($this->getThrowExceptions()) { |
|
57 | + throw new EE_Error($error_string); |
|
58 | + } |
|
59 | + } |
|
60 | + if ($notices->hasSuccess()) { |
|
61 | + foreach ($notices->getSuccess() as $notice) { |
|
62 | + EE_Error::add_success( |
|
63 | + $notice->message(), |
|
64 | + $notice->file(), |
|
65 | + $notice->func(), |
|
66 | + $notice->line() |
|
67 | + ); |
|
68 | + } |
|
69 | + } |
|
70 | + $this->clearNotices(); |
|
71 | + } |
|
72 | 72 | |
73 | 73 | |
74 | 74 | } |
@@ -11,48 +11,48 @@ |
||
11 | 11 | * @version 4+ |
12 | 12 | */ |
13 | 13 | if (have_posts()) : |
14 | - if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?> |
|
14 | + if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?> |
|
15 | 15 | <header class="page-header"> |
16 | 16 | <h1 class="page-title"> |
17 | 17 | <?php |
18 | - if (is_day()) : |
|
19 | - printf(__('Today\'s Events: %s', 'event_espresso'), get_the_date()); |
|
20 | - elseif (is_month()) : |
|
21 | - printf( |
|
22 | - __('Events This Month: %s', 'event_espresso'), |
|
23 | - get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso')) |
|
24 | - ); |
|
25 | - elseif (is_year()) : |
|
26 | - printf( |
|
27 | - __('Events This Year: %s', 'event_espresso'), |
|
28 | - get_the_date(_x('Y', 'yearly archives date format', 'event_espresso')) |
|
29 | - ); |
|
30 | - else : |
|
31 | - echo apply_filters( |
|
32 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
33 | - __('Upcoming Events', 'event_espresso') |
|
34 | - ); |
|
35 | - endif; |
|
36 | - ?> |
|
18 | + if (is_day()) : |
|
19 | + printf(__('Today\'s Events: %s', 'event_espresso'), get_the_date()); |
|
20 | + elseif (is_month()) : |
|
21 | + printf( |
|
22 | + __('Events This Month: %s', 'event_espresso'), |
|
23 | + get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso')) |
|
24 | + ); |
|
25 | + elseif (is_year()) : |
|
26 | + printf( |
|
27 | + __('Events This Year: %s', 'event_espresso'), |
|
28 | + get_the_date(_x('Y', 'yearly archives date format', 'event_espresso')) |
|
29 | + ); |
|
30 | + else : |
|
31 | + echo apply_filters( |
|
32 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
33 | + __('Upcoming Events', 'event_espresso') |
|
34 | + ); |
|
35 | + endif; |
|
36 | + ?> |
|
37 | 37 | </h1> |
38 | 38 | |
39 | 39 | </header><!-- .page-header --> |
40 | 40 | |
41 | 41 | <?php |
42 | - endif; |
|
43 | - // allow other stuff |
|
44 | - do_action('AHEE__archive_espresso_events_template__before_loop'); |
|
45 | - // Start the Loop. |
|
46 | - while (have_posts()) : the_post(); |
|
47 | - // Include the post TYPE-specific template for the content. |
|
48 | - espresso_get_template_part('content', 'espresso_events-shortcode'); |
|
49 | - endwhile; |
|
50 | - // Previous/next page navigation. |
|
51 | - espresso_pagination(); |
|
52 | - // allow moar other stuff |
|
53 | - do_action('AHEE__archive_espresso_events_template__after_loop'); |
|
42 | + endif; |
|
43 | + // allow other stuff |
|
44 | + do_action('AHEE__archive_espresso_events_template__before_loop'); |
|
45 | + // Start the Loop. |
|
46 | + while (have_posts()) : the_post(); |
|
47 | + // Include the post TYPE-specific template for the content. |
|
48 | + espresso_get_template_part('content', 'espresso_events-shortcode'); |
|
49 | + endwhile; |
|
50 | + // Previous/next page navigation. |
|
51 | + espresso_pagination(); |
|
52 | + // allow moar other stuff |
|
53 | + do_action('AHEE__archive_espresso_events_template__after_loop'); |
|
54 | 54 | else : |
55 | - // If no content, include the "No posts found" template. |
|
56 | - espresso_get_template_part('content', 'none'); |
|
55 | + // If no content, include the "No posts found" template. |
|
56 | + espresso_get_template_part('content', 'none'); |
|
57 | 57 | endif; |
58 | 58 |
@@ -27,11 +27,13 @@ discard block |
||
27 | 27 | __('Events This Year: %s', 'event_espresso'), |
28 | 28 | get_the_date(_x('Y', 'yearly archives date format', 'event_espresso')) |
29 | 29 | ); |
30 | - else : |
|
30 | + else { |
|
31 | + : |
|
31 | 32 | echo apply_filters( |
32 | 33 | 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
33 | 34 | __('Upcoming Events', 'event_espresso') |
34 | 35 | ); |
36 | + } |
|
35 | 37 | endif; |
36 | 38 | ?> |
37 | 39 | </h1> |
@@ -51,8 +53,10 @@ discard block |
||
51 | 53 | espresso_pagination(); |
52 | 54 | // allow moar other stuff |
53 | 55 | do_action('AHEE__archive_espresso_events_template__after_loop'); |
54 | -else : |
|
56 | +else { |
|
57 | + : |
|
55 | 58 | // If no content, include the "No posts found" template. |
56 | 59 | espresso_get_template_part('content', 'none'); |
60 | +} |
|
57 | 61 | endif; |
58 | 62 |
@@ -450,7 +450,7 @@ |
||
450 | 450 | |
451 | 451 | |
452 | 452 | /** |
453 | - * @param $Request |
|
453 | + * @param string $Request |
|
454 | 454 | * @return mixed |
455 | 455 | */ |
456 | 456 | private function _CURLRequest($Request) |
@@ -77,13 +77,13 @@ discard block |
||
77 | 77 | public function do_direct_payment($payment, $billing_info = null) |
78 | 78 | { |
79 | 79 | $transaction = $payment->transaction(); |
80 | - if (! $transaction instanceof EEI_Transaction) { |
|
80 | + if ( ! $transaction instanceof EEI_Transaction) { |
|
81 | 81 | throw new EE_Error( |
82 | 82 | esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso') |
83 | 83 | ); |
84 | 84 | } |
85 | 85 | $primary_registrant = $transaction->primary_registration(); |
86 | - if (! $primary_registrant instanceof EEI_Registration) { |
|
86 | + if ( ! $primary_registrant instanceof EEI_Registration) { |
|
87 | 87 | throw new EE_Error( |
88 | 88 | esc_html__( |
89 | 89 | 'No primary registration on transaction while paying with PayPal Pro.', |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | ); |
93 | 93 | } |
94 | 94 | $attendee = $primary_registrant->attendee(); |
95 | - if (! $attendee instanceof EEI_Attendee) { |
|
95 | + if ( ! $attendee instanceof EEI_Attendee) { |
|
96 | 96 | throw new EE_Error( |
97 | 97 | esc_html__( |
98 | 98 | 'No attendee on primary registration while paying with PayPal Pro.', |
@@ -189,7 +189,7 @@ discard block |
||
189 | 189 | // Required. Credit card number. No spaces or punctuation. |
190 | 190 | 'acct' => $billing_info['credit_card'], |
191 | 191 | // Required. Credit card expiration date. Format is MMYYYY |
192 | - 'expdate' => $billing_info['exp_month'] . $billing_info['exp_year'], |
|
192 | + 'expdate' => $billing_info['exp_month'].$billing_info['exp_year'], |
|
193 | 193 | // Requirements determined by your PayPal account settings. Security digits for credit card. |
194 | 194 | 'cvv2' => $billing_info['cvv'], |
195 | 195 | ); |
@@ -241,7 +241,7 @@ discard block |
||
241 | 241 | $ShippingAddress = array( |
242 | 242 | 'shiptoname' => substr($use_registration_address_info |
243 | 243 | ? $attendee->full_name() |
244 | - : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32), |
|
244 | + : $billing_info['first_name'].' '.$billing_info['last_name'], 0, 32), |
|
245 | 245 | 'shiptostreet' => substr($use_registration_address_info |
246 | 246 | ? $attendee->address() |
247 | 247 | : $billing_info['address'], 0, 100), |
@@ -270,7 +270,7 @@ discard block |
||
270 | 270 | 'currencycode' => $payment->currency_code(), |
271 | 271 | // Required if you include itemized cart details. (L_AMTn, etc.) |
272 | 272 | // Subtotal of items not including S&H, or tax. |
273 | - 'itemamt' => $gateway_formatter->formatCurrency($item_amount),// |
|
273 | + 'itemamt' => $gateway_formatter->formatCurrency($item_amount), // |
|
274 | 274 | // Total shipping costs for the order. If you specify shippingamt, you must also specify itemamt. |
275 | 275 | 'shippingamt' => '', |
276 | 276 | // Total handling costs for the order. If you specify handlingamt, you must also specify itemamt. |
@@ -283,10 +283,10 @@ discard block |
||
283 | 283 | // Free-form field for your own use. 256 char max. |
284 | 284 | 'custom' => $primary_registrant ? $primary_registrant->ID() : '', |
285 | 285 | // Your own invoice or tracking number |
286 | - 'invnum' => wp_generate_password(12, false),// $transaction->ID(), |
|
286 | + 'invnum' => wp_generate_password(12, false), // $transaction->ID(), |
|
287 | 287 | // URL for receiving Instant Payment Notifications. This overrides what your profile is set to use. |
288 | 288 | 'notifyurl' => '', |
289 | - 'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this |
|
289 | + 'buttonsource' => 'EventEspresso_SP', // EE will blow up if you change this |
|
290 | 290 | ); |
291 | 291 | // Wrap all data arrays into a single, "master" array which will be passed into the class function. |
292 | 292 | $PayPalRequestData = array( |
@@ -396,52 +396,52 @@ discard block |
||
396 | 396 | // DP Fields |
397 | 397 | $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array(); |
398 | 398 | foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) { |
399 | - $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal); |
|
399 | + $DPFieldsNVP .= '&'.strtoupper($DPFieldsVar).'='.urlencode($DPFieldsVal); |
|
400 | 400 | } |
401 | 401 | // CC Details Fields |
402 | 402 | $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array(); |
403 | 403 | foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) { |
404 | - $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal); |
|
404 | + $CCDetailsNVP .= '&'.strtoupper($CCDetailsVar).'='.urlencode($CCDetailsVal); |
|
405 | 405 | } |
406 | 406 | // PayerInfo Type Fields |
407 | 407 | $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array(); |
408 | 408 | foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) { |
409 | - $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal); |
|
409 | + $PayerInfoNVP .= '&'.strtoupper($PayerInfoVar).'='.urlencode($PayerInfoVal); |
|
410 | 410 | } |
411 | 411 | // Payer Name Fields |
412 | 412 | $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array(); |
413 | 413 | foreach ($PayerName as $PayerNameVar => $PayerNameVal) { |
414 | - $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal); |
|
414 | + $PayerNameNVP .= '&'.strtoupper($PayerNameVar).'='.urlencode($PayerNameVal); |
|
415 | 415 | } |
416 | 416 | // Address Fields (Billing) |
417 | 417 | $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array(); |
418 | 418 | foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) { |
419 | - $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal); |
|
419 | + $BillingAddressNVP .= '&'.strtoupper($BillingAddressVar).'='.urlencode($BillingAddressVal); |
|
420 | 420 | } |
421 | 421 | // Payment Details Type Fields |
422 | 422 | $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array(); |
423 | 423 | foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) { |
424 | - $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal); |
|
424 | + $PaymentDetailsNVP .= '&'.strtoupper($PaymentDetailsVar).'='.urlencode($PaymentDetailsVal); |
|
425 | 425 | } |
426 | 426 | // Payment Details Item Type Fields |
427 | 427 | $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array(); |
428 | 428 | $n = 0; |
429 | 429 | foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) { |
430 | - $CurrentItem = $OrderItems[ $OrderItemsVar ]; |
|
430 | + $CurrentItem = $OrderItems[$OrderItemsVar]; |
|
431 | 431 | foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) { |
432 | - $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal); |
|
432 | + $OrderItemsNVP .= '&'.strtoupper($CurrentItemVar).$n.'='.urlencode($CurrentItemVal); |
|
433 | 433 | } |
434 | 434 | $n++; |
435 | 435 | } |
436 | 436 | // Ship To Address Fields |
437 | 437 | $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array(); |
438 | 438 | foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) { |
439 | - $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal); |
|
439 | + $ShippingAddressNVP .= '&'.strtoupper($ShippingAddressVar).'='.urlencode($ShippingAddressVal); |
|
440 | 440 | } |
441 | 441 | // 3D Secure Fields |
442 | 442 | $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array(); |
443 | 443 | foreach ($Secure3D as $Secure3DVar => $Secure3DVal) { |
444 | - $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal); |
|
444 | + $Secure3DNVP .= '&'.strtoupper($Secure3DVar).'='.urlencode($Secure3DVal); |
|
445 | 445 | } |
446 | 446 | // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string |
447 | 447 | $NVPRequest = 'USER=' |
@@ -512,7 +512,7 @@ discard block |
||
512 | 512 | $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString); |
513 | 513 | $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1); |
514 | 514 | // decoding the response |
515 | - $proArray[ $keyval ] = urldecode($valval); |
|
515 | + $proArray[$keyval] = urldecode($valval); |
|
516 | 516 | $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString)); |
517 | 517 | } |
518 | 518 | return $proArray; |
@@ -545,16 +545,16 @@ discard block |
||
545 | 545 | { |
546 | 546 | $Errors = array(); |
547 | 547 | $n = 0; |
548 | - while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) { |
|
549 | - $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : ''; |
|
550 | - $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ]) |
|
551 | - ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ] |
|
548 | + while (isset($DataArray['L_ERRORCODE'.$n.''])) { |
|
549 | + $LErrorCode = isset($DataArray['L_ERRORCODE'.$n.'']) ? $DataArray['L_ERRORCODE'.$n.''] : ''; |
|
550 | + $LShortMessage = isset($DataArray['L_SHORTMESSAGE'.$n.'']) |
|
551 | + ? $DataArray['L_SHORTMESSAGE'.$n.''] |
|
552 | 552 | : ''; |
553 | - $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ]) |
|
554 | - ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ] |
|
553 | + $LLongMessage = isset($DataArray['L_LONGMESSAGE'.$n.'']) |
|
554 | + ? $DataArray['L_LONGMESSAGE'.$n.''] |
|
555 | 555 | : ''; |
556 | - $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ]) |
|
557 | - ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ] |
|
556 | + $LSeverityCode = isset($DataArray['L_SEVERITYCODE'.$n.'']) |
|
557 | + ? $DataArray['L_SEVERITYCODE'.$n.''] |
|
558 | 558 | : ''; |
559 | 559 | $CurrentItem = array( |
560 | 560 | 'L_ERRORCODE' => $LErrorCode, |
@@ -581,7 +581,7 @@ discard block |
||
581 | 581 | { |
582 | 582 | $error = ''; |
583 | 583 | foreach ($Errors as $ErrorVar => $ErrorVal) { |
584 | - $CurrentError = $Errors[ $ErrorVar ]; |
|
584 | + $CurrentError = $Errors[$ErrorVar]; |
|
585 | 585 | foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) { |
586 | 586 | $CurrentVarName = ''; |
587 | 587 | if ($CurrentErrorVar == 'L_ERRORCODE') { |
@@ -593,7 +593,7 @@ discard block |
||
593 | 593 | } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') { |
594 | 594 | $CurrentVarName = 'Severity Code'; |
595 | 595 | } |
596 | - $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal; |
|
596 | + $error .= '<br />'.$CurrentVarName.': '.$CurrentErrorVal; |
|
597 | 597 | } |
598 | 598 | } |
599 | 599 | return $error; |
@@ -11,606 +11,606 @@ |
||
11 | 11 | class EEG_Paypal_Pro extends EE_Onsite_Gateway |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @var $_paypal_api_username string |
|
16 | - */ |
|
17 | - protected $_api_username = null; |
|
18 | - |
|
19 | - /** |
|
20 | - * @var $_api_password string |
|
21 | - */ |
|
22 | - protected $_api_password = null; |
|
23 | - |
|
24 | - /** |
|
25 | - * @var $_api_signature string |
|
26 | - */ |
|
27 | - protected $_api_signature = null; |
|
28 | - |
|
29 | - /** |
|
30 | - * @var $_credit_card_types array with the keys for credit card types accepted on this account |
|
31 | - */ |
|
32 | - protected $_credit_card_types = null; |
|
33 | - |
|
34 | - protected $_currencies_supported = array( |
|
35 | - 'USD', |
|
36 | - 'GBP', |
|
37 | - 'CAD', |
|
38 | - 'AUD', |
|
39 | - 'BRL', |
|
40 | - 'CHF', |
|
41 | - 'CZK', |
|
42 | - 'DKK', |
|
43 | - 'EUR', |
|
44 | - 'HKD', |
|
45 | - 'HUF', |
|
46 | - 'ILS', |
|
47 | - 'JPY', |
|
48 | - 'MXN', |
|
49 | - 'MYR', |
|
50 | - 'NOK', |
|
51 | - 'NZD', |
|
52 | - 'PHP', |
|
53 | - 'PLN', |
|
54 | - 'SEK', |
|
55 | - 'SGD', |
|
56 | - 'THB', |
|
57 | - 'TRY', |
|
58 | - 'TWD', |
|
59 | - 'RUB', |
|
60 | - 'INR', |
|
61 | - ); |
|
62 | - |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * @param EEI_Payment $payment |
|
67 | - * @param array $billing_info { |
|
68 | - * @type string $credit_card |
|
69 | - * @type string $credit_card_type |
|
70 | - * @type string $exp_month always 2 characters |
|
71 | - * @type string $exp_year always 4 characters |
|
72 | - * @type string $cvv |
|
73 | - * } |
|
74 | - * @see parent::do_direct_payment for more info |
|
75 | - * @return EE_Payment|EEI_Payment |
|
76 | - * @throws EE_Error |
|
77 | - */ |
|
78 | - public function do_direct_payment($payment, $billing_info = null) |
|
79 | - { |
|
80 | - $transaction = $payment->transaction(); |
|
81 | - if (! $transaction instanceof EEI_Transaction) { |
|
82 | - throw new EE_Error( |
|
83 | - esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso') |
|
84 | - ); |
|
85 | - } |
|
86 | - $primary_registrant = $transaction->primary_registration(); |
|
87 | - if (! $primary_registrant instanceof EEI_Registration) { |
|
88 | - throw new EE_Error( |
|
89 | - esc_html__( |
|
90 | - 'No primary registration on transaction while paying with PayPal Pro.', |
|
91 | - 'event_espresso' |
|
92 | - ) |
|
93 | - ); |
|
94 | - } |
|
95 | - $attendee = $primary_registrant->attendee(); |
|
96 | - if (! $attendee instanceof EEI_Attendee) { |
|
97 | - throw new EE_Error( |
|
98 | - esc_html__( |
|
99 | - 'No attendee on primary registration while paying with PayPal Pro.', |
|
100 | - 'event_espresso' |
|
101 | - ) |
|
102 | - ); |
|
103 | - } |
|
104 | - $gateway_formatter = $this->_get_gateway_formatter(); |
|
105 | - $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127); |
|
106 | - // charge for the full amount. Show itemized list |
|
107 | - if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) { |
|
108 | - $item_num = 1; |
|
109 | - $total_line_item = $transaction->total_line_item(); |
|
110 | - $order_items = array(); |
|
111 | - foreach ($total_line_item->get_items() as $line_item) { |
|
112 | - // ignore line items with a quantity of 0 |
|
113 | - if ($line_item->quantity() == 0) { |
|
114 | - continue; |
|
115 | - } |
|
116 | - // For percent items, whose unit_price is 0, use the total instead. |
|
117 | - if ($line_item->is_percent()) { |
|
118 | - $unit_price = $line_item->total(); |
|
119 | - $line_item_quantity = 1; |
|
120 | - } else { |
|
121 | - $unit_price = $line_item->unit_price(); |
|
122 | - $line_item_quantity = $line_item->quantity(); |
|
123 | - } |
|
124 | - $item = array( |
|
125 | - // Item Name. 127 char max. |
|
126 | - 'l_name' => substr( |
|
127 | - $gateway_formatter->formatLineItemName($line_item, $payment), |
|
128 | - 0, |
|
129 | - 127 |
|
130 | - ), |
|
131 | - // Item description. 127 char max. |
|
132 | - 'l_desc' => substr( |
|
133 | - $gateway_formatter->formatLineItemDesc($line_item, $payment), |
|
134 | - 0, |
|
135 | - 127 |
|
136 | - ), |
|
137 | - // Cost of individual item. |
|
138 | - 'l_amt' => $unit_price, |
|
139 | - // Item Number. 127 char max. |
|
140 | - 'l_number' => $item_num++, |
|
141 | - // Item quantity. Must be any positive integer. |
|
142 | - 'l_qty' => $line_item_quantity, |
|
143 | - // Item's sales tax amount. |
|
144 | - 'l_taxamt' => '', |
|
145 | - // eBay auction number of item. |
|
146 | - 'l_ebayitemnumber' => '', |
|
147 | - // eBay transaction ID of purchased item. |
|
148 | - 'l_ebayitemauctiontxnid' => '', |
|
149 | - // eBay order ID for the item. |
|
150 | - 'l_ebayitemorderid' => '', |
|
151 | - ); |
|
152 | - // add to array of all items |
|
153 | - array_push($order_items, $item); |
|
154 | - } |
|
155 | - $item_amount = $total_line_item->get_items_total(); |
|
156 | - $tax_amount = $total_line_item->get_total_tax(); |
|
157 | - } else { |
|
158 | - $order_items = array(); |
|
159 | - $item_amount = $payment->amount(); |
|
160 | - $tax_amount = 0; |
|
161 | - array_push($order_items, array( |
|
162 | - // Item Name. 127 char max. |
|
163 | - 'l_name' => substr( |
|
164 | - $gateway_formatter->formatPartialPaymentLineItemName($payment), |
|
165 | - 0, |
|
166 | - 127 |
|
167 | - ), |
|
168 | - // Item description. 127 char max. |
|
169 | - 'l_desc' => substr( |
|
170 | - $gateway_formatter->formatPartialPaymentLineItemDesc($payment), |
|
171 | - 0, |
|
172 | - 127 |
|
173 | - ), |
|
174 | - // Cost of individual item. |
|
175 | - 'l_amt' => $payment->amount(), |
|
176 | - // Item Number. 127 char max. |
|
177 | - 'l_number' => 1, |
|
178 | - // Item quantity. Must be any positive integer. |
|
179 | - 'l_qty' => 1, |
|
180 | - )); |
|
181 | - } |
|
182 | - // Populate data arrays with order data. |
|
183 | - $DPFields = array( |
|
184 | - // How you want to obtain payment ? |
|
185 | - // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture. |
|
186 | - // Sale indicates that this is a final sale for which you are requesting payment. Default is Sale. |
|
187 | - 'paymentaction' => 'Sale', |
|
188 | - // Required. IP address of the payer's browser. |
|
189 | - 'ipaddress' => $_SERVER['REMOTE_ADDR'], |
|
190 | - // Flag to determine whether you want the results returned by FMF. 1 or 0. Default is 0. |
|
191 | - 'returnfmfdetails' => '1', |
|
192 | - ); |
|
193 | - $CCDetails = array( |
|
194 | - // Required. Type of credit card. Visa, MasterCard, Discover, Amex, Maestro, Solo. |
|
195 | - // If Maestro or Solo, the currency code must be GBP. |
|
196 | - // In addition, either start date or issue number must be specified. |
|
197 | - 'creditcardtype' => $billing_info['credit_card_type'], |
|
198 | - // Required. Credit card number. No spaces or punctuation. |
|
199 | - 'acct' => $billing_info['credit_card'], |
|
200 | - // Required. Credit card expiration date. Format is MMYYYY |
|
201 | - 'expdate' => $billing_info['exp_month'] . $billing_info['exp_year'], |
|
202 | - // Requirements determined by your PayPal account settings. Security digits for credit card. |
|
203 | - 'cvv2' => $billing_info['cvv'], |
|
204 | - ); |
|
205 | - $PayerInfo = array( |
|
206 | - // Email address of payer. |
|
207 | - 'email' => $billing_info['email'], |
|
208 | - // Unique PayPal customer ID for payer. |
|
209 | - 'payerid' => '', |
|
210 | - // Status of payer. Values are verified or unverified |
|
211 | - 'payerstatus' => '', |
|
212 | - // Payer's business name. |
|
213 | - 'business' => '', |
|
214 | - ); |
|
215 | - $PayerName = array( |
|
216 | - // Payer's salutation. 20 char max. |
|
217 | - 'salutation' => '', |
|
218 | - // Payer's first name. 25 char max. |
|
219 | - 'firstname' => substr($billing_info['first_name'], 0, 25), |
|
220 | - // Payer's middle name. 25 char max. |
|
221 | - 'middlename' => '', |
|
222 | - // Payer's last name. 25 char max. |
|
223 | - 'lastname' => substr($billing_info['last_name'], 0, 25), |
|
224 | - // Payer's suffix. 12 char max. |
|
225 | - 'suffix' => '', |
|
226 | - ); |
|
227 | - $BillingAddress = array( |
|
228 | - // Required. First street address. |
|
229 | - 'street' => $billing_info['address'], |
|
230 | - // Second street address. |
|
231 | - 'street2' => $billing_info['address2'], |
|
232 | - // Required. Name of City. |
|
233 | - 'city' => $billing_info['city'], |
|
234 | - // Required. Name of State or Province. |
|
235 | - 'state' => substr($billing_info['state'], 0, 40), |
|
236 | - // Required. Country code. |
|
237 | - 'countrycode' => $billing_info['country'], |
|
238 | - // Required. Postal code of payer. |
|
239 | - 'zip' => $billing_info['zip'], |
|
240 | - ); |
|
241 | - // check if the registration info contains the needed fields for paypal pro |
|
242 | - // (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/) |
|
243 | - if ($attendee->address() && $attendee->city() && $attendee->country_ID()) { |
|
244 | - $use_registration_address_info = true; |
|
245 | - } else { |
|
246 | - $use_registration_address_info = false; |
|
247 | - } |
|
248 | - // so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. |
|
249 | - // If not, use the billing info again |
|
250 | - $ShippingAddress = array( |
|
251 | - 'shiptoname' => substr($use_registration_address_info |
|
252 | - ? $attendee->full_name() |
|
253 | - : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32), |
|
254 | - 'shiptostreet' => substr($use_registration_address_info |
|
255 | - ? $attendee->address() |
|
256 | - : $billing_info['address'], 0, 100), |
|
257 | - 'shiptostreet2' => substr($use_registration_address_info |
|
258 | - ? $attendee->address2() : $billing_info['address2'], 0, 100), |
|
259 | - 'shiptocity' => substr($use_registration_address_info |
|
260 | - ? $attendee->city() |
|
261 | - : $billing_info['city'], 0, 40), |
|
262 | - 'shiptostate' => substr($use_registration_address_info |
|
263 | - ? $attendee->state_name() |
|
264 | - : $billing_info['state'], 0, 40), |
|
265 | - 'shiptocountry' => $use_registration_address_info |
|
266 | - ? $attendee->country_ID() |
|
267 | - : $billing_info['country'], |
|
268 | - 'shiptozip' => substr($use_registration_address_info |
|
269 | - ? $attendee->zip() |
|
270 | - : $billing_info['zip'], 0, 20), |
|
271 | - 'shiptophonenum' => substr($use_registration_address_info |
|
272 | - ? $attendee->phone() |
|
273 | - : $billing_info['phone'], 0, 20), |
|
274 | - ); |
|
275 | - $PaymentDetails = array( |
|
276 | - // Required. Total amount of order, including shipping, handling, and tax. |
|
277 | - 'amt' => $gateway_formatter->formatCurrency($payment->amount()), |
|
278 | - // Required. Three-letter currency code. Default is USD. |
|
279 | - 'currencycode' => $payment->currency_code(), |
|
280 | - // Required if you include itemized cart details. (L_AMTn, etc.) |
|
281 | - // Subtotal of items not including S&H, or tax. |
|
282 | - 'itemamt' => $gateway_formatter->formatCurrency($item_amount),// |
|
283 | - // Total shipping costs for the order. If you specify shippingamt, you must also specify itemamt. |
|
284 | - 'shippingamt' => '', |
|
285 | - // Total handling costs for the order. If you specify handlingamt, you must also specify itemamt. |
|
286 | - 'handlingamt' => '', |
|
287 | - // Required if you specify itemized cart tax details. |
|
288 | - // Sum of tax for all items on the order. Total sales tax. |
|
289 | - 'taxamt' => $gateway_formatter->formatCurrency($tax_amount), |
|
290 | - // Description of the order the customer is purchasing. 127 char max. |
|
291 | - 'desc' => $order_description, |
|
292 | - // Free-form field for your own use. 256 char max. |
|
293 | - 'custom' => $primary_registrant ? $primary_registrant->ID() : '', |
|
294 | - // Your own invoice or tracking number |
|
295 | - 'invnum' => wp_generate_password(12, false),// $transaction->ID(), |
|
296 | - // URL for receiving Instant Payment Notifications. This overrides what your profile is set to use. |
|
297 | - 'notifyurl' => '', |
|
298 | - 'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this |
|
299 | - ); |
|
300 | - // Wrap all data arrays into a single, "master" array which will be passed into the class function. |
|
301 | - $PayPalRequestData = array( |
|
302 | - 'DPFields' => $DPFields, |
|
303 | - 'CCDetails' => $CCDetails, |
|
304 | - 'PayerInfo' => $PayerInfo, |
|
305 | - 'PayerName' => $PayerName, |
|
306 | - 'BillingAddress' => $BillingAddress, |
|
307 | - 'ShippingAddress' => $ShippingAddress, |
|
308 | - 'PaymentDetails' => $PaymentDetails, |
|
309 | - 'OrderItems' => $order_items, |
|
310 | - ); |
|
311 | - $this->_log_clean_request($PayPalRequestData, $payment); |
|
312 | - try { |
|
313 | - $PayPalResult = $this->prep_and_curl_request($PayPalRequestData); |
|
314 | - // remove PCI-sensitive data so it doesn't get stored |
|
315 | - $PayPalResult = $this->_log_clean_response($PayPalResult, $payment); |
|
316 | - if (isset($PayPalResult['L_ERRORCODE0']) && $PayPalResult['L_ERRORCODE0'] === '10002') { |
|
317 | - $message = esc_html__('PayPal did not accept your API username, password, or signature. Please double-check these credentials and if debug mode is on.', 'event_espresso'); |
|
318 | - } elseif (isset($PayPalResult['L_LONGMESSAGE0'])) { |
|
319 | - $message = $PayPalResult['L_LONGMESSAGE0']; |
|
320 | - } else { |
|
321 | - $message = $PayPalResult['ACK']; |
|
322 | - } |
|
323 | - if (empty($PayPalResult['RAWRESPONSE'])) { |
|
324 | - $payment->set_status($this->_pay_model->failed_status()); |
|
325 | - $payment->set_gateway_response(esc_html__('No response received from Paypal Pro', 'event_espresso')); |
|
326 | - $payment->set_details($PayPalResult); |
|
327 | - } else { |
|
328 | - if ($this->_APICallSuccessful($PayPalResult)) { |
|
329 | - $payment->set_status($this->_pay_model->approved_status()); |
|
330 | - } else { |
|
331 | - $payment->set_status($this->_pay_model->declined_status()); |
|
332 | - } |
|
333 | - // make sure we interpret the AMT as a float, not an international string |
|
334 | - // (where periods are thousand separators) |
|
335 | - $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0); |
|
336 | - $payment->set_gateway_response($message); |
|
337 | - $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID']) |
|
338 | - ? $PayPalResult['TRANSACTIONID'] |
|
339 | - : null); |
|
340 | - $primary_registration_code = $primary_registrant instanceof EE_Registration |
|
341 | - ? $primary_registrant->reg_code() |
|
342 | - : ''; |
|
343 | - $payment->set_extra_accntng($primary_registration_code); |
|
344 | - $payment->set_details($PayPalResult); |
|
345 | - } |
|
346 | - } catch (Exception $e) { |
|
347 | - $payment->set_status($this->_pay_model->failed_status()); |
|
348 | - $payment->set_gateway_response($e->getMessage()); |
|
349 | - } |
|
350 | - // $payment->set_status( $this->_pay_model->declined_status() ); |
|
351 | - // $payment->set_gateway_response( '' ); |
|
352 | - return $payment; |
|
353 | - } |
|
354 | - |
|
355 | - |
|
356 | - |
|
357 | - /** |
|
358 | - * CLeans out sensitive CC data and then logs it, and returns the cleaned request |
|
359 | - * |
|
360 | - * @param array $request |
|
361 | - * @param EEI_Payment $payment |
|
362 | - * @return void |
|
363 | - */ |
|
364 | - private function _log_clean_request($request, $payment) |
|
365 | - { |
|
366 | - $cleaned_request_data = $request; |
|
367 | - unset($cleaned_request_data['CCDetails']['acct']); |
|
368 | - unset($cleaned_request_data['CCDetails']['cvv2']); |
|
369 | - unset($cleaned_request_data['CCDetails']['expdate']); |
|
370 | - $this->log(array('Paypal Request' => $cleaned_request_data), $payment); |
|
371 | - } |
|
372 | - |
|
373 | - |
|
374 | - |
|
375 | - /** |
|
376 | - * Cleans the response, logs it, and returns it |
|
377 | - * |
|
378 | - * @param array $response |
|
379 | - * @param EEI_Payment $payment |
|
380 | - * @return array cleaned |
|
381 | - */ |
|
382 | - private function _log_clean_response($response, $payment) |
|
383 | - { |
|
384 | - unset($response['REQUESTDATA']['CREDITCARDTYPE']); |
|
385 | - unset($response['REQUESTDATA']['ACCT']); |
|
386 | - unset($response['REQUESTDATA']['EXPDATE']); |
|
387 | - unset($response['REQUESTDATA']['CVV2']); |
|
388 | - unset($response['RAWREQUEST']); |
|
389 | - $this->log(array('Paypal Response' => $response), $payment); |
|
390 | - return $response; |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - |
|
395 | - /** |
|
396 | - * @param $DataArray |
|
397 | - * @return array |
|
398 | - */ |
|
399 | - private function prep_and_curl_request($DataArray) |
|
400 | - { |
|
401 | - // Create empty holders for each portion of the NVP string |
|
402 | - $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP'; |
|
403 | - $CCDetailsNVP = ''; |
|
404 | - $PayerInfoNVP = ''; |
|
405 | - $PayerNameNVP = ''; |
|
406 | - $BillingAddressNVP = ''; |
|
407 | - $ShippingAddressNVP = ''; |
|
408 | - $PaymentDetailsNVP = ''; |
|
409 | - $OrderItemsNVP = ''; |
|
410 | - $Secure3DNVP = ''; |
|
411 | - // DP Fields |
|
412 | - $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array(); |
|
413 | - foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) { |
|
414 | - $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal); |
|
415 | - } |
|
416 | - // CC Details Fields |
|
417 | - $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array(); |
|
418 | - foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) { |
|
419 | - $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal); |
|
420 | - } |
|
421 | - // PayerInfo Type Fields |
|
422 | - $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array(); |
|
423 | - foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) { |
|
424 | - $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal); |
|
425 | - } |
|
426 | - // Payer Name Fields |
|
427 | - $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array(); |
|
428 | - foreach ($PayerName as $PayerNameVar => $PayerNameVal) { |
|
429 | - $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal); |
|
430 | - } |
|
431 | - // Address Fields (Billing) |
|
432 | - $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array(); |
|
433 | - foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) { |
|
434 | - $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal); |
|
435 | - } |
|
436 | - // Payment Details Type Fields |
|
437 | - $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array(); |
|
438 | - foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) { |
|
439 | - $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal); |
|
440 | - } |
|
441 | - // Payment Details Item Type Fields |
|
442 | - $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array(); |
|
443 | - $n = 0; |
|
444 | - foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) { |
|
445 | - $CurrentItem = $OrderItems[ $OrderItemsVar ]; |
|
446 | - foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) { |
|
447 | - $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal); |
|
448 | - } |
|
449 | - $n++; |
|
450 | - } |
|
451 | - // Ship To Address Fields |
|
452 | - $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array(); |
|
453 | - foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) { |
|
454 | - $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal); |
|
455 | - } |
|
456 | - // 3D Secure Fields |
|
457 | - $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array(); |
|
458 | - foreach ($Secure3D as $Secure3DVar => $Secure3DVal) { |
|
459 | - $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal); |
|
460 | - } |
|
461 | - // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string |
|
462 | - $NVPRequest = 'USER=' |
|
463 | - . $this->_api_username |
|
464 | - . '&PWD=' |
|
465 | - . $this->_api_password |
|
466 | - . '&VERSION=64.0' |
|
467 | - . '&SIGNATURE=' |
|
468 | - . $this->_api_signature |
|
469 | - . $DPFieldsNVP |
|
470 | - . $CCDetailsNVP |
|
471 | - . $PayerInfoNVP |
|
472 | - . $PayerNameNVP |
|
473 | - . $BillingAddressNVP |
|
474 | - . $PaymentDetailsNVP |
|
475 | - . $OrderItemsNVP |
|
476 | - . $ShippingAddressNVP |
|
477 | - . $Secure3DNVP; |
|
478 | - $NVPResponse = $this->_CURLRequest($NVPRequest); |
|
479 | - $NVPRequestArray = $this->_NVPToArray($NVPRequest); |
|
480 | - $NVPResponseArray = $this->_NVPToArray($NVPResponse); |
|
481 | - $Errors = $this->_GetErrors($NVPResponseArray); |
|
482 | - $NVPResponseArray['ERRORS'] = $Errors; |
|
483 | - $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray; |
|
484 | - $NVPResponseArray['RAWREQUEST'] = $NVPRequest; |
|
485 | - $NVPResponseArray['RAWRESPONSE'] = $NVPResponse; |
|
486 | - return $NVPResponseArray; |
|
487 | - } |
|
488 | - |
|
489 | - |
|
490 | - |
|
491 | - /** |
|
492 | - * @param $Request |
|
493 | - * @return mixed |
|
494 | - */ |
|
495 | - private function _CURLRequest($Request) |
|
496 | - { |
|
497 | - $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp'; |
|
498 | - $curl = curl_init(); |
|
499 | - curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true)); |
|
500 | - curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); |
|
501 | - curl_setopt($curl, CURLOPT_TIMEOUT, 60); |
|
502 | - curl_setopt($curl, CURLOPT_URL, $EndPointURL); |
|
503 | - curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); |
|
504 | - curl_setopt($curl, CURLOPT_POSTFIELDS, $Request); |
|
505 | - curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1); |
|
506 | - // execute the curl POST |
|
507 | - $Response = curl_exec($curl); |
|
508 | - curl_close($curl); |
|
509 | - return $Response; |
|
510 | - } |
|
511 | - |
|
512 | - |
|
513 | - |
|
514 | - /** |
|
515 | - * @param $NVPString |
|
516 | - * @return array |
|
517 | - */ |
|
518 | - private function _NVPToArray($NVPString) |
|
519 | - { |
|
520 | - // prepare responses into array |
|
521 | - $proArray = array(); |
|
522 | - while (strlen($NVPString)) { |
|
523 | - // name |
|
524 | - $keypos = strpos($NVPString, '='); |
|
525 | - $keyval = substr($NVPString, 0, $keypos); |
|
526 | - // value |
|
527 | - $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString); |
|
528 | - $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1); |
|
529 | - // decoding the response |
|
530 | - $proArray[ $keyval ] = urldecode($valval); |
|
531 | - $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString)); |
|
532 | - } |
|
533 | - return $proArray; |
|
534 | - } |
|
535 | - |
|
536 | - |
|
537 | - |
|
538 | - /** |
|
539 | - * @param array $PayPalResult |
|
540 | - * @return bool |
|
541 | - */ |
|
542 | - private function _APICallSuccessful($PayPalResult) |
|
543 | - { |
|
544 | - $approved = false; |
|
545 | - // check main response message from PayPal |
|
546 | - if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) { |
|
547 | - $ack = strtoupper($PayPalResult['ACK']); |
|
548 | - $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false; |
|
549 | - } |
|
550 | - return $approved; |
|
551 | - } |
|
552 | - |
|
553 | - |
|
554 | - |
|
555 | - /** |
|
556 | - * @param $DataArray |
|
557 | - * @return array |
|
558 | - */ |
|
559 | - private function _GetErrors($DataArray) |
|
560 | - { |
|
561 | - $Errors = array(); |
|
562 | - $n = 0; |
|
563 | - while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) { |
|
564 | - $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : ''; |
|
565 | - $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ]) |
|
566 | - ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ] |
|
567 | - : ''; |
|
568 | - $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ]) |
|
569 | - ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ] |
|
570 | - : ''; |
|
571 | - $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ]) |
|
572 | - ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ] |
|
573 | - : ''; |
|
574 | - $CurrentItem = array( |
|
575 | - 'L_ERRORCODE' => $LErrorCode, |
|
576 | - 'L_SHORTMESSAGE' => $LShortMessage, |
|
577 | - 'L_LONGMESSAGE' => $LLongMessage, |
|
578 | - 'L_SEVERITYCODE' => $LSeverityCode, |
|
579 | - ); |
|
580 | - array_push($Errors, $CurrentItem); |
|
581 | - $n++; |
|
582 | - } |
|
583 | - return $Errors; |
|
584 | - } |
|
585 | - |
|
586 | - |
|
587 | - |
|
588 | - /** |
|
589 | - * nothing to see here... move along.... |
|
590 | - * |
|
591 | - * @access protected |
|
592 | - * @param $Errors |
|
593 | - * @return string |
|
594 | - */ |
|
595 | - private function _DisplayErrors($Errors) |
|
596 | - { |
|
597 | - $error = ''; |
|
598 | - foreach ($Errors as $ErrorVar => $ErrorVal) { |
|
599 | - $CurrentError = $Errors[ $ErrorVar ]; |
|
600 | - foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) { |
|
601 | - $CurrentVarName = ''; |
|
602 | - if ($CurrentErrorVar == 'L_ERRORCODE') { |
|
603 | - $CurrentVarName = 'Error Code'; |
|
604 | - } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') { |
|
605 | - $CurrentVarName = 'Short Message'; |
|
606 | - } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') { |
|
607 | - $CurrentVarName = 'Long Message'; |
|
608 | - } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') { |
|
609 | - $CurrentVarName = 'Severity Code'; |
|
610 | - } |
|
611 | - $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal; |
|
612 | - } |
|
613 | - } |
|
614 | - return $error; |
|
615 | - } |
|
14 | + /** |
|
15 | + * @var $_paypal_api_username string |
|
16 | + */ |
|
17 | + protected $_api_username = null; |
|
18 | + |
|
19 | + /** |
|
20 | + * @var $_api_password string |
|
21 | + */ |
|
22 | + protected $_api_password = null; |
|
23 | + |
|
24 | + /** |
|
25 | + * @var $_api_signature string |
|
26 | + */ |
|
27 | + protected $_api_signature = null; |
|
28 | + |
|
29 | + /** |
|
30 | + * @var $_credit_card_types array with the keys for credit card types accepted on this account |
|
31 | + */ |
|
32 | + protected $_credit_card_types = null; |
|
33 | + |
|
34 | + protected $_currencies_supported = array( |
|
35 | + 'USD', |
|
36 | + 'GBP', |
|
37 | + 'CAD', |
|
38 | + 'AUD', |
|
39 | + 'BRL', |
|
40 | + 'CHF', |
|
41 | + 'CZK', |
|
42 | + 'DKK', |
|
43 | + 'EUR', |
|
44 | + 'HKD', |
|
45 | + 'HUF', |
|
46 | + 'ILS', |
|
47 | + 'JPY', |
|
48 | + 'MXN', |
|
49 | + 'MYR', |
|
50 | + 'NOK', |
|
51 | + 'NZD', |
|
52 | + 'PHP', |
|
53 | + 'PLN', |
|
54 | + 'SEK', |
|
55 | + 'SGD', |
|
56 | + 'THB', |
|
57 | + 'TRY', |
|
58 | + 'TWD', |
|
59 | + 'RUB', |
|
60 | + 'INR', |
|
61 | + ); |
|
62 | + |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * @param EEI_Payment $payment |
|
67 | + * @param array $billing_info { |
|
68 | + * @type string $credit_card |
|
69 | + * @type string $credit_card_type |
|
70 | + * @type string $exp_month always 2 characters |
|
71 | + * @type string $exp_year always 4 characters |
|
72 | + * @type string $cvv |
|
73 | + * } |
|
74 | + * @see parent::do_direct_payment for more info |
|
75 | + * @return EE_Payment|EEI_Payment |
|
76 | + * @throws EE_Error |
|
77 | + */ |
|
78 | + public function do_direct_payment($payment, $billing_info = null) |
|
79 | + { |
|
80 | + $transaction = $payment->transaction(); |
|
81 | + if (! $transaction instanceof EEI_Transaction) { |
|
82 | + throw new EE_Error( |
|
83 | + esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso') |
|
84 | + ); |
|
85 | + } |
|
86 | + $primary_registrant = $transaction->primary_registration(); |
|
87 | + if (! $primary_registrant instanceof EEI_Registration) { |
|
88 | + throw new EE_Error( |
|
89 | + esc_html__( |
|
90 | + 'No primary registration on transaction while paying with PayPal Pro.', |
|
91 | + 'event_espresso' |
|
92 | + ) |
|
93 | + ); |
|
94 | + } |
|
95 | + $attendee = $primary_registrant->attendee(); |
|
96 | + if (! $attendee instanceof EEI_Attendee) { |
|
97 | + throw new EE_Error( |
|
98 | + esc_html__( |
|
99 | + 'No attendee on primary registration while paying with PayPal Pro.', |
|
100 | + 'event_espresso' |
|
101 | + ) |
|
102 | + ); |
|
103 | + } |
|
104 | + $gateway_formatter = $this->_get_gateway_formatter(); |
|
105 | + $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127); |
|
106 | + // charge for the full amount. Show itemized list |
|
107 | + if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) { |
|
108 | + $item_num = 1; |
|
109 | + $total_line_item = $transaction->total_line_item(); |
|
110 | + $order_items = array(); |
|
111 | + foreach ($total_line_item->get_items() as $line_item) { |
|
112 | + // ignore line items with a quantity of 0 |
|
113 | + if ($line_item->quantity() == 0) { |
|
114 | + continue; |
|
115 | + } |
|
116 | + // For percent items, whose unit_price is 0, use the total instead. |
|
117 | + if ($line_item->is_percent()) { |
|
118 | + $unit_price = $line_item->total(); |
|
119 | + $line_item_quantity = 1; |
|
120 | + } else { |
|
121 | + $unit_price = $line_item->unit_price(); |
|
122 | + $line_item_quantity = $line_item->quantity(); |
|
123 | + } |
|
124 | + $item = array( |
|
125 | + // Item Name. 127 char max. |
|
126 | + 'l_name' => substr( |
|
127 | + $gateway_formatter->formatLineItemName($line_item, $payment), |
|
128 | + 0, |
|
129 | + 127 |
|
130 | + ), |
|
131 | + // Item description. 127 char max. |
|
132 | + 'l_desc' => substr( |
|
133 | + $gateway_formatter->formatLineItemDesc($line_item, $payment), |
|
134 | + 0, |
|
135 | + 127 |
|
136 | + ), |
|
137 | + // Cost of individual item. |
|
138 | + 'l_amt' => $unit_price, |
|
139 | + // Item Number. 127 char max. |
|
140 | + 'l_number' => $item_num++, |
|
141 | + // Item quantity. Must be any positive integer. |
|
142 | + 'l_qty' => $line_item_quantity, |
|
143 | + // Item's sales tax amount. |
|
144 | + 'l_taxamt' => '', |
|
145 | + // eBay auction number of item. |
|
146 | + 'l_ebayitemnumber' => '', |
|
147 | + // eBay transaction ID of purchased item. |
|
148 | + 'l_ebayitemauctiontxnid' => '', |
|
149 | + // eBay order ID for the item. |
|
150 | + 'l_ebayitemorderid' => '', |
|
151 | + ); |
|
152 | + // add to array of all items |
|
153 | + array_push($order_items, $item); |
|
154 | + } |
|
155 | + $item_amount = $total_line_item->get_items_total(); |
|
156 | + $tax_amount = $total_line_item->get_total_tax(); |
|
157 | + } else { |
|
158 | + $order_items = array(); |
|
159 | + $item_amount = $payment->amount(); |
|
160 | + $tax_amount = 0; |
|
161 | + array_push($order_items, array( |
|
162 | + // Item Name. 127 char max. |
|
163 | + 'l_name' => substr( |
|
164 | + $gateway_formatter->formatPartialPaymentLineItemName($payment), |
|
165 | + 0, |
|
166 | + 127 |
|
167 | + ), |
|
168 | + // Item description. 127 char max. |
|
169 | + 'l_desc' => substr( |
|
170 | + $gateway_formatter->formatPartialPaymentLineItemDesc($payment), |
|
171 | + 0, |
|
172 | + 127 |
|
173 | + ), |
|
174 | + // Cost of individual item. |
|
175 | + 'l_amt' => $payment->amount(), |
|
176 | + // Item Number. 127 char max. |
|
177 | + 'l_number' => 1, |
|
178 | + // Item quantity. Must be any positive integer. |
|
179 | + 'l_qty' => 1, |
|
180 | + )); |
|
181 | + } |
|
182 | + // Populate data arrays with order data. |
|
183 | + $DPFields = array( |
|
184 | + // How you want to obtain payment ? |
|
185 | + // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture. |
|
186 | + // Sale indicates that this is a final sale for which you are requesting payment. Default is Sale. |
|
187 | + 'paymentaction' => 'Sale', |
|
188 | + // Required. IP address of the payer's browser. |
|
189 | + 'ipaddress' => $_SERVER['REMOTE_ADDR'], |
|
190 | + // Flag to determine whether you want the results returned by FMF. 1 or 0. Default is 0. |
|
191 | + 'returnfmfdetails' => '1', |
|
192 | + ); |
|
193 | + $CCDetails = array( |
|
194 | + // Required. Type of credit card. Visa, MasterCard, Discover, Amex, Maestro, Solo. |
|
195 | + // If Maestro or Solo, the currency code must be GBP. |
|
196 | + // In addition, either start date or issue number must be specified. |
|
197 | + 'creditcardtype' => $billing_info['credit_card_type'], |
|
198 | + // Required. Credit card number. No spaces or punctuation. |
|
199 | + 'acct' => $billing_info['credit_card'], |
|
200 | + // Required. Credit card expiration date. Format is MMYYYY |
|
201 | + 'expdate' => $billing_info['exp_month'] . $billing_info['exp_year'], |
|
202 | + // Requirements determined by your PayPal account settings. Security digits for credit card. |
|
203 | + 'cvv2' => $billing_info['cvv'], |
|
204 | + ); |
|
205 | + $PayerInfo = array( |
|
206 | + // Email address of payer. |
|
207 | + 'email' => $billing_info['email'], |
|
208 | + // Unique PayPal customer ID for payer. |
|
209 | + 'payerid' => '', |
|
210 | + // Status of payer. Values are verified or unverified |
|
211 | + 'payerstatus' => '', |
|
212 | + // Payer's business name. |
|
213 | + 'business' => '', |
|
214 | + ); |
|
215 | + $PayerName = array( |
|
216 | + // Payer's salutation. 20 char max. |
|
217 | + 'salutation' => '', |
|
218 | + // Payer's first name. 25 char max. |
|
219 | + 'firstname' => substr($billing_info['first_name'], 0, 25), |
|
220 | + // Payer's middle name. 25 char max. |
|
221 | + 'middlename' => '', |
|
222 | + // Payer's last name. 25 char max. |
|
223 | + 'lastname' => substr($billing_info['last_name'], 0, 25), |
|
224 | + // Payer's suffix. 12 char max. |
|
225 | + 'suffix' => '', |
|
226 | + ); |
|
227 | + $BillingAddress = array( |
|
228 | + // Required. First street address. |
|
229 | + 'street' => $billing_info['address'], |
|
230 | + // Second street address. |
|
231 | + 'street2' => $billing_info['address2'], |
|
232 | + // Required. Name of City. |
|
233 | + 'city' => $billing_info['city'], |
|
234 | + // Required. Name of State or Province. |
|
235 | + 'state' => substr($billing_info['state'], 0, 40), |
|
236 | + // Required. Country code. |
|
237 | + 'countrycode' => $billing_info['country'], |
|
238 | + // Required. Postal code of payer. |
|
239 | + 'zip' => $billing_info['zip'], |
|
240 | + ); |
|
241 | + // check if the registration info contains the needed fields for paypal pro |
|
242 | + // (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/) |
|
243 | + if ($attendee->address() && $attendee->city() && $attendee->country_ID()) { |
|
244 | + $use_registration_address_info = true; |
|
245 | + } else { |
|
246 | + $use_registration_address_info = false; |
|
247 | + } |
|
248 | + // so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. |
|
249 | + // If not, use the billing info again |
|
250 | + $ShippingAddress = array( |
|
251 | + 'shiptoname' => substr($use_registration_address_info |
|
252 | + ? $attendee->full_name() |
|
253 | + : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32), |
|
254 | + 'shiptostreet' => substr($use_registration_address_info |
|
255 | + ? $attendee->address() |
|
256 | + : $billing_info['address'], 0, 100), |
|
257 | + 'shiptostreet2' => substr($use_registration_address_info |
|
258 | + ? $attendee->address2() : $billing_info['address2'], 0, 100), |
|
259 | + 'shiptocity' => substr($use_registration_address_info |
|
260 | + ? $attendee->city() |
|
261 | + : $billing_info['city'], 0, 40), |
|
262 | + 'shiptostate' => substr($use_registration_address_info |
|
263 | + ? $attendee->state_name() |
|
264 | + : $billing_info['state'], 0, 40), |
|
265 | + 'shiptocountry' => $use_registration_address_info |
|
266 | + ? $attendee->country_ID() |
|
267 | + : $billing_info['country'], |
|
268 | + 'shiptozip' => substr($use_registration_address_info |
|
269 | + ? $attendee->zip() |
|
270 | + : $billing_info['zip'], 0, 20), |
|
271 | + 'shiptophonenum' => substr($use_registration_address_info |
|
272 | + ? $attendee->phone() |
|
273 | + : $billing_info['phone'], 0, 20), |
|
274 | + ); |
|
275 | + $PaymentDetails = array( |
|
276 | + // Required. Total amount of order, including shipping, handling, and tax. |
|
277 | + 'amt' => $gateway_formatter->formatCurrency($payment->amount()), |
|
278 | + // Required. Three-letter currency code. Default is USD. |
|
279 | + 'currencycode' => $payment->currency_code(), |
|
280 | + // Required if you include itemized cart details. (L_AMTn, etc.) |
|
281 | + // Subtotal of items not including S&H, or tax. |
|
282 | + 'itemamt' => $gateway_formatter->formatCurrency($item_amount),// |
|
283 | + // Total shipping costs for the order. If you specify shippingamt, you must also specify itemamt. |
|
284 | + 'shippingamt' => '', |
|
285 | + // Total handling costs for the order. If you specify handlingamt, you must also specify itemamt. |
|
286 | + 'handlingamt' => '', |
|
287 | + // Required if you specify itemized cart tax details. |
|
288 | + // Sum of tax for all items on the order. Total sales tax. |
|
289 | + 'taxamt' => $gateway_formatter->formatCurrency($tax_amount), |
|
290 | + // Description of the order the customer is purchasing. 127 char max. |
|
291 | + 'desc' => $order_description, |
|
292 | + // Free-form field for your own use. 256 char max. |
|
293 | + 'custom' => $primary_registrant ? $primary_registrant->ID() : '', |
|
294 | + // Your own invoice or tracking number |
|
295 | + 'invnum' => wp_generate_password(12, false),// $transaction->ID(), |
|
296 | + // URL for receiving Instant Payment Notifications. This overrides what your profile is set to use. |
|
297 | + 'notifyurl' => '', |
|
298 | + 'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this |
|
299 | + ); |
|
300 | + // Wrap all data arrays into a single, "master" array which will be passed into the class function. |
|
301 | + $PayPalRequestData = array( |
|
302 | + 'DPFields' => $DPFields, |
|
303 | + 'CCDetails' => $CCDetails, |
|
304 | + 'PayerInfo' => $PayerInfo, |
|
305 | + 'PayerName' => $PayerName, |
|
306 | + 'BillingAddress' => $BillingAddress, |
|
307 | + 'ShippingAddress' => $ShippingAddress, |
|
308 | + 'PaymentDetails' => $PaymentDetails, |
|
309 | + 'OrderItems' => $order_items, |
|
310 | + ); |
|
311 | + $this->_log_clean_request($PayPalRequestData, $payment); |
|
312 | + try { |
|
313 | + $PayPalResult = $this->prep_and_curl_request($PayPalRequestData); |
|
314 | + // remove PCI-sensitive data so it doesn't get stored |
|
315 | + $PayPalResult = $this->_log_clean_response($PayPalResult, $payment); |
|
316 | + if (isset($PayPalResult['L_ERRORCODE0']) && $PayPalResult['L_ERRORCODE0'] === '10002') { |
|
317 | + $message = esc_html__('PayPal did not accept your API username, password, or signature. Please double-check these credentials and if debug mode is on.', 'event_espresso'); |
|
318 | + } elseif (isset($PayPalResult['L_LONGMESSAGE0'])) { |
|
319 | + $message = $PayPalResult['L_LONGMESSAGE0']; |
|
320 | + } else { |
|
321 | + $message = $PayPalResult['ACK']; |
|
322 | + } |
|
323 | + if (empty($PayPalResult['RAWRESPONSE'])) { |
|
324 | + $payment->set_status($this->_pay_model->failed_status()); |
|
325 | + $payment->set_gateway_response(esc_html__('No response received from Paypal Pro', 'event_espresso')); |
|
326 | + $payment->set_details($PayPalResult); |
|
327 | + } else { |
|
328 | + if ($this->_APICallSuccessful($PayPalResult)) { |
|
329 | + $payment->set_status($this->_pay_model->approved_status()); |
|
330 | + } else { |
|
331 | + $payment->set_status($this->_pay_model->declined_status()); |
|
332 | + } |
|
333 | + // make sure we interpret the AMT as a float, not an international string |
|
334 | + // (where periods are thousand separators) |
|
335 | + $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0); |
|
336 | + $payment->set_gateway_response($message); |
|
337 | + $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID']) |
|
338 | + ? $PayPalResult['TRANSACTIONID'] |
|
339 | + : null); |
|
340 | + $primary_registration_code = $primary_registrant instanceof EE_Registration |
|
341 | + ? $primary_registrant->reg_code() |
|
342 | + : ''; |
|
343 | + $payment->set_extra_accntng($primary_registration_code); |
|
344 | + $payment->set_details($PayPalResult); |
|
345 | + } |
|
346 | + } catch (Exception $e) { |
|
347 | + $payment->set_status($this->_pay_model->failed_status()); |
|
348 | + $payment->set_gateway_response($e->getMessage()); |
|
349 | + } |
|
350 | + // $payment->set_status( $this->_pay_model->declined_status() ); |
|
351 | + // $payment->set_gateway_response( '' ); |
|
352 | + return $payment; |
|
353 | + } |
|
354 | + |
|
355 | + |
|
356 | + |
|
357 | + /** |
|
358 | + * CLeans out sensitive CC data and then logs it, and returns the cleaned request |
|
359 | + * |
|
360 | + * @param array $request |
|
361 | + * @param EEI_Payment $payment |
|
362 | + * @return void |
|
363 | + */ |
|
364 | + private function _log_clean_request($request, $payment) |
|
365 | + { |
|
366 | + $cleaned_request_data = $request; |
|
367 | + unset($cleaned_request_data['CCDetails']['acct']); |
|
368 | + unset($cleaned_request_data['CCDetails']['cvv2']); |
|
369 | + unset($cleaned_request_data['CCDetails']['expdate']); |
|
370 | + $this->log(array('Paypal Request' => $cleaned_request_data), $payment); |
|
371 | + } |
|
372 | + |
|
373 | + |
|
374 | + |
|
375 | + /** |
|
376 | + * Cleans the response, logs it, and returns it |
|
377 | + * |
|
378 | + * @param array $response |
|
379 | + * @param EEI_Payment $payment |
|
380 | + * @return array cleaned |
|
381 | + */ |
|
382 | + private function _log_clean_response($response, $payment) |
|
383 | + { |
|
384 | + unset($response['REQUESTDATA']['CREDITCARDTYPE']); |
|
385 | + unset($response['REQUESTDATA']['ACCT']); |
|
386 | + unset($response['REQUESTDATA']['EXPDATE']); |
|
387 | + unset($response['REQUESTDATA']['CVV2']); |
|
388 | + unset($response['RAWREQUEST']); |
|
389 | + $this->log(array('Paypal Response' => $response), $payment); |
|
390 | + return $response; |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + |
|
395 | + /** |
|
396 | + * @param $DataArray |
|
397 | + * @return array |
|
398 | + */ |
|
399 | + private function prep_and_curl_request($DataArray) |
|
400 | + { |
|
401 | + // Create empty holders for each portion of the NVP string |
|
402 | + $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP'; |
|
403 | + $CCDetailsNVP = ''; |
|
404 | + $PayerInfoNVP = ''; |
|
405 | + $PayerNameNVP = ''; |
|
406 | + $BillingAddressNVP = ''; |
|
407 | + $ShippingAddressNVP = ''; |
|
408 | + $PaymentDetailsNVP = ''; |
|
409 | + $OrderItemsNVP = ''; |
|
410 | + $Secure3DNVP = ''; |
|
411 | + // DP Fields |
|
412 | + $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array(); |
|
413 | + foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) { |
|
414 | + $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal); |
|
415 | + } |
|
416 | + // CC Details Fields |
|
417 | + $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array(); |
|
418 | + foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) { |
|
419 | + $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal); |
|
420 | + } |
|
421 | + // PayerInfo Type Fields |
|
422 | + $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array(); |
|
423 | + foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) { |
|
424 | + $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal); |
|
425 | + } |
|
426 | + // Payer Name Fields |
|
427 | + $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array(); |
|
428 | + foreach ($PayerName as $PayerNameVar => $PayerNameVal) { |
|
429 | + $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal); |
|
430 | + } |
|
431 | + // Address Fields (Billing) |
|
432 | + $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array(); |
|
433 | + foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) { |
|
434 | + $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal); |
|
435 | + } |
|
436 | + // Payment Details Type Fields |
|
437 | + $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array(); |
|
438 | + foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) { |
|
439 | + $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal); |
|
440 | + } |
|
441 | + // Payment Details Item Type Fields |
|
442 | + $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array(); |
|
443 | + $n = 0; |
|
444 | + foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) { |
|
445 | + $CurrentItem = $OrderItems[ $OrderItemsVar ]; |
|
446 | + foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) { |
|
447 | + $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal); |
|
448 | + } |
|
449 | + $n++; |
|
450 | + } |
|
451 | + // Ship To Address Fields |
|
452 | + $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array(); |
|
453 | + foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) { |
|
454 | + $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal); |
|
455 | + } |
|
456 | + // 3D Secure Fields |
|
457 | + $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array(); |
|
458 | + foreach ($Secure3D as $Secure3DVar => $Secure3DVal) { |
|
459 | + $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal); |
|
460 | + } |
|
461 | + // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string |
|
462 | + $NVPRequest = 'USER=' |
|
463 | + . $this->_api_username |
|
464 | + . '&PWD=' |
|
465 | + . $this->_api_password |
|
466 | + . '&VERSION=64.0' |
|
467 | + . '&SIGNATURE=' |
|
468 | + . $this->_api_signature |
|
469 | + . $DPFieldsNVP |
|
470 | + . $CCDetailsNVP |
|
471 | + . $PayerInfoNVP |
|
472 | + . $PayerNameNVP |
|
473 | + . $BillingAddressNVP |
|
474 | + . $PaymentDetailsNVP |
|
475 | + . $OrderItemsNVP |
|
476 | + . $ShippingAddressNVP |
|
477 | + . $Secure3DNVP; |
|
478 | + $NVPResponse = $this->_CURLRequest($NVPRequest); |
|
479 | + $NVPRequestArray = $this->_NVPToArray($NVPRequest); |
|
480 | + $NVPResponseArray = $this->_NVPToArray($NVPResponse); |
|
481 | + $Errors = $this->_GetErrors($NVPResponseArray); |
|
482 | + $NVPResponseArray['ERRORS'] = $Errors; |
|
483 | + $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray; |
|
484 | + $NVPResponseArray['RAWREQUEST'] = $NVPRequest; |
|
485 | + $NVPResponseArray['RAWRESPONSE'] = $NVPResponse; |
|
486 | + return $NVPResponseArray; |
|
487 | + } |
|
488 | + |
|
489 | + |
|
490 | + |
|
491 | + /** |
|
492 | + * @param $Request |
|
493 | + * @return mixed |
|
494 | + */ |
|
495 | + private function _CURLRequest($Request) |
|
496 | + { |
|
497 | + $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp'; |
|
498 | + $curl = curl_init(); |
|
499 | + curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true)); |
|
500 | + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); |
|
501 | + curl_setopt($curl, CURLOPT_TIMEOUT, 60); |
|
502 | + curl_setopt($curl, CURLOPT_URL, $EndPointURL); |
|
503 | + curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); |
|
504 | + curl_setopt($curl, CURLOPT_POSTFIELDS, $Request); |
|
505 | + curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1); |
|
506 | + // execute the curl POST |
|
507 | + $Response = curl_exec($curl); |
|
508 | + curl_close($curl); |
|
509 | + return $Response; |
|
510 | + } |
|
511 | + |
|
512 | + |
|
513 | + |
|
514 | + /** |
|
515 | + * @param $NVPString |
|
516 | + * @return array |
|
517 | + */ |
|
518 | + private function _NVPToArray($NVPString) |
|
519 | + { |
|
520 | + // prepare responses into array |
|
521 | + $proArray = array(); |
|
522 | + while (strlen($NVPString)) { |
|
523 | + // name |
|
524 | + $keypos = strpos($NVPString, '='); |
|
525 | + $keyval = substr($NVPString, 0, $keypos); |
|
526 | + // value |
|
527 | + $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString); |
|
528 | + $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1); |
|
529 | + // decoding the response |
|
530 | + $proArray[ $keyval ] = urldecode($valval); |
|
531 | + $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString)); |
|
532 | + } |
|
533 | + return $proArray; |
|
534 | + } |
|
535 | + |
|
536 | + |
|
537 | + |
|
538 | + /** |
|
539 | + * @param array $PayPalResult |
|
540 | + * @return bool |
|
541 | + */ |
|
542 | + private function _APICallSuccessful($PayPalResult) |
|
543 | + { |
|
544 | + $approved = false; |
|
545 | + // check main response message from PayPal |
|
546 | + if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) { |
|
547 | + $ack = strtoupper($PayPalResult['ACK']); |
|
548 | + $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false; |
|
549 | + } |
|
550 | + return $approved; |
|
551 | + } |
|
552 | + |
|
553 | + |
|
554 | + |
|
555 | + /** |
|
556 | + * @param $DataArray |
|
557 | + * @return array |
|
558 | + */ |
|
559 | + private function _GetErrors($DataArray) |
|
560 | + { |
|
561 | + $Errors = array(); |
|
562 | + $n = 0; |
|
563 | + while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) { |
|
564 | + $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : ''; |
|
565 | + $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ]) |
|
566 | + ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ] |
|
567 | + : ''; |
|
568 | + $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ]) |
|
569 | + ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ] |
|
570 | + : ''; |
|
571 | + $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ]) |
|
572 | + ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ] |
|
573 | + : ''; |
|
574 | + $CurrentItem = array( |
|
575 | + 'L_ERRORCODE' => $LErrorCode, |
|
576 | + 'L_SHORTMESSAGE' => $LShortMessage, |
|
577 | + 'L_LONGMESSAGE' => $LLongMessage, |
|
578 | + 'L_SEVERITYCODE' => $LSeverityCode, |
|
579 | + ); |
|
580 | + array_push($Errors, $CurrentItem); |
|
581 | + $n++; |
|
582 | + } |
|
583 | + return $Errors; |
|
584 | + } |
|
585 | + |
|
586 | + |
|
587 | + |
|
588 | + /** |
|
589 | + * nothing to see here... move along.... |
|
590 | + * |
|
591 | + * @access protected |
|
592 | + * @param $Errors |
|
593 | + * @return string |
|
594 | + */ |
|
595 | + private function _DisplayErrors($Errors) |
|
596 | + { |
|
597 | + $error = ''; |
|
598 | + foreach ($Errors as $ErrorVar => $ErrorVal) { |
|
599 | + $CurrentError = $Errors[ $ErrorVar ]; |
|
600 | + foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) { |
|
601 | + $CurrentVarName = ''; |
|
602 | + if ($CurrentErrorVar == 'L_ERRORCODE') { |
|
603 | + $CurrentVarName = 'Error Code'; |
|
604 | + } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') { |
|
605 | + $CurrentVarName = 'Short Message'; |
|
606 | + } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') { |
|
607 | + $CurrentVarName = 'Long Message'; |
|
608 | + } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') { |
|
609 | + $CurrentVarName = 'Severity Code'; |
|
610 | + } |
|
611 | + $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal; |
|
612 | + } |
|
613 | + } |
|
614 | + return $error; |
|
615 | + } |
|
616 | 616 | } |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | /** |
74 | 74 | * error_handler |
75 | 75 | * |
76 | - * @param $code |
|
76 | + * @param integer $code |
|
77 | 77 | * @param $message |
78 | 78 | * @param $file |
79 | 79 | * @param $line |
@@ -177,7 +177,7 @@ discard block |
||
177 | 177 | /** |
178 | 178 | * _format_error |
179 | 179 | * |
180 | - * @param $code |
|
180 | + * @param string $code |
|
181 | 181 | * @param $message |
182 | 182 | * @param $file |
183 | 183 | * @param $line |
@@ -210,7 +210,7 @@ discard block |
||
210 | 210 | |
211 | 211 | |
212 | 212 | /** |
213 | - * @return void |
|
213 | + * @return string|null |
|
214 | 214 | * @throws EE_Error |
215 | 215 | * @throws ReflectionException |
216 | 216 | */ |
@@ -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('<br />', self::$_espresso_notices['success']); |
|
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('<br />', self::$_espresso_notices['attention']); |
|
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('<br />', self::$_espresso_notices['errors']); |
|
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', 'registered')) { |
|
1006 | - wp_enqueue_style('espresso_default'); |
|
1007 | - wp_enqueue_style('espresso_custom_css'); |
|
1008 | - wp_enqueue_script('ee_error_js'); |
|
1009 | - } |
|
1010 | - if (wp_script_is('ee_error_js', 'enqueued')) { |
|
1011 | - wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG)); |
|
1012 | - return ''; |
|
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('<br />', self::$_espresso_notices['success']); |
|
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('<br />', self::$_espresso_notices['attention']); |
|
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('<br />', self::$_espresso_notices['errors']); |
|
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', 'registered')) { |
|
1006 | + wp_enqueue_style('espresso_default'); |
|
1007 | + wp_enqueue_style('espresso_custom_css'); |
|
1008 | + wp_enqueue_script('ee_error_js'); |
|
1009 | + } |
|
1010 | + if (wp_script_is('ee_error_js', 'enqueued')) { |
|
1011 | + wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG)); |
|
1012 | + return ''; |
|
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,29 +1249,29 @@ discard block |
||
1249 | 1249 | */ |
1250 | 1250 | function espresso_error_enqueue_scripts() |
1251 | 1251 | { |
1252 | - // js for error handling |
|
1253 | - if (! wp_script_is('espresso_core', 'registered')) { |
|
1254 | - wp_register_script( |
|
1255 | - 'espresso_core', |
|
1256 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
1257 | - ['jquery'], |
|
1258 | - EVENT_ESPRESSO_VERSION, |
|
1259 | - false |
|
1260 | - ); |
|
1261 | - } |
|
1262 | - wp_register_script( |
|
1263 | - 'ee_error_js', |
|
1264 | - EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
1265 | - array('espresso_core'), |
|
1266 | - EVENT_ESPRESSO_VERSION, |
|
1267 | - false |
|
1268 | - ); |
|
1252 | + // js for error handling |
|
1253 | + if (! wp_script_is('espresso_core', 'registered')) { |
|
1254 | + wp_register_script( |
|
1255 | + 'espresso_core', |
|
1256 | + EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
1257 | + ['jquery'], |
|
1258 | + EVENT_ESPRESSO_VERSION, |
|
1259 | + false |
|
1260 | + ); |
|
1261 | + } |
|
1262 | + wp_register_script( |
|
1263 | + 'ee_error_js', |
|
1264 | + EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
1265 | + array('espresso_core'), |
|
1266 | + EVENT_ESPRESSO_VERSION, |
|
1267 | + false |
|
1268 | + ); |
|
1269 | 1269 | } |
1270 | 1270 | |
1271 | 1271 | if (is_admin()) { |
1272 | - add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1272 | + add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1273 | 1273 | } else { |
1274 | - add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1274 | + add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5); |
|
1275 | 1275 | } |
1276 | 1276 | |
1277 | 1277 |
@@ -99,14 +99,14 @@ discard block |
||
99 | 99 | default: |
100 | 100 | $to = get_option('admin_email'); |
101 | 101 | } |
102 | - $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url(); |
|
102 | + $subject = $type.' '.$message.' in '.EVENT_ESPRESSO_VERSION.' on '.site_url(); |
|
103 | 103 | $msg = EE_Error::_format_error($type, $message, $file, $line); |
104 | 104 | if (function_exists('wp_mail')) { |
105 | 105 | add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type')); |
106 | 106 | wp_mail($to, $subject, $msg); |
107 | 107 | } |
108 | 108 | echo '<div id="message" class="espresso-notices error"><p>'; |
109 | - echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line; |
|
109 | + echo $type.': '.$message.'<br />'.$file.' line '.$line; |
|
110 | 110 | echo '<br /></p></div>'; |
111 | 111 | } |
112 | 112 | |
@@ -222,13 +222,13 @@ discard block |
||
222 | 222 | $msg = WP_DEBUG ? $dev_msg : $user_msg; |
223 | 223 | // add details to _all_exceptions array |
224 | 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(); |
|
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 | 232 | self::$_error_count++; |
233 | 233 | // add_action( 'shutdown', array( $this, 'display_errors' )); |
234 | 234 | $this->display_errors(); |
@@ -246,8 +246,8 @@ discard block |
||
246 | 246 | */ |
247 | 247 | public static function has_error($check_stored = false, $type_to_check = 'errors') |
248 | 248 | { |
249 | - $has_error = isset(self::$_espresso_notices[ $type_to_check ]) |
|
250 | - && ! empty(self::$_espresso_notices[ $type_to_check ]) |
|
249 | + $has_error = isset(self::$_espresso_notices[$type_to_check]) |
|
250 | + && ! empty(self::$_espresso_notices[$type_to_check]) |
|
251 | 251 | ? true |
252 | 252 | : false; |
253 | 253 | if ($check_stored && ! $has_error) { |
@@ -325,7 +325,7 @@ discard block |
||
325 | 325 | } |
326 | 326 | </style> |
327 | 327 | <div id="ee-error-message" class="error">'; |
328 | - if (! WP_DEBUG) { |
|
328 | + if ( ! WP_DEBUG) { |
|
329 | 329 | $output .= ' |
330 | 330 | <p>'; |
331 | 331 | } |
@@ -384,14 +384,14 @@ discard block |
||
384 | 384 | $class_dsply = ! empty($class) ? $class : ' '; |
385 | 385 | $type_dsply = ! empty($type) ? $type : ' '; |
386 | 386 | $function_dsply = ! empty($function) ? $function : ' '; |
387 | - $args_dsply = ! empty($args) ? '( ' . $args . ' )' : ''; |
|
387 | + $args_dsply = ! empty($args) ? '( '.$args.' )' : ''; |
|
388 | 388 | $trace_details .= ' |
389 | 389 | <tr> |
390 | - <td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td> |
|
391 | - <td align="right" class="' . $zebra . '">' . $line_dsply . '</td> |
|
392 | - <td align="left" class="' . $zebra . '">' . $file_dsply . '</td> |
|
393 | - <td align="left" class="' . $zebra . '">' . $class_dsply . '</td> |
|
394 | - <td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td> |
|
390 | + <td align="right" class="' . $zebra.'">'.$nmbr_dsply.'</td> |
|
391 | + <td align="right" class="' . $zebra.'">'.$line_dsply.'</td> |
|
392 | + <td align="left" class="' . $zebra.'">'.$file_dsply.'</td> |
|
393 | + <td align="left" class="' . $zebra.'">'.$class_dsply.'</td> |
|
394 | + <td align="left" class="' . $zebra.'">'.$type_dsply.$function_dsply.$args_dsply.'</td> |
|
395 | 395 | </tr>'; |
396 | 396 | } |
397 | 397 | $trace_details .= ' |
@@ -400,7 +400,7 @@ discard block |
||
400 | 400 | } |
401 | 401 | $ex['code'] = $ex['code'] ? $ex['code'] : $error_code; |
402 | 402 | // add generic non-identifying messages for non-privileged users |
403 | - if (! WP_DEBUG) { |
|
403 | + if ( ! WP_DEBUG) { |
|
404 | 404 | $output .= '<span class="ee-error-user-msg-spn">' |
405 | 405 | . trim($ex['msg']) |
406 | 406 | . '</span> <sup>' |
@@ -442,14 +442,14 @@ discard block |
||
442 | 442 | . '-dv" class="ee-error-trace-dv" style="display: none;"> |
443 | 443 | ' |
444 | 444 | . $trace_details; |
445 | - if (! empty($class)) { |
|
445 | + if ( ! empty($class)) { |
|
446 | 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 | 450 | $a = new ReflectionClass($class); |
451 | 451 | $output .= ' |
452 | - <pre>' . $a . '</pre> |
|
452 | + <pre>' . $a.'</pre> |
|
453 | 453 | </div> |
454 | 454 | </div>'; |
455 | 455 | } |
@@ -462,7 +462,7 @@ discard block |
||
462 | 462 | } |
463 | 463 | // remove last linebreak |
464 | 464 | $output = substr($output, 0, -6); |
465 | - if (! WP_DEBUG) { |
|
465 | + if ( ! WP_DEBUG) { |
|
466 | 466 | $output .= ' |
467 | 467 | </p>'; |
468 | 468 | } |
@@ -488,20 +488,20 @@ discard block |
||
488 | 488 | private function _convert_args_to_string($arguments = array(), $array = false) |
489 | 489 | { |
490 | 490 | $arg_string = ''; |
491 | - if (! empty($arguments)) { |
|
491 | + if ( ! empty($arguments)) { |
|
492 | 492 | $args = array(); |
493 | 493 | foreach ($arguments as $arg) { |
494 | - if (! empty($arg)) { |
|
494 | + if ( ! empty($arg)) { |
|
495 | 495 | if (is_string($arg)) { |
496 | - $args[] = " '" . $arg . "'"; |
|
496 | + $args[] = " '".$arg."'"; |
|
497 | 497 | } elseif (is_array($arg)) { |
498 | - $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true); |
|
498 | + $args[] = 'ARRAY('.$this->_convert_args_to_string($arg, true); |
|
499 | 499 | } elseif ($arg === null) { |
500 | 500 | $args[] = ' NULL'; |
501 | 501 | } elseif (is_bool($arg)) { |
502 | 502 | $args[] = ($arg) ? ' TRUE' : ' FALSE'; |
503 | 503 | } elseif (is_object($arg)) { |
504 | - $args[] = ' OBJECT ' . get_class($arg); |
|
504 | + $args[] = ' OBJECT '.get_class($arg); |
|
505 | 505 | } elseif (is_resource($arg)) { |
506 | 506 | $args[] = get_resource_type($arg); |
507 | 507 | } else { |
@@ -599,7 +599,7 @@ discard block |
||
599 | 599 | { |
600 | 600 | if (empty($msg)) { |
601 | 601 | EE_Error::doing_it_wrong( |
602 | - 'EE_Error::add_' . $type . '()', |
|
602 | + 'EE_Error::add_'.$type.'()', |
|
603 | 603 | sprintf( |
604 | 604 | __( |
605 | 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', |
@@ -639,17 +639,17 @@ discard block |
||
639 | 639 | do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line); |
640 | 640 | $msg = WP_DEBUG ? $dev_msg : $user_msg; |
641 | 641 | // add notice if message exists |
642 | - if (! empty($msg)) { |
|
642 | + if ( ! empty($msg)) { |
|
643 | 643 | // get error code |
644 | 644 | $notice_code = EE_Error::generate_error_code($file, $func, $line); |
645 | 645 | if (WP_DEBUG && $type === 'errors') { |
646 | - $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>'; |
|
646 | + $msg .= '<br/><span class="tiny-text">'.$notice_code.'</span>'; |
|
647 | 647 | } |
648 | 648 | // add notice. Index by code if it's not blank |
649 | 649 | if ($notice_code) { |
650 | - self::$_espresso_notices[ $type ][ $notice_code ] = $msg; |
|
650 | + self::$_espresso_notices[$type][$notice_code] = $msg; |
|
651 | 651 | } else { |
652 | - self::$_espresso_notices[ $type ][] = $msg; |
|
652 | + self::$_espresso_notices[$type][] = $msg; |
|
653 | 653 | } |
654 | 654 | add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1); |
655 | 655 | } |
@@ -900,7 +900,7 @@ discard block |
||
900 | 900 | // remove empty notices |
901 | 901 | foreach ($notices as $type => $notice) { |
902 | 902 | if (empty($notice)) { |
903 | - unset($notices[ $type ]); |
|
903 | + unset($notices[$type]); |
|
904 | 904 | } |
905 | 905 | } |
906 | 906 | } |
@@ -923,16 +923,16 @@ discard block |
||
923 | 923 | $print_scripts = false; |
924 | 924 | // grab any notices that have been previously saved |
925 | 925 | $notices = EE_Error::getStoredNotices(); |
926 | - if (! empty($notices)) { |
|
926 | + if ( ! empty($notices)) { |
|
927 | 927 | foreach ($notices as $type => $notice) { |
928 | 928 | if (is_array($notice) && ! empty($notice)) { |
929 | 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 ] |
|
930 | + self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type]) |
|
931 | + && ! empty(self::$_espresso_notices[$type]) |
|
932 | + ? self::$_espresso_notices[$type] |
|
933 | 933 | : array(); |
934 | 934 | // add newly created notices to existing ones |
935 | - self::$_espresso_notices[ $type ] += $notice; |
|
935 | + self::$_espresso_notices[$type] += $notice; |
|
936 | 936 | $print_scripts = true; |
937 | 937 | } |
938 | 938 | } |
@@ -959,10 +959,10 @@ discard block |
||
959 | 959 | $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success'; |
960 | 960 | $css_class = is_admin() ? 'updated fade' : 'success fade-away'; |
961 | 961 | // showMessage( $success_messages ); |
962 | - $notices .= '<div id="' . $css_id . '" ' |
|
963 | - . 'class="espresso-notices ' . $css_class . '" ' |
|
962 | + $notices .= '<div id="'.$css_id.'" ' |
|
963 | + . 'class="espresso-notices '.$css_class.'" ' |
|
964 | 964 | . 'style="display:none;">' |
965 | - . '<p>' . $success_messages . '</p>' |
|
965 | + . '<p>'.$success_messages.'</p>' |
|
966 | 966 | . $close |
967 | 967 | . '</div>'; |
968 | 968 | } |
@@ -970,10 +970,10 @@ discard block |
||
970 | 970 | $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention'; |
971 | 971 | $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away'; |
972 | 972 | // showMessage( $error_messages, TRUE ); |
973 | - $notices .= '<div id="' . $css_id . '" ' |
|
974 | - . 'class="espresso-notices ' . $css_class . '" ' |
|
973 | + $notices .= '<div id="'.$css_id.'" ' |
|
974 | + . 'class="espresso-notices '.$css_class.'" ' |
|
975 | 975 | . 'style="display:none;">' |
976 | - . '<p>' . $attention_messages . '</p>' |
|
976 | + . '<p>'.$attention_messages.'</p>' |
|
977 | 977 | . $close |
978 | 978 | . '</div>'; |
979 | 979 | } |
@@ -981,10 +981,10 @@ discard block |
||
981 | 981 | $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error'; |
982 | 982 | $css_class = is_admin() ? 'error' : 'error fade-away'; |
983 | 983 | // showMessage( $error_messages, TRUE ); |
984 | - $notices .= '<div id="' . $css_id . '" ' |
|
985 | - . 'class="espresso-notices ' . $css_class . '" ' |
|
984 | + $notices .= '<div id="'.$css_id.'" ' |
|
985 | + . 'class="espresso-notices '.$css_class.'" ' |
|
986 | 986 | . 'style="display:none;">' |
987 | - . '<p>' . $error_messages . '</p>' |
|
987 | + . '<p>'.$error_messages.'</p>' |
|
988 | 988 | . $close |
989 | 989 | . '</div>'; |
990 | 990 | } |
@@ -1001,7 +1001,7 @@ discard block |
||
1001 | 1001 | */ |
1002 | 1002 | private static function _print_scripts($force_print = false) |
1003 | 1003 | { |
1004 | - if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) { |
|
1004 | + if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) { |
|
1005 | 1005 | if (wp_script_is('ee_error_js', 'registered')) { |
1006 | 1006 | wp_enqueue_style('espresso_default'); |
1007 | 1007 | wp_enqueue_style('espresso_custom_css'); |
@@ -1015,12 +1015,12 @@ discard block |
||
1015 | 1015 | return ' |
1016 | 1016 | <script> |
1017 | 1017 | /* <![CDATA[ */ |
1018 | -var ee_settings = {"wp_debug":"' . WP_DEBUG . '"}; |
|
1018 | +var ee_settings = {"wp_debug":"' . WP_DEBUG.'"}; |
|
1019 | 1019 | /* ]]> */ |
1020 | 1020 | </script> |
1021 | -<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script> |
|
1022 | -<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
|
1023 | -<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
|
1021 | +<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script> |
|
1022 | +<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script> |
|
1023 | +<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script> |
|
1024 | 1024 | '; |
1025 | 1025 | } |
1026 | 1026 | return ''; |
@@ -1049,8 +1049,8 @@ discard block |
||
1049 | 1049 | { |
1050 | 1050 | $file = explode('.', basename($file)); |
1051 | 1051 | $error_code = ! empty($file[0]) ? $file[0] : ''; |
1052 | - $error_code .= ! empty($func) ? ' - ' . $func : ''; |
|
1053 | - $error_code .= ! empty($line) ? ' - ' . $line : ''; |
|
1052 | + $error_code .= ! empty($func) ? ' - '.$func : ''; |
|
1053 | + $error_code .= ! empty($line) ? ' - '.$line : ''; |
|
1054 | 1054 | return $error_code; |
1055 | 1055 | } |
1056 | 1056 | |
@@ -1069,18 +1069,18 @@ discard block |
||
1069 | 1069 | if (empty($ex)) { |
1070 | 1070 | return; |
1071 | 1071 | } |
1072 | - if (! $time) { |
|
1072 | + if ( ! $time) { |
|
1073 | 1073 | $time = time(); |
1074 | 1074 | } |
1075 | 1075 | $exception_log = '----------------------------------------------------------------------------------------' |
1076 | 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; |
|
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 | 1084 | $exception_log .= '----------------------------------------------------------------------------------------' |
1085 | 1085 | . PHP_EOL; |
1086 | 1086 | try { |
@@ -1250,10 +1250,10 @@ discard block |
||
1250 | 1250 | function espresso_error_enqueue_scripts() |
1251 | 1251 | { |
1252 | 1252 | // js for error handling |
1253 | - if (! wp_script_is('espresso_core', 'registered')) { |
|
1253 | + if ( ! wp_script_is('espresso_core', 'registered')) { |
|
1254 | 1254 | wp_register_script( |
1255 | 1255 | 'espresso_core', |
1256 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
1256 | + EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', |
|
1257 | 1257 | ['jquery'], |
1258 | 1258 | EVENT_ESPRESSO_VERSION, |
1259 | 1259 | false |
@@ -1261,7 +1261,7 @@ discard block |
||
1261 | 1261 | } |
1262 | 1262 | wp_register_script( |
1263 | 1263 | 'ee_error_js', |
1264 | - EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
1264 | + EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js', |
|
1265 | 1265 | array('espresso_core'), |
1266 | 1266 | EVENT_ESPRESSO_VERSION, |
1267 | 1267 | false |