@@ -1,5 +1,5 @@ discard block |
||
| 1 | 1 | <?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
| 2 | - exit('No direct script access allowed'); |
|
| 2 | + exit('No direct script access allowed'); |
|
| 3 | 3 | } |
| 4 | 4 | |
| 5 | 5 | |
@@ -15,85 +15,85 @@ discard block |
||
| 15 | 15 | class EE_Float_Normalization extends EE_Normalization_Strategy_Base |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /* |
|
| 18 | + /* |
|
| 19 | 19 | * regex pattern that matches for the following: |
| 20 | 20 | * * optional negative sign |
| 21 | 21 | * * one or more digits or decimals |
| 22 | 22 | */ |
| 23 | - const REGEX = '/^(-?)([\d.]+)$/'; |
|
| 23 | + const REGEX = '/^(-?)([\d.]+)$/'; |
|
| 24 | 24 | |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @param string $value_to_normalize |
|
| 28 | - * @return float |
|
| 29 | - * @throws \EE_Validation_Error |
|
| 30 | - */ |
|
| 31 | - public function normalize($value_to_normalize) |
|
| 32 | - { |
|
| 33 | - if ($value_to_normalize === null) { |
|
| 34 | - return null; |
|
| 35 | - } |
|
| 36 | - if (is_float($value_to_normalize) || is_int($value_to_normalize)) { |
|
| 37 | - return (float)$value_to_normalize; |
|
| 38 | - } |
|
| 39 | - if (! is_string($value_to_normalize)) { |
|
| 40 | - throw new EE_Validation_Error( |
|
| 41 | - sprintf( |
|
| 42 | - __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), |
|
| 43 | - print_r($value_to_normalize, true), |
|
| 44 | - gettype($value_to_normalize) |
|
| 45 | - ) |
|
| 46 | - ); |
|
| 47 | - } |
|
| 48 | - $normalized_value = filter_var( |
|
| 49 | - $value_to_normalize, |
|
| 50 | - FILTER_SANITIZE_NUMBER_FLOAT, |
|
| 51 | - FILTER_FLAG_ALLOW_FRACTION |
|
| 52 | - ); |
|
| 53 | - if($normalized_value === ''){ |
|
| 54 | - return null; |
|
| 55 | - } |
|
| 56 | - if (preg_match(EE_Float_Normalization::REGEX, $normalized_value, $matches)) { |
|
| 57 | - if (count($matches) === 3) { |
|
| 58 | - // if first match is the negative sign, |
|
| 59 | - // then the number needs to be multiplied by -1 to remain negative |
|
| 60 | - return $matches[1] === '-' |
|
| 61 | - ? (float)$matches[2] * -1 |
|
| 62 | - : (float)$matches[2]; |
|
| 63 | - } |
|
| 64 | - } |
|
| 65 | - //find if this input has a float validation strategy |
|
| 66 | - //in which case, use its message |
|
| 67 | - $validation_error_message = null; |
|
| 68 | - foreach ($this->_input->get_validation_strategies() as $validation_strategy) { |
|
| 69 | - if ($validation_strategy instanceof EE_Float_Validation_Strategy) { |
|
| 70 | - $validation_error_message = $validation_strategy->get_validation_error_message(); |
|
| 71 | - } |
|
| 72 | - } |
|
| 73 | - //this really shouldn't ever happen because fields with a float normalization strategy |
|
| 74 | - //should also have a float validation strategy, but in case it doesn't use the default |
|
| 75 | - if (! $validation_error_message) { |
|
| 76 | - $default_validation_strategy = new EE_Float_Validation_Strategy(); |
|
| 77 | - $validation_error_message = $default_validation_strategy->get_validation_error_message(); |
|
| 78 | - } |
|
| 79 | - throw new EE_Validation_Error($validation_error_message, 'float_only'); |
|
| 80 | - } |
|
| 26 | + /** |
|
| 27 | + * @param string $value_to_normalize |
|
| 28 | + * @return float |
|
| 29 | + * @throws \EE_Validation_Error |
|
| 30 | + */ |
|
| 31 | + public function normalize($value_to_normalize) |
|
| 32 | + { |
|
| 33 | + if ($value_to_normalize === null) { |
|
| 34 | + return null; |
|
| 35 | + } |
|
| 36 | + if (is_float($value_to_normalize) || is_int($value_to_normalize)) { |
|
| 37 | + return (float)$value_to_normalize; |
|
| 38 | + } |
|
| 39 | + if (! is_string($value_to_normalize)) { |
|
| 40 | + throw new EE_Validation_Error( |
|
| 41 | + sprintf( |
|
| 42 | + __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), |
|
| 43 | + print_r($value_to_normalize, true), |
|
| 44 | + gettype($value_to_normalize) |
|
| 45 | + ) |
|
| 46 | + ); |
|
| 47 | + } |
|
| 48 | + $normalized_value = filter_var( |
|
| 49 | + $value_to_normalize, |
|
| 50 | + FILTER_SANITIZE_NUMBER_FLOAT, |
|
| 51 | + FILTER_FLAG_ALLOW_FRACTION |
|
| 52 | + ); |
|
| 53 | + if($normalized_value === ''){ |
|
| 54 | + return null; |
|
| 55 | + } |
|
| 56 | + if (preg_match(EE_Float_Normalization::REGEX, $normalized_value, $matches)) { |
|
| 57 | + if (count($matches) === 3) { |
|
| 58 | + // if first match is the negative sign, |
|
| 59 | + // then the number needs to be multiplied by -1 to remain negative |
|
| 60 | + return $matches[1] === '-' |
|
| 61 | + ? (float)$matches[2] * -1 |
|
| 62 | + : (float)$matches[2]; |
|
| 63 | + } |
|
| 64 | + } |
|
| 65 | + //find if this input has a float validation strategy |
|
| 66 | + //in which case, use its message |
|
| 67 | + $validation_error_message = null; |
|
| 68 | + foreach ($this->_input->get_validation_strategies() as $validation_strategy) { |
|
| 69 | + if ($validation_strategy instanceof EE_Float_Validation_Strategy) { |
|
| 70 | + $validation_error_message = $validation_strategy->get_validation_error_message(); |
|
| 71 | + } |
|
| 72 | + } |
|
| 73 | + //this really shouldn't ever happen because fields with a float normalization strategy |
|
| 74 | + //should also have a float validation strategy, but in case it doesn't use the default |
|
| 75 | + if (! $validation_error_message) { |
|
| 76 | + $default_validation_strategy = new EE_Float_Validation_Strategy(); |
|
| 77 | + $validation_error_message = $default_validation_strategy->get_validation_error_message(); |
|
| 78 | + } |
|
| 79 | + throw new EE_Validation_Error($validation_error_message, 'float_only'); |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | 82 | |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Converts a float into a string |
|
| 86 | - * |
|
| 87 | - * @param float $normalized_value |
|
| 88 | - * @return string |
|
| 89 | - */ |
|
| 90 | - public function unnormalize($normalized_value) |
|
| 91 | - { |
|
| 92 | - if (empty($normalized_value)) { |
|
| 93 | - return '0.00'; |
|
| 94 | - } |
|
| 95 | - return "{$normalized_value}"; |
|
| 96 | - } |
|
| 84 | + /** |
|
| 85 | + * Converts a float into a string |
|
| 86 | + * |
|
| 87 | + * @param float $normalized_value |
|
| 88 | + * @return string |
|
| 89 | + */ |
|
| 90 | + public function unnormalize($normalized_value) |
|
| 91 | + { |
|
| 92 | + if (empty($normalized_value)) { |
|
| 93 | + return '0.00'; |
|
| 94 | + } |
|
| 95 | + return "{$normalized_value}"; |
|
| 96 | + } |
|
| 97 | 97 | } |
| 98 | 98 | |
| 99 | 99 | // End of file EE_Float_Normalization.strategy.php |
| 100 | 100 | \ No newline at end of file |
@@ -1,4 +1,4 @@ discard block |
||
| 1 | -<?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 2 | 2 | exit('No direct script access allowed'); |
| 3 | 3 | } |
| 4 | 4 | |
@@ -34,9 +34,9 @@ discard block |
||
| 34 | 34 | return null; |
| 35 | 35 | } |
| 36 | 36 | if (is_float($value_to_normalize) || is_int($value_to_normalize)) { |
| 37 | - return (float)$value_to_normalize; |
|
| 37 | + return (float) $value_to_normalize; |
|
| 38 | 38 | } |
| 39 | - if (! is_string($value_to_normalize)) { |
|
| 39 | + if ( ! is_string($value_to_normalize)) { |
|
| 40 | 40 | throw new EE_Validation_Error( |
| 41 | 41 | sprintf( |
| 42 | 42 | __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), |
@@ -50,7 +50,7 @@ discard block |
||
| 50 | 50 | FILTER_SANITIZE_NUMBER_FLOAT, |
| 51 | 51 | FILTER_FLAG_ALLOW_FRACTION |
| 52 | 52 | ); |
| 53 | - if($normalized_value === ''){ |
|
| 53 | + if ($normalized_value === '') { |
|
| 54 | 54 | return null; |
| 55 | 55 | } |
| 56 | 56 | if (preg_match(EE_Float_Normalization::REGEX, $normalized_value, $matches)) { |
@@ -58,8 +58,8 @@ discard block |
||
| 58 | 58 | // if first match is the negative sign, |
| 59 | 59 | // then the number needs to be multiplied by -1 to remain negative |
| 60 | 60 | return $matches[1] === '-' |
| 61 | - ? (float)$matches[2] * -1 |
|
| 62 | - : (float)$matches[2]; |
|
| 61 | + ? (float) $matches[2] * -1 |
|
| 62 | + : (float) $matches[2]; |
|
| 63 | 63 | } |
| 64 | 64 | } |
| 65 | 65 | //find if this input has a float validation strategy |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | } |
| 73 | 73 | //this really shouldn't ever happen because fields with a float normalization strategy |
| 74 | 74 | //should also have a float validation strategy, but in case it doesn't use the default |
| 75 | - if (! $validation_error_message) { |
|
| 75 | + if ( ! $validation_error_message) { |
|
| 76 | 76 | $default_validation_strategy = new EE_Float_Validation_Strategy(); |
| 77 | 77 | $validation_error_message = $default_validation_strategy->get_validation_error_message(); |
| 78 | 78 | } |
@@ -38,7 +38,7 @@ |
||
| 38 | 38 | */ |
| 39 | 39 | public function __construct($generator) |
| 40 | 40 | { |
| 41 | - if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
| 41 | + if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
| 42 | 42 | throw new InvalidArgumentException( |
| 43 | 43 | esc_html__( |
| 44 | 44 | 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
@@ -33,7 +33,7 @@ |
||
| 33 | 33 | /** |
| 34 | 34 | * CoreLoader constructor. |
| 35 | 35 | * |
| 36 | - * @param EE_Registry|CoffeeShop $generator |
|
| 36 | + * @param EE_Registry $generator |
|
| 37 | 37 | * @throws InvalidArgumentException |
| 38 | 38 | */ |
| 39 | 39 | public function __construct($generator) |
@@ -23,58 +23,58 @@ |
||
| 23 | 23 | class CoreLoader implements LoaderInterface |
| 24 | 24 | { |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var EE_Registry|CoffeeShop $generator |
|
| 28 | - */ |
|
| 29 | - private $generator; |
|
| 30 | - |
|
| 31 | - |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * CoreLoader constructor. |
|
| 35 | - * |
|
| 36 | - * @param EE_Registry|CoffeeShop $generator |
|
| 37 | - * @throws InvalidArgumentException |
|
| 38 | - */ |
|
| 39 | - public function __construct($generator) |
|
| 40 | - { |
|
| 41 | - if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
| 42 | - throw new InvalidArgumentException( |
|
| 43 | - esc_html__( |
|
| 44 | - 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
| 45 | - 'event_espresso' |
|
| 46 | - ) |
|
| 47 | - ); |
|
| 48 | - } |
|
| 49 | - $this->generator = $generator; |
|
| 50 | - } |
|
| 51 | - |
|
| 52 | - |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * @param string $fqcn |
|
| 56 | - * @param array $arguments |
|
| 57 | - * @return mixed |
|
| 58 | - * @throws ServiceNotFoundException |
|
| 59 | - */ |
|
| 60 | - public function load($fqcn, $arguments = array()) |
|
| 61 | - { |
|
| 62 | - return $this->generator instanceof EE_Registry |
|
| 63 | - ? $this->generator->create($fqcn, $arguments) |
|
| 64 | - : $this->generator->brew($fqcn, $arguments); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * calls reset() on generator if method exists |
|
| 71 | - */ |
|
| 72 | - public function reset() |
|
| 73 | - { |
|
| 74 | - if (method_exists($this->generator, 'reset')) { |
|
| 75 | - $this->generator->reset(); |
|
| 76 | - } |
|
| 77 | - } |
|
| 26 | + /** |
|
| 27 | + * @var EE_Registry|CoffeeShop $generator |
|
| 28 | + */ |
|
| 29 | + private $generator; |
|
| 30 | + |
|
| 31 | + |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * CoreLoader constructor. |
|
| 35 | + * |
|
| 36 | + * @param EE_Registry|CoffeeShop $generator |
|
| 37 | + * @throws InvalidArgumentException |
|
| 38 | + */ |
|
| 39 | + public function __construct($generator) |
|
| 40 | + { |
|
| 41 | + if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
| 42 | + throw new InvalidArgumentException( |
|
| 43 | + esc_html__( |
|
| 44 | + 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
| 45 | + 'event_espresso' |
|
| 46 | + ) |
|
| 47 | + ); |
|
| 48 | + } |
|
| 49 | + $this->generator = $generator; |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * @param string $fqcn |
|
| 56 | + * @param array $arguments |
|
| 57 | + * @return mixed |
|
| 58 | + * @throws ServiceNotFoundException |
|
| 59 | + */ |
|
| 60 | + public function load($fqcn, $arguments = array()) |
|
| 61 | + { |
|
| 62 | + return $this->generator instanceof EE_Registry |
|
| 63 | + ? $this->generator->create($fqcn, $arguments) |
|
| 64 | + : $this->generator->brew($fqcn, $arguments); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * calls reset() on generator if method exists |
|
| 71 | + */ |
|
| 72 | + public function reset() |
|
| 73 | + { |
|
| 74 | + if (method_exists($this->generator, 'reset')) { |
|
| 75 | + $this->generator->reset(); |
|
| 76 | + } |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | 79 | } |
| 80 | 80 | // End of file CoreLoader.php |
@@ -19,22 +19,22 @@ |
||
| 19 | 19 | { |
| 20 | 20 | |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var LoaderInterface $loader |
|
| 24 | - */ |
|
| 25 | - protected $loader; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * LoaderDecorator constructor. |
|
| 31 | - * |
|
| 32 | - * @param LoaderInterface $loader |
|
| 33 | - */ |
|
| 34 | - public function __construct(LoaderInterface $loader) |
|
| 35 | - { |
|
| 36 | - $this->loader = $loader; |
|
| 37 | - } |
|
| 22 | + /** |
|
| 23 | + * @var LoaderInterface $loader |
|
| 24 | + */ |
|
| 25 | + protected $loader; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * LoaderDecorator constructor. |
|
| 31 | + * |
|
| 32 | + * @param LoaderInterface $loader |
|
| 33 | + */ |
|
| 34 | + public function __construct(LoaderInterface $loader) |
|
| 35 | + { |
|
| 36 | + $this->loader = $loader; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | 39 | |
| 40 | 40 | |
@@ -1,8 +1,8 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | namespace EventEspresso\core\services\collections; |
| 3 | 3 | |
| 4 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
| 5 | - exit( 'No direct script access allowed' ); |
|
| 4 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 5 | + exit('No direct script access allowed'); |
|
| 6 | 6 | } |
| 7 | 7 | |
| 8 | 8 | |
@@ -27,7 +27,7 @@ discard block |
||
| 27 | 27 | * @param mixed $identifier |
| 28 | 28 | * @return bool |
| 29 | 29 | */ |
| 30 | - public function add( $object, $identifier = null ); |
|
| 30 | + public function add($object, $identifier = null); |
|
| 31 | 31 | |
| 32 | 32 | /** |
| 33 | 33 | * setIdentifier |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | * @param mixed $identifier |
| 40 | 40 | * @return bool |
| 41 | 41 | */ |
| 42 | - public function setIdentifier( $object, $identifier = null ); |
|
| 42 | + public function setIdentifier($object, $identifier = null); |
|
| 43 | 43 | |
| 44 | 44 | /** |
| 45 | 45 | * get |
@@ -50,7 +50,7 @@ discard block |
||
| 50 | 50 | * @param mixed $identifier |
| 51 | 51 | * @return mixed |
| 52 | 52 | */ |
| 53 | - public function get( $identifier ); |
|
| 53 | + public function get($identifier); |
|
| 54 | 54 | |
| 55 | 55 | /** |
| 56 | 56 | * has |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | * @param mixed $identifier |
| 63 | 63 | * @return bool |
| 64 | 64 | */ |
| 65 | - public function has( $identifier ); |
|
| 65 | + public function has($identifier); |
|
| 66 | 66 | |
| 67 | 67 | /** |
| 68 | 68 | * hasObject |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | * @param $object |
| 73 | 73 | * @return bool |
| 74 | 74 | */ |
| 75 | - public function hasObject( $object ); |
|
| 75 | + public function hasObject($object); |
|
| 76 | 76 | |
| 77 | 77 | /** |
| 78 | 78 | * remove |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | * @param $object |
| 83 | 83 | * @return bool |
| 84 | 84 | */ |
| 85 | - public function remove( $object ); |
|
| 85 | + public function remove($object); |
|
| 86 | 86 | |
| 87 | 87 | /** |
| 88 | 88 | * setCurrent |
@@ -92,7 +92,7 @@ discard block |
||
| 92 | 92 | * @param mixed $identifier |
| 93 | 93 | * @return boolean |
| 94 | 94 | */ |
| 95 | - public function setCurrent( $identifier ) ; |
|
| 95 | + public function setCurrent($identifier); |
|
| 96 | 96 | |
| 97 | 97 | /** |
| 98 | 98 | * setCurrentUsingObject |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | * @param $object |
| 103 | 103 | * @return boolean |
| 104 | 104 | */ |
| 105 | - public function setCurrentUsingObject( $object ); |
|
| 105 | + public function setCurrentUsingObject($object); |
|
| 106 | 106 | |
| 107 | 107 | /** |
| 108 | 108 | * Returns the object occupying the index before the current object, |
@@ -119,7 +119,7 @@ discard block |
||
| 119 | 119 | * @param $object |
| 120 | 120 | * @return boolean|int|string |
| 121 | 121 | */ |
| 122 | - public function indexOf( $object ); |
|
| 122 | + public function indexOf($object); |
|
| 123 | 123 | |
| 124 | 124 | |
| 125 | 125 | /** |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | * @param $index |
| 130 | 130 | * @return mixed |
| 131 | 131 | */ |
| 132 | - public function objectAtIndex( $index ); |
|
| 132 | + public function objectAtIndex($index); |
|
| 133 | 133 | |
| 134 | 134 | /** |
| 135 | 135 | * Returns the sequence of objects as specified by the offset and length |
@@ -139,7 +139,7 @@ discard block |
||
| 139 | 139 | * @param int $length |
| 140 | 140 | * @return array |
| 141 | 141 | */ |
| 142 | - public function slice( $offset, $length ); |
|
| 142 | + public function slice($offset, $length); |
|
| 143 | 143 | |
| 144 | 144 | /** |
| 145 | 145 | * Inserts an object (or an array of objects) at a certain point |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | * @param mixed $objects A single object or an array of objects |
| 149 | 149 | * @param integer $index |
| 150 | 150 | */ |
| 151 | - public function insertAt( $objects, $index ); |
|
| 151 | + public function insertAt($objects, $index); |
|
| 152 | 152 | |
| 153 | 153 | /** |
| 154 | 154 | * Removes the object at the given index |
@@ -156,7 +156,7 @@ discard block |
||
| 156 | 156 | * @see http://stackoverflow.com/a/8736013 |
| 157 | 157 | * @param integer $index |
| 158 | 158 | */ |
| 159 | - public function removeAt( $index ) ; |
|
| 159 | + public function removeAt($index); |
|
| 160 | 160 | |
| 161 | 161 | |
| 162 | 162 | |
@@ -113,12 +113,12 @@ discard block |
||
| 113 | 113 | public function previous(); |
| 114 | 114 | |
| 115 | 115 | /** |
| 116 | - * Returns the index of a given object, or false if not found |
|
| 117 | - * |
|
| 118 | - * @see http://stackoverflow.com/a/8736013 |
|
| 119 | - * @param $object |
|
| 120 | - * @return boolean|int|string |
|
| 121 | - */ |
|
| 116 | + * Returns the index of a given object, or false if not found |
|
| 117 | + * |
|
| 118 | + * @see http://stackoverflow.com/a/8736013 |
|
| 119 | + * @param $object |
|
| 120 | + * @return boolean|int|string |
|
| 121 | + */ |
|
| 122 | 122 | public function indexOf( $object ); |
| 123 | 123 | |
| 124 | 124 | |
@@ -160,10 +160,10 @@ discard block |
||
| 160 | 160 | |
| 161 | 161 | |
| 162 | 162 | |
| 163 | - /** |
|
| 164 | - * detaches ALL objects from the Collection |
|
| 165 | - */ |
|
| 166 | - public function detachAll(); |
|
| 163 | + /** |
|
| 164 | + * detaches ALL objects from the Collection |
|
| 165 | + */ |
|
| 166 | + public function detachAll(); |
|
| 167 | 167 | |
| 168 | 168 | } |
| 169 | 169 | // End of file CollectionInterface.php |
@@ -83,7 +83,6 @@ discard block |
||
| 83 | 83 | |
| 84 | 84 | /** |
| 85 | 85 | * setIdentifier |
| 86 | - |
|
| 87 | 86 | * Sets the data associated with an object in the Collection |
| 88 | 87 | * if no $identifier is supplied, then the spl_object_hash() is used |
| 89 | 88 | * |
@@ -352,18 +351,18 @@ discard block |
||
| 352 | 351 | |
| 353 | 352 | |
| 354 | 353 | |
| 355 | - /** |
|
| 356 | - * detaches ALL objects from the Collection |
|
| 357 | - */ |
|
| 358 | - public function detachAll() |
|
| 359 | - { |
|
| 360 | - $this->rewind(); |
|
| 361 | - while ($this->valid()) { |
|
| 362 | - $object = $this->current(); |
|
| 363 | - $this->next(); |
|
| 364 | - $this->detach($object); |
|
| 365 | - } |
|
| 366 | - } |
|
| 354 | + /** |
|
| 355 | + * detaches ALL objects from the Collection |
|
| 356 | + */ |
|
| 357 | + public function detachAll() |
|
| 358 | + { |
|
| 359 | + $this->rewind(); |
|
| 360 | + while ($this->valid()) { |
|
| 361 | + $object = $this->current(); |
|
| 362 | + $this->next(); |
|
| 363 | + $this->detach($object); |
|
| 364 | + } |
|
| 365 | + } |
|
| 367 | 366 | |
| 368 | 367 | |
| 369 | 368 | |
@@ -24,140 +24,140 @@ |
||
| 24 | 24 | { |
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var LoaderInterface $new_loader |
|
| 29 | - */ |
|
| 30 | - private $new_loader; |
|
| 31 | - |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var LoaderInterface $shared_loader |
|
| 35 | - */ |
|
| 36 | - private $shared_loader; |
|
| 37 | - |
|
| 38 | - |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Loader constructor. |
|
| 42 | - * |
|
| 43 | - * @param LoaderInterface|null $new_loader |
|
| 44 | - * @param LoaderInterface|null $shared_loader |
|
| 45 | - * @throws InvalidInterfaceException |
|
| 46 | - * @throws InvalidArgumentException |
|
| 47 | - * @throws InvalidDataTypeException |
|
| 48 | - */ |
|
| 49 | - public function __construct(LoaderInterface $new_loader = null, LoaderInterface $shared_loader = null) |
|
| 50 | - { |
|
| 51 | - $this->new_loader = $this->setupNewLoader($new_loader); |
|
| 52 | - $this->shared_loader = $this->setupSharedLoader($shared_loader); |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * @param LoaderInterface|null $new_loader |
|
| 59 | - * @return CoreLoader|LoaderInterface |
|
| 60 | - * @throws InvalidArgumentException |
|
| 61 | - */ |
|
| 62 | - private function setupNewLoader(LoaderInterface $new_loader = null) |
|
| 63 | - { |
|
| 64 | - // if not already generated, create a standard loader |
|
| 65 | - if (! $new_loader instanceof LoaderInterface) { |
|
| 66 | - $new_loader = new CoreLoader(EE_Registry::instance()); |
|
| 67 | - } |
|
| 68 | - return $new_loader; |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * @param LoaderInterface|null $shared_loader |
|
| 75 | - * @return CoreLoader|LoaderInterface |
|
| 76 | - * @throws InvalidDataTypeException |
|
| 77 | - * @throws InvalidInterfaceException |
|
| 78 | - * @throws InvalidArgumentException |
|
| 79 | - */ |
|
| 80 | - private function setupSharedLoader(LoaderInterface $shared_loader = null) |
|
| 81 | - { |
|
| 82 | - // if not already generated, create a caching loader |
|
| 83 | - if (! $shared_loader instanceof LoaderInterface) { |
|
| 84 | - $shared_loader = new CachingLoader( |
|
| 85 | - new CoreLoader(EE_Registry::instance()), |
|
| 86 | - new LooseCollection('') |
|
| 87 | - ); |
|
| 88 | - } |
|
| 89 | - return $shared_loader; |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * @return LoaderInterface |
|
| 96 | - */ |
|
| 97 | - public function getNewLoader() |
|
| 98 | - { |
|
| 99 | - return $this->new_loader; |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * @return LoaderInterface |
|
| 106 | - */ |
|
| 107 | - public function getSharedLoader() |
|
| 108 | - { |
|
| 109 | - return $this->shared_loader; |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * @param string $fqcn |
|
| 116 | - * @param array $arguments |
|
| 117 | - * @param bool $shared |
|
| 118 | - * @return mixed |
|
| 119 | - */ |
|
| 120 | - public function load($fqcn, $arguments = array(), $shared = true) |
|
| 121 | - { |
|
| 122 | - return $shared |
|
| 123 | - ? $this->getSharedLoader()->load($fqcn, $arguments) |
|
| 124 | - : $this->getNewLoader()->load($fqcn, $arguments); |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * @param string $fqcn |
|
| 131 | - * @param array $arguments |
|
| 132 | - * @return mixed |
|
| 133 | - */ |
|
| 134 | - public function getNew($fqcn, $arguments = array()) |
|
| 135 | - { |
|
| 136 | - return $this->getNewLoader()->load($fqcn, $arguments); |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * @param string $fqcn |
|
| 143 | - * @param array $arguments |
|
| 144 | - * @return mixed |
|
| 145 | - */ |
|
| 146 | - public function getShared($fqcn, $arguments = array()) |
|
| 147 | - { |
|
| 148 | - return $this->getSharedLoader()->load($fqcn, $arguments); |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * calls reset() on loaders if that method exists |
|
| 155 | - */ |
|
| 156 | - public function reset() |
|
| 157 | - { |
|
| 158 | - $this->new_loader->reset(); |
|
| 159 | - $this->shared_loader->reset(); |
|
| 160 | - } |
|
| 27 | + /** |
|
| 28 | + * @var LoaderInterface $new_loader |
|
| 29 | + */ |
|
| 30 | + private $new_loader; |
|
| 31 | + |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var LoaderInterface $shared_loader |
|
| 35 | + */ |
|
| 36 | + private $shared_loader; |
|
| 37 | + |
|
| 38 | + |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Loader constructor. |
|
| 42 | + * |
|
| 43 | + * @param LoaderInterface|null $new_loader |
|
| 44 | + * @param LoaderInterface|null $shared_loader |
|
| 45 | + * @throws InvalidInterfaceException |
|
| 46 | + * @throws InvalidArgumentException |
|
| 47 | + * @throws InvalidDataTypeException |
|
| 48 | + */ |
|
| 49 | + public function __construct(LoaderInterface $new_loader = null, LoaderInterface $shared_loader = null) |
|
| 50 | + { |
|
| 51 | + $this->new_loader = $this->setupNewLoader($new_loader); |
|
| 52 | + $this->shared_loader = $this->setupSharedLoader($shared_loader); |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * @param LoaderInterface|null $new_loader |
|
| 59 | + * @return CoreLoader|LoaderInterface |
|
| 60 | + * @throws InvalidArgumentException |
|
| 61 | + */ |
|
| 62 | + private function setupNewLoader(LoaderInterface $new_loader = null) |
|
| 63 | + { |
|
| 64 | + // if not already generated, create a standard loader |
|
| 65 | + if (! $new_loader instanceof LoaderInterface) { |
|
| 66 | + $new_loader = new CoreLoader(EE_Registry::instance()); |
|
| 67 | + } |
|
| 68 | + return $new_loader; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * @param LoaderInterface|null $shared_loader |
|
| 75 | + * @return CoreLoader|LoaderInterface |
|
| 76 | + * @throws InvalidDataTypeException |
|
| 77 | + * @throws InvalidInterfaceException |
|
| 78 | + * @throws InvalidArgumentException |
|
| 79 | + */ |
|
| 80 | + private function setupSharedLoader(LoaderInterface $shared_loader = null) |
|
| 81 | + { |
|
| 82 | + // if not already generated, create a caching loader |
|
| 83 | + if (! $shared_loader instanceof LoaderInterface) { |
|
| 84 | + $shared_loader = new CachingLoader( |
|
| 85 | + new CoreLoader(EE_Registry::instance()), |
|
| 86 | + new LooseCollection('') |
|
| 87 | + ); |
|
| 88 | + } |
|
| 89 | + return $shared_loader; |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * @return LoaderInterface |
|
| 96 | + */ |
|
| 97 | + public function getNewLoader() |
|
| 98 | + { |
|
| 99 | + return $this->new_loader; |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * @return LoaderInterface |
|
| 106 | + */ |
|
| 107 | + public function getSharedLoader() |
|
| 108 | + { |
|
| 109 | + return $this->shared_loader; |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * @param string $fqcn |
|
| 116 | + * @param array $arguments |
|
| 117 | + * @param bool $shared |
|
| 118 | + * @return mixed |
|
| 119 | + */ |
|
| 120 | + public function load($fqcn, $arguments = array(), $shared = true) |
|
| 121 | + { |
|
| 122 | + return $shared |
|
| 123 | + ? $this->getSharedLoader()->load($fqcn, $arguments) |
|
| 124 | + : $this->getNewLoader()->load($fqcn, $arguments); |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * @param string $fqcn |
|
| 131 | + * @param array $arguments |
|
| 132 | + * @return mixed |
|
| 133 | + */ |
|
| 134 | + public function getNew($fqcn, $arguments = array()) |
|
| 135 | + { |
|
| 136 | + return $this->getNewLoader()->load($fqcn, $arguments); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * @param string $fqcn |
|
| 143 | + * @param array $arguments |
|
| 144 | + * @return mixed |
|
| 145 | + */ |
|
| 146 | + public function getShared($fqcn, $arguments = array()) |
|
| 147 | + { |
|
| 148 | + return $this->getSharedLoader()->load($fqcn, $arguments); |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * calls reset() on loaders if that method exists |
|
| 155 | + */ |
|
| 156 | + public function reset() |
|
| 157 | + { |
|
| 158 | + $this->new_loader->reset(); |
|
| 159 | + $this->shared_loader->reset(); |
|
| 160 | + } |
|
| 161 | 161 | |
| 162 | 162 | } |
| 163 | 163 | // End of file Loader.php |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | private function setupNewLoader(LoaderInterface $new_loader = null) |
| 63 | 63 | { |
| 64 | 64 | // if not already generated, create a standard loader |
| 65 | - if (! $new_loader instanceof LoaderInterface) { |
|
| 65 | + if ( ! $new_loader instanceof LoaderInterface) { |
|
| 66 | 66 | $new_loader = new CoreLoader(EE_Registry::instance()); |
| 67 | 67 | } |
| 68 | 68 | return $new_loader; |
@@ -80,7 +80,7 @@ discard block |
||
| 80 | 80 | private function setupSharedLoader(LoaderInterface $shared_loader = null) |
| 81 | 81 | { |
| 82 | 82 | // if not already generated, create a caching loader |
| 83 | - if (! $shared_loader instanceof LoaderInterface) { |
|
| 83 | + if ( ! $shared_loader instanceof LoaderInterface) { |
|
| 84 | 84 | $shared_loader = new CachingLoader( |
| 85 | 85 | new CoreLoader(EE_Registry::instance()), |
| 86 | 86 | new LooseCollection('') |
@@ -102,17 +102,17 @@ |
||
| 102 | 102 | $fqcn = ltrim($fqcn, '\\'); |
| 103 | 103 | // caching can be turned off via the following code: |
| 104 | 104 | // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
| 105 | - if( |
|
| 105 | + if ( |
|
| 106 | 106 | apply_filters( |
| 107 | 107 | 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
| 108 | 108 | false, |
| 109 | 109 | $this |
| 110 | 110 | ) |
| 111 | - ){ |
|
| 111 | + ) { |
|
| 112 | 112 | return $this->loader->load($fqcn, $arguments); |
| 113 | 113 | } |
| 114 | - $identifier = md5($fqcn . serialize($arguments)); |
|
| 115 | - if($this->cache->has($identifier)){ |
|
| 114 | + $identifier = md5($fqcn.serialize($arguments)); |
|
| 115 | + if ($this->cache->has($identifier)) { |
|
| 116 | 116 | return $this->cache->get($identifier); |
| 117 | 117 | } |
| 118 | 118 | $object = $this->loader->load($fqcn, $arguments); |
@@ -22,114 +22,114 @@ |
||
| 22 | 22 | class CachingLoader extends LoaderDecorator |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var CollectionInterface $cache |
|
| 27 | - */ |
|
| 28 | - protected $cache; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var string $identifier |
|
| 32 | - */ |
|
| 33 | - protected $identifier; |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * CachingLoader constructor. |
|
| 39 | - * |
|
| 40 | - * @param LoaderInterface $loader |
|
| 41 | - * @param CollectionInterface $cache |
|
| 42 | - * @param string $identifier |
|
| 43 | - * @throws InvalidDataTypeException |
|
| 44 | - */ |
|
| 45 | - public function __construct(LoaderInterface $loader, CollectionInterface $cache, $identifier = '') |
|
| 46 | - { |
|
| 47 | - parent::__construct($loader); |
|
| 48 | - $this->cache = $cache; |
|
| 49 | - $this->setIdentifier($identifier); |
|
| 50 | - if ($this->identifier !== '') { |
|
| 51 | - // to only clear this cache, and assuming an identifier has been set, simply do the following: |
|
| 52 | - // do_action('AHEE__EventEspresso\core\services\loaders\CachingLoader__resetCache__IDENTIFIER'); |
|
| 53 | - // where "IDENTIFIER" = the string that was set during construction |
|
| 54 | - add_action( |
|
| 55 | - "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}", |
|
| 56 | - array($this, 'reset') |
|
| 57 | - ); |
|
| 58 | - } |
|
| 59 | - // to clear ALL caches, simply do the following: |
|
| 60 | - // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache'); |
|
| 61 | - add_action( |
|
| 62 | - 'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache', |
|
| 63 | - array($this, 'reset') |
|
| 64 | - ); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * @return string |
|
| 71 | - */ |
|
| 72 | - public function identifier() |
|
| 73 | - { |
|
| 74 | - return $this->identifier; |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * @param string $identifier |
|
| 81 | - * @throws InvalidDataTypeException |
|
| 82 | - */ |
|
| 83 | - private function setIdentifier($identifier) |
|
| 84 | - { |
|
| 85 | - if ( ! is_string($identifier)) { |
|
| 86 | - throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
|
| 87 | - } |
|
| 88 | - $this->identifier = $identifier; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * @param string $fqcn |
|
| 95 | - * @param array $arguments |
|
| 96 | - * @return mixed |
|
| 97 | - * @throws InvalidEntityException |
|
| 98 | - * @throws ServiceNotFoundException |
|
| 99 | - */ |
|
| 100 | - public function load($fqcn, $arguments = array()) |
|
| 101 | - { |
|
| 102 | - $fqcn = ltrim($fqcn, '\\'); |
|
| 103 | - // caching can be turned off via the following code: |
|
| 104 | - // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
| 105 | - if( |
|
| 106 | - apply_filters( |
|
| 107 | - 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
|
| 108 | - false, |
|
| 109 | - $this |
|
| 110 | - ) |
|
| 111 | - ){ |
|
| 112 | - return $this->loader->load($fqcn, $arguments); |
|
| 113 | - } |
|
| 114 | - $identifier = md5($fqcn . serialize($arguments)); |
|
| 115 | - if($this->cache->has($identifier)){ |
|
| 116 | - return $this->cache->get($identifier); |
|
| 117 | - } |
|
| 118 | - $object = $this->loader->load($fqcn, $arguments); |
|
| 119 | - $this->cache->add($object, $identifier); |
|
| 120 | - return $object; |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * empties cache and calls reset() on loader if method exists |
|
| 127 | - */ |
|
| 128 | - public function reset() |
|
| 129 | - { |
|
| 130 | - $this->cache->detachAll(); |
|
| 131 | - $this->loader->reset(); |
|
| 132 | - } |
|
| 25 | + /** |
|
| 26 | + * @var CollectionInterface $cache |
|
| 27 | + */ |
|
| 28 | + protected $cache; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var string $identifier |
|
| 32 | + */ |
|
| 33 | + protected $identifier; |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * CachingLoader constructor. |
|
| 39 | + * |
|
| 40 | + * @param LoaderInterface $loader |
|
| 41 | + * @param CollectionInterface $cache |
|
| 42 | + * @param string $identifier |
|
| 43 | + * @throws InvalidDataTypeException |
|
| 44 | + */ |
|
| 45 | + public function __construct(LoaderInterface $loader, CollectionInterface $cache, $identifier = '') |
|
| 46 | + { |
|
| 47 | + parent::__construct($loader); |
|
| 48 | + $this->cache = $cache; |
|
| 49 | + $this->setIdentifier($identifier); |
|
| 50 | + if ($this->identifier !== '') { |
|
| 51 | + // to only clear this cache, and assuming an identifier has been set, simply do the following: |
|
| 52 | + // do_action('AHEE__EventEspresso\core\services\loaders\CachingLoader__resetCache__IDENTIFIER'); |
|
| 53 | + // where "IDENTIFIER" = the string that was set during construction |
|
| 54 | + add_action( |
|
| 55 | + "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}", |
|
| 56 | + array($this, 'reset') |
|
| 57 | + ); |
|
| 58 | + } |
|
| 59 | + // to clear ALL caches, simply do the following: |
|
| 60 | + // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache'); |
|
| 61 | + add_action( |
|
| 62 | + 'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache', |
|
| 63 | + array($this, 'reset') |
|
| 64 | + ); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * @return string |
|
| 71 | + */ |
|
| 72 | + public function identifier() |
|
| 73 | + { |
|
| 74 | + return $this->identifier; |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * @param string $identifier |
|
| 81 | + * @throws InvalidDataTypeException |
|
| 82 | + */ |
|
| 83 | + private function setIdentifier($identifier) |
|
| 84 | + { |
|
| 85 | + if ( ! is_string($identifier)) { |
|
| 86 | + throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
|
| 87 | + } |
|
| 88 | + $this->identifier = $identifier; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * @param string $fqcn |
|
| 95 | + * @param array $arguments |
|
| 96 | + * @return mixed |
|
| 97 | + * @throws InvalidEntityException |
|
| 98 | + * @throws ServiceNotFoundException |
|
| 99 | + */ |
|
| 100 | + public function load($fqcn, $arguments = array()) |
|
| 101 | + { |
|
| 102 | + $fqcn = ltrim($fqcn, '\\'); |
|
| 103 | + // caching can be turned off via the following code: |
|
| 104 | + // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
| 105 | + if( |
|
| 106 | + apply_filters( |
|
| 107 | + 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
|
| 108 | + false, |
|
| 109 | + $this |
|
| 110 | + ) |
|
| 111 | + ){ |
|
| 112 | + return $this->loader->load($fqcn, $arguments); |
|
| 113 | + } |
|
| 114 | + $identifier = md5($fqcn . serialize($arguments)); |
|
| 115 | + if($this->cache->has($identifier)){ |
|
| 116 | + return $this->cache->get($identifier); |
|
| 117 | + } |
|
| 118 | + $object = $this->loader->load($fqcn, $arguments); |
|
| 119 | + $this->cache->add($object, $identifier); |
|
| 120 | + return $object; |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * empties cache and calls reset() on loader if method exists |
|
| 127 | + */ |
|
| 128 | + public function reset() |
|
| 129 | + { |
|
| 130 | + $this->cache->detachAll(); |
|
| 131 | + $this->loader->reset(); |
|
| 132 | + } |
|
| 133 | 133 | |
| 134 | 134 | |
| 135 | 135 | } |
@@ -9,19 +9,19 @@ |
||
| 9 | 9 | interface LoaderInterface |
| 10 | 10 | { |
| 11 | 11 | |
| 12 | - /** |
|
| 13 | - * @param string $fqcn |
|
| 14 | - * @param array $arguments |
|
| 15 | - * @return mixed |
|
| 16 | - */ |
|
| 17 | - public function load($fqcn, $arguments = array()); |
|
| 12 | + /** |
|
| 13 | + * @param string $fqcn |
|
| 14 | + * @param array $arguments |
|
| 15 | + * @return mixed |
|
| 16 | + */ |
|
| 17 | + public function load($fqcn, $arguments = array()); |
|
| 18 | 18 | |
| 19 | 19 | |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * calls reset() on loader if method exists |
|
| 23 | - */ |
|
| 24 | - public function reset(); |
|
| 21 | + /** |
|
| 22 | + * calls reset() on loader if method exists |
|
| 23 | + */ |
|
| 24 | + public function reset(); |
|
| 25 | 25 | |
| 26 | 26 | } |
| 27 | 27 | // End of file LoaderInterface.php |
@@ -1,5 +1,5 @@ discard block |
||
| 1 | 1 | <?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
| 2 | - exit('No direct script access allowed'); |
|
| 2 | + exit('No direct script access allowed'); |
|
| 3 | 3 | } |
| 4 | 4 | |
| 5 | 5 | |
@@ -19,1048 +19,1048 @@ discard block |
||
| 19 | 19 | { |
| 20 | 20 | |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * possibly truncated version of the EE core version string |
|
| 24 | - * |
|
| 25 | - * @var string |
|
| 26 | - */ |
|
| 27 | - protected static $_core_version = ''; |
|
| 22 | + /** |
|
| 23 | + * possibly truncated version of the EE core version string |
|
| 24 | + * |
|
| 25 | + * @var string |
|
| 26 | + */ |
|
| 27 | + protected static $_core_version = ''; |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Holds values for registered addons |
|
| 31 | - * |
|
| 32 | - * @var array |
|
| 33 | - */ |
|
| 34 | - protected static $_settings = array(); |
|
| 29 | + /** |
|
| 30 | + * Holds values for registered addons |
|
| 31 | + * |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 34 | + protected static $_settings = array(); |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var array $_incompatible_addons keys are addon SLUGS |
|
| 38 | - * (first argument passed to EE_Register_Addon::register()), keys are |
|
| 39 | - * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004). |
|
| 40 | - * Generally this should be used sparingly, as we don't want to muddle up |
|
| 41 | - * EE core with knowledge of ALL the addons out there. |
|
| 42 | - * If you want NO versions of an addon to run with a certain version of core, |
|
| 43 | - * it's usually best to define the addon's "min_core_version" as part of its call |
|
| 44 | - * to EE_Register_Addon::register(), rather than using this array with a super high value for its |
|
| 45 | - * minimum plugin version. |
|
| 46 | - * @access protected |
|
| 47 | - */ |
|
| 48 | - protected static $_incompatible_addons = array( |
|
| 49 | - 'Multi_Event_Registration' => '2.0.11.rc.002', |
|
| 50 | - 'Promotions' => '1.0.0.rc.084', |
|
| 51 | - ); |
|
| 36 | + /** |
|
| 37 | + * @var array $_incompatible_addons keys are addon SLUGS |
|
| 38 | + * (first argument passed to EE_Register_Addon::register()), keys are |
|
| 39 | + * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004). |
|
| 40 | + * Generally this should be used sparingly, as we don't want to muddle up |
|
| 41 | + * EE core with knowledge of ALL the addons out there. |
|
| 42 | + * If you want NO versions of an addon to run with a certain version of core, |
|
| 43 | + * it's usually best to define the addon's "min_core_version" as part of its call |
|
| 44 | + * to EE_Register_Addon::register(), rather than using this array with a super high value for its |
|
| 45 | + * minimum plugin version. |
|
| 46 | + * @access protected |
|
| 47 | + */ |
|
| 48 | + protected static $_incompatible_addons = array( |
|
| 49 | + 'Multi_Event_Registration' => '2.0.11.rc.002', |
|
| 50 | + 'Promotions' => '1.0.0.rc.084', |
|
| 51 | + ); |
|
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * We should always be comparing core to a version like '4.3.0.rc.000', |
|
| 56 | - * not just '4.3.0'. |
|
| 57 | - * So if the addon developer doesn't provide that full version string, |
|
| 58 | - * fill in the blanks for them |
|
| 59 | - * |
|
| 60 | - * @param string $min_core_version |
|
| 61 | - * @return string always like '4.3.0.rc.000' |
|
| 62 | - */ |
|
| 63 | - protected static function _effective_version($min_core_version) |
|
| 64 | - { |
|
| 65 | - // versions: 4 . 3 . 1 . p . 123 |
|
| 66 | - // offsets: 0 . 1 . 2 . 3 . 4 |
|
| 67 | - $version_parts = explode('.', $min_core_version); |
|
| 68 | - //check they specified the micro version (after 2nd period) |
|
| 69 | - if (! isset($version_parts[2])) { |
|
| 70 | - $version_parts[2] = '0'; |
|
| 71 | - } |
|
| 72 | - //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible |
|
| 73 | - //soon we can assume that's 'rc', but this current version is 'alpha' |
|
| 74 | - if (! isset($version_parts[3])) { |
|
| 75 | - $version_parts[3] = 'dev'; |
|
| 76 | - } |
|
| 77 | - if (! isset($version_parts[4])) { |
|
| 78 | - $version_parts[4] = '000'; |
|
| 79 | - } |
|
| 80 | - return implode('.', $version_parts); |
|
| 81 | - } |
|
| 54 | + /** |
|
| 55 | + * We should always be comparing core to a version like '4.3.0.rc.000', |
|
| 56 | + * not just '4.3.0'. |
|
| 57 | + * So if the addon developer doesn't provide that full version string, |
|
| 58 | + * fill in the blanks for them |
|
| 59 | + * |
|
| 60 | + * @param string $min_core_version |
|
| 61 | + * @return string always like '4.3.0.rc.000' |
|
| 62 | + */ |
|
| 63 | + protected static function _effective_version($min_core_version) |
|
| 64 | + { |
|
| 65 | + // versions: 4 . 3 . 1 . p . 123 |
|
| 66 | + // offsets: 0 . 1 . 2 . 3 . 4 |
|
| 67 | + $version_parts = explode('.', $min_core_version); |
|
| 68 | + //check they specified the micro version (after 2nd period) |
|
| 69 | + if (! isset($version_parts[2])) { |
|
| 70 | + $version_parts[2] = '0'; |
|
| 71 | + } |
|
| 72 | + //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible |
|
| 73 | + //soon we can assume that's 'rc', but this current version is 'alpha' |
|
| 74 | + if (! isset($version_parts[3])) { |
|
| 75 | + $version_parts[3] = 'dev'; |
|
| 76 | + } |
|
| 77 | + if (! isset($version_parts[4])) { |
|
| 78 | + $version_parts[4] = '000'; |
|
| 79 | + } |
|
| 80 | + return implode('.', $version_parts); |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Returns whether or not the min core version requirement of the addon is met |
|
| 86 | - * |
|
| 87 | - * @param string $min_core_version the minimum core version required by the addon |
|
| 88 | - * @param string $actual_core_version the actual core version, optional |
|
| 89 | - * @return boolean |
|
| 90 | - */ |
|
| 91 | - public static function _meets_min_core_version_requirement( |
|
| 92 | - $min_core_version, |
|
| 93 | - $actual_core_version = EVENT_ESPRESSO_VERSION |
|
| 94 | - ) { |
|
| 95 | - return version_compare( |
|
| 96 | - self::_effective_version($actual_core_version), |
|
| 97 | - self::_effective_version($min_core_version), |
|
| 98 | - '>=' |
|
| 99 | - ); |
|
| 100 | - } |
|
| 84 | + /** |
|
| 85 | + * Returns whether or not the min core version requirement of the addon is met |
|
| 86 | + * |
|
| 87 | + * @param string $min_core_version the minimum core version required by the addon |
|
| 88 | + * @param string $actual_core_version the actual core version, optional |
|
| 89 | + * @return boolean |
|
| 90 | + */ |
|
| 91 | + public static function _meets_min_core_version_requirement( |
|
| 92 | + $min_core_version, |
|
| 93 | + $actual_core_version = EVENT_ESPRESSO_VERSION |
|
| 94 | + ) { |
|
| 95 | + return version_compare( |
|
| 96 | + self::_effective_version($actual_core_version), |
|
| 97 | + self::_effective_version($min_core_version), |
|
| 98 | + '>=' |
|
| 99 | + ); |
|
| 100 | + } |
|
| 101 | 101 | |
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Method for registering new EE_Addons. |
|
| 105 | - * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE |
|
| 106 | - * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it |
|
| 107 | - * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon |
|
| 108 | - * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after |
|
| 109 | - * 'activate_plugin', it registers the addon still, but its components are not registered |
|
| 110 | - * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do |
|
| 111 | - * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns |
|
| 112 | - * (so that we can detect that the addon has activated on the subsequent request) |
|
| 113 | - * |
|
| 114 | - * @since 4.3.0 |
|
| 115 | - * @param string $addon_name the EE_Addon's name. Required. |
|
| 116 | - * @param array $setup_args { An |
|
| 117 | - * array of arguments provided for registering |
|
| 118 | - * the message type. |
|
| 119 | - * @type string $class_name the addon's main file name. |
|
| 120 | - * If left blank, generated from the addon |
|
| 121 | - * name, changes something like "calendar" to |
|
| 122 | - * "EE_Calendar" |
|
| 123 | - * @type string $min_core_version the minimum version of EE Core that the |
|
| 124 | - * addon will work with. eg "4.8.1.rc.084" |
|
| 125 | - * @type string $version the "software" version for the addon. eg |
|
| 126 | - * "1.0.0.p" for a first stable release, or "1.0.0.rc.043" for a version in progress |
|
| 127 | - * @type string $main_file_path the full server path to the main file |
|
| 128 | - * loaded |
|
| 129 | - * directly by WP |
|
| 130 | - * @type string $admin_path full server path to the folder where the |
|
| 131 | - * addon\'s admin files reside |
|
| 132 | - * @type string $admin_callback a method to be called when the EE Admin is |
|
| 133 | - * first invoked, can be used for hooking into any admin page |
|
| 134 | - * @type string $config_section the section name for this addon's |
|
| 135 | - * configuration settings section (defaults to "addons") |
|
| 136 | - * @type string $config_class the class name for this addon's |
|
| 137 | - * configuration settings object |
|
| 138 | - * @type string $config_name the class name for this addon's |
|
| 139 | - * configuration settings object |
|
| 140 | - * @type string $autoloader_paths an array of class names and the full server |
|
| 141 | - * paths to those files. Required. |
|
| 142 | - * @type string $autoloader_folders an array of "full server paths" for any |
|
| 143 | - * folders containing classes that might be invoked by the addon |
|
| 144 | - * @type string $dms_paths an array of full server paths to folders |
|
| 145 | - * that contain data migration scripts. Required. |
|
| 146 | - * @type string $module_paths an array of full server paths to any |
|
| 147 | - * EED_Modules used by the addon |
|
| 148 | - * @type string $shortcode_paths an array of full server paths to folders |
|
| 149 | - * that contain EES_Shortcodes |
|
| 150 | - * @type string $widget_paths an array of full server paths to folders |
|
| 151 | - * that contain WP_Widgets |
|
| 152 | - * @type string $pue_options |
|
| 153 | - * @type array $capabilities an array indexed by role name |
|
| 154 | - * (i.e administrator,author ) and the values |
|
| 155 | - * are an array of caps to add to the role. |
|
| 156 | - * 'administrator' => array( |
|
| 157 | - * 'read_addon', 'edit_addon', etc. |
|
| 158 | - * ). |
|
| 159 | - * @type EE_Meta_Capability_Map[] $capability_maps an array of EE_Meta_Capability_Map object |
|
| 160 | - * for any addons that need to register any special meta mapped capabilities. Should be indexed where the |
|
| 161 | - * key is the EE_Meta_Capability_Map class name and the values are the arguments sent to the class. |
|
| 162 | - * @type array $model_paths array of folders containing DB models |
|
| 163 | - * @see EE_Register_Model |
|
| 164 | - * @type array $class_paths array of folders containing DB classes |
|
| 165 | - * @see EE_Register_Model |
|
| 166 | - * @type array $model_extension_paths array of folders containing DB model |
|
| 167 | - * extensions |
|
| 168 | - * @see EE_Register_Model_Extension |
|
| 169 | - * @type array $class_extension_paths array of folders containing DB class |
|
| 170 | - * extensions |
|
| 171 | - * @see EE_Register_Model_Extension |
|
| 172 | - * @type array message_types { |
|
| 173 | - * An array of message types with the key as |
|
| 174 | - * the message type name and the values as |
|
| 175 | - * below: |
|
| 176 | - * @type string $mtfilename The filename of the message type being |
|
| 177 | - * registered. This will be the main EE_{Messagetype_Name}_message_type class. |
|
| 178 | - * (eg. |
|
| 179 | - * EE_Declined_Registration_message_type.class.php) |
|
| 180 | - * Required. |
|
| 181 | - * @type array $autoloadpaths An array of paths to add to the messages |
|
| 182 | - * autoloader for the new message type. |
|
| 183 | - * Required. |
|
| 184 | - * @type array $messengers_to_activate_with An array of messengers that this message |
|
| 185 | - * type should activate with. Each value in |
|
| 186 | - * the |
|
| 187 | - * array |
|
| 188 | - * should match the name property of a |
|
| 189 | - * EE_messenger. Optional. |
|
| 190 | - * @type array $messengers_to_validate_with An array of messengers that this message |
|
| 191 | - * type should validate with. Each value in |
|
| 192 | - * the |
|
| 193 | - * array |
|
| 194 | - * should match the name property of an |
|
| 195 | - * EE_messenger. |
|
| 196 | - * Optional. |
|
| 197 | - * } |
|
| 198 | - * @type array $custom_post_types |
|
| 199 | - * @type array $custom_taxonomies |
|
| 200 | - * @type array $payment_method_paths each element is the folder containing the |
|
| 201 | - * EE_PMT_Base child class |
|
| 202 | - * (eg, |
|
| 203 | - * '/wp-content/plugins/my_plugin/Payomatic/' |
|
| 204 | - * which contains the files |
|
| 205 | - * EE_PMT_Payomatic.pm.php) |
|
| 206 | - * @type array $default_terms |
|
| 207 | - * @type array $namespace { |
|
| 208 | - * An array with two items for registering the |
|
| 209 | - * addon's namespace. (If, for some reason, |
|
| 210 | - * you |
|
| 211 | - * require additional namespaces, use |
|
| 212 | - * EventEspresso\core\Psr4Autoloader::addNamespace() |
|
| 213 | - * directly) |
|
| 214 | - * @see EventEspresso\core\Psr4Autoloader::addNamespace() |
|
| 215 | - * @type string $FQNS the namespace prefix |
|
| 216 | - * @type string $DIR a base directory for class files in the |
|
| 217 | - * namespace. |
|
| 218 | - * } |
|
| 219 | - * } |
|
| 220 | - * @throws EE_Error |
|
| 221 | - * @return void |
|
| 222 | - */ |
|
| 223 | - public static function register($addon_name = '', $setup_args = array()) |
|
| 224 | - { |
|
| 225 | - // required fields MUST be present, so let's make sure they are. |
|
| 226 | - \EE_Register_Addon::_verify_parameters($addon_name, $setup_args); |
|
| 227 | - // get class name for addon |
|
| 228 | - $class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args); |
|
| 229 | - //setup $_settings array from incoming values. |
|
| 230 | - $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args); |
|
| 231 | - // setup PUE |
|
| 232 | - \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args); |
|
| 233 | - // does this addon work with this version of core or WordPress ? |
|
| 234 | - if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) { |
|
| 235 | - return; |
|
| 236 | - } |
|
| 237 | - // register namespaces |
|
| 238 | - \EE_Register_Addon::_setup_namespaces($addon_settings); |
|
| 239 | - // check if this is an activation request |
|
| 240 | - if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) { |
|
| 241 | - // dont bother setting up the rest of the addon atm |
|
| 242 | - return; |
|
| 243 | - } |
|
| 244 | - // we need cars |
|
| 245 | - \EE_Register_Addon::_setup_autoloaders($addon_name); |
|
| 246 | - // register new models and extensions |
|
| 247 | - \EE_Register_Addon::_register_models_and_extensions($addon_name); |
|
| 248 | - // setup DMS |
|
| 249 | - \EE_Register_Addon::_register_data_migration_scripts($addon_name); |
|
| 250 | - // if config_class is present let's register config. |
|
| 251 | - \EE_Register_Addon::_register_config($addon_name); |
|
| 252 | - // register admin pages |
|
| 253 | - \EE_Register_Addon::_register_admin_pages($addon_name); |
|
| 254 | - // add to list of modules to be registered |
|
| 255 | - \EE_Register_Addon::_register_modules($addon_name); |
|
| 256 | - // add to list of shortcodes to be registered |
|
| 257 | - \EE_Register_Addon::_register_shortcodes($addon_name); |
|
| 258 | - // add to list of widgets to be registered |
|
| 259 | - \EE_Register_Addon::_register_widgets($addon_name); |
|
| 260 | - // register capability related stuff. |
|
| 261 | - \EE_Register_Addon::_register_capabilities($addon_name); |
|
| 262 | - // any message type to register? |
|
| 263 | - \EE_Register_Addon::_register_message_types($addon_name); |
|
| 264 | - // any custom post type/ custom capabilities or default terms to register |
|
| 265 | - \EE_Register_Addon::_register_custom_post_types($addon_name); |
|
| 266 | - // and any payment methods |
|
| 267 | - \EE_Register_Addon::_register_payment_methods($addon_name); |
|
| 268 | - // load and instantiate main addon class |
|
| 269 | - $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name); |
|
| 270 | - $addon->after_registration(); |
|
| 271 | - } |
|
| 103 | + /** |
|
| 104 | + * Method for registering new EE_Addons. |
|
| 105 | + * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE |
|
| 106 | + * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it |
|
| 107 | + * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon |
|
| 108 | + * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after |
|
| 109 | + * 'activate_plugin', it registers the addon still, but its components are not registered |
|
| 110 | + * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do |
|
| 111 | + * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns |
|
| 112 | + * (so that we can detect that the addon has activated on the subsequent request) |
|
| 113 | + * |
|
| 114 | + * @since 4.3.0 |
|
| 115 | + * @param string $addon_name the EE_Addon's name. Required. |
|
| 116 | + * @param array $setup_args { An |
|
| 117 | + * array of arguments provided for registering |
|
| 118 | + * the message type. |
|
| 119 | + * @type string $class_name the addon's main file name. |
|
| 120 | + * If left blank, generated from the addon |
|
| 121 | + * name, changes something like "calendar" to |
|
| 122 | + * "EE_Calendar" |
|
| 123 | + * @type string $min_core_version the minimum version of EE Core that the |
|
| 124 | + * addon will work with. eg "4.8.1.rc.084" |
|
| 125 | + * @type string $version the "software" version for the addon. eg |
|
| 126 | + * "1.0.0.p" for a first stable release, or "1.0.0.rc.043" for a version in progress |
|
| 127 | + * @type string $main_file_path the full server path to the main file |
|
| 128 | + * loaded |
|
| 129 | + * directly by WP |
|
| 130 | + * @type string $admin_path full server path to the folder where the |
|
| 131 | + * addon\'s admin files reside |
|
| 132 | + * @type string $admin_callback a method to be called when the EE Admin is |
|
| 133 | + * first invoked, can be used for hooking into any admin page |
|
| 134 | + * @type string $config_section the section name for this addon's |
|
| 135 | + * configuration settings section (defaults to "addons") |
|
| 136 | + * @type string $config_class the class name for this addon's |
|
| 137 | + * configuration settings object |
|
| 138 | + * @type string $config_name the class name for this addon's |
|
| 139 | + * configuration settings object |
|
| 140 | + * @type string $autoloader_paths an array of class names and the full server |
|
| 141 | + * paths to those files. Required. |
|
| 142 | + * @type string $autoloader_folders an array of "full server paths" for any |
|
| 143 | + * folders containing classes that might be invoked by the addon |
|
| 144 | + * @type string $dms_paths an array of full server paths to folders |
|
| 145 | + * that contain data migration scripts. Required. |
|
| 146 | + * @type string $module_paths an array of full server paths to any |
|
| 147 | + * EED_Modules used by the addon |
|
| 148 | + * @type string $shortcode_paths an array of full server paths to folders |
|
| 149 | + * that contain EES_Shortcodes |
|
| 150 | + * @type string $widget_paths an array of full server paths to folders |
|
| 151 | + * that contain WP_Widgets |
|
| 152 | + * @type string $pue_options |
|
| 153 | + * @type array $capabilities an array indexed by role name |
|
| 154 | + * (i.e administrator,author ) and the values |
|
| 155 | + * are an array of caps to add to the role. |
|
| 156 | + * 'administrator' => array( |
|
| 157 | + * 'read_addon', 'edit_addon', etc. |
|
| 158 | + * ). |
|
| 159 | + * @type EE_Meta_Capability_Map[] $capability_maps an array of EE_Meta_Capability_Map object |
|
| 160 | + * for any addons that need to register any special meta mapped capabilities. Should be indexed where the |
|
| 161 | + * key is the EE_Meta_Capability_Map class name and the values are the arguments sent to the class. |
|
| 162 | + * @type array $model_paths array of folders containing DB models |
|
| 163 | + * @see EE_Register_Model |
|
| 164 | + * @type array $class_paths array of folders containing DB classes |
|
| 165 | + * @see EE_Register_Model |
|
| 166 | + * @type array $model_extension_paths array of folders containing DB model |
|
| 167 | + * extensions |
|
| 168 | + * @see EE_Register_Model_Extension |
|
| 169 | + * @type array $class_extension_paths array of folders containing DB class |
|
| 170 | + * extensions |
|
| 171 | + * @see EE_Register_Model_Extension |
|
| 172 | + * @type array message_types { |
|
| 173 | + * An array of message types with the key as |
|
| 174 | + * the message type name and the values as |
|
| 175 | + * below: |
|
| 176 | + * @type string $mtfilename The filename of the message type being |
|
| 177 | + * registered. This will be the main EE_{Messagetype_Name}_message_type class. |
|
| 178 | + * (eg. |
|
| 179 | + * EE_Declined_Registration_message_type.class.php) |
|
| 180 | + * Required. |
|
| 181 | + * @type array $autoloadpaths An array of paths to add to the messages |
|
| 182 | + * autoloader for the new message type. |
|
| 183 | + * Required. |
|
| 184 | + * @type array $messengers_to_activate_with An array of messengers that this message |
|
| 185 | + * type should activate with. Each value in |
|
| 186 | + * the |
|
| 187 | + * array |
|
| 188 | + * should match the name property of a |
|
| 189 | + * EE_messenger. Optional. |
|
| 190 | + * @type array $messengers_to_validate_with An array of messengers that this message |
|
| 191 | + * type should validate with. Each value in |
|
| 192 | + * the |
|
| 193 | + * array |
|
| 194 | + * should match the name property of an |
|
| 195 | + * EE_messenger. |
|
| 196 | + * Optional. |
|
| 197 | + * } |
|
| 198 | + * @type array $custom_post_types |
|
| 199 | + * @type array $custom_taxonomies |
|
| 200 | + * @type array $payment_method_paths each element is the folder containing the |
|
| 201 | + * EE_PMT_Base child class |
|
| 202 | + * (eg, |
|
| 203 | + * '/wp-content/plugins/my_plugin/Payomatic/' |
|
| 204 | + * which contains the files |
|
| 205 | + * EE_PMT_Payomatic.pm.php) |
|
| 206 | + * @type array $default_terms |
|
| 207 | + * @type array $namespace { |
|
| 208 | + * An array with two items for registering the |
|
| 209 | + * addon's namespace. (If, for some reason, |
|
| 210 | + * you |
|
| 211 | + * require additional namespaces, use |
|
| 212 | + * EventEspresso\core\Psr4Autoloader::addNamespace() |
|
| 213 | + * directly) |
|
| 214 | + * @see EventEspresso\core\Psr4Autoloader::addNamespace() |
|
| 215 | + * @type string $FQNS the namespace prefix |
|
| 216 | + * @type string $DIR a base directory for class files in the |
|
| 217 | + * namespace. |
|
| 218 | + * } |
|
| 219 | + * } |
|
| 220 | + * @throws EE_Error |
|
| 221 | + * @return void |
|
| 222 | + */ |
|
| 223 | + public static function register($addon_name = '', $setup_args = array()) |
|
| 224 | + { |
|
| 225 | + // required fields MUST be present, so let's make sure they are. |
|
| 226 | + \EE_Register_Addon::_verify_parameters($addon_name, $setup_args); |
|
| 227 | + // get class name for addon |
|
| 228 | + $class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args); |
|
| 229 | + //setup $_settings array from incoming values. |
|
| 230 | + $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args); |
|
| 231 | + // setup PUE |
|
| 232 | + \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args); |
|
| 233 | + // does this addon work with this version of core or WordPress ? |
|
| 234 | + if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) { |
|
| 235 | + return; |
|
| 236 | + } |
|
| 237 | + // register namespaces |
|
| 238 | + \EE_Register_Addon::_setup_namespaces($addon_settings); |
|
| 239 | + // check if this is an activation request |
|
| 240 | + if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) { |
|
| 241 | + // dont bother setting up the rest of the addon atm |
|
| 242 | + return; |
|
| 243 | + } |
|
| 244 | + // we need cars |
|
| 245 | + \EE_Register_Addon::_setup_autoloaders($addon_name); |
|
| 246 | + // register new models and extensions |
|
| 247 | + \EE_Register_Addon::_register_models_and_extensions($addon_name); |
|
| 248 | + // setup DMS |
|
| 249 | + \EE_Register_Addon::_register_data_migration_scripts($addon_name); |
|
| 250 | + // if config_class is present let's register config. |
|
| 251 | + \EE_Register_Addon::_register_config($addon_name); |
|
| 252 | + // register admin pages |
|
| 253 | + \EE_Register_Addon::_register_admin_pages($addon_name); |
|
| 254 | + // add to list of modules to be registered |
|
| 255 | + \EE_Register_Addon::_register_modules($addon_name); |
|
| 256 | + // add to list of shortcodes to be registered |
|
| 257 | + \EE_Register_Addon::_register_shortcodes($addon_name); |
|
| 258 | + // add to list of widgets to be registered |
|
| 259 | + \EE_Register_Addon::_register_widgets($addon_name); |
|
| 260 | + // register capability related stuff. |
|
| 261 | + \EE_Register_Addon::_register_capabilities($addon_name); |
|
| 262 | + // any message type to register? |
|
| 263 | + \EE_Register_Addon::_register_message_types($addon_name); |
|
| 264 | + // any custom post type/ custom capabilities or default terms to register |
|
| 265 | + \EE_Register_Addon::_register_custom_post_types($addon_name); |
|
| 266 | + // and any payment methods |
|
| 267 | + \EE_Register_Addon::_register_payment_methods($addon_name); |
|
| 268 | + // load and instantiate main addon class |
|
| 269 | + $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name); |
|
| 270 | + $addon->after_registration(); |
|
| 271 | + } |
|
| 272 | 272 | |
| 273 | 273 | |
| 274 | - /** |
|
| 275 | - * @param string $addon_name |
|
| 276 | - * @param array $setup_args |
|
| 277 | - * @return void |
|
| 278 | - * @throws \EE_Error |
|
| 279 | - */ |
|
| 280 | - private static function _verify_parameters($addon_name, array $setup_args) |
|
| 281 | - { |
|
| 282 | - // required fields MUST be present, so let's make sure they are. |
|
| 283 | - if (empty($addon_name) || ! is_array($setup_args)) { |
|
| 284 | - throw new EE_Error( |
|
| 285 | - __( |
|
| 286 | - 'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.', |
|
| 287 | - 'event_espresso' |
|
| 288 | - ) |
|
| 289 | - ); |
|
| 290 | - } |
|
| 291 | - if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) { |
|
| 292 | - throw new EE_Error( |
|
| 293 | - sprintf( |
|
| 294 | - __( |
|
| 295 | - 'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s', |
|
| 296 | - 'event_espresso' |
|
| 297 | - ), |
|
| 298 | - implode(',', array_keys($setup_args)) |
|
| 299 | - ) |
|
| 300 | - ); |
|
| 301 | - } |
|
| 302 | - // check that addon has not already been registered with that name |
|
| 303 | - if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) { |
|
| 304 | - throw new EE_Error( |
|
| 305 | - sprintf( |
|
| 306 | - __( |
|
| 307 | - 'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.', |
|
| 308 | - 'event_espresso' |
|
| 309 | - ), |
|
| 310 | - $addon_name |
|
| 311 | - ) |
|
| 312 | - ); |
|
| 313 | - } |
|
| 314 | - } |
|
| 274 | + /** |
|
| 275 | + * @param string $addon_name |
|
| 276 | + * @param array $setup_args |
|
| 277 | + * @return void |
|
| 278 | + * @throws \EE_Error |
|
| 279 | + */ |
|
| 280 | + private static function _verify_parameters($addon_name, array $setup_args) |
|
| 281 | + { |
|
| 282 | + // required fields MUST be present, so let's make sure they are. |
|
| 283 | + if (empty($addon_name) || ! is_array($setup_args)) { |
|
| 284 | + throw new EE_Error( |
|
| 285 | + __( |
|
| 286 | + 'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.', |
|
| 287 | + 'event_espresso' |
|
| 288 | + ) |
|
| 289 | + ); |
|
| 290 | + } |
|
| 291 | + if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) { |
|
| 292 | + throw new EE_Error( |
|
| 293 | + sprintf( |
|
| 294 | + __( |
|
| 295 | + 'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s', |
|
| 296 | + 'event_espresso' |
|
| 297 | + ), |
|
| 298 | + implode(',', array_keys($setup_args)) |
|
| 299 | + ) |
|
| 300 | + ); |
|
| 301 | + } |
|
| 302 | + // check that addon has not already been registered with that name |
|
| 303 | + if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) { |
|
| 304 | + throw new EE_Error( |
|
| 305 | + sprintf( |
|
| 306 | + __( |
|
| 307 | + 'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.', |
|
| 308 | + 'event_espresso' |
|
| 309 | + ), |
|
| 310 | + $addon_name |
|
| 311 | + ) |
|
| 312 | + ); |
|
| 313 | + } |
|
| 314 | + } |
|
| 315 | 315 | |
| 316 | 316 | |
| 317 | - /** |
|
| 318 | - * @param string $addon_name |
|
| 319 | - * @param array $setup_args |
|
| 320 | - * @return string |
|
| 321 | - */ |
|
| 322 | - private static function _parse_class_name($addon_name, array $setup_args) |
|
| 323 | - { |
|
| 324 | - if (empty($setup_args['class_name'])) { |
|
| 325 | - // generate one by first separating name with spaces |
|
| 326 | - $class_name = str_replace(array('-', '_'), ' ', trim($addon_name)); |
|
| 327 | - //capitalize, then replace spaces with underscores |
|
| 328 | - $class_name = str_replace(' ', '_', ucwords($class_name)); |
|
| 329 | - } else { |
|
| 330 | - $class_name = $setup_args['class_name']; |
|
| 331 | - } |
|
| 332 | - return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name; |
|
| 333 | - } |
|
| 317 | + /** |
|
| 318 | + * @param string $addon_name |
|
| 319 | + * @param array $setup_args |
|
| 320 | + * @return string |
|
| 321 | + */ |
|
| 322 | + private static function _parse_class_name($addon_name, array $setup_args) |
|
| 323 | + { |
|
| 324 | + if (empty($setup_args['class_name'])) { |
|
| 325 | + // generate one by first separating name with spaces |
|
| 326 | + $class_name = str_replace(array('-', '_'), ' ', trim($addon_name)); |
|
| 327 | + //capitalize, then replace spaces with underscores |
|
| 328 | + $class_name = str_replace(' ', '_', ucwords($class_name)); |
|
| 329 | + } else { |
|
| 330 | + $class_name = $setup_args['class_name']; |
|
| 331 | + } |
|
| 332 | + return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name; |
|
| 333 | + } |
|
| 334 | 334 | |
| 335 | 335 | |
| 336 | - /** |
|
| 337 | - * @param string $class_name |
|
| 338 | - * @param array $setup_args |
|
| 339 | - * @return array |
|
| 340 | - */ |
|
| 341 | - private static function _get_addon_settings($class_name, array $setup_args) |
|
| 342 | - { |
|
| 343 | - //setup $_settings array from incoming values. |
|
| 344 | - $addon_settings = array( |
|
| 345 | - // generated from the addon name, changes something like "calendar" to "EE_Calendar" |
|
| 346 | - 'class_name' => $class_name, |
|
| 347 | - // the addon slug for use in URLs, etc |
|
| 348 | - 'plugin_slug' => isset($setup_args['plugin_slug']) |
|
| 349 | - ? (string)$setup_args['plugin_slug'] |
|
| 350 | - : '', |
|
| 351 | - // page slug to be used when generating the "Settings" link on the WP plugin page |
|
| 352 | - 'plugin_action_slug' => isset($setup_args['plugin_action_slug']) |
|
| 353 | - ? (string)$setup_args['plugin_action_slug'] |
|
| 354 | - : '', |
|
| 355 | - // the "software" version for the addon |
|
| 356 | - 'version' => isset($setup_args['version']) |
|
| 357 | - ? (string)$setup_args['version'] |
|
| 358 | - : '', |
|
| 359 | - // the minimum version of EE Core that the addon will work with |
|
| 360 | - 'min_core_version' => isset($setup_args['min_core_version']) |
|
| 361 | - ? (string)$setup_args['min_core_version'] |
|
| 362 | - : '', |
|
| 363 | - // the minimum version of WordPress that the addon will work with |
|
| 364 | - 'min_wp_version' => isset($setup_args['min_wp_version']) |
|
| 365 | - ? (string)$setup_args['min_wp_version'] |
|
| 366 | - : EE_MIN_WP_VER_REQUIRED, |
|
| 367 | - // full server path to main file (file loaded directly by WP) |
|
| 368 | - 'main_file_path' => isset($setup_args['main_file_path']) |
|
| 369 | - ? (string)$setup_args['main_file_path'] |
|
| 370 | - : '', |
|
| 371 | - // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages |
|
| 372 | - 'admin_path' => isset($setup_args['admin_path']) |
|
| 373 | - ? (string)$setup_args['admin_path'] : '', |
|
| 374 | - // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page |
|
| 375 | - 'admin_callback' => isset($setup_args['admin_callback']) |
|
| 376 | - ? (string)$setup_args['admin_callback'] |
|
| 377 | - : '', |
|
| 378 | - // the section name for this addon's configuration settings section (defaults to "addons") |
|
| 379 | - 'config_section' => isset($setup_args['config_section']) |
|
| 380 | - ? (string)$setup_args['config_section'] |
|
| 381 | - : 'addons', |
|
| 382 | - // the class name for this addon's configuration settings object |
|
| 383 | - 'config_class' => isset($setup_args['config_class']) |
|
| 384 | - ? (string)$setup_args['config_class'] : '', |
|
| 385 | - //the name given to the config for this addons' configuration settings object (optional) |
|
| 386 | - 'config_name' => isset($setup_args['config_name']) |
|
| 387 | - ? (string)$setup_args['config_name'] : '', |
|
| 388 | - // an array of "class names" => "full server paths" for any classes that might be invoked by the addon |
|
| 389 | - 'autoloader_paths' => isset($setup_args['autoloader_paths']) |
|
| 390 | - ? (array)$setup_args['autoloader_paths'] |
|
| 391 | - : array(), |
|
| 392 | - // an array of "full server paths" for any folders containing classes that might be invoked by the addon |
|
| 393 | - 'autoloader_folders' => isset($setup_args['autoloader_folders']) |
|
| 394 | - ? (array)$setup_args['autoloader_folders'] |
|
| 395 | - : array(), |
|
| 396 | - // array of full server paths to any EE_DMS data migration scripts used by the addon |
|
| 397 | - 'dms_paths' => isset($setup_args['dms_paths']) |
|
| 398 | - ? (array)$setup_args['dms_paths'] |
|
| 399 | - : array(), |
|
| 400 | - // array of full server paths to any EED_Modules used by the addon |
|
| 401 | - 'module_paths' => isset($setup_args['module_paths']) |
|
| 402 | - ? (array)$setup_args['module_paths'] |
|
| 403 | - : array(), |
|
| 404 | - // array of full server paths to any EES_Shortcodes used by the addon |
|
| 405 | - 'shortcode_paths' => isset($setup_args['shortcode_paths']) |
|
| 406 | - ? (array)$setup_args['shortcode_paths'] |
|
| 407 | - : array(), |
|
| 408 | - // array of full server paths to any WP_Widgets used by the addon |
|
| 409 | - 'widget_paths' => isset($setup_args['widget_paths']) |
|
| 410 | - ? (array)$setup_args['widget_paths'] |
|
| 411 | - : array(), |
|
| 412 | - // array of PUE options used by the addon |
|
| 413 | - 'pue_options' => isset($setup_args['pue_options']) |
|
| 414 | - ? (array)$setup_args['pue_options'] |
|
| 415 | - : array(), |
|
| 416 | - 'message_types' => isset($setup_args['message_types']) |
|
| 417 | - ? (array)$setup_args['message_types'] |
|
| 418 | - : array(), |
|
| 419 | - 'capabilities' => isset($setup_args['capabilities']) |
|
| 420 | - ? (array)$setup_args['capabilities'] |
|
| 421 | - : array(), |
|
| 422 | - 'capability_maps' => isset($setup_args['capability_maps']) |
|
| 423 | - ? (array)$setup_args['capability_maps'] |
|
| 424 | - : array(), |
|
| 425 | - 'model_paths' => isset($setup_args['model_paths']) |
|
| 426 | - ? (array)$setup_args['model_paths'] |
|
| 427 | - : array(), |
|
| 428 | - 'class_paths' => isset($setup_args['class_paths']) |
|
| 429 | - ? (array)$setup_args['class_paths'] |
|
| 430 | - : array(), |
|
| 431 | - 'model_extension_paths' => isset($setup_args['model_extension_paths']) |
|
| 432 | - ? (array)$setup_args['model_extension_paths'] |
|
| 433 | - : array(), |
|
| 434 | - 'class_extension_paths' => isset($setup_args['class_extension_paths']) |
|
| 435 | - ? (array)$setup_args['class_extension_paths'] |
|
| 436 | - : array(), |
|
| 437 | - 'custom_post_types' => isset($setup_args['custom_post_types']) |
|
| 438 | - ? (array)$setup_args['custom_post_types'] |
|
| 439 | - : array(), |
|
| 440 | - 'custom_taxonomies' => isset($setup_args['custom_taxonomies']) |
|
| 441 | - ? (array)$setup_args['custom_taxonomies'] |
|
| 442 | - : array(), |
|
| 443 | - 'payment_method_paths' => isset($setup_args['payment_method_paths']) |
|
| 444 | - ? (array)$setup_args['payment_method_paths'] |
|
| 445 | - : array(), |
|
| 446 | - 'default_terms' => isset($setup_args['default_terms']) |
|
| 447 | - ? (array)$setup_args['default_terms'] |
|
| 448 | - : array(), |
|
| 449 | - // if not empty, inserts a new table row after this plugin's row on the WP Plugins page |
|
| 450 | - // that can be used for adding upgrading/marketing info |
|
| 451 | - 'plugins_page_row' => isset($setup_args['plugins_page_row']) |
|
| 452 | - ? $setup_args['plugins_page_row'] |
|
| 453 | - : '', |
|
| 454 | - 'namespace' => isset( |
|
| 455 | - $setup_args['namespace'], |
|
| 456 | - $setup_args['namespace']['FQNS'], |
|
| 457 | - $setup_args['namespace']['DIR'] |
|
| 458 | - ) |
|
| 459 | - ? (array)$setup_args['namespace'] |
|
| 460 | - : array(), |
|
| 461 | - ); |
|
| 462 | - // if plugin_action_slug is NOT set, but an admin page path IS set, |
|
| 463 | - // then let's just use the plugin_slug since that will be used for linking to the admin page |
|
| 464 | - $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug']) |
|
| 465 | - && ! empty($addon_settings['admin_path']) |
|
| 466 | - ? $addon_settings['plugin_slug'] |
|
| 467 | - : $addon_settings['plugin_action_slug']; |
|
| 468 | - // full server path to main file (file loaded directly by WP) |
|
| 469 | - $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']); |
|
| 470 | - return $addon_settings; |
|
| 471 | - } |
|
| 336 | + /** |
|
| 337 | + * @param string $class_name |
|
| 338 | + * @param array $setup_args |
|
| 339 | + * @return array |
|
| 340 | + */ |
|
| 341 | + private static function _get_addon_settings($class_name, array $setup_args) |
|
| 342 | + { |
|
| 343 | + //setup $_settings array from incoming values. |
|
| 344 | + $addon_settings = array( |
|
| 345 | + // generated from the addon name, changes something like "calendar" to "EE_Calendar" |
|
| 346 | + 'class_name' => $class_name, |
|
| 347 | + // the addon slug for use in URLs, etc |
|
| 348 | + 'plugin_slug' => isset($setup_args['plugin_slug']) |
|
| 349 | + ? (string)$setup_args['plugin_slug'] |
|
| 350 | + : '', |
|
| 351 | + // page slug to be used when generating the "Settings" link on the WP plugin page |
|
| 352 | + 'plugin_action_slug' => isset($setup_args['plugin_action_slug']) |
|
| 353 | + ? (string)$setup_args['plugin_action_slug'] |
|
| 354 | + : '', |
|
| 355 | + // the "software" version for the addon |
|
| 356 | + 'version' => isset($setup_args['version']) |
|
| 357 | + ? (string)$setup_args['version'] |
|
| 358 | + : '', |
|
| 359 | + // the minimum version of EE Core that the addon will work with |
|
| 360 | + 'min_core_version' => isset($setup_args['min_core_version']) |
|
| 361 | + ? (string)$setup_args['min_core_version'] |
|
| 362 | + : '', |
|
| 363 | + // the minimum version of WordPress that the addon will work with |
|
| 364 | + 'min_wp_version' => isset($setup_args['min_wp_version']) |
|
| 365 | + ? (string)$setup_args['min_wp_version'] |
|
| 366 | + : EE_MIN_WP_VER_REQUIRED, |
|
| 367 | + // full server path to main file (file loaded directly by WP) |
|
| 368 | + 'main_file_path' => isset($setup_args['main_file_path']) |
|
| 369 | + ? (string)$setup_args['main_file_path'] |
|
| 370 | + : '', |
|
| 371 | + // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages |
|
| 372 | + 'admin_path' => isset($setup_args['admin_path']) |
|
| 373 | + ? (string)$setup_args['admin_path'] : '', |
|
| 374 | + // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page |
|
| 375 | + 'admin_callback' => isset($setup_args['admin_callback']) |
|
| 376 | + ? (string)$setup_args['admin_callback'] |
|
| 377 | + : '', |
|
| 378 | + // the section name for this addon's configuration settings section (defaults to "addons") |
|
| 379 | + 'config_section' => isset($setup_args['config_section']) |
|
| 380 | + ? (string)$setup_args['config_section'] |
|
| 381 | + : 'addons', |
|
| 382 | + // the class name for this addon's configuration settings object |
|
| 383 | + 'config_class' => isset($setup_args['config_class']) |
|
| 384 | + ? (string)$setup_args['config_class'] : '', |
|
| 385 | + //the name given to the config for this addons' configuration settings object (optional) |
|
| 386 | + 'config_name' => isset($setup_args['config_name']) |
|
| 387 | + ? (string)$setup_args['config_name'] : '', |
|
| 388 | + // an array of "class names" => "full server paths" for any classes that might be invoked by the addon |
|
| 389 | + 'autoloader_paths' => isset($setup_args['autoloader_paths']) |
|
| 390 | + ? (array)$setup_args['autoloader_paths'] |
|
| 391 | + : array(), |
|
| 392 | + // an array of "full server paths" for any folders containing classes that might be invoked by the addon |
|
| 393 | + 'autoloader_folders' => isset($setup_args['autoloader_folders']) |
|
| 394 | + ? (array)$setup_args['autoloader_folders'] |
|
| 395 | + : array(), |
|
| 396 | + // array of full server paths to any EE_DMS data migration scripts used by the addon |
|
| 397 | + 'dms_paths' => isset($setup_args['dms_paths']) |
|
| 398 | + ? (array)$setup_args['dms_paths'] |
|
| 399 | + : array(), |
|
| 400 | + // array of full server paths to any EED_Modules used by the addon |
|
| 401 | + 'module_paths' => isset($setup_args['module_paths']) |
|
| 402 | + ? (array)$setup_args['module_paths'] |
|
| 403 | + : array(), |
|
| 404 | + // array of full server paths to any EES_Shortcodes used by the addon |
|
| 405 | + 'shortcode_paths' => isset($setup_args['shortcode_paths']) |
|
| 406 | + ? (array)$setup_args['shortcode_paths'] |
|
| 407 | + : array(), |
|
| 408 | + // array of full server paths to any WP_Widgets used by the addon |
|
| 409 | + 'widget_paths' => isset($setup_args['widget_paths']) |
|
| 410 | + ? (array)$setup_args['widget_paths'] |
|
| 411 | + : array(), |
|
| 412 | + // array of PUE options used by the addon |
|
| 413 | + 'pue_options' => isset($setup_args['pue_options']) |
|
| 414 | + ? (array)$setup_args['pue_options'] |
|
| 415 | + : array(), |
|
| 416 | + 'message_types' => isset($setup_args['message_types']) |
|
| 417 | + ? (array)$setup_args['message_types'] |
|
| 418 | + : array(), |
|
| 419 | + 'capabilities' => isset($setup_args['capabilities']) |
|
| 420 | + ? (array)$setup_args['capabilities'] |
|
| 421 | + : array(), |
|
| 422 | + 'capability_maps' => isset($setup_args['capability_maps']) |
|
| 423 | + ? (array)$setup_args['capability_maps'] |
|
| 424 | + : array(), |
|
| 425 | + 'model_paths' => isset($setup_args['model_paths']) |
|
| 426 | + ? (array)$setup_args['model_paths'] |
|
| 427 | + : array(), |
|
| 428 | + 'class_paths' => isset($setup_args['class_paths']) |
|
| 429 | + ? (array)$setup_args['class_paths'] |
|
| 430 | + : array(), |
|
| 431 | + 'model_extension_paths' => isset($setup_args['model_extension_paths']) |
|
| 432 | + ? (array)$setup_args['model_extension_paths'] |
|
| 433 | + : array(), |
|
| 434 | + 'class_extension_paths' => isset($setup_args['class_extension_paths']) |
|
| 435 | + ? (array)$setup_args['class_extension_paths'] |
|
| 436 | + : array(), |
|
| 437 | + 'custom_post_types' => isset($setup_args['custom_post_types']) |
|
| 438 | + ? (array)$setup_args['custom_post_types'] |
|
| 439 | + : array(), |
|
| 440 | + 'custom_taxonomies' => isset($setup_args['custom_taxonomies']) |
|
| 441 | + ? (array)$setup_args['custom_taxonomies'] |
|
| 442 | + : array(), |
|
| 443 | + 'payment_method_paths' => isset($setup_args['payment_method_paths']) |
|
| 444 | + ? (array)$setup_args['payment_method_paths'] |
|
| 445 | + : array(), |
|
| 446 | + 'default_terms' => isset($setup_args['default_terms']) |
|
| 447 | + ? (array)$setup_args['default_terms'] |
|
| 448 | + : array(), |
|
| 449 | + // if not empty, inserts a new table row after this plugin's row on the WP Plugins page |
|
| 450 | + // that can be used for adding upgrading/marketing info |
|
| 451 | + 'plugins_page_row' => isset($setup_args['plugins_page_row']) |
|
| 452 | + ? $setup_args['plugins_page_row'] |
|
| 453 | + : '', |
|
| 454 | + 'namespace' => isset( |
|
| 455 | + $setup_args['namespace'], |
|
| 456 | + $setup_args['namespace']['FQNS'], |
|
| 457 | + $setup_args['namespace']['DIR'] |
|
| 458 | + ) |
|
| 459 | + ? (array)$setup_args['namespace'] |
|
| 460 | + : array(), |
|
| 461 | + ); |
|
| 462 | + // if plugin_action_slug is NOT set, but an admin page path IS set, |
|
| 463 | + // then let's just use the plugin_slug since that will be used for linking to the admin page |
|
| 464 | + $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug']) |
|
| 465 | + && ! empty($addon_settings['admin_path']) |
|
| 466 | + ? $addon_settings['plugin_slug'] |
|
| 467 | + : $addon_settings['plugin_action_slug']; |
|
| 468 | + // full server path to main file (file loaded directly by WP) |
|
| 469 | + $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']); |
|
| 470 | + return $addon_settings; |
|
| 471 | + } |
|
| 472 | 472 | |
| 473 | 473 | |
| 474 | - /** |
|
| 475 | - * @param string $addon_name |
|
| 476 | - * @param array $addon_settings |
|
| 477 | - * @return boolean |
|
| 478 | - */ |
|
| 479 | - private static function _addon_is_compatible($addon_name, array $addon_settings) |
|
| 480 | - { |
|
| 481 | - global $wp_version; |
|
| 482 | - $incompatibility_message = ''; |
|
| 483 | - //check whether this addon version is compatible with EE core |
|
| 484 | - if ( |
|
| 485 | - isset(EE_Register_Addon::$_incompatible_addons[$addon_name]) |
|
| 486 | - && ! self::_meets_min_core_version_requirement( |
|
| 487 | - EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
| 488 | - $addon_settings['version'] |
|
| 489 | - ) |
|
| 490 | - ) { |
|
| 491 | - $incompatibility_message = sprintf( |
|
| 492 | - __( |
|
| 493 | - '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.' |
|
| 494 | - ), |
|
| 495 | - $addon_name, |
|
| 496 | - '<br />', |
|
| 497 | - EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
| 498 | - '<span style="font-weight: bold; color: #D54E21;">', |
|
| 499 | - '</span><br />' |
|
| 500 | - ); |
|
| 501 | - } else if ( |
|
| 502 | - ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version()) |
|
| 503 | - ) { |
|
| 504 | - $incompatibility_message = sprintf( |
|
| 505 | - __( |
|
| 506 | - '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".', |
|
| 507 | - 'event_espresso' |
|
| 508 | - ), |
|
| 509 | - $addon_name, |
|
| 510 | - self::_effective_version($addon_settings['min_core_version']), |
|
| 511 | - self::_effective_version(espresso_version()), |
|
| 512 | - '<br />', |
|
| 513 | - '<span style="font-weight: bold; color: #D54E21;">', |
|
| 514 | - '</span><br />' |
|
| 515 | - ); |
|
| 516 | - } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) { |
|
| 517 | - $incompatibility_message = sprintf( |
|
| 518 | - __( |
|
| 519 | - '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.', |
|
| 520 | - 'event_espresso' |
|
| 521 | - ), |
|
| 522 | - $addon_name, |
|
| 523 | - $addon_settings['min_wp_version'], |
|
| 524 | - '<br />', |
|
| 525 | - '<span style="font-weight: bold; color: #D54E21;">', |
|
| 526 | - '</span><br />' |
|
| 527 | - ); |
|
| 528 | - } |
|
| 529 | - if (! empty($incompatibility_message)) { |
|
| 530 | - // remove 'activate' from the REQUEST |
|
| 531 | - // so WP doesn't erroneously tell the user the plugin activated fine when it didn't |
|
| 532 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
| 533 | - if (current_user_can('activate_plugins')) { |
|
| 534 | - // show an error message indicating the plugin didn't activate properly |
|
| 535 | - EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__); |
|
| 536 | - } |
|
| 537 | - // BAIL FROM THE ADDON REGISTRATION PROCESS |
|
| 538 | - return false; |
|
| 539 | - } |
|
| 540 | - // addon IS compatible |
|
| 541 | - return true; |
|
| 542 | - } |
|
| 474 | + /** |
|
| 475 | + * @param string $addon_name |
|
| 476 | + * @param array $addon_settings |
|
| 477 | + * @return boolean |
|
| 478 | + */ |
|
| 479 | + private static function _addon_is_compatible($addon_name, array $addon_settings) |
|
| 480 | + { |
|
| 481 | + global $wp_version; |
|
| 482 | + $incompatibility_message = ''; |
|
| 483 | + //check whether this addon version is compatible with EE core |
|
| 484 | + if ( |
|
| 485 | + isset(EE_Register_Addon::$_incompatible_addons[$addon_name]) |
|
| 486 | + && ! self::_meets_min_core_version_requirement( |
|
| 487 | + EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
| 488 | + $addon_settings['version'] |
|
| 489 | + ) |
|
| 490 | + ) { |
|
| 491 | + $incompatibility_message = sprintf( |
|
| 492 | + __( |
|
| 493 | + '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.' |
|
| 494 | + ), |
|
| 495 | + $addon_name, |
|
| 496 | + '<br />', |
|
| 497 | + EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
| 498 | + '<span style="font-weight: bold; color: #D54E21;">', |
|
| 499 | + '</span><br />' |
|
| 500 | + ); |
|
| 501 | + } else if ( |
|
| 502 | + ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version()) |
|
| 503 | + ) { |
|
| 504 | + $incompatibility_message = sprintf( |
|
| 505 | + __( |
|
| 506 | + '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".', |
|
| 507 | + 'event_espresso' |
|
| 508 | + ), |
|
| 509 | + $addon_name, |
|
| 510 | + self::_effective_version($addon_settings['min_core_version']), |
|
| 511 | + self::_effective_version(espresso_version()), |
|
| 512 | + '<br />', |
|
| 513 | + '<span style="font-weight: bold; color: #D54E21;">', |
|
| 514 | + '</span><br />' |
|
| 515 | + ); |
|
| 516 | + } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) { |
|
| 517 | + $incompatibility_message = sprintf( |
|
| 518 | + __( |
|
| 519 | + '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.', |
|
| 520 | + 'event_espresso' |
|
| 521 | + ), |
|
| 522 | + $addon_name, |
|
| 523 | + $addon_settings['min_wp_version'], |
|
| 524 | + '<br />', |
|
| 525 | + '<span style="font-weight: bold; color: #D54E21;">', |
|
| 526 | + '</span><br />' |
|
| 527 | + ); |
|
| 528 | + } |
|
| 529 | + if (! empty($incompatibility_message)) { |
|
| 530 | + // remove 'activate' from the REQUEST |
|
| 531 | + // so WP doesn't erroneously tell the user the plugin activated fine when it didn't |
|
| 532 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
| 533 | + if (current_user_can('activate_plugins')) { |
|
| 534 | + // show an error message indicating the plugin didn't activate properly |
|
| 535 | + EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__); |
|
| 536 | + } |
|
| 537 | + // BAIL FROM THE ADDON REGISTRATION PROCESS |
|
| 538 | + return false; |
|
| 539 | + } |
|
| 540 | + // addon IS compatible |
|
| 541 | + return true; |
|
| 542 | + } |
|
| 543 | 543 | |
| 544 | 544 | |
| 545 | - /** |
|
| 546 | - * if plugin update engine is being used for auto-updates, |
|
| 547 | - * then let's set that up now before going any further so that ALL addons can be updated |
|
| 548 | - * (not needed if PUE is not being used) |
|
| 549 | - * |
|
| 550 | - * @param string $addon_name |
|
| 551 | - * @param string $class_name |
|
| 552 | - * @param array $setup_args |
|
| 553 | - * @return void |
|
| 554 | - */ |
|
| 555 | - private static function _parse_pue_options($addon_name, $class_name, array $setup_args) |
|
| 556 | - { |
|
| 557 | - if (! empty($setup_args['pue_options'])) { |
|
| 558 | - self::$_settings[$addon_name]['pue_options'] = array( |
|
| 559 | - 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug']) |
|
| 560 | - ? (string)$setup_args['pue_options']['pue_plugin_slug'] |
|
| 561 | - : 'espresso_' . strtolower($class_name), |
|
| 562 | - 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) |
|
| 563 | - ? (string)$setup_args['pue_options']['plugin_basename'] |
|
| 564 | - : plugin_basename($setup_args['main_file_path']), |
|
| 565 | - 'checkPeriod' => isset($setup_args['pue_options']['checkPeriod']) |
|
| 566 | - ? (string)$setup_args['pue_options']['checkPeriod'] |
|
| 567 | - : '24', |
|
| 568 | - 'use_wp_update' => isset($setup_args['pue_options']['use_wp_update']) |
|
| 569 | - ? (string)$setup_args['pue_options']['use_wp_update'] |
|
| 570 | - : false, |
|
| 571 | - ); |
|
| 572 | - add_action( |
|
| 573 | - 'AHEE__EE_System__brew_espresso__after_pue_init', |
|
| 574 | - array('EE_Register_Addon', 'load_pue_update') |
|
| 575 | - ); |
|
| 576 | - } |
|
| 577 | - } |
|
| 545 | + /** |
|
| 546 | + * if plugin update engine is being used for auto-updates, |
|
| 547 | + * then let's set that up now before going any further so that ALL addons can be updated |
|
| 548 | + * (not needed if PUE is not being used) |
|
| 549 | + * |
|
| 550 | + * @param string $addon_name |
|
| 551 | + * @param string $class_name |
|
| 552 | + * @param array $setup_args |
|
| 553 | + * @return void |
|
| 554 | + */ |
|
| 555 | + private static function _parse_pue_options($addon_name, $class_name, array $setup_args) |
|
| 556 | + { |
|
| 557 | + if (! empty($setup_args['pue_options'])) { |
|
| 558 | + self::$_settings[$addon_name]['pue_options'] = array( |
|
| 559 | + 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug']) |
|
| 560 | + ? (string)$setup_args['pue_options']['pue_plugin_slug'] |
|
| 561 | + : 'espresso_' . strtolower($class_name), |
|
| 562 | + 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) |
|
| 563 | + ? (string)$setup_args['pue_options']['plugin_basename'] |
|
| 564 | + : plugin_basename($setup_args['main_file_path']), |
|
| 565 | + 'checkPeriod' => isset($setup_args['pue_options']['checkPeriod']) |
|
| 566 | + ? (string)$setup_args['pue_options']['checkPeriod'] |
|
| 567 | + : '24', |
|
| 568 | + 'use_wp_update' => isset($setup_args['pue_options']['use_wp_update']) |
|
| 569 | + ? (string)$setup_args['pue_options']['use_wp_update'] |
|
| 570 | + : false, |
|
| 571 | + ); |
|
| 572 | + add_action( |
|
| 573 | + 'AHEE__EE_System__brew_espresso__after_pue_init', |
|
| 574 | + array('EE_Register_Addon', 'load_pue_update') |
|
| 575 | + ); |
|
| 576 | + } |
|
| 577 | + } |
|
| 578 | 578 | |
| 579 | 579 | |
| 580 | - /** |
|
| 581 | - * register namespaces right away before any other files or classes get loaded, but AFTER the version checks |
|
| 582 | - * |
|
| 583 | - * @param array $addon_settings |
|
| 584 | - * @return void |
|
| 585 | - */ |
|
| 586 | - private static function _setup_namespaces(array $addon_settings) |
|
| 587 | - { |
|
| 588 | - // |
|
| 589 | - if ( |
|
| 590 | - isset( |
|
| 591 | - $addon_settings['namespace'], |
|
| 592 | - $addon_settings['namespace']['FQNS'], |
|
| 593 | - $addon_settings['namespace']['DIR'] |
|
| 594 | - ) |
|
| 595 | - ) { |
|
| 596 | - EE_Psr4AutoloaderInit::psr4_loader()->addNamespace( |
|
| 597 | - $addon_settings['namespace']['FQNS'], |
|
| 598 | - $addon_settings['namespace']['DIR'] |
|
| 599 | - ); |
|
| 600 | - } |
|
| 601 | - } |
|
| 580 | + /** |
|
| 581 | + * register namespaces right away before any other files or classes get loaded, but AFTER the version checks |
|
| 582 | + * |
|
| 583 | + * @param array $addon_settings |
|
| 584 | + * @return void |
|
| 585 | + */ |
|
| 586 | + private static function _setup_namespaces(array $addon_settings) |
|
| 587 | + { |
|
| 588 | + // |
|
| 589 | + if ( |
|
| 590 | + isset( |
|
| 591 | + $addon_settings['namespace'], |
|
| 592 | + $addon_settings['namespace']['FQNS'], |
|
| 593 | + $addon_settings['namespace']['DIR'] |
|
| 594 | + ) |
|
| 595 | + ) { |
|
| 596 | + EE_Psr4AutoloaderInit::psr4_loader()->addNamespace( |
|
| 597 | + $addon_settings['namespace']['FQNS'], |
|
| 598 | + $addon_settings['namespace']['DIR'] |
|
| 599 | + ); |
|
| 600 | + } |
|
| 601 | + } |
|
| 602 | 602 | |
| 603 | 603 | |
| 604 | - /** |
|
| 605 | - * @param string $addon_name |
|
| 606 | - * @param array $addon_settings |
|
| 607 | - * @return bool |
|
| 608 | - */ |
|
| 609 | - private static function _addon_activation($addon_name, array $addon_settings) |
|
| 610 | - { |
|
| 611 | - // this is an activation request |
|
| 612 | - if (did_action('activate_plugin')) { |
|
| 613 | - //to find if THIS is the addon that was activated, just check if we have already registered it or not |
|
| 614 | - //(as the newly-activated addon wasn't around the first time addons were registered). |
|
| 615 | - //Note: the presence of pue_options in the addon registration options will initialize the $_settings |
|
| 616 | - //property for the add-on, but the add-on is only partially initialized. Hence, the additional check. |
|
| 617 | - if (! isset(self::$_settings[$addon_name]) |
|
| 618 | - || (isset(self::$_settings[$addon_name]) |
|
| 619 | - && ! isset(self::$_settings[$addon_name]['class_name']) |
|
| 620 | - ) |
|
| 621 | - ) { |
|
| 622 | - self::$_settings[$addon_name] = $addon_settings; |
|
| 623 | - $addon = self::_load_and_init_addon_class($addon_name); |
|
| 624 | - $addon->set_activation_indicator_option(); |
|
| 625 | - // dont bother setting up the rest of the addon. |
|
| 626 | - // we know it was just activated and the request will end soon |
|
| 627 | - } |
|
| 628 | - return true; |
|
| 629 | - } else { |
|
| 630 | - // make sure this was called in the right place! |
|
| 631 | - if ( |
|
| 632 | - ! did_action('AHEE__EE_System__load_espresso_addons') |
|
| 633 | - || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin') |
|
| 634 | - ) { |
|
| 635 | - EE_Error::doing_it_wrong( |
|
| 636 | - __METHOD__, |
|
| 637 | - sprintf( |
|
| 638 | - __( |
|
| 639 | - 'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time. Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.', |
|
| 640 | - 'event_espresso' |
|
| 641 | - ), |
|
| 642 | - $addon_name |
|
| 643 | - ), |
|
| 644 | - '4.3.0' |
|
| 645 | - ); |
|
| 646 | - } |
|
| 647 | - // make sure addon settings are set correctly without overwriting anything existing |
|
| 648 | - if (isset(self::$_settings[$addon_name])) { |
|
| 649 | - self::$_settings[$addon_name] += $addon_settings; |
|
| 650 | - } else { |
|
| 651 | - self::$_settings[$addon_name] = $addon_settings; |
|
| 652 | - } |
|
| 653 | - } |
|
| 654 | - return false; |
|
| 655 | - } |
|
| 604 | + /** |
|
| 605 | + * @param string $addon_name |
|
| 606 | + * @param array $addon_settings |
|
| 607 | + * @return bool |
|
| 608 | + */ |
|
| 609 | + private static function _addon_activation($addon_name, array $addon_settings) |
|
| 610 | + { |
|
| 611 | + // this is an activation request |
|
| 612 | + if (did_action('activate_plugin')) { |
|
| 613 | + //to find if THIS is the addon that was activated, just check if we have already registered it or not |
|
| 614 | + //(as the newly-activated addon wasn't around the first time addons were registered). |
|
| 615 | + //Note: the presence of pue_options in the addon registration options will initialize the $_settings |
|
| 616 | + //property for the add-on, but the add-on is only partially initialized. Hence, the additional check. |
|
| 617 | + if (! isset(self::$_settings[$addon_name]) |
|
| 618 | + || (isset(self::$_settings[$addon_name]) |
|
| 619 | + && ! isset(self::$_settings[$addon_name]['class_name']) |
|
| 620 | + ) |
|
| 621 | + ) { |
|
| 622 | + self::$_settings[$addon_name] = $addon_settings; |
|
| 623 | + $addon = self::_load_and_init_addon_class($addon_name); |
|
| 624 | + $addon->set_activation_indicator_option(); |
|
| 625 | + // dont bother setting up the rest of the addon. |
|
| 626 | + // we know it was just activated and the request will end soon |
|
| 627 | + } |
|
| 628 | + return true; |
|
| 629 | + } else { |
|
| 630 | + // make sure this was called in the right place! |
|
| 631 | + if ( |
|
| 632 | + ! did_action('AHEE__EE_System__load_espresso_addons') |
|
| 633 | + || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin') |
|
| 634 | + ) { |
|
| 635 | + EE_Error::doing_it_wrong( |
|
| 636 | + __METHOD__, |
|
| 637 | + sprintf( |
|
| 638 | + __( |
|
| 639 | + 'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time. Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.', |
|
| 640 | + 'event_espresso' |
|
| 641 | + ), |
|
| 642 | + $addon_name |
|
| 643 | + ), |
|
| 644 | + '4.3.0' |
|
| 645 | + ); |
|
| 646 | + } |
|
| 647 | + // make sure addon settings are set correctly without overwriting anything existing |
|
| 648 | + if (isset(self::$_settings[$addon_name])) { |
|
| 649 | + self::$_settings[$addon_name] += $addon_settings; |
|
| 650 | + } else { |
|
| 651 | + self::$_settings[$addon_name] = $addon_settings; |
|
| 652 | + } |
|
| 653 | + } |
|
| 654 | + return false; |
|
| 655 | + } |
|
| 656 | 656 | |
| 657 | 657 | |
| 658 | - /** |
|
| 659 | - * @param string $addon_name |
|
| 660 | - * @return void |
|
| 661 | - * @throws \EE_Error |
|
| 662 | - */ |
|
| 663 | - private static function _setup_autoloaders($addon_name) |
|
| 664 | - { |
|
| 665 | - if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) { |
|
| 666 | - // setup autoloader for single file |
|
| 667 | - EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']); |
|
| 668 | - } |
|
| 669 | - // setup autoloaders for folders |
|
| 670 | - if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
|
| 671 | - foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
| 672 | - EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder); |
|
| 673 | - } |
|
| 674 | - } |
|
| 675 | - } |
|
| 658 | + /** |
|
| 659 | + * @param string $addon_name |
|
| 660 | + * @return void |
|
| 661 | + * @throws \EE_Error |
|
| 662 | + */ |
|
| 663 | + private static function _setup_autoloaders($addon_name) |
|
| 664 | + { |
|
| 665 | + if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) { |
|
| 666 | + // setup autoloader for single file |
|
| 667 | + EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']); |
|
| 668 | + } |
|
| 669 | + // setup autoloaders for folders |
|
| 670 | + if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
|
| 671 | + foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
| 672 | + EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder); |
|
| 673 | + } |
|
| 674 | + } |
|
| 675 | + } |
|
| 676 | 676 | |
| 677 | 677 | |
| 678 | - /** |
|
| 679 | - * register new models and extensions |
|
| 680 | - * |
|
| 681 | - * @param string $addon_name |
|
| 682 | - * @return void |
|
| 683 | - * @throws \EE_Error |
|
| 684 | - */ |
|
| 685 | - private static function _register_models_and_extensions($addon_name) |
|
| 686 | - { |
|
| 687 | - // register new models |
|
| 688 | - if ( |
|
| 689 | - ! empty(self::$_settings[$addon_name]['model_paths']) |
|
| 690 | - || ! empty(self::$_settings[$addon_name]['class_paths']) |
|
| 691 | - ) { |
|
| 692 | - EE_Register_Model::register( |
|
| 693 | - $addon_name, |
|
| 694 | - array( |
|
| 695 | - 'model_paths' => self::$_settings[$addon_name]['model_paths'], |
|
| 696 | - 'class_paths' => self::$_settings[$addon_name]['class_paths'], |
|
| 697 | - ) |
|
| 698 | - ); |
|
| 699 | - } |
|
| 700 | - // register model extensions |
|
| 701 | - if ( |
|
| 702 | - ! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
| 703 | - || ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
| 704 | - ) { |
|
| 705 | - EE_Register_Model_Extensions::register( |
|
| 706 | - $addon_name, |
|
| 707 | - array( |
|
| 708 | - 'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'], |
|
| 709 | - 'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'], |
|
| 710 | - ) |
|
| 711 | - ); |
|
| 712 | - } |
|
| 713 | - } |
|
| 678 | + /** |
|
| 679 | + * register new models and extensions |
|
| 680 | + * |
|
| 681 | + * @param string $addon_name |
|
| 682 | + * @return void |
|
| 683 | + * @throws \EE_Error |
|
| 684 | + */ |
|
| 685 | + private static function _register_models_and_extensions($addon_name) |
|
| 686 | + { |
|
| 687 | + // register new models |
|
| 688 | + if ( |
|
| 689 | + ! empty(self::$_settings[$addon_name]['model_paths']) |
|
| 690 | + || ! empty(self::$_settings[$addon_name]['class_paths']) |
|
| 691 | + ) { |
|
| 692 | + EE_Register_Model::register( |
|
| 693 | + $addon_name, |
|
| 694 | + array( |
|
| 695 | + 'model_paths' => self::$_settings[$addon_name]['model_paths'], |
|
| 696 | + 'class_paths' => self::$_settings[$addon_name]['class_paths'], |
|
| 697 | + ) |
|
| 698 | + ); |
|
| 699 | + } |
|
| 700 | + // register model extensions |
|
| 701 | + if ( |
|
| 702 | + ! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
| 703 | + || ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
| 704 | + ) { |
|
| 705 | + EE_Register_Model_Extensions::register( |
|
| 706 | + $addon_name, |
|
| 707 | + array( |
|
| 708 | + 'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'], |
|
| 709 | + 'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'], |
|
| 710 | + ) |
|
| 711 | + ); |
|
| 712 | + } |
|
| 713 | + } |
|
| 714 | 714 | |
| 715 | 715 | |
| 716 | - /** |
|
| 717 | - * @param string $addon_name |
|
| 718 | - * @return void |
|
| 719 | - * @throws \EE_Error |
|
| 720 | - */ |
|
| 721 | - private static function _register_data_migration_scripts($addon_name) |
|
| 722 | - { |
|
| 723 | - // setup DMS |
|
| 724 | - if (! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 725 | - EE_Register_Data_Migration_Scripts::register( |
|
| 726 | - $addon_name, |
|
| 727 | - array('dms_paths' => self::$_settings[$addon_name]['dms_paths']) |
|
| 728 | - ); |
|
| 729 | - } |
|
| 730 | - } |
|
| 716 | + /** |
|
| 717 | + * @param string $addon_name |
|
| 718 | + * @return void |
|
| 719 | + * @throws \EE_Error |
|
| 720 | + */ |
|
| 721 | + private static function _register_data_migration_scripts($addon_name) |
|
| 722 | + { |
|
| 723 | + // setup DMS |
|
| 724 | + if (! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 725 | + EE_Register_Data_Migration_Scripts::register( |
|
| 726 | + $addon_name, |
|
| 727 | + array('dms_paths' => self::$_settings[$addon_name]['dms_paths']) |
|
| 728 | + ); |
|
| 729 | + } |
|
| 730 | + } |
|
| 731 | 731 | |
| 732 | 732 | |
| 733 | - /** |
|
| 734 | - * @param string $addon_name |
|
| 735 | - * @return void |
|
| 736 | - * @throws \EE_Error |
|
| 737 | - */ |
|
| 738 | - private static function _register_config($addon_name) |
|
| 739 | - { |
|
| 740 | - // if config_class is present let's register config. |
|
| 741 | - if (! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 742 | - EE_Register_Config::register( |
|
| 743 | - self::$_settings[$addon_name]['config_class'], |
|
| 744 | - array( |
|
| 745 | - 'config_section' => self::$_settings[$addon_name]['config_section'], |
|
| 746 | - 'config_name' => self::$_settings[$addon_name]['config_name'], |
|
| 747 | - ) |
|
| 748 | - ); |
|
| 749 | - } |
|
| 750 | - } |
|
| 733 | + /** |
|
| 734 | + * @param string $addon_name |
|
| 735 | + * @return void |
|
| 736 | + * @throws \EE_Error |
|
| 737 | + */ |
|
| 738 | + private static function _register_config($addon_name) |
|
| 739 | + { |
|
| 740 | + // if config_class is present let's register config. |
|
| 741 | + if (! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 742 | + EE_Register_Config::register( |
|
| 743 | + self::$_settings[$addon_name]['config_class'], |
|
| 744 | + array( |
|
| 745 | + 'config_section' => self::$_settings[$addon_name]['config_section'], |
|
| 746 | + 'config_name' => self::$_settings[$addon_name]['config_name'], |
|
| 747 | + ) |
|
| 748 | + ); |
|
| 749 | + } |
|
| 750 | + } |
|
| 751 | 751 | |
| 752 | 752 | |
| 753 | - /** |
|
| 754 | - * @param string $addon_name |
|
| 755 | - * @return void |
|
| 756 | - * @throws \EE_Error |
|
| 757 | - */ |
|
| 758 | - private static function _register_admin_pages($addon_name) |
|
| 759 | - { |
|
| 760 | - if (! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 761 | - EE_Register_Admin_Page::register( |
|
| 762 | - $addon_name, |
|
| 763 | - array('page_path' => self::$_settings[$addon_name]['admin_path']) |
|
| 764 | - ); |
|
| 765 | - } |
|
| 766 | - } |
|
| 753 | + /** |
|
| 754 | + * @param string $addon_name |
|
| 755 | + * @return void |
|
| 756 | + * @throws \EE_Error |
|
| 757 | + */ |
|
| 758 | + private static function _register_admin_pages($addon_name) |
|
| 759 | + { |
|
| 760 | + if (! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 761 | + EE_Register_Admin_Page::register( |
|
| 762 | + $addon_name, |
|
| 763 | + array('page_path' => self::$_settings[$addon_name]['admin_path']) |
|
| 764 | + ); |
|
| 765 | + } |
|
| 766 | + } |
|
| 767 | 767 | |
| 768 | 768 | |
| 769 | - /** |
|
| 770 | - * @param string $addon_name |
|
| 771 | - * @return void |
|
| 772 | - * @throws \EE_Error |
|
| 773 | - */ |
|
| 774 | - private static function _register_modules($addon_name) |
|
| 775 | - { |
|
| 776 | - if (! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 777 | - EE_Register_Module::register( |
|
| 778 | - $addon_name, |
|
| 779 | - array('module_paths' => self::$_settings[$addon_name]['module_paths']) |
|
| 780 | - ); |
|
| 781 | - } |
|
| 782 | - } |
|
| 769 | + /** |
|
| 770 | + * @param string $addon_name |
|
| 771 | + * @return void |
|
| 772 | + * @throws \EE_Error |
|
| 773 | + */ |
|
| 774 | + private static function _register_modules($addon_name) |
|
| 775 | + { |
|
| 776 | + if (! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 777 | + EE_Register_Module::register( |
|
| 778 | + $addon_name, |
|
| 779 | + array('module_paths' => self::$_settings[$addon_name]['module_paths']) |
|
| 780 | + ); |
|
| 781 | + } |
|
| 782 | + } |
|
| 783 | 783 | |
| 784 | 784 | |
| 785 | - /** |
|
| 786 | - * @param string $addon_name |
|
| 787 | - * @return void |
|
| 788 | - * @throws \EE_Error |
|
| 789 | - */ |
|
| 790 | - private static function _register_shortcodes($addon_name) |
|
| 791 | - { |
|
| 792 | - if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 793 | - EE_Register_Shortcode::register( |
|
| 794 | - $addon_name, |
|
| 795 | - array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths']) |
|
| 796 | - ); |
|
| 797 | - } |
|
| 798 | - } |
|
| 785 | + /** |
|
| 786 | + * @param string $addon_name |
|
| 787 | + * @return void |
|
| 788 | + * @throws \EE_Error |
|
| 789 | + */ |
|
| 790 | + private static function _register_shortcodes($addon_name) |
|
| 791 | + { |
|
| 792 | + if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 793 | + EE_Register_Shortcode::register( |
|
| 794 | + $addon_name, |
|
| 795 | + array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths']) |
|
| 796 | + ); |
|
| 797 | + } |
|
| 798 | + } |
|
| 799 | 799 | |
| 800 | 800 | |
| 801 | - /** |
|
| 802 | - * @param string $addon_name |
|
| 803 | - * @return void |
|
| 804 | - * @throws \EE_Error |
|
| 805 | - */ |
|
| 806 | - private static function _register_widgets($addon_name) |
|
| 807 | - { |
|
| 808 | - if (! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 809 | - EE_Register_Widget::register( |
|
| 810 | - $addon_name, |
|
| 811 | - array('widget_paths' => self::$_settings[$addon_name]['widget_paths']) |
|
| 812 | - ); |
|
| 813 | - } |
|
| 814 | - } |
|
| 801 | + /** |
|
| 802 | + * @param string $addon_name |
|
| 803 | + * @return void |
|
| 804 | + * @throws \EE_Error |
|
| 805 | + */ |
|
| 806 | + private static function _register_widgets($addon_name) |
|
| 807 | + { |
|
| 808 | + if (! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 809 | + EE_Register_Widget::register( |
|
| 810 | + $addon_name, |
|
| 811 | + array('widget_paths' => self::$_settings[$addon_name]['widget_paths']) |
|
| 812 | + ); |
|
| 813 | + } |
|
| 814 | + } |
|
| 815 | 815 | |
| 816 | 816 | |
| 817 | - /** |
|
| 818 | - * @param string $addon_name |
|
| 819 | - * @return void |
|
| 820 | - * @throws \EE_Error |
|
| 821 | - */ |
|
| 822 | - private static function _register_capabilities($addon_name) |
|
| 823 | - { |
|
| 824 | - if (! empty(self::$_settings[$addon_name]['capabilities'])) { |
|
| 825 | - EE_Register_Capabilities::register( |
|
| 826 | - $addon_name, |
|
| 827 | - array( |
|
| 828 | - 'capabilities' => self::$_settings[$addon_name]['capabilities'], |
|
| 829 | - 'capability_maps' => self::$_settings[$addon_name]['capability_maps'], |
|
| 830 | - ) |
|
| 831 | - ); |
|
| 832 | - } |
|
| 833 | - } |
|
| 817 | + /** |
|
| 818 | + * @param string $addon_name |
|
| 819 | + * @return void |
|
| 820 | + * @throws \EE_Error |
|
| 821 | + */ |
|
| 822 | + private static function _register_capabilities($addon_name) |
|
| 823 | + { |
|
| 824 | + if (! empty(self::$_settings[$addon_name]['capabilities'])) { |
|
| 825 | + EE_Register_Capabilities::register( |
|
| 826 | + $addon_name, |
|
| 827 | + array( |
|
| 828 | + 'capabilities' => self::$_settings[$addon_name]['capabilities'], |
|
| 829 | + 'capability_maps' => self::$_settings[$addon_name]['capability_maps'], |
|
| 830 | + ) |
|
| 831 | + ); |
|
| 832 | + } |
|
| 833 | + } |
|
| 834 | 834 | |
| 835 | 835 | |
| 836 | - /** |
|
| 837 | - * @param string $addon_name |
|
| 838 | - * @return void |
|
| 839 | - * @throws \EE_Error |
|
| 840 | - */ |
|
| 841 | - private static function _register_message_types($addon_name) |
|
| 842 | - { |
|
| 843 | - if (! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 844 | - add_action( |
|
| 845 | - 'EE_Brewing_Regular___messages_caf', |
|
| 846 | - array('EE_Register_Addon', 'register_message_types') |
|
| 847 | - ); |
|
| 848 | - } |
|
| 849 | - } |
|
| 836 | + /** |
|
| 837 | + * @param string $addon_name |
|
| 838 | + * @return void |
|
| 839 | + * @throws \EE_Error |
|
| 840 | + */ |
|
| 841 | + private static function _register_message_types($addon_name) |
|
| 842 | + { |
|
| 843 | + if (! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 844 | + add_action( |
|
| 845 | + 'EE_Brewing_Regular___messages_caf', |
|
| 846 | + array('EE_Register_Addon', 'register_message_types') |
|
| 847 | + ); |
|
| 848 | + } |
|
| 849 | + } |
|
| 850 | 850 | |
| 851 | 851 | |
| 852 | - /** |
|
| 853 | - * @param string $addon_name |
|
| 854 | - * @return void |
|
| 855 | - * @throws \EE_Error |
|
| 856 | - */ |
|
| 857 | - private static function _register_custom_post_types($addon_name) |
|
| 858 | - { |
|
| 859 | - if ( |
|
| 860 | - ! empty(self::$_settings[$addon_name]['custom_post_types']) |
|
| 861 | - || ! empty(self::$_settings[$addon_name]['custom_taxonomies']) |
|
| 862 | - ) { |
|
| 863 | - EE_Register_CPT::register( |
|
| 864 | - $addon_name, |
|
| 865 | - array( |
|
| 866 | - 'cpts' => self::$_settings[$addon_name]['custom_post_types'], |
|
| 867 | - 'cts' => self::$_settings[$addon_name]['custom_taxonomies'], |
|
| 868 | - 'default_terms' => self::$_settings[$addon_name]['default_terms'], |
|
| 869 | - ) |
|
| 870 | - ); |
|
| 871 | - } |
|
| 872 | - } |
|
| 852 | + /** |
|
| 853 | + * @param string $addon_name |
|
| 854 | + * @return void |
|
| 855 | + * @throws \EE_Error |
|
| 856 | + */ |
|
| 857 | + private static function _register_custom_post_types($addon_name) |
|
| 858 | + { |
|
| 859 | + if ( |
|
| 860 | + ! empty(self::$_settings[$addon_name]['custom_post_types']) |
|
| 861 | + || ! empty(self::$_settings[$addon_name]['custom_taxonomies']) |
|
| 862 | + ) { |
|
| 863 | + EE_Register_CPT::register( |
|
| 864 | + $addon_name, |
|
| 865 | + array( |
|
| 866 | + 'cpts' => self::$_settings[$addon_name]['custom_post_types'], |
|
| 867 | + 'cts' => self::$_settings[$addon_name]['custom_taxonomies'], |
|
| 868 | + 'default_terms' => self::$_settings[$addon_name]['default_terms'], |
|
| 869 | + ) |
|
| 870 | + ); |
|
| 871 | + } |
|
| 872 | + } |
|
| 873 | 873 | |
| 874 | 874 | |
| 875 | - /** |
|
| 876 | - * @param string $addon_name |
|
| 877 | - * @return void |
|
| 878 | - * @throws \EE_Error |
|
| 879 | - */ |
|
| 880 | - private static function _register_payment_methods($addon_name) |
|
| 881 | - { |
|
| 882 | - if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
|
| 883 | - EE_Register_Payment_Method::register( |
|
| 884 | - $addon_name, |
|
| 885 | - array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']) |
|
| 886 | - ); |
|
| 887 | - } |
|
| 888 | - } |
|
| 875 | + /** |
|
| 876 | + * @param string $addon_name |
|
| 877 | + * @return void |
|
| 878 | + * @throws \EE_Error |
|
| 879 | + */ |
|
| 880 | + private static function _register_payment_methods($addon_name) |
|
| 881 | + { |
|
| 882 | + if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
|
| 883 | + EE_Register_Payment_Method::register( |
|
| 884 | + $addon_name, |
|
| 885 | + array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']) |
|
| 886 | + ); |
|
| 887 | + } |
|
| 888 | + } |
|
| 889 | 889 | |
| 890 | 890 | |
| 891 | - /** |
|
| 892 | - * Loads and instantiates the EE_Addon class and adds it onto the registry |
|
| 893 | - * |
|
| 894 | - * @param string $addon_name |
|
| 895 | - * @return EE_Addon |
|
| 896 | - */ |
|
| 897 | - private static function _load_and_init_addon_class($addon_name) |
|
| 898 | - { |
|
| 899 | - $addon = EE_Registry::instance()->load_addon( |
|
| 900 | - dirname(self::$_settings[$addon_name]['main_file_path']), |
|
| 901 | - self::$_settings[$addon_name]['class_name'] |
|
| 902 | - ); |
|
| 903 | - $addon->set_name($addon_name); |
|
| 904 | - $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']); |
|
| 905 | - $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']); |
|
| 906 | - $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']); |
|
| 907 | - $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']); |
|
| 908 | - $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']); |
|
| 909 | - $addon->set_version(self::$_settings[$addon_name]['version']); |
|
| 910 | - $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version'])); |
|
| 911 | - $addon->set_config_section(self::$_settings[$addon_name]['config_section']); |
|
| 912 | - $addon->set_config_class(self::$_settings[$addon_name]['config_class']); |
|
| 913 | - $addon->set_config_name(self::$_settings[$addon_name]['config_name']); |
|
| 914 | - //unfortunately this can't be hooked in upon construction, because we don't have |
|
| 915 | - //the plugin mainfile's path upon construction. |
|
| 916 | - register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation')); |
|
| 917 | - // call any additional admin_callback functions during load_admin_controller hook |
|
| 918 | - if (! empty(self::$_settings[$addon_name]['admin_callback'])) { |
|
| 919 | - add_action( |
|
| 920 | - 'AHEE__EE_System__load_controllers__load_admin_controllers', |
|
| 921 | - array($addon, self::$_settings[$addon_name]['admin_callback']) |
|
| 922 | - ); |
|
| 923 | - } |
|
| 924 | - return $addon; |
|
| 925 | - } |
|
| 891 | + /** |
|
| 892 | + * Loads and instantiates the EE_Addon class and adds it onto the registry |
|
| 893 | + * |
|
| 894 | + * @param string $addon_name |
|
| 895 | + * @return EE_Addon |
|
| 896 | + */ |
|
| 897 | + private static function _load_and_init_addon_class($addon_name) |
|
| 898 | + { |
|
| 899 | + $addon = EE_Registry::instance()->load_addon( |
|
| 900 | + dirname(self::$_settings[$addon_name]['main_file_path']), |
|
| 901 | + self::$_settings[$addon_name]['class_name'] |
|
| 902 | + ); |
|
| 903 | + $addon->set_name($addon_name); |
|
| 904 | + $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']); |
|
| 905 | + $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']); |
|
| 906 | + $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']); |
|
| 907 | + $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']); |
|
| 908 | + $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']); |
|
| 909 | + $addon->set_version(self::$_settings[$addon_name]['version']); |
|
| 910 | + $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version'])); |
|
| 911 | + $addon->set_config_section(self::$_settings[$addon_name]['config_section']); |
|
| 912 | + $addon->set_config_class(self::$_settings[$addon_name]['config_class']); |
|
| 913 | + $addon->set_config_name(self::$_settings[$addon_name]['config_name']); |
|
| 914 | + //unfortunately this can't be hooked in upon construction, because we don't have |
|
| 915 | + //the plugin mainfile's path upon construction. |
|
| 916 | + register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation')); |
|
| 917 | + // call any additional admin_callback functions during load_admin_controller hook |
|
| 918 | + if (! empty(self::$_settings[$addon_name]['admin_callback'])) { |
|
| 919 | + add_action( |
|
| 920 | + 'AHEE__EE_System__load_controllers__load_admin_controllers', |
|
| 921 | + array($addon, self::$_settings[$addon_name]['admin_callback']) |
|
| 922 | + ); |
|
| 923 | + } |
|
| 924 | + return $addon; |
|
| 925 | + } |
|
| 926 | 926 | |
| 927 | 927 | |
| 928 | - /** |
|
| 929 | - * load_pue_update - Update notifications |
|
| 930 | - * |
|
| 931 | - * @return void |
|
| 932 | - */ |
|
| 933 | - public static function load_pue_update() |
|
| 934 | - { |
|
| 935 | - // load PUE client |
|
| 936 | - require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php'; |
|
| 937 | - // cycle thru settings |
|
| 938 | - foreach (self::$_settings as $settings) { |
|
| 939 | - if (! empty($settings['pue_options'])) { |
|
| 940 | - // initiate the class and start the plugin update engine! |
|
| 941 | - new PluginUpdateEngineChecker( |
|
| 942 | - // host file URL |
|
| 943 | - 'https://eventespresso.com', |
|
| 944 | - // plugin slug(s) |
|
| 945 | - array( |
|
| 946 | - 'premium' => array('p' => $settings['pue_options']['pue_plugin_slug']), |
|
| 947 | - 'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'), |
|
| 948 | - ), |
|
| 949 | - // options |
|
| 950 | - array( |
|
| 951 | - 'apikey' => EE_Registry::instance()->NET_CFG->core->site_license_key, |
|
| 952 | - 'lang_domain' => 'event_espresso', |
|
| 953 | - 'checkPeriod' => $settings['pue_options']['checkPeriod'], |
|
| 954 | - 'option_key' => 'site_license_key', |
|
| 955 | - 'options_page_slug' => 'event_espresso', |
|
| 956 | - 'plugin_basename' => $settings['pue_options']['plugin_basename'], |
|
| 957 | - // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP |
|
| 958 | - 'use_wp_update' => $settings['pue_options']['use_wp_update'], |
|
| 959 | - ) |
|
| 960 | - ); |
|
| 961 | - } |
|
| 962 | - } |
|
| 963 | - } |
|
| 928 | + /** |
|
| 929 | + * load_pue_update - Update notifications |
|
| 930 | + * |
|
| 931 | + * @return void |
|
| 932 | + */ |
|
| 933 | + public static function load_pue_update() |
|
| 934 | + { |
|
| 935 | + // load PUE client |
|
| 936 | + require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php'; |
|
| 937 | + // cycle thru settings |
|
| 938 | + foreach (self::$_settings as $settings) { |
|
| 939 | + if (! empty($settings['pue_options'])) { |
|
| 940 | + // initiate the class and start the plugin update engine! |
|
| 941 | + new PluginUpdateEngineChecker( |
|
| 942 | + // host file URL |
|
| 943 | + 'https://eventespresso.com', |
|
| 944 | + // plugin slug(s) |
|
| 945 | + array( |
|
| 946 | + 'premium' => array('p' => $settings['pue_options']['pue_plugin_slug']), |
|
| 947 | + 'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'), |
|
| 948 | + ), |
|
| 949 | + // options |
|
| 950 | + array( |
|
| 951 | + 'apikey' => EE_Registry::instance()->NET_CFG->core->site_license_key, |
|
| 952 | + 'lang_domain' => 'event_espresso', |
|
| 953 | + 'checkPeriod' => $settings['pue_options']['checkPeriod'], |
|
| 954 | + 'option_key' => 'site_license_key', |
|
| 955 | + 'options_page_slug' => 'event_espresso', |
|
| 956 | + 'plugin_basename' => $settings['pue_options']['plugin_basename'], |
|
| 957 | + // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP |
|
| 958 | + 'use_wp_update' => $settings['pue_options']['use_wp_update'], |
|
| 959 | + ) |
|
| 960 | + ); |
|
| 961 | + } |
|
| 962 | + } |
|
| 963 | + } |
|
| 964 | 964 | |
| 965 | 965 | |
| 966 | - /** |
|
| 967 | - * Callback for EE_Brewing_Regular__messages_caf hook used to register message types. |
|
| 968 | - * |
|
| 969 | - * @since 4.4.0 |
|
| 970 | - * @return void |
|
| 971 | - * @throws \EE_Error |
|
| 972 | - */ |
|
| 973 | - public static function register_message_types() |
|
| 974 | - { |
|
| 975 | - foreach (self::$_settings as $addon_name => $settings) { |
|
| 976 | - if (! empty($settings['message_types'])) { |
|
| 977 | - foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) { |
|
| 978 | - EE_Register_Message_Type::register($message_type, $message_type_settings); |
|
| 979 | - } |
|
| 980 | - } |
|
| 981 | - } |
|
| 982 | - } |
|
| 966 | + /** |
|
| 967 | + * Callback for EE_Brewing_Regular__messages_caf hook used to register message types. |
|
| 968 | + * |
|
| 969 | + * @since 4.4.0 |
|
| 970 | + * @return void |
|
| 971 | + * @throws \EE_Error |
|
| 972 | + */ |
|
| 973 | + public static function register_message_types() |
|
| 974 | + { |
|
| 975 | + foreach (self::$_settings as $addon_name => $settings) { |
|
| 976 | + if (! empty($settings['message_types'])) { |
|
| 977 | + foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) { |
|
| 978 | + EE_Register_Message_Type::register($message_type, $message_type_settings); |
|
| 979 | + } |
|
| 980 | + } |
|
| 981 | + } |
|
| 982 | + } |
|
| 983 | 983 | |
| 984 | 984 | |
| 985 | - /** |
|
| 986 | - * This deregisters an addon that was previously registered with a specific addon_name. |
|
| 987 | - * |
|
| 988 | - * @since 4.3.0 |
|
| 989 | - * @param string $addon_name the name for the addon that was previously registered |
|
| 990 | - * @throws EE_Error |
|
| 991 | - * @return void |
|
| 992 | - */ |
|
| 993 | - public static function deregister($addon_name = null) |
|
| 994 | - { |
|
| 995 | - if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) { |
|
| 996 | - do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name); |
|
| 997 | - $class_name = self::$_settings[$addon_name]['class_name']; |
|
| 998 | - if (! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 999 | - // setup DMS |
|
| 1000 | - EE_Register_Data_Migration_Scripts::deregister($addon_name); |
|
| 1001 | - } |
|
| 1002 | - if (! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 1003 | - // register admin page |
|
| 1004 | - EE_Register_Admin_Page::deregister($addon_name); |
|
| 1005 | - } |
|
| 1006 | - if (! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 1007 | - // add to list of modules to be registered |
|
| 1008 | - EE_Register_Module::deregister($addon_name); |
|
| 1009 | - } |
|
| 1010 | - if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 1011 | - // add to list of shortcodes to be registered |
|
| 1012 | - EE_Register_Shortcode::deregister($addon_name); |
|
| 1013 | - } |
|
| 1014 | - if (! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 1015 | - // if config_class present let's register config. |
|
| 1016 | - EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']); |
|
| 1017 | - } |
|
| 1018 | - if (! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 1019 | - // add to list of widgets to be registered |
|
| 1020 | - EE_Register_Widget::deregister($addon_name); |
|
| 1021 | - } |
|
| 1022 | - if (! empty(self::$_settings[$addon_name]['model_paths']) |
|
| 1023 | - || |
|
| 1024 | - ! empty(self::$_settings[$addon_name]['class_paths']) |
|
| 1025 | - ) { |
|
| 1026 | - // add to list of shortcodes to be registered |
|
| 1027 | - EE_Register_Model::deregister($addon_name); |
|
| 1028 | - } |
|
| 1029 | - if (! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
| 1030 | - || |
|
| 1031 | - ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
| 1032 | - ) { |
|
| 1033 | - // add to list of shortcodes to be registered |
|
| 1034 | - EE_Register_Model_Extensions::deregister($addon_name); |
|
| 1035 | - } |
|
| 1036 | - if (! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 1037 | - foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) { |
|
| 1038 | - EE_Register_Message_Type::deregister($message_type); |
|
| 1039 | - } |
|
| 1040 | - } |
|
| 1041 | - //deregister capabilities for addon |
|
| 1042 | - if ( |
|
| 1043 | - ! empty(self::$_settings[$addon_name]['capabilities']) |
|
| 1044 | - || ! empty(self::$_settings[$addon_name]['capability_maps']) |
|
| 1045 | - ) { |
|
| 1046 | - EE_Register_Capabilities::deregister($addon_name); |
|
| 1047 | - } |
|
| 1048 | - //deregister custom_post_types for addon |
|
| 1049 | - if (! empty(self::$_settings[$addon_name]['custom_post_types'])) { |
|
| 1050 | - EE_Register_CPT::deregister($addon_name); |
|
| 1051 | - } |
|
| 1052 | - remove_action( |
|
| 1053 | - 'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(), |
|
| 1054 | - array(EE_Registry::instance()->addons->{$class_name}, 'deactivation') |
|
| 1055 | - ); |
|
| 1056 | - remove_action( |
|
| 1057 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
| 1058 | - array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required') |
|
| 1059 | - ); |
|
| 1060 | - unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]); |
|
| 1061 | - do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name); |
|
| 1062 | - } |
|
| 1063 | - } |
|
| 985 | + /** |
|
| 986 | + * This deregisters an addon that was previously registered with a specific addon_name. |
|
| 987 | + * |
|
| 988 | + * @since 4.3.0 |
|
| 989 | + * @param string $addon_name the name for the addon that was previously registered |
|
| 990 | + * @throws EE_Error |
|
| 991 | + * @return void |
|
| 992 | + */ |
|
| 993 | + public static function deregister($addon_name = null) |
|
| 994 | + { |
|
| 995 | + if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) { |
|
| 996 | + do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name); |
|
| 997 | + $class_name = self::$_settings[$addon_name]['class_name']; |
|
| 998 | + if (! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 999 | + // setup DMS |
|
| 1000 | + EE_Register_Data_Migration_Scripts::deregister($addon_name); |
|
| 1001 | + } |
|
| 1002 | + if (! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 1003 | + // register admin page |
|
| 1004 | + EE_Register_Admin_Page::deregister($addon_name); |
|
| 1005 | + } |
|
| 1006 | + if (! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 1007 | + // add to list of modules to be registered |
|
| 1008 | + EE_Register_Module::deregister($addon_name); |
|
| 1009 | + } |
|
| 1010 | + if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 1011 | + // add to list of shortcodes to be registered |
|
| 1012 | + EE_Register_Shortcode::deregister($addon_name); |
|
| 1013 | + } |
|
| 1014 | + if (! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 1015 | + // if config_class present let's register config. |
|
| 1016 | + EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']); |
|
| 1017 | + } |
|
| 1018 | + if (! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 1019 | + // add to list of widgets to be registered |
|
| 1020 | + EE_Register_Widget::deregister($addon_name); |
|
| 1021 | + } |
|
| 1022 | + if (! empty(self::$_settings[$addon_name]['model_paths']) |
|
| 1023 | + || |
|
| 1024 | + ! empty(self::$_settings[$addon_name]['class_paths']) |
|
| 1025 | + ) { |
|
| 1026 | + // add to list of shortcodes to be registered |
|
| 1027 | + EE_Register_Model::deregister($addon_name); |
|
| 1028 | + } |
|
| 1029 | + if (! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
| 1030 | + || |
|
| 1031 | + ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
| 1032 | + ) { |
|
| 1033 | + // add to list of shortcodes to be registered |
|
| 1034 | + EE_Register_Model_Extensions::deregister($addon_name); |
|
| 1035 | + } |
|
| 1036 | + if (! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 1037 | + foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) { |
|
| 1038 | + EE_Register_Message_Type::deregister($message_type); |
|
| 1039 | + } |
|
| 1040 | + } |
|
| 1041 | + //deregister capabilities for addon |
|
| 1042 | + if ( |
|
| 1043 | + ! empty(self::$_settings[$addon_name]['capabilities']) |
|
| 1044 | + || ! empty(self::$_settings[$addon_name]['capability_maps']) |
|
| 1045 | + ) { |
|
| 1046 | + EE_Register_Capabilities::deregister($addon_name); |
|
| 1047 | + } |
|
| 1048 | + //deregister custom_post_types for addon |
|
| 1049 | + if (! empty(self::$_settings[$addon_name]['custom_post_types'])) { |
|
| 1050 | + EE_Register_CPT::deregister($addon_name); |
|
| 1051 | + } |
|
| 1052 | + remove_action( |
|
| 1053 | + 'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(), |
|
| 1054 | + array(EE_Registry::instance()->addons->{$class_name}, 'deactivation') |
|
| 1055 | + ); |
|
| 1056 | + remove_action( |
|
| 1057 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
| 1058 | + array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required') |
|
| 1059 | + ); |
|
| 1060 | + unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]); |
|
| 1061 | + do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name); |
|
| 1062 | + } |
|
| 1063 | + } |
|
| 1064 | 1064 | |
| 1065 | 1065 | |
| 1066 | 1066 | } |
@@ -1,4 +1,4 @@ discard block |
||
| 1 | -<?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 2 | 2 | exit('No direct script access allowed'); |
| 3 | 3 | } |
| 4 | 4 | |
@@ -66,15 +66,15 @@ discard block |
||
| 66 | 66 | // offsets: 0 . 1 . 2 . 3 . 4 |
| 67 | 67 | $version_parts = explode('.', $min_core_version); |
| 68 | 68 | //check they specified the micro version (after 2nd period) |
| 69 | - if (! isset($version_parts[2])) { |
|
| 69 | + if ( ! isset($version_parts[2])) { |
|
| 70 | 70 | $version_parts[2] = '0'; |
| 71 | 71 | } |
| 72 | 72 | //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible |
| 73 | 73 | //soon we can assume that's 'rc', but this current version is 'alpha' |
| 74 | - if (! isset($version_parts[3])) { |
|
| 74 | + if ( ! isset($version_parts[3])) { |
|
| 75 | 75 | $version_parts[3] = 'dev'; |
| 76 | 76 | } |
| 77 | - if (! isset($version_parts[4])) { |
|
| 77 | + if ( ! isset($version_parts[4])) { |
|
| 78 | 78 | $version_parts[4] = '000'; |
| 79 | 79 | } |
| 80 | 80 | return implode('.', $version_parts); |
@@ -231,7 +231,7 @@ discard block |
||
| 231 | 231 | // setup PUE |
| 232 | 232 | \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args); |
| 233 | 233 | // does this addon work with this version of core or WordPress ? |
| 234 | - if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) { |
|
| 234 | + if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) { |
|
| 235 | 235 | return; |
| 236 | 236 | } |
| 237 | 237 | // register namespaces |
@@ -288,7 +288,7 @@ discard block |
||
| 288 | 288 | ) |
| 289 | 289 | ); |
| 290 | 290 | } |
| 291 | - if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) { |
|
| 291 | + if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) { |
|
| 292 | 292 | throw new EE_Error( |
| 293 | 293 | sprintf( |
| 294 | 294 | __( |
@@ -329,7 +329,7 @@ discard block |
||
| 329 | 329 | } else { |
| 330 | 330 | $class_name = $setup_args['class_name']; |
| 331 | 331 | } |
| 332 | - return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name; |
|
| 332 | + return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_'.$class_name; |
|
| 333 | 333 | } |
| 334 | 334 | |
| 335 | 335 | |
@@ -346,105 +346,105 @@ discard block |
||
| 346 | 346 | 'class_name' => $class_name, |
| 347 | 347 | // the addon slug for use in URLs, etc |
| 348 | 348 | 'plugin_slug' => isset($setup_args['plugin_slug']) |
| 349 | - ? (string)$setup_args['plugin_slug'] |
|
| 349 | + ? (string) $setup_args['plugin_slug'] |
|
| 350 | 350 | : '', |
| 351 | 351 | // page slug to be used when generating the "Settings" link on the WP plugin page |
| 352 | 352 | 'plugin_action_slug' => isset($setup_args['plugin_action_slug']) |
| 353 | - ? (string)$setup_args['plugin_action_slug'] |
|
| 353 | + ? (string) $setup_args['plugin_action_slug'] |
|
| 354 | 354 | : '', |
| 355 | 355 | // the "software" version for the addon |
| 356 | 356 | 'version' => isset($setup_args['version']) |
| 357 | - ? (string)$setup_args['version'] |
|
| 357 | + ? (string) $setup_args['version'] |
|
| 358 | 358 | : '', |
| 359 | 359 | // the minimum version of EE Core that the addon will work with |
| 360 | 360 | 'min_core_version' => isset($setup_args['min_core_version']) |
| 361 | - ? (string)$setup_args['min_core_version'] |
|
| 361 | + ? (string) $setup_args['min_core_version'] |
|
| 362 | 362 | : '', |
| 363 | 363 | // the minimum version of WordPress that the addon will work with |
| 364 | 364 | 'min_wp_version' => isset($setup_args['min_wp_version']) |
| 365 | - ? (string)$setup_args['min_wp_version'] |
|
| 365 | + ? (string) $setup_args['min_wp_version'] |
|
| 366 | 366 | : EE_MIN_WP_VER_REQUIRED, |
| 367 | 367 | // full server path to main file (file loaded directly by WP) |
| 368 | 368 | 'main_file_path' => isset($setup_args['main_file_path']) |
| 369 | - ? (string)$setup_args['main_file_path'] |
|
| 369 | + ? (string) $setup_args['main_file_path'] |
|
| 370 | 370 | : '', |
| 371 | 371 | // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages |
| 372 | 372 | 'admin_path' => isset($setup_args['admin_path']) |
| 373 | - ? (string)$setup_args['admin_path'] : '', |
|
| 373 | + ? (string) $setup_args['admin_path'] : '', |
|
| 374 | 374 | // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page |
| 375 | 375 | 'admin_callback' => isset($setup_args['admin_callback']) |
| 376 | - ? (string)$setup_args['admin_callback'] |
|
| 376 | + ? (string) $setup_args['admin_callback'] |
|
| 377 | 377 | : '', |
| 378 | 378 | // the section name for this addon's configuration settings section (defaults to "addons") |
| 379 | 379 | 'config_section' => isset($setup_args['config_section']) |
| 380 | - ? (string)$setup_args['config_section'] |
|
| 380 | + ? (string) $setup_args['config_section'] |
|
| 381 | 381 | : 'addons', |
| 382 | 382 | // the class name for this addon's configuration settings object |
| 383 | 383 | 'config_class' => isset($setup_args['config_class']) |
| 384 | - ? (string)$setup_args['config_class'] : '', |
|
| 384 | + ? (string) $setup_args['config_class'] : '', |
|
| 385 | 385 | //the name given to the config for this addons' configuration settings object (optional) |
| 386 | 386 | 'config_name' => isset($setup_args['config_name']) |
| 387 | - ? (string)$setup_args['config_name'] : '', |
|
| 387 | + ? (string) $setup_args['config_name'] : '', |
|
| 388 | 388 | // an array of "class names" => "full server paths" for any classes that might be invoked by the addon |
| 389 | 389 | 'autoloader_paths' => isset($setup_args['autoloader_paths']) |
| 390 | - ? (array)$setup_args['autoloader_paths'] |
|
| 390 | + ? (array) $setup_args['autoloader_paths'] |
|
| 391 | 391 | : array(), |
| 392 | 392 | // an array of "full server paths" for any folders containing classes that might be invoked by the addon |
| 393 | 393 | 'autoloader_folders' => isset($setup_args['autoloader_folders']) |
| 394 | - ? (array)$setup_args['autoloader_folders'] |
|
| 394 | + ? (array) $setup_args['autoloader_folders'] |
|
| 395 | 395 | : array(), |
| 396 | 396 | // array of full server paths to any EE_DMS data migration scripts used by the addon |
| 397 | 397 | 'dms_paths' => isset($setup_args['dms_paths']) |
| 398 | - ? (array)$setup_args['dms_paths'] |
|
| 398 | + ? (array) $setup_args['dms_paths'] |
|
| 399 | 399 | : array(), |
| 400 | 400 | // array of full server paths to any EED_Modules used by the addon |
| 401 | 401 | 'module_paths' => isset($setup_args['module_paths']) |
| 402 | - ? (array)$setup_args['module_paths'] |
|
| 402 | + ? (array) $setup_args['module_paths'] |
|
| 403 | 403 | : array(), |
| 404 | 404 | // array of full server paths to any EES_Shortcodes used by the addon |
| 405 | 405 | 'shortcode_paths' => isset($setup_args['shortcode_paths']) |
| 406 | - ? (array)$setup_args['shortcode_paths'] |
|
| 406 | + ? (array) $setup_args['shortcode_paths'] |
|
| 407 | 407 | : array(), |
| 408 | 408 | // array of full server paths to any WP_Widgets used by the addon |
| 409 | 409 | 'widget_paths' => isset($setup_args['widget_paths']) |
| 410 | - ? (array)$setup_args['widget_paths'] |
|
| 410 | + ? (array) $setup_args['widget_paths'] |
|
| 411 | 411 | : array(), |
| 412 | 412 | // array of PUE options used by the addon |
| 413 | 413 | 'pue_options' => isset($setup_args['pue_options']) |
| 414 | - ? (array)$setup_args['pue_options'] |
|
| 414 | + ? (array) $setup_args['pue_options'] |
|
| 415 | 415 | : array(), |
| 416 | 416 | 'message_types' => isset($setup_args['message_types']) |
| 417 | - ? (array)$setup_args['message_types'] |
|
| 417 | + ? (array) $setup_args['message_types'] |
|
| 418 | 418 | : array(), |
| 419 | 419 | 'capabilities' => isset($setup_args['capabilities']) |
| 420 | - ? (array)$setup_args['capabilities'] |
|
| 420 | + ? (array) $setup_args['capabilities'] |
|
| 421 | 421 | : array(), |
| 422 | 422 | 'capability_maps' => isset($setup_args['capability_maps']) |
| 423 | - ? (array)$setup_args['capability_maps'] |
|
| 423 | + ? (array) $setup_args['capability_maps'] |
|
| 424 | 424 | : array(), |
| 425 | 425 | 'model_paths' => isset($setup_args['model_paths']) |
| 426 | - ? (array)$setup_args['model_paths'] |
|
| 426 | + ? (array) $setup_args['model_paths'] |
|
| 427 | 427 | : array(), |
| 428 | 428 | 'class_paths' => isset($setup_args['class_paths']) |
| 429 | - ? (array)$setup_args['class_paths'] |
|
| 429 | + ? (array) $setup_args['class_paths'] |
|
| 430 | 430 | : array(), |
| 431 | 431 | 'model_extension_paths' => isset($setup_args['model_extension_paths']) |
| 432 | - ? (array)$setup_args['model_extension_paths'] |
|
| 432 | + ? (array) $setup_args['model_extension_paths'] |
|
| 433 | 433 | : array(), |
| 434 | 434 | 'class_extension_paths' => isset($setup_args['class_extension_paths']) |
| 435 | - ? (array)$setup_args['class_extension_paths'] |
|
| 435 | + ? (array) $setup_args['class_extension_paths'] |
|
| 436 | 436 | : array(), |
| 437 | 437 | 'custom_post_types' => isset($setup_args['custom_post_types']) |
| 438 | - ? (array)$setup_args['custom_post_types'] |
|
| 438 | + ? (array) $setup_args['custom_post_types'] |
|
| 439 | 439 | : array(), |
| 440 | 440 | 'custom_taxonomies' => isset($setup_args['custom_taxonomies']) |
| 441 | - ? (array)$setup_args['custom_taxonomies'] |
|
| 441 | + ? (array) $setup_args['custom_taxonomies'] |
|
| 442 | 442 | : array(), |
| 443 | 443 | 'payment_method_paths' => isset($setup_args['payment_method_paths']) |
| 444 | - ? (array)$setup_args['payment_method_paths'] |
|
| 444 | + ? (array) $setup_args['payment_method_paths'] |
|
| 445 | 445 | : array(), |
| 446 | 446 | 'default_terms' => isset($setup_args['default_terms']) |
| 447 | - ? (array)$setup_args['default_terms'] |
|
| 447 | + ? (array) $setup_args['default_terms'] |
|
| 448 | 448 | : array(), |
| 449 | 449 | // if not empty, inserts a new table row after this plugin's row on the WP Plugins page |
| 450 | 450 | // that can be used for adding upgrading/marketing info |
@@ -456,7 +456,7 @@ discard block |
||
| 456 | 456 | $setup_args['namespace']['FQNS'], |
| 457 | 457 | $setup_args['namespace']['DIR'] |
| 458 | 458 | ) |
| 459 | - ? (array)$setup_args['namespace'] |
|
| 459 | + ? (array) $setup_args['namespace'] |
|
| 460 | 460 | : array(), |
| 461 | 461 | ); |
| 462 | 462 | // if plugin_action_slug is NOT set, but an admin page path IS set, |
@@ -526,7 +526,7 @@ discard block |
||
| 526 | 526 | '</span><br />' |
| 527 | 527 | ); |
| 528 | 528 | } |
| 529 | - if (! empty($incompatibility_message)) { |
|
| 529 | + if ( ! empty($incompatibility_message)) { |
|
| 530 | 530 | // remove 'activate' from the REQUEST |
| 531 | 531 | // so WP doesn't erroneously tell the user the plugin activated fine when it didn't |
| 532 | 532 | unset($_GET['activate'], $_REQUEST['activate']); |
@@ -554,19 +554,19 @@ discard block |
||
| 554 | 554 | */ |
| 555 | 555 | private static function _parse_pue_options($addon_name, $class_name, array $setup_args) |
| 556 | 556 | { |
| 557 | - if (! empty($setup_args['pue_options'])) { |
|
| 557 | + if ( ! empty($setup_args['pue_options'])) { |
|
| 558 | 558 | self::$_settings[$addon_name]['pue_options'] = array( |
| 559 | 559 | 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug']) |
| 560 | - ? (string)$setup_args['pue_options']['pue_plugin_slug'] |
|
| 561 | - : 'espresso_' . strtolower($class_name), |
|
| 560 | + ? (string) $setup_args['pue_options']['pue_plugin_slug'] |
|
| 561 | + : 'espresso_'.strtolower($class_name), |
|
| 562 | 562 | 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) |
| 563 | - ? (string)$setup_args['pue_options']['plugin_basename'] |
|
| 563 | + ? (string) $setup_args['pue_options']['plugin_basename'] |
|
| 564 | 564 | : plugin_basename($setup_args['main_file_path']), |
| 565 | 565 | 'checkPeriod' => isset($setup_args['pue_options']['checkPeriod']) |
| 566 | - ? (string)$setup_args['pue_options']['checkPeriod'] |
|
| 566 | + ? (string) $setup_args['pue_options']['checkPeriod'] |
|
| 567 | 567 | : '24', |
| 568 | 568 | 'use_wp_update' => isset($setup_args['pue_options']['use_wp_update']) |
| 569 | - ? (string)$setup_args['pue_options']['use_wp_update'] |
|
| 569 | + ? (string) $setup_args['pue_options']['use_wp_update'] |
|
| 570 | 570 | : false, |
| 571 | 571 | ); |
| 572 | 572 | add_action( |
@@ -614,7 +614,7 @@ discard block |
||
| 614 | 614 | //(as the newly-activated addon wasn't around the first time addons were registered). |
| 615 | 615 | //Note: the presence of pue_options in the addon registration options will initialize the $_settings |
| 616 | 616 | //property for the add-on, but the add-on is only partially initialized. Hence, the additional check. |
| 617 | - if (! isset(self::$_settings[$addon_name]) |
|
| 617 | + if ( ! isset(self::$_settings[$addon_name]) |
|
| 618 | 618 | || (isset(self::$_settings[$addon_name]) |
| 619 | 619 | && ! isset(self::$_settings[$addon_name]['class_name']) |
| 620 | 620 | ) |
@@ -662,13 +662,13 @@ discard block |
||
| 662 | 662 | */ |
| 663 | 663 | private static function _setup_autoloaders($addon_name) |
| 664 | 664 | { |
| 665 | - if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) { |
|
| 665 | + if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) { |
|
| 666 | 666 | // setup autoloader for single file |
| 667 | 667 | EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']); |
| 668 | 668 | } |
| 669 | 669 | // setup autoloaders for folders |
| 670 | - if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
|
| 671 | - foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
| 670 | + if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
|
| 671 | + foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
| 672 | 672 | EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder); |
| 673 | 673 | } |
| 674 | 674 | } |
@@ -721,7 +721,7 @@ discard block |
||
| 721 | 721 | private static function _register_data_migration_scripts($addon_name) |
| 722 | 722 | { |
| 723 | 723 | // setup DMS |
| 724 | - if (! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 724 | + if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 725 | 725 | EE_Register_Data_Migration_Scripts::register( |
| 726 | 726 | $addon_name, |
| 727 | 727 | array('dms_paths' => self::$_settings[$addon_name]['dms_paths']) |
@@ -738,7 +738,7 @@ discard block |
||
| 738 | 738 | private static function _register_config($addon_name) |
| 739 | 739 | { |
| 740 | 740 | // if config_class is present let's register config. |
| 741 | - if (! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 741 | + if ( ! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 742 | 742 | EE_Register_Config::register( |
| 743 | 743 | self::$_settings[$addon_name]['config_class'], |
| 744 | 744 | array( |
@@ -757,7 +757,7 @@ discard block |
||
| 757 | 757 | */ |
| 758 | 758 | private static function _register_admin_pages($addon_name) |
| 759 | 759 | { |
| 760 | - if (! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 760 | + if ( ! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 761 | 761 | EE_Register_Admin_Page::register( |
| 762 | 762 | $addon_name, |
| 763 | 763 | array('page_path' => self::$_settings[$addon_name]['admin_path']) |
@@ -773,7 +773,7 @@ discard block |
||
| 773 | 773 | */ |
| 774 | 774 | private static function _register_modules($addon_name) |
| 775 | 775 | { |
| 776 | - if (! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 776 | + if ( ! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 777 | 777 | EE_Register_Module::register( |
| 778 | 778 | $addon_name, |
| 779 | 779 | array('module_paths' => self::$_settings[$addon_name]['module_paths']) |
@@ -789,7 +789,7 @@ discard block |
||
| 789 | 789 | */ |
| 790 | 790 | private static function _register_shortcodes($addon_name) |
| 791 | 791 | { |
| 792 | - if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 792 | + if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 793 | 793 | EE_Register_Shortcode::register( |
| 794 | 794 | $addon_name, |
| 795 | 795 | array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths']) |
@@ -805,7 +805,7 @@ discard block |
||
| 805 | 805 | */ |
| 806 | 806 | private static function _register_widgets($addon_name) |
| 807 | 807 | { |
| 808 | - if (! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 808 | + if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 809 | 809 | EE_Register_Widget::register( |
| 810 | 810 | $addon_name, |
| 811 | 811 | array('widget_paths' => self::$_settings[$addon_name]['widget_paths']) |
@@ -821,7 +821,7 @@ discard block |
||
| 821 | 821 | */ |
| 822 | 822 | private static function _register_capabilities($addon_name) |
| 823 | 823 | { |
| 824 | - if (! empty(self::$_settings[$addon_name]['capabilities'])) { |
|
| 824 | + if ( ! empty(self::$_settings[$addon_name]['capabilities'])) { |
|
| 825 | 825 | EE_Register_Capabilities::register( |
| 826 | 826 | $addon_name, |
| 827 | 827 | array( |
@@ -840,7 +840,7 @@ discard block |
||
| 840 | 840 | */ |
| 841 | 841 | private static function _register_message_types($addon_name) |
| 842 | 842 | { |
| 843 | - if (! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 843 | + if ( ! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 844 | 844 | add_action( |
| 845 | 845 | 'EE_Brewing_Regular___messages_caf', |
| 846 | 846 | array('EE_Register_Addon', 'register_message_types') |
@@ -879,7 +879,7 @@ discard block |
||
| 879 | 879 | */ |
| 880 | 880 | private static function _register_payment_methods($addon_name) |
| 881 | 881 | { |
| 882 | - if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
|
| 882 | + if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
|
| 883 | 883 | EE_Register_Payment_Method::register( |
| 884 | 884 | $addon_name, |
| 885 | 885 | array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']) |
@@ -915,7 +915,7 @@ discard block |
||
| 915 | 915 | //the plugin mainfile's path upon construction. |
| 916 | 916 | register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation')); |
| 917 | 917 | // call any additional admin_callback functions during load_admin_controller hook |
| 918 | - if (! empty(self::$_settings[$addon_name]['admin_callback'])) { |
|
| 918 | + if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) { |
|
| 919 | 919 | add_action( |
| 920 | 920 | 'AHEE__EE_System__load_controllers__load_admin_controllers', |
| 921 | 921 | array($addon, self::$_settings[$addon_name]['admin_callback']) |
@@ -933,10 +933,10 @@ discard block |
||
| 933 | 933 | public static function load_pue_update() |
| 934 | 934 | { |
| 935 | 935 | // load PUE client |
| 936 | - require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php'; |
|
| 936 | + require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php'; |
|
| 937 | 937 | // cycle thru settings |
| 938 | 938 | foreach (self::$_settings as $settings) { |
| 939 | - if (! empty($settings['pue_options'])) { |
|
| 939 | + if ( ! empty($settings['pue_options'])) { |
|
| 940 | 940 | // initiate the class and start the plugin update engine! |
| 941 | 941 | new PluginUpdateEngineChecker( |
| 942 | 942 | // host file URL |
@@ -944,7 +944,7 @@ discard block |
||
| 944 | 944 | // plugin slug(s) |
| 945 | 945 | array( |
| 946 | 946 | 'premium' => array('p' => $settings['pue_options']['pue_plugin_slug']), |
| 947 | - 'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'), |
|
| 947 | + 'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'), |
|
| 948 | 948 | ), |
| 949 | 949 | // options |
| 950 | 950 | array( |
@@ -973,8 +973,8 @@ discard block |
||
| 973 | 973 | public static function register_message_types() |
| 974 | 974 | { |
| 975 | 975 | foreach (self::$_settings as $addon_name => $settings) { |
| 976 | - if (! empty($settings['message_types'])) { |
|
| 977 | - foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) { |
|
| 976 | + if ( ! empty($settings['message_types'])) { |
|
| 977 | + foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) { |
|
| 978 | 978 | EE_Register_Message_Type::register($message_type, $message_type_settings); |
| 979 | 979 | } |
| 980 | 980 | } |
@@ -995,46 +995,46 @@ discard block |
||
| 995 | 995 | if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) { |
| 996 | 996 | do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name); |
| 997 | 997 | $class_name = self::$_settings[$addon_name]['class_name']; |
| 998 | - if (! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 998 | + if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
| 999 | 999 | // setup DMS |
| 1000 | 1000 | EE_Register_Data_Migration_Scripts::deregister($addon_name); |
| 1001 | 1001 | } |
| 1002 | - if (! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 1002 | + if ( ! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
| 1003 | 1003 | // register admin page |
| 1004 | 1004 | EE_Register_Admin_Page::deregister($addon_name); |
| 1005 | 1005 | } |
| 1006 | - if (! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 1006 | + if ( ! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
| 1007 | 1007 | // add to list of modules to be registered |
| 1008 | 1008 | EE_Register_Module::deregister($addon_name); |
| 1009 | 1009 | } |
| 1010 | - if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 1010 | + if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
| 1011 | 1011 | // add to list of shortcodes to be registered |
| 1012 | 1012 | EE_Register_Shortcode::deregister($addon_name); |
| 1013 | 1013 | } |
| 1014 | - if (! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 1014 | + if ( ! empty(self::$_settings[$addon_name]['config_class'])) { |
|
| 1015 | 1015 | // if config_class present let's register config. |
| 1016 | 1016 | EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']); |
| 1017 | 1017 | } |
| 1018 | - if (! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 1018 | + if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
| 1019 | 1019 | // add to list of widgets to be registered |
| 1020 | 1020 | EE_Register_Widget::deregister($addon_name); |
| 1021 | 1021 | } |
| 1022 | - if (! empty(self::$_settings[$addon_name]['model_paths']) |
|
| 1022 | + if ( ! empty(self::$_settings[$addon_name]['model_paths']) |
|
| 1023 | 1023 | || |
| 1024 | 1024 | ! empty(self::$_settings[$addon_name]['class_paths']) |
| 1025 | 1025 | ) { |
| 1026 | 1026 | // add to list of shortcodes to be registered |
| 1027 | 1027 | EE_Register_Model::deregister($addon_name); |
| 1028 | 1028 | } |
| 1029 | - if (! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
| 1029 | + if ( ! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
| 1030 | 1030 | || |
| 1031 | 1031 | ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
| 1032 | 1032 | ) { |
| 1033 | 1033 | // add to list of shortcodes to be registered |
| 1034 | 1034 | EE_Register_Model_Extensions::deregister($addon_name); |
| 1035 | 1035 | } |
| 1036 | - if (! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 1037 | - foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) { |
|
| 1036 | + if ( ! empty(self::$_settings[$addon_name]['message_types'])) { |
|
| 1037 | + foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) { |
|
| 1038 | 1038 | EE_Register_Message_Type::deregister($message_type); |
| 1039 | 1039 | } |
| 1040 | 1040 | } |
@@ -1046,11 +1046,11 @@ discard block |
||
| 1046 | 1046 | EE_Register_Capabilities::deregister($addon_name); |
| 1047 | 1047 | } |
| 1048 | 1048 | //deregister custom_post_types for addon |
| 1049 | - if (! empty(self::$_settings[$addon_name]['custom_post_types'])) { |
|
| 1049 | + if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) { |
|
| 1050 | 1050 | EE_Register_CPT::deregister($addon_name); |
| 1051 | 1051 | } |
| 1052 | 1052 | remove_action( |
| 1053 | - 'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(), |
|
| 1053 | + 'deactivate_'.EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(), |
|
| 1054 | 1054 | array(EE_Registry::instance()->addons->{$class_name}, 'deactivation') |
| 1055 | 1055 | ); |
| 1056 | 1056 | remove_action( |