@@ -12,24 +12,24 @@ |
||
12 | 12 | interface ContainerInterface |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * Finds an entry of the container by its identifier and returns it. |
|
17 | - * |
|
18 | - * @param string $id Identifier of the entry to look for. |
|
19 | - * @return mixed Entry. |
|
20 | - */ |
|
21 | - public function get($id); |
|
15 | + /** |
|
16 | + * Finds an entry of the container by its identifier and returns it. |
|
17 | + * |
|
18 | + * @param string $id Identifier of the entry to look for. |
|
19 | + * @return mixed Entry. |
|
20 | + */ |
|
21 | + public function get($id); |
|
22 | 22 | |
23 | 23 | |
24 | 24 | |
25 | - /** |
|
26 | - * Returns true if the container can return an entry for the given identifier. |
|
27 | - * Returns false otherwise. |
|
28 | - * `has($id)` returning true does not mean that `get($id)` will not throw an exception. |
|
29 | - * It does however mean that `get($id)` will not throw a `NotFoundException`. |
|
30 | - * |
|
31 | - * @param string $id Identifier of the entry to look for. |
|
32 | - * @return boolean |
|
33 | - */ |
|
34 | - public function has($id); |
|
25 | + /** |
|
26 | + * Returns true if the container can return an entry for the given identifier. |
|
27 | + * Returns false otherwise. |
|
28 | + * `has($id)` returning true does not mean that `get($id)` will not throw an exception. |
|
29 | + * It does however mean that `get($id)` will not throw a `NotFoundException`. |
|
30 | + * |
|
31 | + * @param string $id Identifier of the entry to look for. |
|
32 | + * @return boolean |
|
33 | + */ |
|
34 | + public function has($id); |
|
35 | 35 | } |
@@ -11,82 +11,82 @@ |
||
11 | 11 | interface RecipeInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @return string |
|
16 | - */ |
|
17 | - public function identifier(); |
|
14 | + /** |
|
15 | + * @return string |
|
16 | + */ |
|
17 | + public function identifier(); |
|
18 | 18 | |
19 | - /** |
|
20 | - * @return string |
|
21 | - */ |
|
22 | - public function fqcn(); |
|
19 | + /** |
|
20 | + * @return string |
|
21 | + */ |
|
22 | + public function fqcn(); |
|
23 | 23 | |
24 | - /** |
|
25 | - * @return array |
|
26 | - */ |
|
27 | - public function ingredients(); |
|
24 | + /** |
|
25 | + * @return array |
|
26 | + */ |
|
27 | + public function ingredients(); |
|
28 | 28 | |
29 | - /** |
|
30 | - * @return string |
|
31 | - */ |
|
32 | - public function type(); |
|
29 | + /** |
|
30 | + * @return string |
|
31 | + */ |
|
32 | + public function type(); |
|
33 | 33 | |
34 | - /** |
|
35 | - * @return array |
|
36 | - */ |
|
37 | - public function filters(); |
|
34 | + /** |
|
35 | + * @return array |
|
36 | + */ |
|
37 | + public function filters(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return array |
|
41 | - */ |
|
42 | - public function paths(); |
|
39 | + /** |
|
40 | + * @return array |
|
41 | + */ |
|
42 | + public function paths(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * @param string $identifier Identifier for the entity class that the Recipe applies to |
|
46 | - * Typically a Fully Qualified Class Name |
|
47 | - */ |
|
48 | - public function setIdentifier($identifier); |
|
44 | + /** |
|
45 | + * @param string $identifier Identifier for the entity class that the Recipe applies to |
|
46 | + * Typically a Fully Qualified Class Name |
|
47 | + */ |
|
48 | + public function setIdentifier($identifier); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Ensures incoming string is a valid Fully Qualified Class Name, |
|
52 | - * except if this is the default wildcard Recipe ( * ), |
|
53 | - * or it's NOT an actual FQCN because the Recipe is using filepaths |
|
54 | - * for classes that are not PSR-4 compatible |
|
55 | - * PLZ NOTE: |
|
56 | - * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
57 | - * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
58 | - * |
|
59 | - * @param string $fqcn |
|
60 | - */ |
|
61 | - public function setFqcn($fqcn); |
|
50 | + /** |
|
51 | + * Ensures incoming string is a valid Fully Qualified Class Name, |
|
52 | + * except if this is the default wildcard Recipe ( * ), |
|
53 | + * or it's NOT an actual FQCN because the Recipe is using filepaths |
|
54 | + * for classes that are not PSR-4 compatible |
|
55 | + * PLZ NOTE: |
|
56 | + * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
57 | + * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
58 | + * |
|
59 | + * @param string $fqcn |
|
60 | + */ |
|
61 | + public function setFqcn($fqcn); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @param array $ingredients an array of dependencies where keys are the aliases and values are the FQCNs |
|
65 | - * example: |
|
66 | - * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
67 | - */ |
|
68 | - public function setIngredients(array $ingredients); |
|
63 | + /** |
|
64 | + * @param array $ingredients an array of dependencies where keys are the aliases and values are the FQCNs |
|
65 | + * example: |
|
66 | + * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
67 | + */ |
|
68 | + public function setIngredients(array $ingredients); |
|
69 | 69 | |
70 | - /** |
|
71 | - * @param string $type one of the class constants returned from CoffeeMaker::getTypes() |
|
72 | - */ |
|
73 | - public function setType($type = CoffeeMaker::BREW_NEW); |
|
70 | + /** |
|
71 | + * @param string $type one of the class constants returned from CoffeeMaker::getTypes() |
|
72 | + */ |
|
73 | + public function setType($type = CoffeeMaker::BREW_NEW); |
|
74 | 74 | |
75 | - /** |
|
76 | - * @param array $filters an array of filters where keys are the aliases and values are the FQCNs |
|
77 | - * example: |
|
78 | - * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
79 | - */ |
|
80 | - public function setFilters(array $filters); |
|
75 | + /** |
|
76 | + * @param array $filters an array of filters where keys are the aliases and values are the FQCNs |
|
77 | + * example: |
|
78 | + * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
79 | + */ |
|
80 | + public function setFilters(array $filters); |
|
81 | 81 | |
82 | - /** |
|
83 | - * Ensures incoming paths is a valid filepath, or array of valid filepaths, |
|
84 | - * and merges them in with any existing filepaths |
|
85 | - * PLZ NOTE: |
|
86 | - * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
87 | - * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
88 | - * |
|
89 | - * @param string|array $paths |
|
90 | - */ |
|
91 | - public function setPaths($paths = array()); |
|
82 | + /** |
|
83 | + * Ensures incoming paths is a valid filepath, or array of valid filepaths, |
|
84 | + * and merges them in with any existing filepaths |
|
85 | + * PLZ NOTE: |
|
86 | + * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
87 | + * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
88 | + * |
|
89 | + * @param string|array $paths |
|
90 | + */ |
|
91 | + public function setPaths($paths = array()); |
|
92 | 92 | } |
@@ -11,37 +11,37 @@ |
||
11 | 11 | interface InjectorInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * getReflectionClass |
|
16 | - * checks if a ReflectionClass object has already been generated for a class |
|
17 | - * and returns that instead of creating a new one |
|
18 | - * |
|
19 | - * @access public |
|
20 | - * @param string $class_name |
|
21 | - * @return \ReflectionClass |
|
22 | - */ |
|
23 | - public function getReflectionClass($class_name); |
|
14 | + /** |
|
15 | + * getReflectionClass |
|
16 | + * checks if a ReflectionClass object has already been generated for a class |
|
17 | + * and returns that instead of creating a new one |
|
18 | + * |
|
19 | + * @access public |
|
20 | + * @param string $class_name |
|
21 | + * @return \ReflectionClass |
|
22 | + */ |
|
23 | + public function getReflectionClass($class_name); |
|
24 | 24 | |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * resolveDependencies |
|
29 | - * examines the constructor for the requested class to determine |
|
30 | - * if any dependencies exist, and if they can be injected. |
|
31 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
32 | - * PLZ NOTE: this is achieved by type hinting the constructor params |
|
33 | - * For example: |
|
34 | - * if attempting to load a class "Foo" with the following constructor: |
|
35 | - * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
36 | - * then $bar_class and $grohl_class will be added to the $arguments array, |
|
37 | - * but only IF they are NOT already present in the incoming arguments array, |
|
38 | - * and the correct classes can be loaded |
|
39 | - * |
|
40 | - * @access public |
|
41 | - * @param \EventEspresso\core\services\container\RecipeInterface $recipe |
|
42 | - * @param \ReflectionClass $reflector |
|
43 | - * @param array $arguments |
|
44 | - * @return array |
|
45 | - */ |
|
46 | - public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array()); |
|
27 | + /** |
|
28 | + * resolveDependencies |
|
29 | + * examines the constructor for the requested class to determine |
|
30 | + * if any dependencies exist, and if they can be injected. |
|
31 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
32 | + * PLZ NOTE: this is achieved by type hinting the constructor params |
|
33 | + * For example: |
|
34 | + * if attempting to load a class "Foo" with the following constructor: |
|
35 | + * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
36 | + * then $bar_class and $grohl_class will be added to the $arguments array, |
|
37 | + * but only IF they are NOT already present in the incoming arguments array, |
|
38 | + * and the correct classes can be loaded |
|
39 | + * |
|
40 | + * @access public |
|
41 | + * @param \EventEspresso\core\services\container\RecipeInterface $recipe |
|
42 | + * @param \ReflectionClass $reflector |
|
43 | + * @param array $arguments |
|
44 | + * @return array |
|
45 | + */ |
|
46 | + public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array()); |
|
47 | 47 | } |
@@ -12,68 +12,68 @@ |
||
12 | 12 | |
13 | 13 | |
14 | 14 | |
15 | - /** |
|
16 | - * returns an instance of the requested entity type using the supplied arguments. |
|
17 | - * If a shared service is requested and an instance is already in the carafe, then it will be returned. |
|
18 | - * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned |
|
19 | - * If the request is for a new entity and a closure exists in the reservoir for creating it, |
|
20 | - * then a new entity will be instantiated from the closure and returned. |
|
21 | - * If a closure does not exist, then one will be built and added to the reservoir |
|
22 | - * before instantiating the requested entity. |
|
23 | - * |
|
24 | - * @param string $identifier Identifier for the entity class to be constructed. |
|
25 | - * Typically a Fully Qualified Class Name |
|
26 | - * @param array $arguments an array of arguments to be passed to the entity constructor |
|
27 | - * @param string $type |
|
28 | - * @return mixed |
|
29 | - */ |
|
30 | - public function brew($identifier, $arguments = array(), $type = ''); |
|
31 | - |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * @param string $identifier |
|
36 | - * @param callable $closure |
|
37 | - */ |
|
38 | - public function addClosure($identifier, $closure); |
|
39 | - |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * @param string $identifier |
|
44 | - * @param mixed $service |
|
45 | - * @return boolean |
|
46 | - */ |
|
47 | - public function addService($identifier, $service); |
|
48 | - |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * Adds instructions on how to brew objects |
|
53 | - * |
|
54 | - * @param RecipeInterface $recipe |
|
55 | - * @return mixed |
|
56 | - */ |
|
57 | - public function addRecipe(RecipeInterface $recipe); |
|
58 | - |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * Get instructions on how to brew objects |
|
63 | - * |
|
64 | - * @param string $identifier |
|
65 | - * @return Recipe |
|
66 | - */ |
|
67 | - public function getRecipe($identifier); |
|
68 | - |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * adds class name aliases to list of filters |
|
73 | - * |
|
74 | - * @param string $identifier |
|
75 | - * @param array $aliases |
|
76 | - * @return string |
|
77 | - */ |
|
78 | - public function addAliases($identifier, $aliases); |
|
15 | + /** |
|
16 | + * returns an instance of the requested entity type using the supplied arguments. |
|
17 | + * If a shared service is requested and an instance is already in the carafe, then it will be returned. |
|
18 | + * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned |
|
19 | + * If the request is for a new entity and a closure exists in the reservoir for creating it, |
|
20 | + * then a new entity will be instantiated from the closure and returned. |
|
21 | + * If a closure does not exist, then one will be built and added to the reservoir |
|
22 | + * before instantiating the requested entity. |
|
23 | + * |
|
24 | + * @param string $identifier Identifier for the entity class to be constructed. |
|
25 | + * Typically a Fully Qualified Class Name |
|
26 | + * @param array $arguments an array of arguments to be passed to the entity constructor |
|
27 | + * @param string $type |
|
28 | + * @return mixed |
|
29 | + */ |
|
30 | + public function brew($identifier, $arguments = array(), $type = ''); |
|
31 | + |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * @param string $identifier |
|
36 | + * @param callable $closure |
|
37 | + */ |
|
38 | + public function addClosure($identifier, $closure); |
|
39 | + |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * @param string $identifier |
|
44 | + * @param mixed $service |
|
45 | + * @return boolean |
|
46 | + */ |
|
47 | + public function addService($identifier, $service); |
|
48 | + |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * Adds instructions on how to brew objects |
|
53 | + * |
|
54 | + * @param RecipeInterface $recipe |
|
55 | + * @return mixed |
|
56 | + */ |
|
57 | + public function addRecipe(RecipeInterface $recipe); |
|
58 | + |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * Get instructions on how to brew objects |
|
63 | + * |
|
64 | + * @param string $identifier |
|
65 | + * @return Recipe |
|
66 | + */ |
|
67 | + public function getRecipe($identifier); |
|
68 | + |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * adds class name aliases to list of filters |
|
73 | + * |
|
74 | + * @param string $identifier |
|
75 | + * @param array $aliases |
|
76 | + * @return string |
|
77 | + */ |
|
78 | + public function addAliases($identifier, $aliases); |
|
79 | 79 | } |
@@ -11,31 +11,31 @@ |
||
11 | 11 | interface CoffeeMakerInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @return array |
|
16 | - */ |
|
17 | - public static function getTypes(); |
|
14 | + /** |
|
15 | + * @return array |
|
16 | + */ |
|
17 | + public static function getTypes(); |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * @param $type |
|
23 | - */ |
|
24 | - public static function validateType($type); |
|
21 | + /** |
|
22 | + * @param $type |
|
23 | + */ |
|
24 | + public static function validateType($type); |
|
25 | 25 | |
26 | 26 | |
27 | 27 | |
28 | - /** |
|
29 | - * @param RecipeInterface $recipe |
|
30 | - * @param array $arguments |
|
31 | - * @return mixed |
|
32 | - */ |
|
33 | - public function brew(RecipeInterface $recipe, $arguments = array()); |
|
28 | + /** |
|
29 | + * @param RecipeInterface $recipe |
|
30 | + * @param array $arguments |
|
31 | + * @return mixed |
|
32 | + */ |
|
33 | + public function brew(RecipeInterface $recipe, $arguments = array()); |
|
34 | 34 | |
35 | 35 | |
36 | 36 | |
37 | - /** |
|
38 | - * @return string |
|
39 | - */ |
|
40 | - public function type(); |
|
37 | + /** |
|
38 | + * @return string |
|
39 | + */ |
|
40 | + public function type(); |
|
41 | 41 | } |
@@ -18,221 +18,221 @@ |
||
18 | 18 | class PhpCompatLessFiveSixHelper extends AbstractHelper |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * PhpCompatLessFiveSixHelper constructor. |
|
23 | - * |
|
24 | - * @throws DomainException |
|
25 | - */ |
|
26 | - public function __construct() |
|
27 | - { |
|
28 | - if (PHP_VERSION_ID >= 50600) { |
|
29 | - throw new DomainException( |
|
30 | - sprintf( |
|
31 | - esc_html__( |
|
32 | - 'The %1$s is only usable on php versions less than 5.6. You\'ll want to use %2$s instead.', |
|
33 | - 'event_espresso' |
|
34 | - ), |
|
35 | - __CLASS__, |
|
36 | - 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper' |
|
37 | - ) |
|
38 | - ); |
|
39 | - } |
|
40 | - } |
|
21 | + /** |
|
22 | + * PhpCompatLessFiveSixHelper constructor. |
|
23 | + * |
|
24 | + * @throws DomainException |
|
25 | + */ |
|
26 | + public function __construct() |
|
27 | + { |
|
28 | + if (PHP_VERSION_ID >= 50600) { |
|
29 | + throw new DomainException( |
|
30 | + sprintf( |
|
31 | + esc_html__( |
|
32 | + 'The %1$s is only usable on php versions less than 5.6. You\'ll want to use %2$s instead.', |
|
33 | + 'event_espresso' |
|
34 | + ), |
|
35 | + __CLASS__, |
|
36 | + 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper' |
|
37 | + ) |
|
38 | + ); |
|
39 | + } |
|
40 | + } |
|
41 | 41 | |
42 | - /** |
|
43 | - * Returns a timezone string for the provided gmt_offset. |
|
44 | - * |
|
45 | - * @param float|string $gmt_offset |
|
46 | - * @return string |
|
47 | - * @throws EE_Error |
|
48 | - */ |
|
49 | - public function getTimezoneStringFromGmtOffset($gmt_offset = '') |
|
50 | - { |
|
51 | - $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset); |
|
52 | - if (is_string($gmt_offset_or_timezone_string)) { |
|
53 | - return $gmt_offset_or_timezone_string; |
|
54 | - } |
|
55 | - // well we know its a float, so let's roll with it. |
|
56 | - $gmt_offset = $gmt_offset_or_timezone_string; |
|
57 | - // convert GMT offset to seconds |
|
58 | - $gmt_offset *= HOUR_IN_SECONDS; |
|
59 | - // although we don't know the TZ abbreviation, we know the UTC offset |
|
60 | - $timezone_string = timezone_name_from_abbr(null, $gmt_offset); |
|
61 | - // only use this timezone_string IF it's current offset matches the given offset |
|
62 | - if (! empty($timezone_string)) { |
|
63 | - $offset = null; |
|
64 | - try { |
|
65 | - $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string)); |
|
66 | - if ($offset !== $gmt_offset) { |
|
67 | - $timezone_string = false; |
|
68 | - } |
|
69 | - } catch (Exception $e) { |
|
70 | - $timezone_string = false; |
|
71 | - } |
|
72 | - } |
|
73 | - // better have a valid timezone string by now, but if not, sigh... loop thru the timezone_abbreviations_list() |
|
74 | - // ... |
|
75 | - $timezone_string = $timezone_string !== false |
|
76 | - ? $timezone_string |
|
77 | - : $this->getTimezoneStringFromAbbreviationsList($gmt_offset); |
|
78 | - return $timezone_string; |
|
79 | - } |
|
42 | + /** |
|
43 | + * Returns a timezone string for the provided gmt_offset. |
|
44 | + * |
|
45 | + * @param float|string $gmt_offset |
|
46 | + * @return string |
|
47 | + * @throws EE_Error |
|
48 | + */ |
|
49 | + public function getTimezoneStringFromGmtOffset($gmt_offset = '') |
|
50 | + { |
|
51 | + $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset); |
|
52 | + if (is_string($gmt_offset_or_timezone_string)) { |
|
53 | + return $gmt_offset_or_timezone_string; |
|
54 | + } |
|
55 | + // well we know its a float, so let's roll with it. |
|
56 | + $gmt_offset = $gmt_offset_or_timezone_string; |
|
57 | + // convert GMT offset to seconds |
|
58 | + $gmt_offset *= HOUR_IN_SECONDS; |
|
59 | + // although we don't know the TZ abbreviation, we know the UTC offset |
|
60 | + $timezone_string = timezone_name_from_abbr(null, $gmt_offset); |
|
61 | + // only use this timezone_string IF it's current offset matches the given offset |
|
62 | + if (! empty($timezone_string)) { |
|
63 | + $offset = null; |
|
64 | + try { |
|
65 | + $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string)); |
|
66 | + if ($offset !== $gmt_offset) { |
|
67 | + $timezone_string = false; |
|
68 | + } |
|
69 | + } catch (Exception $e) { |
|
70 | + $timezone_string = false; |
|
71 | + } |
|
72 | + } |
|
73 | + // better have a valid timezone string by now, but if not, sigh... loop thru the timezone_abbreviations_list() |
|
74 | + // ... |
|
75 | + $timezone_string = $timezone_string !== false |
|
76 | + ? $timezone_string |
|
77 | + : $this->getTimezoneStringFromAbbreviationsList($gmt_offset); |
|
78 | + return $timezone_string; |
|
79 | + } |
|
80 | 80 | |
81 | 81 | |
82 | - /** |
|
83 | - * @param int $gmt_offset |
|
84 | - * @param bool $coerce If true, we attempt to coerce with our adjustment table |
|
85 | - * @see self::adjustInvalidGmtOffset |
|
86 | - * @return string |
|
87 | - * @throws EE_Error |
|
88 | - */ |
|
89 | - protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true) |
|
90 | - { |
|
91 | - $gmt_offset = (int) $gmt_offset; |
|
92 | - /** @var array[] $abbreviations */ |
|
93 | - $abbreviations = DateTimeZone::listAbbreviations(); |
|
94 | - foreach ($abbreviations as $abbreviation) { |
|
95 | - foreach ($abbreviation as $timezone) { |
|
96 | - if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) { |
|
97 | - try { |
|
98 | - $offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id'])); |
|
99 | - if ($offset !== $gmt_offset) { |
|
100 | - continue; |
|
101 | - } |
|
102 | - return $timezone['timezone_id']; |
|
103 | - } catch (Exception $e) { |
|
104 | - continue; |
|
105 | - } |
|
106 | - } |
|
107 | - } |
|
108 | - } |
|
109 | - // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted |
|
110 | - if ($coerce === true) { |
|
111 | - $timezone_string = $this->getTimezoneStringFromAbbreviationsList( |
|
112 | - $this->adjustInvalidGmtOffsets($gmt_offset), |
|
113 | - false |
|
114 | - ); |
|
115 | - if ($timezone_string) { |
|
116 | - return $timezone_string; |
|
117 | - } |
|
118 | - } |
|
119 | - throw new EE_Error( |
|
120 | - sprintf( |
|
121 | - esc_html__( |
|
122 | - 'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', |
|
123 | - 'event_espresso' |
|
124 | - ), |
|
125 | - $gmt_offset / HOUR_IN_SECONDS, |
|
126 | - '<a href="http://www.php.net/manual/en/timezones.php">', |
|
127 | - '</a>' |
|
128 | - ) |
|
129 | - ); |
|
130 | - } |
|
82 | + /** |
|
83 | + * @param int $gmt_offset |
|
84 | + * @param bool $coerce If true, we attempt to coerce with our adjustment table |
|
85 | + * @see self::adjustInvalidGmtOffset |
|
86 | + * @return string |
|
87 | + * @throws EE_Error |
|
88 | + */ |
|
89 | + protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true) |
|
90 | + { |
|
91 | + $gmt_offset = (int) $gmt_offset; |
|
92 | + /** @var array[] $abbreviations */ |
|
93 | + $abbreviations = DateTimeZone::listAbbreviations(); |
|
94 | + foreach ($abbreviations as $abbreviation) { |
|
95 | + foreach ($abbreviation as $timezone) { |
|
96 | + if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) { |
|
97 | + try { |
|
98 | + $offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id'])); |
|
99 | + if ($offset !== $gmt_offset) { |
|
100 | + continue; |
|
101 | + } |
|
102 | + return $timezone['timezone_id']; |
|
103 | + } catch (Exception $e) { |
|
104 | + continue; |
|
105 | + } |
|
106 | + } |
|
107 | + } |
|
108 | + } |
|
109 | + // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted |
|
110 | + if ($coerce === true) { |
|
111 | + $timezone_string = $this->getTimezoneStringFromAbbreviationsList( |
|
112 | + $this->adjustInvalidGmtOffsets($gmt_offset), |
|
113 | + false |
|
114 | + ); |
|
115 | + if ($timezone_string) { |
|
116 | + return $timezone_string; |
|
117 | + } |
|
118 | + } |
|
119 | + throw new EE_Error( |
|
120 | + sprintf( |
|
121 | + esc_html__( |
|
122 | + 'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', |
|
123 | + 'event_espresso' |
|
124 | + ), |
|
125 | + $gmt_offset / HOUR_IN_SECONDS, |
|
126 | + '<a href="http://www.php.net/manual/en/timezones.php">', |
|
127 | + '</a>' |
|
128 | + ) |
|
129 | + ); |
|
130 | + } |
|
131 | 131 | |
132 | 132 | |
133 | - /** |
|
134 | - * Depending on PHP version, |
|
135 | - * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables. |
|
136 | - * To get around that, for these fringe timezones we bump them to a known valid offset. |
|
137 | - * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset. |
|
138 | - * |
|
139 | - * @param int $gmt_offset |
|
140 | - * @return int |
|
141 | - */ |
|
142 | - public function adjustInvalidGmtOffsets($gmt_offset = 0) |
|
143 | - { |
|
144 | - // make sure $gmt_offset is int |
|
145 | - $gmt_offset = (int) $gmt_offset; |
|
146 | - switch ($gmt_offset) { |
|
147 | - // -12 |
|
148 | - case -43200: |
|
149 | - $gmt_offset = -39600; |
|
150 | - break; |
|
151 | - // -11.5 |
|
152 | - case -41400: |
|
153 | - $gmt_offset = -39600; |
|
154 | - break; |
|
155 | - // -10.5 |
|
156 | - case -37800: |
|
157 | - $gmt_offset = -39600; |
|
158 | - break; |
|
159 | - // -8.5 |
|
160 | - case -30600: |
|
161 | - $gmt_offset = -28800; |
|
162 | - break; |
|
163 | - // -7.5 |
|
164 | - case -27000: |
|
165 | - $gmt_offset = -25200; |
|
166 | - break; |
|
167 | - // -6.5 |
|
168 | - case -23400: |
|
169 | - $gmt_offset = -21600; |
|
170 | - break; |
|
171 | - // -5.5 |
|
172 | - case -19800: |
|
173 | - $gmt_offset = -18000; |
|
174 | - break; |
|
175 | - // -4.5 |
|
176 | - case -16200: |
|
177 | - $gmt_offset = -14400; |
|
178 | - break; |
|
179 | - // -3.5 |
|
180 | - case -12600: |
|
181 | - $gmt_offset = -10800; |
|
182 | - break; |
|
183 | - // -2.5 |
|
184 | - case -9000: |
|
185 | - $gmt_offset = -7200; |
|
186 | - break; |
|
187 | - // -1.5 |
|
188 | - case -5400: |
|
189 | - $gmt_offset = -3600; |
|
190 | - break; |
|
191 | - // -0.5 |
|
192 | - case -1800: |
|
193 | - $gmt_offset = 0; |
|
194 | - break; |
|
195 | - // .5 |
|
196 | - case 1800: |
|
197 | - $gmt_offset = 3600; |
|
198 | - break; |
|
199 | - // 1.5 |
|
200 | - case 5400: |
|
201 | - $gmt_offset = 7200; |
|
202 | - break; |
|
203 | - // 2.5 |
|
204 | - case 9000: |
|
205 | - $gmt_offset = 10800; |
|
206 | - break; |
|
207 | - // 3.5 |
|
208 | - case 12600: |
|
209 | - $gmt_offset = 14400; |
|
210 | - break; |
|
211 | - // 7.5 |
|
212 | - case 27000: |
|
213 | - $gmt_offset = 28800; |
|
214 | - break; |
|
215 | - // 8.5 |
|
216 | - case 30600: |
|
217 | - $gmt_offset = 31500; |
|
218 | - break; |
|
219 | - // 10.5 |
|
220 | - case 37800: |
|
221 | - $gmt_offset = 39600; |
|
222 | - break; |
|
223 | - // 11.5 |
|
224 | - case 41400: |
|
225 | - $gmt_offset = 43200; |
|
226 | - break; |
|
227 | - // 12.75 |
|
228 | - case 45900: |
|
229 | - $gmt_offset = 46800; |
|
230 | - break; |
|
231 | - // 13.75 |
|
232 | - case 49500: |
|
233 | - $gmt_offset = 50400; |
|
234 | - break; |
|
235 | - } |
|
236 | - return $gmt_offset; |
|
237 | - } |
|
133 | + /** |
|
134 | + * Depending on PHP version, |
|
135 | + * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables. |
|
136 | + * To get around that, for these fringe timezones we bump them to a known valid offset. |
|
137 | + * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset. |
|
138 | + * |
|
139 | + * @param int $gmt_offset |
|
140 | + * @return int |
|
141 | + */ |
|
142 | + public function adjustInvalidGmtOffsets($gmt_offset = 0) |
|
143 | + { |
|
144 | + // make sure $gmt_offset is int |
|
145 | + $gmt_offset = (int) $gmt_offset; |
|
146 | + switch ($gmt_offset) { |
|
147 | + // -12 |
|
148 | + case -43200: |
|
149 | + $gmt_offset = -39600; |
|
150 | + break; |
|
151 | + // -11.5 |
|
152 | + case -41400: |
|
153 | + $gmt_offset = -39600; |
|
154 | + break; |
|
155 | + // -10.5 |
|
156 | + case -37800: |
|
157 | + $gmt_offset = -39600; |
|
158 | + break; |
|
159 | + // -8.5 |
|
160 | + case -30600: |
|
161 | + $gmt_offset = -28800; |
|
162 | + break; |
|
163 | + // -7.5 |
|
164 | + case -27000: |
|
165 | + $gmt_offset = -25200; |
|
166 | + break; |
|
167 | + // -6.5 |
|
168 | + case -23400: |
|
169 | + $gmt_offset = -21600; |
|
170 | + break; |
|
171 | + // -5.5 |
|
172 | + case -19800: |
|
173 | + $gmt_offset = -18000; |
|
174 | + break; |
|
175 | + // -4.5 |
|
176 | + case -16200: |
|
177 | + $gmt_offset = -14400; |
|
178 | + break; |
|
179 | + // -3.5 |
|
180 | + case -12600: |
|
181 | + $gmt_offset = -10800; |
|
182 | + break; |
|
183 | + // -2.5 |
|
184 | + case -9000: |
|
185 | + $gmt_offset = -7200; |
|
186 | + break; |
|
187 | + // -1.5 |
|
188 | + case -5400: |
|
189 | + $gmt_offset = -3600; |
|
190 | + break; |
|
191 | + // -0.5 |
|
192 | + case -1800: |
|
193 | + $gmt_offset = 0; |
|
194 | + break; |
|
195 | + // .5 |
|
196 | + case 1800: |
|
197 | + $gmt_offset = 3600; |
|
198 | + break; |
|
199 | + // 1.5 |
|
200 | + case 5400: |
|
201 | + $gmt_offset = 7200; |
|
202 | + break; |
|
203 | + // 2.5 |
|
204 | + case 9000: |
|
205 | + $gmt_offset = 10800; |
|
206 | + break; |
|
207 | + // 3.5 |
|
208 | + case 12600: |
|
209 | + $gmt_offset = 14400; |
|
210 | + break; |
|
211 | + // 7.5 |
|
212 | + case 27000: |
|
213 | + $gmt_offset = 28800; |
|
214 | + break; |
|
215 | + // 8.5 |
|
216 | + case 30600: |
|
217 | + $gmt_offset = 31500; |
|
218 | + break; |
|
219 | + // 10.5 |
|
220 | + case 37800: |
|
221 | + $gmt_offset = 39600; |
|
222 | + break; |
|
223 | + // 11.5 |
|
224 | + case 41400: |
|
225 | + $gmt_offset = 43200; |
|
226 | + break; |
|
227 | + // 12.75 |
|
228 | + case 45900: |
|
229 | + $gmt_offset = 46800; |
|
230 | + break; |
|
231 | + // 13.75 |
|
232 | + case 49500: |
|
233 | + $gmt_offset = 50400; |
|
234 | + break; |
|
235 | + } |
|
236 | + return $gmt_offset; |
|
237 | + } |
|
238 | 238 | } |
@@ -59,7 +59,7 @@ |
||
59 | 59 | // although we don't know the TZ abbreviation, we know the UTC offset |
60 | 60 | $timezone_string = timezone_name_from_abbr(null, $gmt_offset); |
61 | 61 | // only use this timezone_string IF it's current offset matches the given offset |
62 | - if (! empty($timezone_string)) { |
|
62 | + if ( ! empty($timezone_string)) { |
|
63 | 63 | $offset = null; |
64 | 64 | try { |
65 | 65 | $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string)); |
@@ -8,91 +8,91 @@ |
||
8 | 8 | |
9 | 9 | class PhpCompatGreaterFiveSixHelper extends AbstractHelper |
10 | 10 | { |
11 | - /** |
|
12 | - * PhpCompatLessFiveSixHelper constructor. |
|
13 | - * |
|
14 | - * @throws DomainException |
|
15 | - */ |
|
16 | - public function __construct() |
|
17 | - { |
|
18 | - if (PHP_VERSION_ID < 50600) { |
|
19 | - throw new DomainException( |
|
20 | - sprintf( |
|
21 | - esc_html__( |
|
22 | - 'The %1$s is only usable on php versions greater than 5.6. You\'ll want to use %2$s instead.', |
|
23 | - 'event_espresso' |
|
24 | - ), |
|
25 | - __CLASS__, |
|
26 | - 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper' |
|
27 | - ) |
|
28 | - ); |
|
29 | - } |
|
30 | - } |
|
11 | + /** |
|
12 | + * PhpCompatLessFiveSixHelper constructor. |
|
13 | + * |
|
14 | + * @throws DomainException |
|
15 | + */ |
|
16 | + public function __construct() |
|
17 | + { |
|
18 | + if (PHP_VERSION_ID < 50600) { |
|
19 | + throw new DomainException( |
|
20 | + sprintf( |
|
21 | + esc_html__( |
|
22 | + 'The %1$s is only usable on php versions greater than 5.6. You\'ll want to use %2$s instead.', |
|
23 | + 'event_espresso' |
|
24 | + ), |
|
25 | + __CLASS__, |
|
26 | + 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper' |
|
27 | + ) |
|
28 | + ); |
|
29 | + } |
|
30 | + } |
|
31 | 31 | |
32 | - /** |
|
33 | - * Returns a timezone string for the provided gmt_offset. |
|
34 | - * This is a valid timezone string that can be sent into DateTimeZone |
|
35 | - * |
|
36 | - * @param float|string $gmt_offset |
|
37 | - * @return string |
|
38 | - */ |
|
39 | - public function getTimezoneStringFromGmtOffset($gmt_offset = '') |
|
40 | - { |
|
41 | - $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset); |
|
42 | - return is_float($gmt_offset_or_timezone_string) |
|
43 | - ? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string) |
|
44 | - : $gmt_offset_or_timezone_string; |
|
45 | - } |
|
32 | + /** |
|
33 | + * Returns a timezone string for the provided gmt_offset. |
|
34 | + * This is a valid timezone string that can be sent into DateTimeZone |
|
35 | + * |
|
36 | + * @param float|string $gmt_offset |
|
37 | + * @return string |
|
38 | + */ |
|
39 | + public function getTimezoneStringFromGmtOffset($gmt_offset = '') |
|
40 | + { |
|
41 | + $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset); |
|
42 | + return is_float($gmt_offset_or_timezone_string) |
|
43 | + ? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string) |
|
44 | + : $gmt_offset_or_timezone_string; |
|
45 | + } |
|
46 | 46 | |
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * Returns a formatted offset for use as an argument for constructing DateTimeZone |
|
51 | - * @param float $gmt_offset This should be a float representing the gmt_offset. |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - protected function convertWpGmtOffsetForDateTimeZone($gmt_offset) |
|
55 | - { |
|
56 | - $gmt_offset = (float) $gmt_offset; |
|
57 | - $is_negative = $gmt_offset < 0; |
|
58 | - $gmt_offset *= 100; |
|
59 | - $gmt_offset = absint($gmt_offset); |
|
60 | - // negative and need zero padding? |
|
61 | - if (strlen($gmt_offset) < 4) { |
|
62 | - $gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT); |
|
63 | - } |
|
64 | - $gmt_offset = $this->convertToTimeFraction($gmt_offset); |
|
65 | - // return something like -1300, -0200 or +1300, +0200 |
|
66 | - return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset; |
|
67 | - } |
|
49 | + /** |
|
50 | + * Returns a formatted offset for use as an argument for constructing DateTimeZone |
|
51 | + * @param float $gmt_offset This should be a float representing the gmt_offset. |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + protected function convertWpGmtOffsetForDateTimeZone($gmt_offset) |
|
55 | + { |
|
56 | + $gmt_offset = (float) $gmt_offset; |
|
57 | + $is_negative = $gmt_offset < 0; |
|
58 | + $gmt_offset *= 100; |
|
59 | + $gmt_offset = absint($gmt_offset); |
|
60 | + // negative and need zero padding? |
|
61 | + if (strlen($gmt_offset) < 4) { |
|
62 | + $gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT); |
|
63 | + } |
|
64 | + $gmt_offset = $this->convertToTimeFraction($gmt_offset); |
|
65 | + // return something like -1300, -0200 or +1300, +0200 |
|
66 | + return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset; |
|
67 | + } |
|
68 | 68 | |
69 | 69 | |
70 | - /** |
|
71 | - * Converts something like `1550` to `1530` or `0275` to `0245` |
|
72 | - * Incoming offset should be a positive value, this will mutate negative values. Be aware! |
|
73 | - * @param int $offset |
|
74 | - * @return mixed |
|
75 | - */ |
|
76 | - protected function convertToTimeFraction($offset) |
|
77 | - { |
|
78 | - $first_part = substr($offset, 0, 2); |
|
79 | - $second_part = substr($offset, 2, 2); |
|
80 | - $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part); |
|
81 | - return $first_part . $second_part; |
|
82 | - } |
|
70 | + /** |
|
71 | + * Converts something like `1550` to `1530` or `0275` to `0245` |
|
72 | + * Incoming offset should be a positive value, this will mutate negative values. Be aware! |
|
73 | + * @param int $offset |
|
74 | + * @return mixed |
|
75 | + */ |
|
76 | + protected function convertToTimeFraction($offset) |
|
77 | + { |
|
78 | + $first_part = substr($offset, 0, 2); |
|
79 | + $second_part = substr($offset, 2, 2); |
|
80 | + $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part); |
|
81 | + return $first_part . $second_part; |
|
82 | + } |
|
83 | 83 | |
84 | 84 | |
85 | - /** |
|
86 | - * Get Timezone offset for given timezone object |
|
87 | - * |
|
88 | - * @param DateTimeZone $date_time_zone |
|
89 | - * @param null|int $time |
|
90 | - * @return int |
|
91 | - */ |
|
92 | - public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null) |
|
93 | - { |
|
94 | - $time = is_int($time) || $time === null ? $time : (int) strtotime($time); |
|
95 | - $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time(); |
|
96 | - return $date_time_zone->getOffset(new DateTime('@' . $time)); |
|
97 | - } |
|
85 | + /** |
|
86 | + * Get Timezone offset for given timezone object |
|
87 | + * |
|
88 | + * @param DateTimeZone $date_time_zone |
|
89 | + * @param null|int $time |
|
90 | + * @return int |
|
91 | + */ |
|
92 | + public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null) |
|
93 | + { |
|
94 | + $time = is_int($time) || $time === null ? $time : (int) strtotime($time); |
|
95 | + $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time(); |
|
96 | + return $date_time_zone->getOffset(new DateTime('@' . $time)); |
|
97 | + } |
|
98 | 98 | } |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | } |
64 | 64 | $gmt_offset = $this->convertToTimeFraction($gmt_offset); |
65 | 65 | // return something like -1300, -0200 or +1300, +0200 |
66 | - return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset; |
|
66 | + return $is_negative ? '-'.$gmt_offset : '+'.$gmt_offset; |
|
67 | 67 | } |
68 | 68 | |
69 | 69 | |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | $first_part = substr($offset, 0, 2); |
79 | 79 | $second_part = substr($offset, 2, 2); |
80 | 80 | $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part); |
81 | - return $first_part . $second_part; |
|
81 | + return $first_part.$second_part; |
|
82 | 82 | } |
83 | 83 | |
84 | 84 | |
@@ -93,6 +93,6 @@ discard block |
||
93 | 93 | { |
94 | 94 | $time = is_int($time) || $time === null ? $time : (int) strtotime($time); |
95 | 95 | $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time(); |
96 | - return $date_time_zone->getOffset(new DateTime('@' . $time)); |
|
96 | + return $date_time_zone->getOffset(new DateTime('@'.$time)); |
|
97 | 97 | } |
98 | 98 | } |
@@ -27,114 +27,114 @@ |
||
27 | 27 | class EE_Load_Espresso_Core implements RequestDecoratorInterface, RequestStackCoreAppInterface |
28 | 28 | { |
29 | 29 | |
30 | - /** |
|
31 | - * @var RequestInterface $request |
|
32 | - */ |
|
33 | - protected $request; |
|
34 | - |
|
35 | - /** |
|
36 | - * @var ResponseInterface $response |
|
37 | - */ |
|
38 | - protected $response; |
|
39 | - |
|
40 | - /** |
|
41 | - * @var EE_Dependency_Map $dependency_map |
|
42 | - */ |
|
43 | - protected $dependency_map; |
|
44 | - |
|
45 | - /** |
|
46 | - * @var EE_Registry $registry |
|
47 | - */ |
|
48 | - protected $registry; |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * EE_Load_Espresso_Core constructor |
|
53 | - * |
|
54 | - * @param EE_Registry $registry |
|
55 | - * @param EE_Dependency_Map $dependency_map |
|
56 | - * @throws EE_Error |
|
57 | - */ |
|
58 | - public function __construct(EE_Registry $registry, EE_Dependency_Map $dependency_map) |
|
59 | - { |
|
60 | - EE_Error::doing_it_wrong( |
|
61 | - __METHOD__, |
|
62 | - sprintf( |
|
63 | - esc_html__( |
|
64 | - 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
65 | - 'event_espresso' |
|
66 | - ), |
|
67 | - 'EventEspresso\core\services\request\RequestStackCoreApp', |
|
68 | - '\core\services\request', |
|
69 | - 'EventEspresso\core\services\request' |
|
70 | - ), |
|
71 | - '4.9.53' |
|
72 | - ); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * handle |
|
78 | - * sets hooks for running rest of system |
|
79 | - * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
80 | - * starting EE Addons from any other point may lead to problems |
|
81 | - * |
|
82 | - * @param RequestInterface $request |
|
83 | - * @param ResponseInterface $response |
|
84 | - * @return ResponseInterface |
|
85 | - * @throws EE_Error |
|
86 | - * @throws InvalidDataTypeException |
|
87 | - * @throws InvalidInterfaceException |
|
88 | - * @throws InvalidArgumentException |
|
89 | - * @throws DomainException |
|
90 | - */ |
|
91 | - public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
92 | - { |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * @return RequestInterface |
|
98 | - */ |
|
99 | - public function request() |
|
100 | - { |
|
101 | - } |
|
102 | - |
|
103 | - |
|
104 | - /** |
|
105 | - * @return ResponseInterface |
|
106 | - */ |
|
107 | - public function response() |
|
108 | - { |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * @return EE_Dependency_Map |
|
114 | - * @throws EE_Error |
|
115 | - */ |
|
116 | - public function dependency_map() |
|
117 | - { |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * @return EE_Registry |
|
123 | - * @throws EE_Error |
|
124 | - */ |
|
125 | - public function registry() |
|
126 | - { |
|
127 | - } |
|
128 | - |
|
129 | - |
|
130 | - /** |
|
131 | - * called after the request stack has been fully processed |
|
132 | - * if any of the middleware apps has requested the plugin be deactivated, then we do that now |
|
133 | - * |
|
134 | - * @param RequestInterface $request |
|
135 | - * @param ResponseInterface $response |
|
136 | - */ |
|
137 | - public function handleResponse(RequestInterface $request, ResponseInterface $response) |
|
138 | - { |
|
139 | - } |
|
30 | + /** |
|
31 | + * @var RequestInterface $request |
|
32 | + */ |
|
33 | + protected $request; |
|
34 | + |
|
35 | + /** |
|
36 | + * @var ResponseInterface $response |
|
37 | + */ |
|
38 | + protected $response; |
|
39 | + |
|
40 | + /** |
|
41 | + * @var EE_Dependency_Map $dependency_map |
|
42 | + */ |
|
43 | + protected $dependency_map; |
|
44 | + |
|
45 | + /** |
|
46 | + * @var EE_Registry $registry |
|
47 | + */ |
|
48 | + protected $registry; |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * EE_Load_Espresso_Core constructor |
|
53 | + * |
|
54 | + * @param EE_Registry $registry |
|
55 | + * @param EE_Dependency_Map $dependency_map |
|
56 | + * @throws EE_Error |
|
57 | + */ |
|
58 | + public function __construct(EE_Registry $registry, EE_Dependency_Map $dependency_map) |
|
59 | + { |
|
60 | + EE_Error::doing_it_wrong( |
|
61 | + __METHOD__, |
|
62 | + sprintf( |
|
63 | + esc_html__( |
|
64 | + 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
65 | + 'event_espresso' |
|
66 | + ), |
|
67 | + 'EventEspresso\core\services\request\RequestStackCoreApp', |
|
68 | + '\core\services\request', |
|
69 | + 'EventEspresso\core\services\request' |
|
70 | + ), |
|
71 | + '4.9.53' |
|
72 | + ); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * handle |
|
78 | + * sets hooks for running rest of system |
|
79 | + * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
80 | + * starting EE Addons from any other point may lead to problems |
|
81 | + * |
|
82 | + * @param RequestInterface $request |
|
83 | + * @param ResponseInterface $response |
|
84 | + * @return ResponseInterface |
|
85 | + * @throws EE_Error |
|
86 | + * @throws InvalidDataTypeException |
|
87 | + * @throws InvalidInterfaceException |
|
88 | + * @throws InvalidArgumentException |
|
89 | + * @throws DomainException |
|
90 | + */ |
|
91 | + public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
92 | + { |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * @return RequestInterface |
|
98 | + */ |
|
99 | + public function request() |
|
100 | + { |
|
101 | + } |
|
102 | + |
|
103 | + |
|
104 | + /** |
|
105 | + * @return ResponseInterface |
|
106 | + */ |
|
107 | + public function response() |
|
108 | + { |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * @return EE_Dependency_Map |
|
114 | + * @throws EE_Error |
|
115 | + */ |
|
116 | + public function dependency_map() |
|
117 | + { |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * @return EE_Registry |
|
123 | + * @throws EE_Error |
|
124 | + */ |
|
125 | + public function registry() |
|
126 | + { |
|
127 | + } |
|
128 | + |
|
129 | + |
|
130 | + /** |
|
131 | + * called after the request stack has been fully processed |
|
132 | + * if any of the middleware apps has requested the plugin be deactivated, then we do that now |
|
133 | + * |
|
134 | + * @param RequestInterface $request |
|
135 | + * @param ResponseInterface $response |
|
136 | + */ |
|
137 | + public function handleResponse(RequestInterface $request, ResponseInterface $response) |
|
138 | + { |
|
139 | + } |
|
140 | 140 | } |
@@ -16,160 +16,160 @@ |
||
16 | 16 | abstract class EE_Object_Collection extends SplObjectStorage implements EEI_Collection |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * an interface (or class) name to be used for restricting the type of objects added to the storage |
|
21 | - * this should be set from within the child class constructor |
|
22 | - * |
|
23 | - * @type string $interface |
|
24 | - */ |
|
25 | - protected $interface; |
|
26 | - |
|
27 | - |
|
28 | - /** |
|
29 | - * add |
|
30 | - * |
|
31 | - * attaches an object to the Collection |
|
32 | - * and sets any supplied data associated with the current iterator entry |
|
33 | - * by calling EE_Object_Collection::set_info() |
|
34 | - * |
|
35 | - * @access public |
|
36 | - * @param object $object |
|
37 | - * @param mixed $info |
|
38 | - * @return bool |
|
39 | - */ |
|
40 | - public function add($object, $info = null) |
|
41 | - { |
|
42 | - $class = $this->interface; |
|
43 | - if (! $object instanceof $class) { |
|
44 | - return false; |
|
45 | - } |
|
46 | - $this->attach($object); |
|
47 | - $this->set_info($object, $info); |
|
48 | - return $this->contains($object); |
|
49 | - } |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * set_info |
|
54 | - * |
|
55 | - * Sets the data associated with an object in the Collection |
|
56 | - * if no $info is supplied, then the spl_object_hash() is used |
|
57 | - * |
|
58 | - * @access public |
|
59 | - * @param object $object |
|
60 | - * @param mixed $info |
|
61 | - * @return bool |
|
62 | - */ |
|
63 | - public function set_info($object, $info = null) |
|
64 | - { |
|
65 | - $info = ! empty($info) ? $info : spl_object_hash($object); |
|
66 | - $this->rewind(); |
|
67 | - while ($this->valid()) { |
|
68 | - if ($object == $this->current()) { |
|
69 | - $this->setInfo($info); |
|
70 | - $this->rewind(); |
|
71 | - return true; |
|
72 | - } |
|
73 | - $this->next(); |
|
74 | - } |
|
75 | - return false; |
|
76 | - } |
|
77 | - |
|
78 | - |
|
79 | - /** |
|
80 | - * get_by_info |
|
81 | - * |
|
82 | - * finds and returns an object in the Collection based on the info that was set using addObject() |
|
83 | - * PLZ NOTE: the pointer is reset to the beginning of the collection before returning |
|
84 | - * |
|
85 | - * @access public |
|
86 | - * @param mixed |
|
87 | - * @return null | object |
|
88 | - */ |
|
89 | - public function get_by_info($info) |
|
90 | - { |
|
91 | - $this->rewind(); |
|
92 | - while ($this->valid()) { |
|
93 | - if ($info === $this->getInfo()) { |
|
94 | - $object = $this->current(); |
|
95 | - $this->rewind(); |
|
96 | - return $object; |
|
97 | - } |
|
98 | - $this->next(); |
|
99 | - } |
|
100 | - return null; |
|
101 | - } |
|
102 | - |
|
103 | - |
|
104 | - /** |
|
105 | - * has |
|
106 | - * |
|
107 | - * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
108 | - * |
|
109 | - * @access public |
|
110 | - * @param object $object |
|
111 | - * @return bool |
|
112 | - */ |
|
113 | - public function has($object) |
|
114 | - { |
|
115 | - return $this->contains($object); |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - /** |
|
120 | - * remove |
|
121 | - * |
|
122 | - * detaches an object from the Collection |
|
123 | - * |
|
124 | - * @access public |
|
125 | - * @param $object |
|
126 | - * @return bool |
|
127 | - */ |
|
128 | - public function remove($object) |
|
129 | - { |
|
130 | - $this->detach($object); |
|
131 | - return true; |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * set_current |
|
137 | - * |
|
138 | - * advances pointer to the provided object |
|
139 | - * |
|
140 | - * @access public |
|
141 | - * @param $object |
|
142 | - * @return void |
|
143 | - */ |
|
144 | - public function set_current($object) |
|
145 | - { |
|
146 | - $this->rewind(); |
|
147 | - while ($this->valid()) { |
|
148 | - if ($this->current() === $object) { |
|
149 | - break; |
|
150 | - } |
|
151 | - $this->next(); |
|
152 | - } |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - /** |
|
157 | - * set_current_by_info |
|
158 | - * |
|
159 | - * advances pointer to the object whose info matches that which was provided |
|
160 | - * |
|
161 | - * @access public |
|
162 | - * @param $info |
|
163 | - * @return void |
|
164 | - */ |
|
165 | - public function set_current_by_info($info) |
|
166 | - { |
|
167 | - $this->rewind(); |
|
168 | - while ($this->valid()) { |
|
169 | - if ($info === $this->getInfo()) { |
|
170 | - break; |
|
171 | - } |
|
172 | - $this->next(); |
|
173 | - } |
|
174 | - } |
|
19 | + /** |
|
20 | + * an interface (or class) name to be used for restricting the type of objects added to the storage |
|
21 | + * this should be set from within the child class constructor |
|
22 | + * |
|
23 | + * @type string $interface |
|
24 | + */ |
|
25 | + protected $interface; |
|
26 | + |
|
27 | + |
|
28 | + /** |
|
29 | + * add |
|
30 | + * |
|
31 | + * attaches an object to the Collection |
|
32 | + * and sets any supplied data associated with the current iterator entry |
|
33 | + * by calling EE_Object_Collection::set_info() |
|
34 | + * |
|
35 | + * @access public |
|
36 | + * @param object $object |
|
37 | + * @param mixed $info |
|
38 | + * @return bool |
|
39 | + */ |
|
40 | + public function add($object, $info = null) |
|
41 | + { |
|
42 | + $class = $this->interface; |
|
43 | + if (! $object instanceof $class) { |
|
44 | + return false; |
|
45 | + } |
|
46 | + $this->attach($object); |
|
47 | + $this->set_info($object, $info); |
|
48 | + return $this->contains($object); |
|
49 | + } |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * set_info |
|
54 | + * |
|
55 | + * Sets the data associated with an object in the Collection |
|
56 | + * if no $info is supplied, then the spl_object_hash() is used |
|
57 | + * |
|
58 | + * @access public |
|
59 | + * @param object $object |
|
60 | + * @param mixed $info |
|
61 | + * @return bool |
|
62 | + */ |
|
63 | + public function set_info($object, $info = null) |
|
64 | + { |
|
65 | + $info = ! empty($info) ? $info : spl_object_hash($object); |
|
66 | + $this->rewind(); |
|
67 | + while ($this->valid()) { |
|
68 | + if ($object == $this->current()) { |
|
69 | + $this->setInfo($info); |
|
70 | + $this->rewind(); |
|
71 | + return true; |
|
72 | + } |
|
73 | + $this->next(); |
|
74 | + } |
|
75 | + return false; |
|
76 | + } |
|
77 | + |
|
78 | + |
|
79 | + /** |
|
80 | + * get_by_info |
|
81 | + * |
|
82 | + * finds and returns an object in the Collection based on the info that was set using addObject() |
|
83 | + * PLZ NOTE: the pointer is reset to the beginning of the collection before returning |
|
84 | + * |
|
85 | + * @access public |
|
86 | + * @param mixed |
|
87 | + * @return null | object |
|
88 | + */ |
|
89 | + public function get_by_info($info) |
|
90 | + { |
|
91 | + $this->rewind(); |
|
92 | + while ($this->valid()) { |
|
93 | + if ($info === $this->getInfo()) { |
|
94 | + $object = $this->current(); |
|
95 | + $this->rewind(); |
|
96 | + return $object; |
|
97 | + } |
|
98 | + $this->next(); |
|
99 | + } |
|
100 | + return null; |
|
101 | + } |
|
102 | + |
|
103 | + |
|
104 | + /** |
|
105 | + * has |
|
106 | + * |
|
107 | + * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
108 | + * |
|
109 | + * @access public |
|
110 | + * @param object $object |
|
111 | + * @return bool |
|
112 | + */ |
|
113 | + public function has($object) |
|
114 | + { |
|
115 | + return $this->contains($object); |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + /** |
|
120 | + * remove |
|
121 | + * |
|
122 | + * detaches an object from the Collection |
|
123 | + * |
|
124 | + * @access public |
|
125 | + * @param $object |
|
126 | + * @return bool |
|
127 | + */ |
|
128 | + public function remove($object) |
|
129 | + { |
|
130 | + $this->detach($object); |
|
131 | + return true; |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * set_current |
|
137 | + * |
|
138 | + * advances pointer to the provided object |
|
139 | + * |
|
140 | + * @access public |
|
141 | + * @param $object |
|
142 | + * @return void |
|
143 | + */ |
|
144 | + public function set_current($object) |
|
145 | + { |
|
146 | + $this->rewind(); |
|
147 | + while ($this->valid()) { |
|
148 | + if ($this->current() === $object) { |
|
149 | + break; |
|
150 | + } |
|
151 | + $this->next(); |
|
152 | + } |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + /** |
|
157 | + * set_current_by_info |
|
158 | + * |
|
159 | + * advances pointer to the object whose info matches that which was provided |
|
160 | + * |
|
161 | + * @access public |
|
162 | + * @param $info |
|
163 | + * @return void |
|
164 | + */ |
|
165 | + public function set_current_by_info($info) |
|
166 | + { |
|
167 | + $this->rewind(); |
|
168 | + while ($this->valid()) { |
|
169 | + if ($info === $this->getInfo()) { |
|
170 | + break; |
|
171 | + } |
|
172 | + $this->next(); |
|
173 | + } |
|
174 | + } |
|
175 | 175 | } |
@@ -40,7 +40,7 @@ |
||
40 | 40 | public function add($object, $info = null) |
41 | 41 | { |
42 | 42 | $class = $this->interface; |
43 | - if (! $object instanceof $class) { |
|
43 | + if ( ! $object instanceof $class) { |
|
44 | 44 | return false; |
45 | 45 | } |
46 | 46 | $this->attach($object); |