@@ -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 | } |
@@ -12,136 +12,136 @@ discard block |
||
| 12 | 12 | { |
| 13 | 13 | |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Ensures that a valid timezone string is returned. |
|
| 17 | - * |
|
| 18 | - * @param string $timezone_string When not provided then attempt to use the timezone_string set in the WP Time |
|
| 19 | - * settings (or derive from set UTC offset). |
|
| 20 | - * @return string |
|
| 21 | - * @throws EE_Error |
|
| 22 | - */ |
|
| 23 | - public function getValidTimezoneString($timezone_string = '') |
|
| 24 | - { |
|
| 25 | - $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string'); |
|
| 26 | - $timezone_string = ! empty($timezone_string) |
|
| 27 | - ? $timezone_string |
|
| 28 | - : $this->getTimezoneStringFromGmtOffset(); |
|
| 29 | - $this->validateTimezone($timezone_string); |
|
| 30 | - return $timezone_string; |
|
| 31 | - } |
|
| 15 | + /** |
|
| 16 | + * Ensures that a valid timezone string is returned. |
|
| 17 | + * |
|
| 18 | + * @param string $timezone_string When not provided then attempt to use the timezone_string set in the WP Time |
|
| 19 | + * settings (or derive from set UTC offset). |
|
| 20 | + * @return string |
|
| 21 | + * @throws EE_Error |
|
| 22 | + */ |
|
| 23 | + public function getValidTimezoneString($timezone_string = '') |
|
| 24 | + { |
|
| 25 | + $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string'); |
|
| 26 | + $timezone_string = ! empty($timezone_string) |
|
| 27 | + ? $timezone_string |
|
| 28 | + : $this->getTimezoneStringFromGmtOffset(); |
|
| 29 | + $this->validateTimezone($timezone_string); |
|
| 30 | + return $timezone_string; |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | 33 | |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone. |
|
| 37 | - * |
|
| 38 | - * @param string $timezone_string |
|
| 39 | - * @param bool $throw_error |
|
| 40 | - * @return bool |
|
| 41 | - * @throws EE_Error |
|
| 42 | - */ |
|
| 43 | - public function validateTimezone($timezone_string, $throw_error = true) |
|
| 44 | - { |
|
| 45 | - // easiest way to test a timezone string is just see if it throws an error when you try to create a |
|
| 46 | - // DateTimeZone object with it |
|
| 47 | - try { |
|
| 48 | - new DateTimeZone($timezone_string); |
|
| 49 | - } catch (Exception $e) { |
|
| 50 | - // sometimes we take exception to exceptions |
|
| 51 | - if (! $throw_error) { |
|
| 52 | - return false; |
|
| 53 | - } |
|
| 54 | - throw new EE_Error( |
|
| 55 | - sprintf( |
|
| 56 | - esc_html__( |
|
| 57 | - 'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', |
|
| 58 | - 'event_espresso' |
|
| 59 | - ), |
|
| 60 | - $timezone_string, |
|
| 61 | - '<a href="http://www.php.net/manual/en/timezones.php">', |
|
| 62 | - '</a>' |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - } |
|
| 66 | - return true; |
|
| 67 | - } |
|
| 35 | + /** |
|
| 36 | + * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone. |
|
| 37 | + * |
|
| 38 | + * @param string $timezone_string |
|
| 39 | + * @param bool $throw_error |
|
| 40 | + * @return bool |
|
| 41 | + * @throws EE_Error |
|
| 42 | + */ |
|
| 43 | + public function validateTimezone($timezone_string, $throw_error = true) |
|
| 44 | + { |
|
| 45 | + // easiest way to test a timezone string is just see if it throws an error when you try to create a |
|
| 46 | + // DateTimeZone object with it |
|
| 47 | + try { |
|
| 48 | + new DateTimeZone($timezone_string); |
|
| 49 | + } catch (Exception $e) { |
|
| 50 | + // sometimes we take exception to exceptions |
|
| 51 | + if (! $throw_error) { |
|
| 52 | + return false; |
|
| 53 | + } |
|
| 54 | + throw new EE_Error( |
|
| 55 | + sprintf( |
|
| 56 | + esc_html__( |
|
| 57 | + 'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', |
|
| 58 | + 'event_espresso' |
|
| 59 | + ), |
|
| 60 | + $timezone_string, |
|
| 61 | + '<a href="http://www.php.net/manual/en/timezones.php">', |
|
| 62 | + '</a>' |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + } |
|
| 66 | + return true; |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Gets the site's GMT offset based on either the timezone string |
|
| 72 | - * (in which case the gmt offset will vary depending on the location's |
|
| 73 | - * observance of daylight savings time) or the gmt_offset wp option |
|
| 74 | - * |
|
| 75 | - * @return int seconds offset |
|
| 76 | - */ |
|
| 77 | - public function getSiteTimezoneGmtOffset() |
|
| 78 | - { |
|
| 79 | - $timezone_string = (string) get_option('timezone_string'); |
|
| 80 | - if ($timezone_string) { |
|
| 81 | - try { |
|
| 82 | - $timezone = new DateTimeZone($timezone_string); |
|
| 83 | - return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC |
|
| 84 | - } catch (Exception $e) { |
|
| 85 | - } |
|
| 86 | - } |
|
| 87 | - $offset = get_option('gmt_offset'); |
|
| 88 | - return (int) ($offset * HOUR_IN_SECONDS); |
|
| 89 | - } |
|
| 70 | + /** |
|
| 71 | + * Gets the site's GMT offset based on either the timezone string |
|
| 72 | + * (in which case the gmt offset will vary depending on the location's |
|
| 73 | + * observance of daylight savings time) or the gmt_offset wp option |
|
| 74 | + * |
|
| 75 | + * @return int seconds offset |
|
| 76 | + */ |
|
| 77 | + public function getSiteTimezoneGmtOffset() |
|
| 78 | + { |
|
| 79 | + $timezone_string = (string) get_option('timezone_string'); |
|
| 80 | + if ($timezone_string) { |
|
| 81 | + try { |
|
| 82 | + $timezone = new DateTimeZone($timezone_string); |
|
| 83 | + return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC |
|
| 84 | + } catch (Exception $e) { |
|
| 85 | + } |
|
| 86 | + } |
|
| 87 | + $offset = get_option('gmt_offset'); |
|
| 88 | + return (int) ($offset * HOUR_IN_SECONDS); |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Get Timezone offset for given timezone object |
|
| 94 | - * |
|
| 95 | - * @param DateTimeZone $date_time_zone |
|
| 96 | - * @param null|int $time |
|
| 97 | - * @return int |
|
| 98 | - * @throws DomainException |
|
| 99 | - */ |
|
| 100 | - public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null) |
|
| 101 | - { |
|
| 102 | - $transition = $this->getTimezoneTransitions($date_time_zone, $time); |
|
| 103 | - if (! isset($transition['offset'])) { |
|
| 104 | - throw new DomainException( |
|
| 105 | - sprintf( |
|
| 106 | - esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'), |
|
| 107 | - print_r($transition, true) |
|
| 108 | - ) |
|
| 109 | - ); |
|
| 110 | - } |
|
| 111 | - return $transition['offset']; |
|
| 112 | - } |
|
| 92 | + /** |
|
| 93 | + * Get Timezone offset for given timezone object |
|
| 94 | + * |
|
| 95 | + * @param DateTimeZone $date_time_zone |
|
| 96 | + * @param null|int $time |
|
| 97 | + * @return int |
|
| 98 | + * @throws DomainException |
|
| 99 | + */ |
|
| 100 | + public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null) |
|
| 101 | + { |
|
| 102 | + $transition = $this->getTimezoneTransitions($date_time_zone, $time); |
|
| 103 | + if (! isset($transition['offset'])) { |
|
| 104 | + throw new DomainException( |
|
| 105 | + sprintf( |
|
| 106 | + esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'), |
|
| 107 | + print_r($transition, true) |
|
| 108 | + ) |
|
| 109 | + ); |
|
| 110 | + } |
|
| 111 | + return $transition['offset']; |
|
| 112 | + } |
|
| 113 | 113 | |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Provide a timezone select input |
|
| 117 | - * |
|
| 118 | - * @param string $timezone_string |
|
| 119 | - * @return string |
|
| 120 | - * @throws EE_Error |
|
| 121 | - */ |
|
| 122 | - public function timezoneSelectInput($timezone_string = '') |
|
| 123 | - { |
|
| 124 | - // get WP date time format |
|
| 125 | - $datetime_format = get_option('date_format') . ' ' . get_option('time_format'); |
|
| 126 | - // if passed a value, then use that, else get WP option |
|
| 127 | - $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string'); |
|
| 128 | - // check if the timezone is valid but don't throw any errors if it isn't |
|
| 129 | - $timezone_string = $this->validateTimezone($timezone_string, false) |
|
| 130 | - ? $timezone_string |
|
| 131 | - : ''; |
|
| 132 | - $gmt_offset = get_option('gmt_offset'); |
|
| 133 | - $check_zone_info = true; |
|
| 134 | - if (empty($timezone_string)) { |
|
| 135 | - // Create a UTC+- zone if no timezone string exists |
|
| 136 | - $timezone_string = 'UTC'; |
|
| 137 | - $check_zone_info = false; |
|
| 138 | - if ($gmt_offset > 0) { |
|
| 139 | - $timezone_string = 'UTC+' . $gmt_offset; |
|
| 140 | - } elseif ($gmt_offset < 0) { |
|
| 141 | - $timezone_string = 'UTC' . $gmt_offset; |
|
| 142 | - } |
|
| 143 | - } |
|
| 144 | - ?> |
|
| 115 | + /** |
|
| 116 | + * Provide a timezone select input |
|
| 117 | + * |
|
| 118 | + * @param string $timezone_string |
|
| 119 | + * @return string |
|
| 120 | + * @throws EE_Error |
|
| 121 | + */ |
|
| 122 | + public function timezoneSelectInput($timezone_string = '') |
|
| 123 | + { |
|
| 124 | + // get WP date time format |
|
| 125 | + $datetime_format = get_option('date_format') . ' ' . get_option('time_format'); |
|
| 126 | + // if passed a value, then use that, else get WP option |
|
| 127 | + $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string'); |
|
| 128 | + // check if the timezone is valid but don't throw any errors if it isn't |
|
| 129 | + $timezone_string = $this->validateTimezone($timezone_string, false) |
|
| 130 | + ? $timezone_string |
|
| 131 | + : ''; |
|
| 132 | + $gmt_offset = get_option('gmt_offset'); |
|
| 133 | + $check_zone_info = true; |
|
| 134 | + if (empty($timezone_string)) { |
|
| 135 | + // Create a UTC+- zone if no timezone string exists |
|
| 136 | + $timezone_string = 'UTC'; |
|
| 137 | + $check_zone_info = false; |
|
| 138 | + if ($gmt_offset > 0) { |
|
| 139 | + $timezone_string = 'UTC+' . $gmt_offset; |
|
| 140 | + } elseif ($gmt_offset < 0) { |
|
| 141 | + $timezone_string = 'UTC' . $gmt_offset; |
|
| 142 | + } |
|
| 143 | + } |
|
| 144 | + ?> |
|
| 145 | 145 | <p> |
| 146 | 146 | <label for="timezone_string"><?php _e('timezone', 'event_espresso'); ?></label> |
| 147 | 147 | <select id="timezone_string" name="timezone_string"> |
@@ -154,150 +154,150 @@ discard block |
||
| 154 | 154 | <p> |
| 155 | 155 | <span> |
| 156 | 156 | <?php |
| 157 | - printf( |
|
| 158 | - __('%1$sUTC%2$s time is %3$s', 'event_espresso'), |
|
| 159 | - '<abbr title="Coordinated Universal Time">', |
|
| 160 | - '</abbr>', |
|
| 161 | - '<code>' . date_i18n($datetime_format, false, true) . '</code>' |
|
| 162 | - ); |
|
| 163 | - ?></span> |
|
| 157 | + printf( |
|
| 158 | + __('%1$sUTC%2$s time is %3$s', 'event_espresso'), |
|
| 159 | + '<abbr title="Coordinated Universal Time">', |
|
| 160 | + '</abbr>', |
|
| 161 | + '<code>' . date_i18n($datetime_format, false, true) . '</code>' |
|
| 162 | + ); |
|
| 163 | + ?></span> |
|
| 164 | 164 | <?php |
| 165 | - if (! empty($timezone_string) || ! empty($gmt_offset)) : ?> |
|
| 165 | + if (! empty($timezone_string) || ! empty($gmt_offset)) : ?> |
|
| 166 | 166 | <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span> |
| 167 | 167 | <?php |
| 168 | - endif; ?> |
|
| 168 | + endif; ?> |
|
| 169 | 169 | |
| 170 | 170 | <?php |
| 171 | - if ($check_zone_info && $timezone_string) : ?> |
|
| 171 | + if ($check_zone_info && $timezone_string) : ?> |
|
| 172 | 172 | <br/> |
| 173 | 173 | <span> |
| 174 | 174 | <?php |
| 175 | - // Set TZ so localtime works. |
|
| 176 | - date_default_timezone_set($timezone_string); |
|
| 177 | - $now = localtime(time(), true); |
|
| 178 | - if ($now['tm_isdst']) { |
|
| 179 | - _e('This timezone is currently in daylight saving time.', 'event_espresso'); |
|
| 180 | - } else { |
|
| 181 | - _e('This timezone is currently in standard time.', 'event_espresso'); |
|
| 182 | - } |
|
| 183 | - ?> |
|
| 175 | + // Set TZ so localtime works. |
|
| 176 | + date_default_timezone_set($timezone_string); |
|
| 177 | + $now = localtime(time(), true); |
|
| 178 | + if ($now['tm_isdst']) { |
|
| 179 | + _e('This timezone is currently in daylight saving time.', 'event_espresso'); |
|
| 180 | + } else { |
|
| 181 | + _e('This timezone is currently in standard time.', 'event_espresso'); |
|
| 182 | + } |
|
| 183 | + ?> |
|
| 184 | 184 | <br/> |
| 185 | 185 | <?php |
| 186 | - if (function_exists('timezone_transitions_get')) { |
|
| 187 | - $found = false; |
|
| 188 | - $date_time_zone_selected = new DateTimeZone($timezone_string); |
|
| 189 | - $tz_offset = timezone_offset_get($date_time_zone_selected, date_create()); |
|
| 190 | - $right_now = time(); |
|
| 191 | - $tr['isdst'] = false; |
|
| 192 | - foreach (timezone_transitions_get($date_time_zone_selected) as $tr) { |
|
| 193 | - if ($tr['ts'] > $right_now) { |
|
| 194 | - $found = true; |
|
| 195 | - break; |
|
| 196 | - } |
|
| 197 | - } |
|
| 198 | - if ($found) { |
|
| 199 | - $message = $tr['isdst'] |
|
| 200 | - ? __(' Daylight saving time begins on: %s.', 'event_espresso') |
|
| 201 | - : __(' Standard time begins on: %s.', 'event_espresso'); |
|
| 202 | - // Add the difference between the current offset and the new offset to ts to get the correct |
|
| 203 | - // transition time from date_i18n(). |
|
| 204 | - printf( |
|
| 205 | - $message, |
|
| 206 | - '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >' |
|
| 207 | - ); |
|
| 208 | - } else { |
|
| 209 | - _e('This timezone does not observe daylight saving time.', 'event_espresso'); |
|
| 210 | - } |
|
| 211 | - } |
|
| 212 | - // Set back to UTC. |
|
| 213 | - date_default_timezone_set('UTC'); |
|
| 214 | - ?> |
|
| 186 | + if (function_exists('timezone_transitions_get')) { |
|
| 187 | + $found = false; |
|
| 188 | + $date_time_zone_selected = new DateTimeZone($timezone_string); |
|
| 189 | + $tz_offset = timezone_offset_get($date_time_zone_selected, date_create()); |
|
| 190 | + $right_now = time(); |
|
| 191 | + $tr['isdst'] = false; |
|
| 192 | + foreach (timezone_transitions_get($date_time_zone_selected) as $tr) { |
|
| 193 | + if ($tr['ts'] > $right_now) { |
|
| 194 | + $found = true; |
|
| 195 | + break; |
|
| 196 | + } |
|
| 197 | + } |
|
| 198 | + if ($found) { |
|
| 199 | + $message = $tr['isdst'] |
|
| 200 | + ? __(' Daylight saving time begins on: %s.', 'event_espresso') |
|
| 201 | + : __(' Standard time begins on: %s.', 'event_espresso'); |
|
| 202 | + // Add the difference between the current offset and the new offset to ts to get the correct |
|
| 203 | + // transition time from date_i18n(). |
|
| 204 | + printf( |
|
| 205 | + $message, |
|
| 206 | + '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >' |
|
| 207 | + ); |
|
| 208 | + } else { |
|
| 209 | + _e('This timezone does not observe daylight saving time.', 'event_espresso'); |
|
| 210 | + } |
|
| 211 | + } |
|
| 212 | + // Set back to UTC. |
|
| 213 | + date_default_timezone_set('UTC'); |
|
| 214 | + ?> |
|
| 215 | 215 | </span></p> |
| 216 | 216 | <?php |
| 217 | - endif; |
|
| 218 | - } |
|
| 217 | + endif; |
|
| 218 | + } |
|
| 219 | 219 | |
| 220 | 220 | |
| 221 | - /** |
|
| 222 | - * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string. |
|
| 223 | - * If no unix timestamp is given then time() is used. If no timezone is given then the set timezone string for |
|
| 224 | - * the site is used. |
|
| 225 | - * This is used typically when using a Unix timestamp any core WP functions that expect their specially |
|
| 226 | - * computed timestamp (i.e. date_i18n() ) |
|
| 227 | - * |
|
| 228 | - * @param int $unix_timestamp if 0, then time() will be used. |
|
| 229 | - * @param string $timezone_string timezone_string. If empty, then the current set timezone for the |
|
| 230 | - * site will be used. |
|
| 231 | - * @return int unix_timestamp value with the offset applied for the given timezone. |
|
| 232 | - * @throws EE_Error |
|
| 233 | - */ |
|
| 234 | - public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '') |
|
| 235 | - { |
|
| 236 | - $unix_timestamp = $unix_timestamp === 0 ? time() : (int) $unix_timestamp; |
|
| 237 | - $timezone_string = $this->getValidTimezoneString($timezone_string); |
|
| 238 | - $TimeZone = new DateTimeZone($timezone_string); |
|
| 239 | - $DateTime = new DateTime('@' . $unix_timestamp, $TimeZone); |
|
| 240 | - $offset = timezone_offset_get($TimeZone, $DateTime); |
|
| 241 | - return (int) $DateTime->format('U') + (int) $offset; |
|
| 242 | - } |
|
| 221 | + /** |
|
| 222 | + * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string. |
|
| 223 | + * If no unix timestamp is given then time() is used. If no timezone is given then the set timezone string for |
|
| 224 | + * the site is used. |
|
| 225 | + * This is used typically when using a Unix timestamp any core WP functions that expect their specially |
|
| 226 | + * computed timestamp (i.e. date_i18n() ) |
|
| 227 | + * |
|
| 228 | + * @param int $unix_timestamp if 0, then time() will be used. |
|
| 229 | + * @param string $timezone_string timezone_string. If empty, then the current set timezone for the |
|
| 230 | + * site will be used. |
|
| 231 | + * @return int unix_timestamp value with the offset applied for the given timezone. |
|
| 232 | + * @throws EE_Error |
|
| 233 | + */ |
|
| 234 | + public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '') |
|
| 235 | + { |
|
| 236 | + $unix_timestamp = $unix_timestamp === 0 ? time() : (int) $unix_timestamp; |
|
| 237 | + $timezone_string = $this->getValidTimezoneString($timezone_string); |
|
| 238 | + $TimeZone = new DateTimeZone($timezone_string); |
|
| 239 | + $DateTime = new DateTime('@' . $unix_timestamp, $TimeZone); |
|
| 240 | + $offset = timezone_offset_get($TimeZone, $DateTime); |
|
| 241 | + return (int) $DateTime->format('U') + (int) $offset; |
|
| 242 | + } |
|
| 243 | 243 | |
| 244 | 244 | |
| 245 | - /** |
|
| 246 | - * Get Timezone Transitions |
|
| 247 | - * |
|
| 248 | - * @param DateTimeZone $date_time_zone |
|
| 249 | - * @param int|null $time |
|
| 250 | - * @param bool $first_only |
|
| 251 | - * @return array|mixed |
|
| 252 | - */ |
|
| 253 | - public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true) |
|
| 254 | - { |
|
| 255 | - $time = is_int($time) || $time === null ? $time : (int) strtotime($time); |
|
| 256 | - $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time(); |
|
| 257 | - $transitions = $date_time_zone->getTransitions($time); |
|
| 258 | - return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions; |
|
| 259 | - } |
|
| 245 | + /** |
|
| 246 | + * Get Timezone Transitions |
|
| 247 | + * |
|
| 248 | + * @param DateTimeZone $date_time_zone |
|
| 249 | + * @param int|null $time |
|
| 250 | + * @param bool $first_only |
|
| 251 | + * @return array|mixed |
|
| 252 | + */ |
|
| 253 | + public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true) |
|
| 254 | + { |
|
| 255 | + $time = is_int($time) || $time === null ? $time : (int) strtotime($time); |
|
| 256 | + $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time(); |
|
| 257 | + $transitions = $date_time_zone->getTransitions($time); |
|
| 258 | + return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions; |
|
| 259 | + } |
|
| 260 | 260 | |
| 261 | 261 | |
| 262 | 262 | |
| 263 | - /** |
|
| 264 | - * Default to just returning the provided $gmt_offset. Children can override if adjustment needed. |
|
| 265 | - * |
|
| 266 | - * @param int $gmt_offset |
|
| 267 | - * @return int |
|
| 268 | - */ |
|
| 269 | - public function adjustInvalidGmtOffsets($gmt_offset = 0) |
|
| 270 | - { |
|
| 271 | - return $gmt_offset; |
|
| 272 | - } |
|
| 263 | + /** |
|
| 264 | + * Default to just returning the provided $gmt_offset. Children can override if adjustment needed. |
|
| 265 | + * |
|
| 266 | + * @param int $gmt_offset |
|
| 267 | + * @return int |
|
| 268 | + */ |
|
| 269 | + public function adjustInvalidGmtOffsets($gmt_offset = 0) |
|
| 270 | + { |
|
| 271 | + return $gmt_offset; |
|
| 272 | + } |
|
| 273 | 273 | |
| 274 | 274 | |
| 275 | 275 | |
| 276 | - /** |
|
| 277 | - * This receives an incoming gmt_offset and santizes it. If the provide value is an empty string, then this will |
|
| 278 | - * attempt to get the offset from the timezone string. If this returns a string, then a timezone string was |
|
| 279 | - * successfully derived from existing timezone_string in the db. If not, then a float is returned for the provided |
|
| 280 | - * offset. |
|
| 281 | - * @param float|string $gmt_offset |
|
| 282 | - * @return float|string |
|
| 283 | - */ |
|
| 284 | - protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset) |
|
| 285 | - { |
|
| 286 | - // if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is |
|
| 287 | - // set because it will override `gmt_offset` via `pre_get_option` filter. If that's set, then let's just use |
|
| 288 | - // that! Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic. |
|
| 289 | - if ($gmt_offset === '') { |
|
| 290 | - // autoloaded so no need to set to a variable. There will not be multiple hits to the db. |
|
| 291 | - if (get_option('timezone_string')) { |
|
| 292 | - return (string) get_option('timezone_string'); |
|
| 293 | - } |
|
| 294 | - } |
|
| 295 | - $gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset'); |
|
| 296 | - $gmt_offset = (float) $gmt_offset; |
|
| 297 | - // if $gmt_offset is 0 or is still an empty string, then just return UTC |
|
| 298 | - if ($gmt_offset === (float) 0) { |
|
| 299 | - return 'UTC'; |
|
| 300 | - } |
|
| 301 | - return $gmt_offset; |
|
| 302 | - } |
|
| 276 | + /** |
|
| 277 | + * This receives an incoming gmt_offset and santizes it. If the provide value is an empty string, then this will |
|
| 278 | + * attempt to get the offset from the timezone string. If this returns a string, then a timezone string was |
|
| 279 | + * successfully derived from existing timezone_string in the db. If not, then a float is returned for the provided |
|
| 280 | + * offset. |
|
| 281 | + * @param float|string $gmt_offset |
|
| 282 | + * @return float|string |
|
| 283 | + */ |
|
| 284 | + protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset) |
|
| 285 | + { |
|
| 286 | + // if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is |
|
| 287 | + // set because it will override `gmt_offset` via `pre_get_option` filter. If that's set, then let's just use |
|
| 288 | + // that! Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic. |
|
| 289 | + if ($gmt_offset === '') { |
|
| 290 | + // autoloaded so no need to set to a variable. There will not be multiple hits to the db. |
|
| 291 | + if (get_option('timezone_string')) { |
|
| 292 | + return (string) get_option('timezone_string'); |
|
| 293 | + } |
|
| 294 | + } |
|
| 295 | + $gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset'); |
|
| 296 | + $gmt_offset = (float) $gmt_offset; |
|
| 297 | + // if $gmt_offset is 0 or is still an empty string, then just return UTC |
|
| 298 | + if ($gmt_offset === (float) 0) { |
|
| 299 | + return 'UTC'; |
|
| 300 | + } |
|
| 301 | + return $gmt_offset; |
|
| 302 | + } |
|
| 303 | 303 | } |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | new DateTimeZone($timezone_string); |
| 49 | 49 | } catch (Exception $e) { |
| 50 | 50 | // sometimes we take exception to exceptions |
| 51 | - if (! $throw_error) { |
|
| 51 | + if ( ! $throw_error) { |
|
| 52 | 52 | return false; |
| 53 | 53 | } |
| 54 | 54 | throw new EE_Error( |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null) |
| 101 | 101 | { |
| 102 | 102 | $transition = $this->getTimezoneTransitions($date_time_zone, $time); |
| 103 | - if (! isset($transition['offset'])) { |
|
| 103 | + if ( ! isset($transition['offset'])) { |
|
| 104 | 104 | throw new DomainException( |
| 105 | 105 | sprintf( |
| 106 | 106 | esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'), |
@@ -122,7 +122,7 @@ discard block |
||
| 122 | 122 | public function timezoneSelectInput($timezone_string = '') |
| 123 | 123 | { |
| 124 | 124 | // get WP date time format |
| 125 | - $datetime_format = get_option('date_format') . ' ' . get_option('time_format'); |
|
| 125 | + $datetime_format = get_option('date_format').' '.get_option('time_format'); |
|
| 126 | 126 | // if passed a value, then use that, else get WP option |
| 127 | 127 | $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string'); |
| 128 | 128 | // check if the timezone is valid but don't throw any errors if it isn't |
@@ -136,9 +136,9 @@ discard block |
||
| 136 | 136 | $timezone_string = 'UTC'; |
| 137 | 137 | $check_zone_info = false; |
| 138 | 138 | if ($gmt_offset > 0) { |
| 139 | - $timezone_string = 'UTC+' . $gmt_offset; |
|
| 139 | + $timezone_string = 'UTC+'.$gmt_offset; |
|
| 140 | 140 | } elseif ($gmt_offset < 0) { |
| 141 | - $timezone_string = 'UTC' . $gmt_offset; |
|
| 141 | + $timezone_string = 'UTC'.$gmt_offset; |
|
| 142 | 142 | } |
| 143 | 143 | } |
| 144 | 144 | ?> |
@@ -158,12 +158,12 @@ discard block |
||
| 158 | 158 | __('%1$sUTC%2$s time is %3$s', 'event_espresso'), |
| 159 | 159 | '<abbr title="Coordinated Universal Time">', |
| 160 | 160 | '</abbr>', |
| 161 | - '<code>' . date_i18n($datetime_format, false, true) . '</code>' |
|
| 161 | + '<code>'.date_i18n($datetime_format, false, true).'</code>' |
|
| 162 | 162 | ); |
| 163 | 163 | ?></span> |
| 164 | 164 | <?php |
| 165 | - if (! empty($timezone_string) || ! empty($gmt_offset)) : ?> |
|
| 166 | - <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span> |
|
| 165 | + if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?> |
|
| 166 | + <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>'.date_i18n($datetime_format).'</code>'); ?></span> |
|
| 167 | 167 | <?php |
| 168 | 168 | endif; ?> |
| 169 | 169 | |
@@ -203,7 +203,7 @@ discard block |
||
| 203 | 203 | // transition time from date_i18n(). |
| 204 | 204 | printf( |
| 205 | 205 | $message, |
| 206 | - '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >' |
|
| 206 | + '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >' |
|
| 207 | 207 | ); |
| 208 | 208 | } else { |
| 209 | 209 | _e('This timezone does not observe daylight saving time.', 'event_espresso'); |
@@ -236,7 +236,7 @@ discard block |
||
| 236 | 236 | $unix_timestamp = $unix_timestamp === 0 ? time() : (int) $unix_timestamp; |
| 237 | 237 | $timezone_string = $this->getValidTimezoneString($timezone_string); |
| 238 | 238 | $TimeZone = new DateTimeZone($timezone_string); |
| 239 | - $DateTime = new DateTime('@' . $unix_timestamp, $TimeZone); |
|
| 239 | + $DateTime = new DateTime('@'.$unix_timestamp, $TimeZone); |
|
| 240 | 240 | $offset = timezone_offset_get($TimeZone, $DateTime); |
| 241 | 241 | return (int) $DateTime->format('U') + (int) $offset; |
| 242 | 242 | } |
@@ -17,261 +17,261 @@ |
||
| 17 | 17 | class EE_Log |
| 18 | 18 | { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 23 | - private $_logs_folder = ''; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * @var string |
|
| 27 | - */ |
|
| 28 | - private $_log_file = ''; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 33 | - private $_log = ''; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 38 | - private $_debug_file = ''; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 43 | - private $_debug_log = ''; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * Used for remote logging |
|
| 47 | - * |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 50 | - private $_remote_logging_url = ''; |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * @var string |
|
| 54 | - */ |
|
| 55 | - private $_remote_log = ''; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * @var EE_Log |
|
| 59 | - */ |
|
| 60 | - private static $_instance; |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * @return EE_Log |
|
| 65 | - */ |
|
| 66 | - public static function instance() |
|
| 67 | - { |
|
| 68 | - if (! self::$_instance instanceof EE_Log) { |
|
| 69 | - self::$_instance = new self(); |
|
| 70 | - } |
|
| 71 | - return self::$_instance; |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * @access private |
|
| 76 | - * @return EE_Log |
|
| 77 | - */ |
|
| 78 | - private function __construct() |
|
| 79 | - { |
|
| 80 | - |
|
| 81 | - if (! EE_Registry::instance()->CFG->admin->use_full_logging |
|
| 82 | - && ! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
| 83 | - return; |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS; |
|
| 87 | - $this->_log_file = EE_Registry::instance()->CFG->admin->log_file_name(); |
|
| 88 | - $this->_log = ''; |
|
| 89 | - $this->_debug_file = EE_Registry::instance()->CFG->admin->debug_file_name(); |
|
| 90 | - $this->_debug_log = ''; |
|
| 91 | - $this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url; |
|
| 92 | - $this->_remote_log = ''; |
|
| 93 | - |
|
| 94 | - add_action('admin_init', array($this, 'verify_filesystem'), -10); |
|
| 95 | - add_action('AHEE_log', array($this, 'log'), 10, 4); |
|
| 96 | - if (EE_Registry::instance()->CFG->admin->use_full_logging) { |
|
| 97 | - add_action('shutdown', array($this, 'write_log'), 9999); |
|
| 98 | - // if WP_DEBUG |
|
| 99 | - add_action('shutdown', array($this, 'write_debug'), 9999); |
|
| 100 | - } |
|
| 101 | - if (EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
| 102 | - add_action('shutdown', array($this, 'send_log'), 9999); |
|
| 103 | - } |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * verify_filesystem |
|
| 109 | - * tests that the required files and folders exist and are writable |
|
| 110 | - * |
|
| 111 | - */ |
|
| 112 | - public function verify_filesystem() |
|
| 113 | - { |
|
| 114 | - try { |
|
| 115 | - EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_log_file); |
|
| 116 | - EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_debug_file); |
|
| 117 | - EEH_File::add_htaccess_deny_from_all($this->_logs_folder); |
|
| 118 | - } catch (EE_Error $e) { |
|
| 119 | - EE_Error::add_error( |
|
| 120 | - sprintf( |
|
| 121 | - __('Event Espresso logging could not be setup because: %s', 'event_espresso'), |
|
| 122 | - ' ' . $e->getMessage() |
|
| 123 | - ), |
|
| 124 | - __FILE__, |
|
| 125 | - __FUNCTION__, |
|
| 126 | - __LINE__ |
|
| 127 | - ); |
|
| 128 | - return; |
|
| 129 | - } |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * _format_message |
|
| 135 | - * makes yer log entries look all purdy |
|
| 136 | - * |
|
| 137 | - * @param string $file |
|
| 138 | - * @param string $function |
|
| 139 | - * @param string $message |
|
| 140 | - * @param string $type |
|
| 141 | - * @return string |
|
| 142 | - */ |
|
| 143 | - private function _format_message($file = '', $function = '', $message = '', $type = '') |
|
| 144 | - { |
|
| 145 | - $msg = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
| 146 | - $msg .= '[' . current_time('mysql') . '] '; |
|
| 147 | - $msg .= ! empty($file) ? basename($file) : ''; |
|
| 148 | - $msg .= ! empty($file) && ! empty($function) ? ' -> ' : ''; |
|
| 149 | - $msg .= ! empty($function) ? $function . '()' : ''; |
|
| 150 | - $msg .= PHP_EOL; |
|
| 151 | - $type = ! empty($type) ? $type : 'log message'; |
|
| 152 | - $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : ''; |
|
| 153 | - return $msg; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * log |
|
| 159 | - * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the |
|
| 160 | - * EE_Log::write_log() callback |
|
| 161 | - * |
|
| 162 | - * @param string $file |
|
| 163 | - * @param string $function |
|
| 164 | - * @param string $message |
|
| 165 | - * @param string $type |
|
| 166 | - */ |
|
| 167 | - public function log($file = '', $function = '', $message = '', $type = '') |
|
| 168 | - { |
|
| 169 | - $this->_log .= $this->_format_message($file, $function, $message, $type); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * write_log |
|
| 175 | - * appends the results of the 'AHEE_log' filter to the espresso log file |
|
| 176 | - */ |
|
| 177 | - public function write_log() |
|
| 178 | - { |
|
| 179 | - try { |
|
| 180 | - // get existing log file and append new log info |
|
| 181 | - $this->_log = EEH_File::get_file_contents($this->_logs_folder . $this->_log_file) . $this->_log; |
|
| 182 | - EEH_File::write_to_file($this->_logs_folder . $this->_log_file, $this->_log, 'Event Espresso Log'); |
|
| 183 | - } catch (EE_Error $e) { |
|
| 184 | - EE_Error::add_error( |
|
| 185 | - sprintf( |
|
| 186 | - __('Could not write to the Event Espresso log file because: %s', 'event_espresso'), |
|
| 187 | - ' ' . $e->getMessage() |
|
| 188 | - ), |
|
| 189 | - __FILE__, |
|
| 190 | - __FUNCTION__, |
|
| 191 | - __LINE__ |
|
| 192 | - ); |
|
| 193 | - return; |
|
| 194 | - } |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * send_log |
|
| 200 | - * sends the espresso log to a remote URL via a PHP cURL request |
|
| 201 | - */ |
|
| 202 | - public function send_log() |
|
| 203 | - { |
|
| 204 | - |
|
| 205 | - if (empty($this->_remote_logging_url)) { |
|
| 206 | - return; |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - $data = 'domain=' . $_SERVER['HTTP_HOST']; |
|
| 210 | - $data .= '&ip=' . $_SERVER['SERVER_ADDR']; |
|
| 211 | - $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE']; |
|
| 212 | - $data .= '&time=' . time(); |
|
| 213 | - $data .= '&remote_log=' . $this->_log; |
|
| 214 | - $data .= '&request_array=' . json_encode($_REQUEST); |
|
| 215 | - $data .= '&action=save'; |
|
| 216 | - |
|
| 217 | - if (defined('EELOGGING_PASS')) { |
|
| 218 | - $data .= '&pass=' . EELOGGING_PASS; |
|
| 219 | - } |
|
| 220 | - if (defined('EELOGGING_KEY')) { |
|
| 221 | - $data .= '&key=' . EELOGGING_KEY; |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - $c = curl_init($this->_remote_logging_url); |
|
| 225 | - curl_setopt($c, CURLOPT_POST, true); |
|
| 226 | - curl_setopt($c, CURLOPT_POSTFIELDS, $data); |
|
| 227 | - curl_setopt($c, CURLOPT_RETURNTRANSFER, true); |
|
| 228 | - curl_exec($c); |
|
| 229 | - curl_close($c); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * write_debug |
|
| 235 | - * writes the contents of the current request's $_GET and $_POST arrays to a log file. |
|
| 236 | - * previous entries are overwritten |
|
| 237 | - */ |
|
| 238 | - public function write_debug() |
|
| 239 | - { |
|
| 240 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 241 | - $this->_debug_log = ''; |
|
| 242 | - foreach ($_GET as $key => $value) { |
|
| 243 | - $this->_debug_log .= '$_GET["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL; |
|
| 244 | - } |
|
| 245 | - foreach ($_POST as $key => $value) { |
|
| 246 | - $this->_debug_log .= '$_POST["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL; |
|
| 247 | - } |
|
| 248 | - try { |
|
| 249 | - EEH_File::write_to_file( |
|
| 250 | - $this->_logs_folder . $this->_debug_file, |
|
| 251 | - $this->_debug_log, |
|
| 252 | - 'Event Espresso Debug Log' |
|
| 253 | - ); |
|
| 254 | - } catch (EE_Error $e) { |
|
| 255 | - EE_Error::add_error( |
|
| 256 | - sprintf( |
|
| 257 | - __('Could not write to the Event Espresso debug log file because: %s', 'event_espresso'), |
|
| 258 | - ' ' . $e->getMessage() |
|
| 259 | - ), |
|
| 260 | - __FILE__, |
|
| 261 | - __FUNCTION__, |
|
| 262 | - __LINE__ |
|
| 263 | - ); |
|
| 264 | - return; |
|
| 265 | - } |
|
| 266 | - } |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * __clone |
|
| 272 | - */ |
|
| 273 | - public function __clone() |
|
| 274 | - { |
|
| 275 | - trigger_error(__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR); |
|
| 276 | - } |
|
| 20 | + /** |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | + private $_logs_folder = ''; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * @var string |
|
| 27 | + */ |
|
| 28 | + private $_log_file = ''; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | + private $_log = ''; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | + private $_debug_file = ''; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | + private $_debug_log = ''; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * Used for remote logging |
|
| 47 | + * |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | + private $_remote_logging_url = ''; |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * @var string |
|
| 54 | + */ |
|
| 55 | + private $_remote_log = ''; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * @var EE_Log |
|
| 59 | + */ |
|
| 60 | + private static $_instance; |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * @return EE_Log |
|
| 65 | + */ |
|
| 66 | + public static function instance() |
|
| 67 | + { |
|
| 68 | + if (! self::$_instance instanceof EE_Log) { |
|
| 69 | + self::$_instance = new self(); |
|
| 70 | + } |
|
| 71 | + return self::$_instance; |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * @access private |
|
| 76 | + * @return EE_Log |
|
| 77 | + */ |
|
| 78 | + private function __construct() |
|
| 79 | + { |
|
| 80 | + |
|
| 81 | + if (! EE_Registry::instance()->CFG->admin->use_full_logging |
|
| 82 | + && ! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
| 83 | + return; |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS; |
|
| 87 | + $this->_log_file = EE_Registry::instance()->CFG->admin->log_file_name(); |
|
| 88 | + $this->_log = ''; |
|
| 89 | + $this->_debug_file = EE_Registry::instance()->CFG->admin->debug_file_name(); |
|
| 90 | + $this->_debug_log = ''; |
|
| 91 | + $this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url; |
|
| 92 | + $this->_remote_log = ''; |
|
| 93 | + |
|
| 94 | + add_action('admin_init', array($this, 'verify_filesystem'), -10); |
|
| 95 | + add_action('AHEE_log', array($this, 'log'), 10, 4); |
|
| 96 | + if (EE_Registry::instance()->CFG->admin->use_full_logging) { |
|
| 97 | + add_action('shutdown', array($this, 'write_log'), 9999); |
|
| 98 | + // if WP_DEBUG |
|
| 99 | + add_action('shutdown', array($this, 'write_debug'), 9999); |
|
| 100 | + } |
|
| 101 | + if (EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
| 102 | + add_action('shutdown', array($this, 'send_log'), 9999); |
|
| 103 | + } |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * verify_filesystem |
|
| 109 | + * tests that the required files and folders exist and are writable |
|
| 110 | + * |
|
| 111 | + */ |
|
| 112 | + public function verify_filesystem() |
|
| 113 | + { |
|
| 114 | + try { |
|
| 115 | + EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_log_file); |
|
| 116 | + EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_debug_file); |
|
| 117 | + EEH_File::add_htaccess_deny_from_all($this->_logs_folder); |
|
| 118 | + } catch (EE_Error $e) { |
|
| 119 | + EE_Error::add_error( |
|
| 120 | + sprintf( |
|
| 121 | + __('Event Espresso logging could not be setup because: %s', 'event_espresso'), |
|
| 122 | + ' ' . $e->getMessage() |
|
| 123 | + ), |
|
| 124 | + __FILE__, |
|
| 125 | + __FUNCTION__, |
|
| 126 | + __LINE__ |
|
| 127 | + ); |
|
| 128 | + return; |
|
| 129 | + } |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * _format_message |
|
| 135 | + * makes yer log entries look all purdy |
|
| 136 | + * |
|
| 137 | + * @param string $file |
|
| 138 | + * @param string $function |
|
| 139 | + * @param string $message |
|
| 140 | + * @param string $type |
|
| 141 | + * @return string |
|
| 142 | + */ |
|
| 143 | + private function _format_message($file = '', $function = '', $message = '', $type = '') |
|
| 144 | + { |
|
| 145 | + $msg = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
| 146 | + $msg .= '[' . current_time('mysql') . '] '; |
|
| 147 | + $msg .= ! empty($file) ? basename($file) : ''; |
|
| 148 | + $msg .= ! empty($file) && ! empty($function) ? ' -> ' : ''; |
|
| 149 | + $msg .= ! empty($function) ? $function . '()' : ''; |
|
| 150 | + $msg .= PHP_EOL; |
|
| 151 | + $type = ! empty($type) ? $type : 'log message'; |
|
| 152 | + $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : ''; |
|
| 153 | + return $msg; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * log |
|
| 159 | + * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the |
|
| 160 | + * EE_Log::write_log() callback |
|
| 161 | + * |
|
| 162 | + * @param string $file |
|
| 163 | + * @param string $function |
|
| 164 | + * @param string $message |
|
| 165 | + * @param string $type |
|
| 166 | + */ |
|
| 167 | + public function log($file = '', $function = '', $message = '', $type = '') |
|
| 168 | + { |
|
| 169 | + $this->_log .= $this->_format_message($file, $function, $message, $type); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * write_log |
|
| 175 | + * appends the results of the 'AHEE_log' filter to the espresso log file |
|
| 176 | + */ |
|
| 177 | + public function write_log() |
|
| 178 | + { |
|
| 179 | + try { |
|
| 180 | + // get existing log file and append new log info |
|
| 181 | + $this->_log = EEH_File::get_file_contents($this->_logs_folder . $this->_log_file) . $this->_log; |
|
| 182 | + EEH_File::write_to_file($this->_logs_folder . $this->_log_file, $this->_log, 'Event Espresso Log'); |
|
| 183 | + } catch (EE_Error $e) { |
|
| 184 | + EE_Error::add_error( |
|
| 185 | + sprintf( |
|
| 186 | + __('Could not write to the Event Espresso log file because: %s', 'event_espresso'), |
|
| 187 | + ' ' . $e->getMessage() |
|
| 188 | + ), |
|
| 189 | + __FILE__, |
|
| 190 | + __FUNCTION__, |
|
| 191 | + __LINE__ |
|
| 192 | + ); |
|
| 193 | + return; |
|
| 194 | + } |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * send_log |
|
| 200 | + * sends the espresso log to a remote URL via a PHP cURL request |
|
| 201 | + */ |
|
| 202 | + public function send_log() |
|
| 203 | + { |
|
| 204 | + |
|
| 205 | + if (empty($this->_remote_logging_url)) { |
|
| 206 | + return; |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + $data = 'domain=' . $_SERVER['HTTP_HOST']; |
|
| 210 | + $data .= '&ip=' . $_SERVER['SERVER_ADDR']; |
|
| 211 | + $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE']; |
|
| 212 | + $data .= '&time=' . time(); |
|
| 213 | + $data .= '&remote_log=' . $this->_log; |
|
| 214 | + $data .= '&request_array=' . json_encode($_REQUEST); |
|
| 215 | + $data .= '&action=save'; |
|
| 216 | + |
|
| 217 | + if (defined('EELOGGING_PASS')) { |
|
| 218 | + $data .= '&pass=' . EELOGGING_PASS; |
|
| 219 | + } |
|
| 220 | + if (defined('EELOGGING_KEY')) { |
|
| 221 | + $data .= '&key=' . EELOGGING_KEY; |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + $c = curl_init($this->_remote_logging_url); |
|
| 225 | + curl_setopt($c, CURLOPT_POST, true); |
|
| 226 | + curl_setopt($c, CURLOPT_POSTFIELDS, $data); |
|
| 227 | + curl_setopt($c, CURLOPT_RETURNTRANSFER, true); |
|
| 228 | + curl_exec($c); |
|
| 229 | + curl_close($c); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * write_debug |
|
| 235 | + * writes the contents of the current request's $_GET and $_POST arrays to a log file. |
|
| 236 | + * previous entries are overwritten |
|
| 237 | + */ |
|
| 238 | + public function write_debug() |
|
| 239 | + { |
|
| 240 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 241 | + $this->_debug_log = ''; |
|
| 242 | + foreach ($_GET as $key => $value) { |
|
| 243 | + $this->_debug_log .= '$_GET["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL; |
|
| 244 | + } |
|
| 245 | + foreach ($_POST as $key => $value) { |
|
| 246 | + $this->_debug_log .= '$_POST["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL; |
|
| 247 | + } |
|
| 248 | + try { |
|
| 249 | + EEH_File::write_to_file( |
|
| 250 | + $this->_logs_folder . $this->_debug_file, |
|
| 251 | + $this->_debug_log, |
|
| 252 | + 'Event Espresso Debug Log' |
|
| 253 | + ); |
|
| 254 | + } catch (EE_Error $e) { |
|
| 255 | + EE_Error::add_error( |
|
| 256 | + sprintf( |
|
| 257 | + __('Could not write to the Event Espresso debug log file because: %s', 'event_espresso'), |
|
| 258 | + ' ' . $e->getMessage() |
|
| 259 | + ), |
|
| 260 | + __FILE__, |
|
| 261 | + __FUNCTION__, |
|
| 262 | + __LINE__ |
|
| 263 | + ); |
|
| 264 | + return; |
|
| 265 | + } |
|
| 266 | + } |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * __clone |
|
| 272 | + */ |
|
| 273 | + public function __clone() |
|
| 274 | + { |
|
| 275 | + trigger_error(__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR); |
|
| 276 | + } |
|
| 277 | 277 | } |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | */ |
| 66 | 66 | public static function instance() |
| 67 | 67 | { |
| 68 | - if (! self::$_instance instanceof EE_Log) { |
|
| 68 | + if ( ! self::$_instance instanceof EE_Log) { |
|
| 69 | 69 | self::$_instance = new self(); |
| 70 | 70 | } |
| 71 | 71 | return self::$_instance; |
@@ -78,12 +78,12 @@ discard block |
||
| 78 | 78 | private function __construct() |
| 79 | 79 | { |
| 80 | 80 | |
| 81 | - if (! EE_Registry::instance()->CFG->admin->use_full_logging |
|
| 81 | + if ( ! EE_Registry::instance()->CFG->admin->use_full_logging |
|
| 82 | 82 | && ! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
| 83 | 83 | return; |
| 84 | 84 | } |
| 85 | 85 | |
| 86 | - $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS; |
|
| 86 | + $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS; |
|
| 87 | 87 | $this->_log_file = EE_Registry::instance()->CFG->admin->log_file_name(); |
| 88 | 88 | $this->_log = ''; |
| 89 | 89 | $this->_debug_file = EE_Registry::instance()->CFG->admin->debug_file_name(); |
@@ -112,14 +112,14 @@ discard block |
||
| 112 | 112 | public function verify_filesystem() |
| 113 | 113 | { |
| 114 | 114 | try { |
| 115 | - EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_log_file); |
|
| 116 | - EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_debug_file); |
|
| 115 | + EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder.$this->_log_file); |
|
| 116 | + EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder.$this->_debug_file); |
|
| 117 | 117 | EEH_File::add_htaccess_deny_from_all($this->_logs_folder); |
| 118 | 118 | } catch (EE_Error $e) { |
| 119 | 119 | EE_Error::add_error( |
| 120 | 120 | sprintf( |
| 121 | 121 | __('Event Espresso logging could not be setup because: %s', 'event_espresso'), |
| 122 | - ' ' . $e->getMessage() |
|
| 122 | + ' '.$e->getMessage() |
|
| 123 | 123 | ), |
| 124 | 124 | __FILE__, |
| 125 | 125 | __FUNCTION__, |
@@ -142,14 +142,14 @@ discard block |
||
| 142 | 142 | */ |
| 143 | 143 | private function _format_message($file = '', $function = '', $message = '', $type = '') |
| 144 | 144 | { |
| 145 | - $msg = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
| 146 | - $msg .= '[' . current_time('mysql') . '] '; |
|
| 145 | + $msg = '----------------------------------------------------------------------------------------'.PHP_EOL; |
|
| 146 | + $msg .= '['.current_time('mysql').'] '; |
|
| 147 | 147 | $msg .= ! empty($file) ? basename($file) : ''; |
| 148 | 148 | $msg .= ! empty($file) && ! empty($function) ? ' -> ' : ''; |
| 149 | - $msg .= ! empty($function) ? $function . '()' : ''; |
|
| 149 | + $msg .= ! empty($function) ? $function.'()' : ''; |
|
| 150 | 150 | $msg .= PHP_EOL; |
| 151 | 151 | $type = ! empty($type) ? $type : 'log message'; |
| 152 | - $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : ''; |
|
| 152 | + $msg .= ! empty($message) ? "\t".'['.$type.'] '.$message.PHP_EOL : ''; |
|
| 153 | 153 | return $msg; |
| 154 | 154 | } |
| 155 | 155 | |
@@ -178,13 +178,13 @@ discard block |
||
| 178 | 178 | { |
| 179 | 179 | try { |
| 180 | 180 | // get existing log file and append new log info |
| 181 | - $this->_log = EEH_File::get_file_contents($this->_logs_folder . $this->_log_file) . $this->_log; |
|
| 182 | - EEH_File::write_to_file($this->_logs_folder . $this->_log_file, $this->_log, 'Event Espresso Log'); |
|
| 181 | + $this->_log = EEH_File::get_file_contents($this->_logs_folder.$this->_log_file).$this->_log; |
|
| 182 | + EEH_File::write_to_file($this->_logs_folder.$this->_log_file, $this->_log, 'Event Espresso Log'); |
|
| 183 | 183 | } catch (EE_Error $e) { |
| 184 | 184 | EE_Error::add_error( |
| 185 | 185 | sprintf( |
| 186 | 186 | __('Could not write to the Event Espresso log file because: %s', 'event_espresso'), |
| 187 | - ' ' . $e->getMessage() |
|
| 187 | + ' '.$e->getMessage() |
|
| 188 | 188 | ), |
| 189 | 189 | __FILE__, |
| 190 | 190 | __FUNCTION__, |
@@ -206,19 +206,19 @@ discard block |
||
| 206 | 206 | return; |
| 207 | 207 | } |
| 208 | 208 | |
| 209 | - $data = 'domain=' . $_SERVER['HTTP_HOST']; |
|
| 210 | - $data .= '&ip=' . $_SERVER['SERVER_ADDR']; |
|
| 211 | - $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE']; |
|
| 212 | - $data .= '&time=' . time(); |
|
| 213 | - $data .= '&remote_log=' . $this->_log; |
|
| 214 | - $data .= '&request_array=' . json_encode($_REQUEST); |
|
| 209 | + $data = 'domain='.$_SERVER['HTTP_HOST']; |
|
| 210 | + $data .= '&ip='.$_SERVER['SERVER_ADDR']; |
|
| 211 | + $data .= '&server_type='.$_SERVER['SERVER_SOFTWARE']; |
|
| 212 | + $data .= '&time='.time(); |
|
| 213 | + $data .= '&remote_log='.$this->_log; |
|
| 214 | + $data .= '&request_array='.json_encode($_REQUEST); |
|
| 215 | 215 | $data .= '&action=save'; |
| 216 | 216 | |
| 217 | 217 | if (defined('EELOGGING_PASS')) { |
| 218 | - $data .= '&pass=' . EELOGGING_PASS; |
|
| 218 | + $data .= '&pass='.EELOGGING_PASS; |
|
| 219 | 219 | } |
| 220 | 220 | if (defined('EELOGGING_KEY')) { |
| 221 | - $data .= '&key=' . EELOGGING_KEY; |
|
| 221 | + $data .= '&key='.EELOGGING_KEY; |
|
| 222 | 222 | } |
| 223 | 223 | |
| 224 | 224 | $c = curl_init($this->_remote_logging_url); |
@@ -240,14 +240,14 @@ discard block |
||
| 240 | 240 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 241 | 241 | $this->_debug_log = ''; |
| 242 | 242 | foreach ($_GET as $key => $value) { |
| 243 | - $this->_debug_log .= '$_GET["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL; |
|
| 243 | + $this->_debug_log .= '$_GET["'.$key.'"] = "'.serialize($value).'"'.PHP_EOL; |
|
| 244 | 244 | } |
| 245 | 245 | foreach ($_POST as $key => $value) { |
| 246 | - $this->_debug_log .= '$_POST["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL; |
|
| 246 | + $this->_debug_log .= '$_POST["'.$key.'"] = "'.serialize($value).'"'.PHP_EOL; |
|
| 247 | 247 | } |
| 248 | 248 | try { |
| 249 | 249 | EEH_File::write_to_file( |
| 250 | - $this->_logs_folder . $this->_debug_file, |
|
| 250 | + $this->_logs_folder.$this->_debug_file, |
|
| 251 | 251 | $this->_debug_log, |
| 252 | 252 | 'Event Espresso Debug Log' |
| 253 | 253 | ); |
@@ -255,7 +255,7 @@ discard block |
||
| 255 | 255 | EE_Error::add_error( |
| 256 | 256 | sprintf( |
| 257 | 257 | __('Could not write to the Event Espresso debug log file because: %s', 'event_espresso'), |
| 258 | - ' ' . $e->getMessage() |
|
| 258 | + ' '.$e->getMessage() |
|
| 259 | 259 | ), |
| 260 | 260 | __FILE__, |
| 261 | 261 | __FUNCTION__, |