@@ -23,7 +23,7 @@ |
||
| 23 | 23 | public function validate($email_address) |
| 24 | 24 | { |
| 25 | 25 | parent::validate($email_address); |
| 26 | - if (! is_email($email_address)) { |
|
| 26 | + if ( ! is_email($email_address)) { |
|
| 27 | 27 | throw new EmailValidationException( |
| 28 | 28 | esc_html__('The email address provided is not valid.', 'event_espresso') |
| 29 | 29 | ); |
@@ -14,19 +14,19 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class WordPress extends Basic |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * @param string $email_address |
|
| 19 | - * @return boolean |
|
| 20 | - * @throws EmailValidationException |
|
| 21 | - */ |
|
| 22 | - public function validate($email_address) |
|
| 23 | - { |
|
| 24 | - parent::validate($email_address); |
|
| 25 | - if (! is_email($email_address)) { |
|
| 26 | - throw new EmailValidationException( |
|
| 27 | - esc_html__('The email address provided is not valid.', 'event_espresso') |
|
| 28 | - ); |
|
| 29 | - } |
|
| 30 | - return true; |
|
| 31 | - } |
|
| 17 | + /** |
|
| 18 | + * @param string $email_address |
|
| 19 | + * @return boolean |
|
| 20 | + * @throws EmailValidationException |
|
| 21 | + */ |
|
| 22 | + public function validate($email_address) |
|
| 23 | + { |
|
| 24 | + parent::validate($email_address); |
|
| 25 | + if (! is_email($email_address)) { |
|
| 26 | + throw new EmailValidationException( |
|
| 27 | + esc_html__('The email address provided is not valid.', 'event_espresso') |
|
| 28 | + ); |
|
| 29 | + } |
|
| 30 | + return true; |
|
| 31 | + } |
|
| 32 | 32 | } |
@@ -4,31 +4,31 @@ |
||
| 4 | 4 | interface SetHooksInterface |
| 5 | 5 | { |
| 6 | 6 | |
| 7 | - /** |
|
| 8 | - * a place to add action and filter hooks for regular frontend requests |
|
| 9 | - * |
|
| 10 | - * @return void |
|
| 11 | - */ |
|
| 12 | - public function setHooks(); |
|
| 7 | + /** |
|
| 8 | + * a place to add action and filter hooks for regular frontend requests |
|
| 9 | + * |
|
| 10 | + * @return void |
|
| 11 | + */ |
|
| 12 | + public function setHooks(); |
|
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * a place to add action and filter hooks for regular WP admin requests |
|
| 16 | - * |
|
| 17 | - * @return void |
|
| 18 | - */ |
|
| 19 | - public function setAdminHooks(); |
|
| 14 | + /** |
|
| 15 | + * a place to add action and filter hooks for regular WP admin requests |
|
| 16 | + * |
|
| 17 | + * @return void |
|
| 18 | + */ |
|
| 19 | + public function setAdminHooks(); |
|
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * a place to add action and filter hooks for AJAX requests |
|
| 23 | - * |
|
| 24 | - * @return void |
|
| 25 | - */ |
|
| 26 | - public function setAjaxHooks(); |
|
| 21 | + /** |
|
| 22 | + * a place to add action and filter hooks for AJAX requests |
|
| 23 | + * |
|
| 24 | + * @return void |
|
| 25 | + */ |
|
| 26 | + public function setAjaxHooks(); |
|
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * a place to add action and filter hooks for REST API requests |
|
| 30 | - * |
|
| 31 | - * @return void |
|
| 32 | - */ |
|
| 33 | - public function setApiHooks(); |
|
| 28 | + /** |
|
| 29 | + * a place to add action and filter hooks for REST API requests |
|
| 30 | + * |
|
| 31 | + * @return void |
|
| 32 | + */ |
|
| 33 | + public function setApiHooks(); |
|
| 34 | 34 | } |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | ); |
| 103 | 103 | } |
| 104 | 104 | // add defaults for missing pieces |
| 105 | - $version_parts += array(0,0,0,'p',0); |
|
| 105 | + $version_parts += array(0, 0, 0, 'p', 0); |
|
| 106 | 106 | // reassign to individual variables |
| 107 | 107 | list($major, $minor, $patch, $release, $build) = $version_parts; |
| 108 | 108 | return new Version( |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | */ |
| 131 | 131 | private function setMajor($major) |
| 132 | 132 | { |
| 133 | - if (! is_int($major)) { |
|
| 133 | + if ( ! is_int($major)) { |
|
| 134 | 134 | throw new InvalidDataTypeException( |
| 135 | 135 | '$major', |
| 136 | 136 | $major, |
@@ -156,7 +156,7 @@ discard block |
||
| 156 | 156 | */ |
| 157 | 157 | private function setMinor($minor) |
| 158 | 158 | { |
| 159 | - if (! is_int($minor)) { |
|
| 159 | + if ( ! is_int($minor)) { |
|
| 160 | 160 | throw new InvalidDataTypeException( |
| 161 | 161 | '$minor', |
| 162 | 162 | $minor, |
@@ -182,7 +182,7 @@ discard block |
||
| 182 | 182 | */ |
| 183 | 183 | private function setPatch($patch) |
| 184 | 184 | { |
| 185 | - if (! is_int($patch)) { |
|
| 185 | + if ( ! is_int($patch)) { |
|
| 186 | 186 | throw new InvalidDataTypeException( |
| 187 | 187 | '$patch', |
| 188 | 188 | $patch, |
@@ -214,7 +214,7 @@ discard block |
||
| 214 | 214 | Version::RELEASE_TYPE_DECAF, |
| 215 | 215 | Version::RELEASE_TYPE_PROD, |
| 216 | 216 | ); |
| 217 | - if (! in_array($release, $valid_release_types, true)) { |
|
| 217 | + if ( ! in_array($release, $valid_release_types, true)) { |
|
| 218 | 218 | throw new InvalidArgumentException( |
| 219 | 219 | sprintf( |
| 220 | 220 | esc_html__( |
@@ -245,7 +245,7 @@ discard block |
||
| 245 | 245 | */ |
| 246 | 246 | private function setBuild($build) |
| 247 | 247 | { |
| 248 | - if (! is_int($build)) { |
|
| 248 | + if ( ! is_int($build)) { |
|
| 249 | 249 | throw new InvalidDataTypeException( |
| 250 | 250 | '$build', |
| 251 | 251 | $build, |
@@ -303,7 +303,7 @@ discard block |
||
| 303 | 303 | { |
| 304 | 304 | $version_string = "{$this->major}.{$this->minor}.{$this->patch}.{$this->release}"; |
| 305 | 305 | if ($this->release !== Version::RELEASE_TYPE_PROD && $this->release !== Version::RELEASE_TYPE_DECAF) { |
| 306 | - $version_string .= '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT); |
|
| 306 | + $version_string .= '.'.str_pad($this->build, 3, '0', STR_PAD_LEFT); |
|
| 307 | 307 | } |
| 308 | 308 | return $version_string; |
| 309 | 309 | } |
@@ -15,295 +15,295 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class Version |
| 17 | 17 | { |
| 18 | - const RELEASE_TYPE_RC = 'rc'; |
|
| 19 | - |
|
| 20 | - const RELEASE_TYPE_BETA = 'beta'; |
|
| 21 | - |
|
| 22 | - const RELEASE_TYPE_DECAF = 'decaf'; |
|
| 23 | - |
|
| 24 | - const RELEASE_TYPE_PROD = 'p'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * @var int $major |
|
| 28 | - */ |
|
| 29 | - private $major; |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * @var int $minor |
|
| 33 | - */ |
|
| 34 | - private $minor; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var int $patch |
|
| 38 | - */ |
|
| 39 | - private $patch; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * @var string $release |
|
| 43 | - */ |
|
| 44 | - private $release; |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * @var int $build |
|
| 48 | - */ |
|
| 49 | - private $build; |
|
| 50 | - |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Version constructor. |
|
| 54 | - * |
|
| 55 | - * @param int $major |
|
| 56 | - * @param int $minor |
|
| 57 | - * @param int $patch |
|
| 58 | - * @param string $release |
|
| 59 | - * @param int $build |
|
| 60 | - * @throws InvalidDataTypeException |
|
| 61 | - * @throws InvalidArgumentException |
|
| 62 | - */ |
|
| 63 | - public function __construct($major, $minor, $patch, $release = Version::RELEASE_TYPE_PROD, $build = 0) |
|
| 64 | - { |
|
| 65 | - $this->setMajor($major); |
|
| 66 | - $this->setMinor($minor); |
|
| 67 | - $this->setPatch($patch); |
|
| 68 | - $this->setRelease($release); |
|
| 69 | - $this->setBuild($build); |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * @param string $version_string |
|
| 75 | - * @return Version |
|
| 76 | - * @throws InvalidArgumentException |
|
| 77 | - */ |
|
| 78 | - public static function fromString($version_string) |
|
| 79 | - { |
|
| 80 | - // compare incoming version string against the lowest possible valid version |
|
| 81 | - if (version_compare($version_string, '0.0.1.dev.001', '<')) { |
|
| 82 | - throw new InvalidArgumentException( |
|
| 83 | - sprintf( |
|
| 84 | - esc_html__('"%1$s" is not a valid version string', 'event_espresso'), |
|
| 85 | - $version_string |
|
| 86 | - ) |
|
| 87 | - ); |
|
| 88 | - } |
|
| 89 | - // break apart incoming version string |
|
| 90 | - $version_parts = explode('.', $version_string); |
|
| 91 | - // verify that version string at least contains {major}.{minor}.{patch} |
|
| 92 | - if (count($version_parts) < 3) { |
|
| 93 | - throw new InvalidArgumentException( |
|
| 94 | - sprintf( |
|
| 95 | - esc_html__( |
|
| 96 | - 'At minimum, a version string needs to be in a "{major}.{minor}.{patch}" format, therefore "%1$s" is not valid', |
|
| 97 | - 'event_espresso' |
|
| 98 | - ), |
|
| 99 | - $version_string |
|
| 100 | - ) |
|
| 101 | - ); |
|
| 102 | - } |
|
| 103 | - // add defaults for missing pieces |
|
| 104 | - $version_parts += array(0,0,0,'p',0); |
|
| 105 | - // reassign to individual variables |
|
| 106 | - list($major, $minor, $patch, $release, $build) = $version_parts; |
|
| 107 | - return new Version( |
|
| 108 | - (int) $major, |
|
| 109 | - (int) $minor, |
|
| 110 | - (int) $patch, |
|
| 111 | - $release, |
|
| 112 | - (int) $build |
|
| 113 | - ); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * @return int |
|
| 119 | - */ |
|
| 120 | - public function major() |
|
| 121 | - { |
|
| 122 | - return $this->major; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * @param int|string $major |
|
| 128 | - * @throws InvalidDataTypeException |
|
| 129 | - */ |
|
| 130 | - private function setMajor($major) |
|
| 131 | - { |
|
| 132 | - if (! is_int($major)) { |
|
| 133 | - throw new InvalidDataTypeException( |
|
| 134 | - '$major', |
|
| 135 | - $major, |
|
| 136 | - 'integer' |
|
| 137 | - ); |
|
| 138 | - } |
|
| 139 | - $this->major = absint($major); |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @return int |
|
| 145 | - */ |
|
| 146 | - public function minor() |
|
| 147 | - { |
|
| 148 | - return $this->minor; |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * @param int|string $minor |
|
| 154 | - * @throws InvalidDataTypeException |
|
| 155 | - */ |
|
| 156 | - private function setMinor($minor) |
|
| 157 | - { |
|
| 158 | - if (! is_int($minor)) { |
|
| 159 | - throw new InvalidDataTypeException( |
|
| 160 | - '$minor', |
|
| 161 | - $minor, |
|
| 162 | - 'integer' |
|
| 163 | - ); |
|
| 164 | - } |
|
| 165 | - $this->minor = absint($minor); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * @return int |
|
| 171 | - */ |
|
| 172 | - public function patch() |
|
| 173 | - { |
|
| 174 | - return $this->patch; |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * @param int|string $patch |
|
| 180 | - * @throws InvalidDataTypeException |
|
| 181 | - */ |
|
| 182 | - private function setPatch($patch) |
|
| 183 | - { |
|
| 184 | - if (! is_int($patch)) { |
|
| 185 | - throw new InvalidDataTypeException( |
|
| 186 | - '$patch', |
|
| 187 | - $patch, |
|
| 188 | - 'integer' |
|
| 189 | - ); |
|
| 190 | - } |
|
| 191 | - $this->patch = absint($patch); |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * @return string |
|
| 197 | - */ |
|
| 198 | - public function release() |
|
| 199 | - { |
|
| 200 | - return $this->release; |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * @param string $release |
|
| 206 | - * @throws InvalidArgumentException |
|
| 207 | - */ |
|
| 208 | - private function setRelease($release) |
|
| 209 | - { |
|
| 210 | - $valid_release_types = array( |
|
| 211 | - Version::RELEASE_TYPE_RC, |
|
| 212 | - Version::RELEASE_TYPE_BETA, |
|
| 213 | - Version::RELEASE_TYPE_DECAF, |
|
| 214 | - Version::RELEASE_TYPE_PROD, |
|
| 215 | - ); |
|
| 216 | - if (! in_array($release, $valid_release_types, true)) { |
|
| 217 | - throw new InvalidArgumentException( |
|
| 218 | - sprintf( |
|
| 219 | - esc_html__( |
|
| 220 | - '"%1$s" is not a valid release type. Please use one of the following values: %2$s', |
|
| 221 | - 'event_espresso' |
|
| 222 | - ), |
|
| 223 | - $release, |
|
| 224 | - implode(', ', $valid_release_types) |
|
| 225 | - ) |
|
| 226 | - ); |
|
| 227 | - } |
|
| 228 | - $this->release = $release; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * @return int |
|
| 234 | - */ |
|
| 235 | - public function build() |
|
| 236 | - { |
|
| 237 | - return $this->build; |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * @param int|string $build |
|
| 243 | - * @throws InvalidDataTypeException |
|
| 244 | - */ |
|
| 245 | - private function setBuild($build) |
|
| 246 | - { |
|
| 247 | - if (! is_int($build)) { |
|
| 248 | - throw new InvalidDataTypeException( |
|
| 249 | - '$build', |
|
| 250 | - $build, |
|
| 251 | - 'integer' |
|
| 252 | - ); |
|
| 253 | - } |
|
| 254 | - $this->build = absint($build); |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * @param Version $other_version |
|
| 260 | - * @return int |
|
| 261 | - */ |
|
| 262 | - public function compare($other_version) |
|
| 263 | - { |
|
| 264 | - return version_compare((string) $this, (string) $other_version); |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * @param Version $other_version |
|
| 270 | - * @return bool |
|
| 271 | - */ |
|
| 272 | - public function equals($other_version) |
|
| 273 | - { |
|
| 274 | - return version_compare((string) $this, (string) $other_version, '=='); |
|
| 275 | - } |
|
| 276 | - |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * @param Version $other_version |
|
| 280 | - * @return bool |
|
| 281 | - */ |
|
| 282 | - public function newerThan($other_version) |
|
| 283 | - { |
|
| 284 | - return version_compare((string) $this, (string) $other_version, '>'); |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * @param Version $other_version |
|
| 290 | - * @return bool |
|
| 291 | - */ |
|
| 292 | - public function olderThan($other_version) |
|
| 293 | - { |
|
| 294 | - return version_compare((string) $this, (string) $other_version, '<'); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * @return string |
|
| 300 | - */ |
|
| 301 | - public function __toString() |
|
| 302 | - { |
|
| 303 | - $version_string = "{$this->major}.{$this->minor}.{$this->patch}.{$this->release}"; |
|
| 304 | - if ($this->release !== Version::RELEASE_TYPE_PROD && $this->release !== Version::RELEASE_TYPE_DECAF) { |
|
| 305 | - $version_string .= '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT); |
|
| 306 | - } |
|
| 307 | - return $version_string; |
|
| 308 | - } |
|
| 18 | + const RELEASE_TYPE_RC = 'rc'; |
|
| 19 | + |
|
| 20 | + const RELEASE_TYPE_BETA = 'beta'; |
|
| 21 | + |
|
| 22 | + const RELEASE_TYPE_DECAF = 'decaf'; |
|
| 23 | + |
|
| 24 | + const RELEASE_TYPE_PROD = 'p'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * @var int $major |
|
| 28 | + */ |
|
| 29 | + private $major; |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * @var int $minor |
|
| 33 | + */ |
|
| 34 | + private $minor; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var int $patch |
|
| 38 | + */ |
|
| 39 | + private $patch; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * @var string $release |
|
| 43 | + */ |
|
| 44 | + private $release; |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * @var int $build |
|
| 48 | + */ |
|
| 49 | + private $build; |
|
| 50 | + |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Version constructor. |
|
| 54 | + * |
|
| 55 | + * @param int $major |
|
| 56 | + * @param int $minor |
|
| 57 | + * @param int $patch |
|
| 58 | + * @param string $release |
|
| 59 | + * @param int $build |
|
| 60 | + * @throws InvalidDataTypeException |
|
| 61 | + * @throws InvalidArgumentException |
|
| 62 | + */ |
|
| 63 | + public function __construct($major, $minor, $patch, $release = Version::RELEASE_TYPE_PROD, $build = 0) |
|
| 64 | + { |
|
| 65 | + $this->setMajor($major); |
|
| 66 | + $this->setMinor($minor); |
|
| 67 | + $this->setPatch($patch); |
|
| 68 | + $this->setRelease($release); |
|
| 69 | + $this->setBuild($build); |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * @param string $version_string |
|
| 75 | + * @return Version |
|
| 76 | + * @throws InvalidArgumentException |
|
| 77 | + */ |
|
| 78 | + public static function fromString($version_string) |
|
| 79 | + { |
|
| 80 | + // compare incoming version string against the lowest possible valid version |
|
| 81 | + if (version_compare($version_string, '0.0.1.dev.001', '<')) { |
|
| 82 | + throw new InvalidArgumentException( |
|
| 83 | + sprintf( |
|
| 84 | + esc_html__('"%1$s" is not a valid version string', 'event_espresso'), |
|
| 85 | + $version_string |
|
| 86 | + ) |
|
| 87 | + ); |
|
| 88 | + } |
|
| 89 | + // break apart incoming version string |
|
| 90 | + $version_parts = explode('.', $version_string); |
|
| 91 | + // verify that version string at least contains {major}.{minor}.{patch} |
|
| 92 | + if (count($version_parts) < 3) { |
|
| 93 | + throw new InvalidArgumentException( |
|
| 94 | + sprintf( |
|
| 95 | + esc_html__( |
|
| 96 | + 'At minimum, a version string needs to be in a "{major}.{minor}.{patch}" format, therefore "%1$s" is not valid', |
|
| 97 | + 'event_espresso' |
|
| 98 | + ), |
|
| 99 | + $version_string |
|
| 100 | + ) |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | + // add defaults for missing pieces |
|
| 104 | + $version_parts += array(0,0,0,'p',0); |
|
| 105 | + // reassign to individual variables |
|
| 106 | + list($major, $minor, $patch, $release, $build) = $version_parts; |
|
| 107 | + return new Version( |
|
| 108 | + (int) $major, |
|
| 109 | + (int) $minor, |
|
| 110 | + (int) $patch, |
|
| 111 | + $release, |
|
| 112 | + (int) $build |
|
| 113 | + ); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * @return int |
|
| 119 | + */ |
|
| 120 | + public function major() |
|
| 121 | + { |
|
| 122 | + return $this->major; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * @param int|string $major |
|
| 128 | + * @throws InvalidDataTypeException |
|
| 129 | + */ |
|
| 130 | + private function setMajor($major) |
|
| 131 | + { |
|
| 132 | + if (! is_int($major)) { |
|
| 133 | + throw new InvalidDataTypeException( |
|
| 134 | + '$major', |
|
| 135 | + $major, |
|
| 136 | + 'integer' |
|
| 137 | + ); |
|
| 138 | + } |
|
| 139 | + $this->major = absint($major); |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @return int |
|
| 145 | + */ |
|
| 146 | + public function minor() |
|
| 147 | + { |
|
| 148 | + return $this->minor; |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * @param int|string $minor |
|
| 154 | + * @throws InvalidDataTypeException |
|
| 155 | + */ |
|
| 156 | + private function setMinor($minor) |
|
| 157 | + { |
|
| 158 | + if (! is_int($minor)) { |
|
| 159 | + throw new InvalidDataTypeException( |
|
| 160 | + '$minor', |
|
| 161 | + $minor, |
|
| 162 | + 'integer' |
|
| 163 | + ); |
|
| 164 | + } |
|
| 165 | + $this->minor = absint($minor); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * @return int |
|
| 171 | + */ |
|
| 172 | + public function patch() |
|
| 173 | + { |
|
| 174 | + return $this->patch; |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * @param int|string $patch |
|
| 180 | + * @throws InvalidDataTypeException |
|
| 181 | + */ |
|
| 182 | + private function setPatch($patch) |
|
| 183 | + { |
|
| 184 | + if (! is_int($patch)) { |
|
| 185 | + throw new InvalidDataTypeException( |
|
| 186 | + '$patch', |
|
| 187 | + $patch, |
|
| 188 | + 'integer' |
|
| 189 | + ); |
|
| 190 | + } |
|
| 191 | + $this->patch = absint($patch); |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * @return string |
|
| 197 | + */ |
|
| 198 | + public function release() |
|
| 199 | + { |
|
| 200 | + return $this->release; |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * @param string $release |
|
| 206 | + * @throws InvalidArgumentException |
|
| 207 | + */ |
|
| 208 | + private function setRelease($release) |
|
| 209 | + { |
|
| 210 | + $valid_release_types = array( |
|
| 211 | + Version::RELEASE_TYPE_RC, |
|
| 212 | + Version::RELEASE_TYPE_BETA, |
|
| 213 | + Version::RELEASE_TYPE_DECAF, |
|
| 214 | + Version::RELEASE_TYPE_PROD, |
|
| 215 | + ); |
|
| 216 | + if (! in_array($release, $valid_release_types, true)) { |
|
| 217 | + throw new InvalidArgumentException( |
|
| 218 | + sprintf( |
|
| 219 | + esc_html__( |
|
| 220 | + '"%1$s" is not a valid release type. Please use one of the following values: %2$s', |
|
| 221 | + 'event_espresso' |
|
| 222 | + ), |
|
| 223 | + $release, |
|
| 224 | + implode(', ', $valid_release_types) |
|
| 225 | + ) |
|
| 226 | + ); |
|
| 227 | + } |
|
| 228 | + $this->release = $release; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * @return int |
|
| 234 | + */ |
|
| 235 | + public function build() |
|
| 236 | + { |
|
| 237 | + return $this->build; |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * @param int|string $build |
|
| 243 | + * @throws InvalidDataTypeException |
|
| 244 | + */ |
|
| 245 | + private function setBuild($build) |
|
| 246 | + { |
|
| 247 | + if (! is_int($build)) { |
|
| 248 | + throw new InvalidDataTypeException( |
|
| 249 | + '$build', |
|
| 250 | + $build, |
|
| 251 | + 'integer' |
|
| 252 | + ); |
|
| 253 | + } |
|
| 254 | + $this->build = absint($build); |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * @param Version $other_version |
|
| 260 | + * @return int |
|
| 261 | + */ |
|
| 262 | + public function compare($other_version) |
|
| 263 | + { |
|
| 264 | + return version_compare((string) $this, (string) $other_version); |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * @param Version $other_version |
|
| 270 | + * @return bool |
|
| 271 | + */ |
|
| 272 | + public function equals($other_version) |
|
| 273 | + { |
|
| 274 | + return version_compare((string) $this, (string) $other_version, '=='); |
|
| 275 | + } |
|
| 276 | + |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * @param Version $other_version |
|
| 280 | + * @return bool |
|
| 281 | + */ |
|
| 282 | + public function newerThan($other_version) |
|
| 283 | + { |
|
| 284 | + return version_compare((string) $this, (string) $other_version, '>'); |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * @param Version $other_version |
|
| 290 | + * @return bool |
|
| 291 | + */ |
|
| 292 | + public function olderThan($other_version) |
|
| 293 | + { |
|
| 294 | + return version_compare((string) $this, (string) $other_version, '<'); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * @return string |
|
| 300 | + */ |
|
| 301 | + public function __toString() |
|
| 302 | + { |
|
| 303 | + $version_string = "{$this->major}.{$this->minor}.{$this->patch}.{$this->release}"; |
|
| 304 | + if ($this->release !== Version::RELEASE_TYPE_PROD && $this->release !== Version::RELEASE_TYPE_DECAF) { |
|
| 305 | + $version_string .= '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT); |
|
| 306 | + } |
|
| 307 | + return $version_string; |
|
| 308 | + } |
|
| 309 | 309 | } |
@@ -59,7 +59,7 @@ |
||
| 59 | 59 | return; |
| 60 | 60 | } |
| 61 | 61 | $post = reset($wp_query->posts); |
| 62 | - if (! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) { |
|
| 62 | + if ( ! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) { |
|
| 63 | 63 | return; |
| 64 | 64 | } |
| 65 | 65 | $this->is_thank_you_page = true; |
@@ -18,73 +18,73 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class EspressoThankYou extends EspressoShortcode |
| 20 | 20 | { |
| 21 | - /** |
|
| 22 | - * @var bool $is_thank_you_page |
|
| 23 | - */ |
|
| 24 | - private $is_thank_you_page = false; |
|
| 21 | + /** |
|
| 22 | + * @var bool $is_thank_you_page |
|
| 23 | + */ |
|
| 24 | + private $is_thank_you_page = false; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * the actual shortcode tag that gets registered with WordPress |
|
| 28 | - * |
|
| 29 | - * @return string |
|
| 30 | - */ |
|
| 31 | - public function getTag() |
|
| 32 | - { |
|
| 33 | - return 'ESPRESSO_THANK_YOU'; |
|
| 34 | - } |
|
| 26 | + /** |
|
| 27 | + * the actual shortcode tag that gets registered with WordPress |
|
| 28 | + * |
|
| 29 | + * @return string |
|
| 30 | + */ |
|
| 31 | + public function getTag() |
|
| 32 | + { |
|
| 33 | + return 'ESPRESSO_THANK_YOU'; |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * the time in seconds to cache the results of the processShortcode() method |
|
| 39 | - * 0 means the processShortcode() results will NOT be cached at all |
|
| 40 | - * |
|
| 41 | - * @return int |
|
| 42 | - */ |
|
| 43 | - public function cacheExpiration() |
|
| 44 | - { |
|
| 45 | - return 0; |
|
| 46 | - } |
|
| 37 | + /** |
|
| 38 | + * the time in seconds to cache the results of the processShortcode() method |
|
| 39 | + * 0 means the processShortcode() results will NOT be cached at all |
|
| 40 | + * |
|
| 41 | + * @return int |
|
| 42 | + */ |
|
| 43 | + public function cacheExpiration() |
|
| 44 | + { |
|
| 45 | + return 0; |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 51 | - * this may be required for shortcodes that utilize a corresponding module, |
|
| 52 | - * and need to enqueue assets for that module |
|
| 53 | - * |
|
| 54 | - * @return void |
|
| 55 | - * @throws EE_Error |
|
| 56 | - * @throws ReflectionException |
|
| 57 | - */ |
|
| 58 | - public function initializeShortcode() |
|
| 59 | - { |
|
| 60 | - global $wp_query; |
|
| 61 | - if (empty($wp_query->posts) || count($wp_query->posts) > 1) { |
|
| 62 | - return; |
|
| 63 | - } |
|
| 64 | - $post = reset($wp_query->posts); |
|
| 65 | - if (! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) { |
|
| 66 | - return; |
|
| 67 | - } |
|
| 68 | - $this->is_thank_you_page = true; |
|
| 69 | - EED_Thank_You_Page::instance()->load_resources(); |
|
| 70 | - $this->shortcodeHasBeenInitialized(); |
|
| 71 | - } |
|
| 49 | + /** |
|
| 50 | + * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 51 | + * this may be required for shortcodes that utilize a corresponding module, |
|
| 52 | + * and need to enqueue assets for that module |
|
| 53 | + * |
|
| 54 | + * @return void |
|
| 55 | + * @throws EE_Error |
|
| 56 | + * @throws ReflectionException |
|
| 57 | + */ |
|
| 58 | + public function initializeShortcode() |
|
| 59 | + { |
|
| 60 | + global $wp_query; |
|
| 61 | + if (empty($wp_query->posts) || count($wp_query->posts) > 1) { |
|
| 62 | + return; |
|
| 63 | + } |
|
| 64 | + $post = reset($wp_query->posts); |
|
| 65 | + if (! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) { |
|
| 66 | + return; |
|
| 67 | + } |
|
| 68 | + $this->is_thank_you_page = true; |
|
| 69 | + EED_Thank_You_Page::instance()->load_resources(); |
|
| 70 | + $this->shortcodeHasBeenInitialized(); |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * callback that runs when the shortcode is encountered in post content. |
|
| 76 | - * IMPORTANT !!! |
|
| 77 | - * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 78 | - * |
|
| 79 | - * @param array|string $attributes |
|
| 80 | - * @return string |
|
| 81 | - * @throws EE_Error |
|
| 82 | - * @throws ReflectionException |
|
| 83 | - */ |
|
| 84 | - public function processShortcode($attributes = array()) |
|
| 85 | - { |
|
| 86 | - return $this->is_thank_you_page |
|
| 87 | - ? EED_Thank_You_Page::instance()->thank_you_page_results() |
|
| 88 | - : ''; |
|
| 89 | - } |
|
| 74 | + /** |
|
| 75 | + * callback that runs when the shortcode is encountered in post content. |
|
| 76 | + * IMPORTANT !!! |
|
| 77 | + * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 78 | + * |
|
| 79 | + * @param array|string $attributes |
|
| 80 | + * @return string |
|
| 81 | + * @throws EE_Error |
|
| 82 | + * @throws ReflectionException |
|
| 83 | + */ |
|
| 84 | + public function processShortcode($attributes = array()) |
|
| 85 | + { |
|
| 86 | + return $this->is_thank_you_page |
|
| 87 | + ? EED_Thank_You_Page::instance()->thank_you_page_results() |
|
| 88 | + : ''; |
|
| 89 | + } |
|
| 90 | 90 | } |
@@ -28,74 +28,74 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | class Response |
| 30 | 30 | { |
| 31 | - /** |
|
| 32 | - * Succes or failure. |
|
| 33 | - * |
|
| 34 | - * @var boolean |
|
| 35 | - */ |
|
| 36 | - private $success = false; |
|
| 31 | + /** |
|
| 32 | + * Succes or failure. |
|
| 33 | + * |
|
| 34 | + * @var boolean |
|
| 35 | + */ |
|
| 36 | + private $success = false; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Error code strings. |
|
| 40 | - * |
|
| 41 | - * @var array |
|
| 42 | - */ |
|
| 43 | - private $errorCodes = array(); |
|
| 38 | + /** |
|
| 39 | + * Error code strings. |
|
| 40 | + * |
|
| 41 | + * @var array |
|
| 42 | + */ |
|
| 43 | + private $errorCodes = array(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Build the response from the expected JSON returned by the service. |
|
| 47 | - * |
|
| 48 | - * @param string $json |
|
| 49 | - * @return \ReCaptcha\Response |
|
| 50 | - */ |
|
| 51 | - public static function fromJson($json) |
|
| 52 | - { |
|
| 53 | - $responseData = json_decode($json, true); |
|
| 45 | + /** |
|
| 46 | + * Build the response from the expected JSON returned by the service. |
|
| 47 | + * |
|
| 48 | + * @param string $json |
|
| 49 | + * @return \ReCaptcha\Response |
|
| 50 | + */ |
|
| 51 | + public static function fromJson($json) |
|
| 52 | + { |
|
| 53 | + $responseData = json_decode($json, true); |
|
| 54 | 54 | |
| 55 | - if (! $responseData) { |
|
| 56 | - return new Response(false, array('invalid-json')); |
|
| 57 | - } |
|
| 55 | + if (! $responseData) { |
|
| 56 | + return new Response(false, array('invalid-json')); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - if (isset($responseData['success']) && $responseData['success'] == true) { |
|
| 60 | - return new Response(true); |
|
| 61 | - } |
|
| 59 | + if (isset($responseData['success']) && $responseData['success'] == true) { |
|
| 60 | + return new Response(true); |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) { |
|
| 64 | - return new Response(false, $responseData['error-codes']); |
|
| 65 | - } |
|
| 63 | + if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) { |
|
| 64 | + return new Response(false, $responseData['error-codes']); |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - return new Response(false); |
|
| 68 | - } |
|
| 67 | + return new Response(false); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Constructor. |
|
| 72 | - * |
|
| 73 | - * @param boolean $success |
|
| 74 | - * @param array $errorCodes |
|
| 75 | - */ |
|
| 76 | - public function __construct($success, array $errorCodes = array()) |
|
| 77 | - { |
|
| 78 | - $this->success = $success; |
|
| 79 | - $this->errorCodes = $errorCodes; |
|
| 80 | - } |
|
| 70 | + /** |
|
| 71 | + * Constructor. |
|
| 72 | + * |
|
| 73 | + * @param boolean $success |
|
| 74 | + * @param array $errorCodes |
|
| 75 | + */ |
|
| 76 | + public function __construct($success, array $errorCodes = array()) |
|
| 77 | + { |
|
| 78 | + $this->success = $success; |
|
| 79 | + $this->errorCodes = $errorCodes; |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Is success? |
|
| 84 | - * |
|
| 85 | - * @return boolean |
|
| 86 | - */ |
|
| 87 | - public function isSuccess() |
|
| 88 | - { |
|
| 89 | - return $this->success; |
|
| 90 | - } |
|
| 82 | + /** |
|
| 83 | + * Is success? |
|
| 84 | + * |
|
| 85 | + * @return boolean |
|
| 86 | + */ |
|
| 87 | + public function isSuccess() |
|
| 88 | + { |
|
| 89 | + return $this->success; |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Get error codes. |
|
| 94 | - * |
|
| 95 | - * @return array |
|
| 96 | - */ |
|
| 97 | - public function getErrorCodes() |
|
| 98 | - { |
|
| 99 | - return $this->errorCodes; |
|
| 100 | - } |
|
| 92 | + /** |
|
| 93 | + * Get error codes. |
|
| 94 | + * |
|
| 95 | + * @return array |
|
| 96 | + */ |
|
| 97 | + public function getErrorCodes() |
|
| 98 | + { |
|
| 99 | + return $this->errorCodes; |
|
| 100 | + } |
|
| 101 | 101 | } |
@@ -52,7 +52,7 @@ |
||
| 52 | 52 | { |
| 53 | 53 | $responseData = json_decode($json, true); |
| 54 | 54 | |
| 55 | - if (! $responseData) { |
|
| 55 | + if ( ! $responseData) { |
|
| 56 | 56 | return new Response(false, array('invalid-json')); |
| 57 | 57 | } |
| 58 | 58 | |
@@ -56,7 +56,7 @@ discard block |
||
| 56 | 56 | { |
| 57 | 57 | $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array()); |
| 58 | 58 | // verify that cached data was not truncated or corrupted and no longer an array |
| 59 | - if (! is_array($post_related_cache)) { |
|
| 59 | + if ( ! is_array($post_related_cache)) { |
|
| 60 | 60 | // uh-oh... let's get rid of any transients using our cache prefix |
| 61 | 61 | $this->clear(PostRelatedCacheManager::CACHE_PREFIX); |
| 62 | 62 | // then update the post related cache tracking option |
@@ -94,13 +94,13 @@ discard block |
||
| 94 | 94 | { |
| 95 | 95 | $post_related_cache = $this->getPostRelatedCache(); |
| 96 | 96 | // if post is not already being tracked |
| 97 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 97 | + if ( ! isset($post_related_cache[$post_ID])) { |
|
| 98 | 98 | // add array to add cache ids to |
| 99 | - $post_related_cache[ $post_ID ] = array(); |
|
| 99 | + $post_related_cache[$post_ID] = array(); |
|
| 100 | 100 | } |
| 101 | - if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) { |
|
| 101 | + if ( ! in_array($id_prefix, $post_related_cache[$post_ID], true)) { |
|
| 102 | 102 | // add cache id to be tracked |
| 103 | - $post_related_cache[ $post_ID ][] = $id_prefix; |
|
| 103 | + $post_related_cache[$post_ID][] = $id_prefix; |
|
| 104 | 104 | $this->updatePostRelatedCache($post_related_cache); |
| 105 | 105 | } |
| 106 | 106 | } |
@@ -116,18 +116,18 @@ discard block |
||
| 116 | 116 | { |
| 117 | 117 | $post_related_cache = $this->getPostRelatedCache(); |
| 118 | 118 | // if post is not being tracked |
| 119 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 119 | + if ( ! isset($post_related_cache[$post_ID])) { |
|
| 120 | 120 | // let's clean up some of the duplicate IDs that were getting added |
| 121 | 121 | foreach ($post_related_cache as $other_post_ID => $cache_IDs) { |
| 122 | 122 | // remove duplicates |
| 123 | - $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]); |
|
| 123 | + $post_related_cache[$other_post_ID] = array_unique($post_related_cache[$other_post_ID]); |
|
| 124 | 124 | } |
| 125 | 125 | $this->updatePostRelatedCache($post_related_cache); |
| 126 | 126 | return; |
| 127 | 127 | } |
| 128 | 128 | // get cache id prefixes for post, and delete their corresponding transients |
| 129 | - $this->clear($post_related_cache[ $post_ID ]); |
|
| 130 | - unset($post_related_cache[ $post_ID ]); |
|
| 129 | + $this->clear($post_related_cache[$post_ID]); |
|
| 130 | + unset($post_related_cache[$post_ID]); |
|
| 131 | 131 | $this->updatePostRelatedCache($post_related_cache); |
| 132 | 132 | } |
| 133 | 133 | } |
@@ -12,121 +12,121 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class PostRelatedCacheManager extends BasicCacheManager |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * @type string |
|
| 17 | - */ |
|
| 18 | - const POST_CACHE_PREFIX = 'ee_cache_post_'; |
|
| 15 | + /** |
|
| 16 | + * @type string |
|
| 17 | + */ |
|
| 18 | + const POST_CACHE_PREFIX = 'ee_cache_post_'; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * wp-option option_name for tracking post related cache |
|
| 22 | - * |
|
| 23 | - * @type string |
|
| 24 | - */ |
|
| 25 | - const POST_CACHE_OPTIONS_KEY = 'ee_post_cache'; |
|
| 20 | + /** |
|
| 21 | + * wp-option option_name for tracking post related cache |
|
| 22 | + * |
|
| 23 | + * @type string |
|
| 24 | + */ |
|
| 25 | + const POST_CACHE_OPTIONS_KEY = 'ee_post_cache'; |
|
| 26 | 26 | |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * PostRelatedCacheManager constructor. |
|
| 30 | - * |
|
| 31 | - * @param CacheStorageInterface $cache_storage |
|
| 32 | - */ |
|
| 33 | - public function __construct(CacheStorageInterface $cache_storage) |
|
| 34 | - { |
|
| 35 | - parent::__construct($cache_storage); |
|
| 36 | - add_action('save_post', array($this, 'clearPostRelatedCache')); |
|
| 37 | - } |
|
| 28 | + /** |
|
| 29 | + * PostRelatedCacheManager constructor. |
|
| 30 | + * |
|
| 31 | + * @param CacheStorageInterface $cache_storage |
|
| 32 | + */ |
|
| 33 | + public function __construct(CacheStorageInterface $cache_storage) |
|
| 34 | + { |
|
| 35 | + parent::__construct($cache_storage); |
|
| 36 | + add_action('save_post', array($this, 'clearPostRelatedCache')); |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * returns a string that will be prepended to all cache identifiers |
|
| 42 | - * |
|
| 43 | - * @return string |
|
| 44 | - */ |
|
| 45 | - public function cachePrefix() |
|
| 46 | - { |
|
| 47 | - return PostRelatedCacheManager::POST_CACHE_PREFIX; |
|
| 48 | - } |
|
| 40 | + /** |
|
| 41 | + * returns a string that will be prepended to all cache identifiers |
|
| 42 | + * |
|
| 43 | + * @return string |
|
| 44 | + */ |
|
| 45 | + public function cachePrefix() |
|
| 46 | + { |
|
| 47 | + return PostRelatedCacheManager::POST_CACHE_PREFIX; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return array |
|
| 53 | - */ |
|
| 54 | - protected function getPostRelatedCache() |
|
| 55 | - { |
|
| 56 | - $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array()); |
|
| 57 | - // verify that cached data was not truncated or corrupted and no longer an array |
|
| 58 | - if (! is_array($post_related_cache)) { |
|
| 59 | - // uh-oh... let's get rid of any transients using our cache prefix |
|
| 60 | - $this->clear(PostRelatedCacheManager::CACHE_PREFIX); |
|
| 61 | - // then update the post related cache tracking option |
|
| 62 | - $post_related_cache = array(); |
|
| 63 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 64 | - } |
|
| 65 | - return $post_related_cache; |
|
| 66 | - } |
|
| 51 | + /** |
|
| 52 | + * @return array |
|
| 53 | + */ |
|
| 54 | + protected function getPostRelatedCache() |
|
| 55 | + { |
|
| 56 | + $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array()); |
|
| 57 | + // verify that cached data was not truncated or corrupted and no longer an array |
|
| 58 | + if (! is_array($post_related_cache)) { |
|
| 59 | + // uh-oh... let's get rid of any transients using our cache prefix |
|
| 60 | + $this->clear(PostRelatedCacheManager::CACHE_PREFIX); |
|
| 61 | + // then update the post related cache tracking option |
|
| 62 | + $post_related_cache = array(); |
|
| 63 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 64 | + } |
|
| 65 | + return $post_related_cache; |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @param array $post_related_cache |
|
| 71 | - */ |
|
| 72 | - protected function updatePostRelatedCache($post_related_cache = array()) |
|
| 73 | - { |
|
| 74 | - update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache); |
|
| 75 | - } |
|
| 69 | + /** |
|
| 70 | + * @param array $post_related_cache |
|
| 71 | + */ |
|
| 72 | + protected function updatePostRelatedCache($post_related_cache = array()) |
|
| 73 | + { |
|
| 74 | + update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache); |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * If you are caching content that pertains to a Post of any type, |
|
| 80 | - * then it is recommended to pass the post id and cache id prefix to this method |
|
| 81 | - * so that it can be added to the post related cache tracking. |
|
| 82 | - * Then, whenever that post is updated, the cache will automatically be deleted, |
|
| 83 | - * which helps to ensure that outdated cache content will not be served |
|
| 84 | - * |
|
| 85 | - * @param int $post_ID [required] |
|
| 86 | - * @param string $id_prefix [required] Appended to all cache IDs. Can be helpful in finding specific cache types. |
|
| 87 | - * May also be helpful to include an additional specific identifier, |
|
| 88 | - * such as a post ID as part of the $id_prefix so that individual caches |
|
| 89 | - * can be found and/or cleared. ex: "venue-28", or "shortcode-156". |
|
| 90 | - * BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id. |
|
| 91 | - */ |
|
| 92 | - public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix) |
|
| 93 | - { |
|
| 94 | - $post_related_cache = $this->getPostRelatedCache(); |
|
| 95 | - // if post is not already being tracked |
|
| 96 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 97 | - // add array to add cache ids to |
|
| 98 | - $post_related_cache[ $post_ID ] = array(); |
|
| 99 | - } |
|
| 100 | - if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) { |
|
| 101 | - // add cache id to be tracked |
|
| 102 | - $post_related_cache[ $post_ID ][] = $id_prefix; |
|
| 103 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 104 | - } |
|
| 105 | - } |
|
| 78 | + /** |
|
| 79 | + * If you are caching content that pertains to a Post of any type, |
|
| 80 | + * then it is recommended to pass the post id and cache id prefix to this method |
|
| 81 | + * so that it can be added to the post related cache tracking. |
|
| 82 | + * Then, whenever that post is updated, the cache will automatically be deleted, |
|
| 83 | + * which helps to ensure that outdated cache content will not be served |
|
| 84 | + * |
|
| 85 | + * @param int $post_ID [required] |
|
| 86 | + * @param string $id_prefix [required] Appended to all cache IDs. Can be helpful in finding specific cache types. |
|
| 87 | + * May also be helpful to include an additional specific identifier, |
|
| 88 | + * such as a post ID as part of the $id_prefix so that individual caches |
|
| 89 | + * can be found and/or cleared. ex: "venue-28", or "shortcode-156". |
|
| 90 | + * BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id. |
|
| 91 | + */ |
|
| 92 | + public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix) |
|
| 93 | + { |
|
| 94 | + $post_related_cache = $this->getPostRelatedCache(); |
|
| 95 | + // if post is not already being tracked |
|
| 96 | + if (! isset($post_related_cache[ $post_ID ])) { |
|
| 97 | + // add array to add cache ids to |
|
| 98 | + $post_related_cache[ $post_ID ] = array(); |
|
| 99 | + } |
|
| 100 | + if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) { |
|
| 101 | + // add cache id to be tracked |
|
| 102 | + $post_related_cache[ $post_ID ][] = $id_prefix; |
|
| 103 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * callback hooked into the WordPress "save_post" action |
|
| 110 | - * deletes any cache content associated with the post |
|
| 111 | - * |
|
| 112 | - * @param int $post_ID [required] |
|
| 113 | - */ |
|
| 114 | - public function clearPostRelatedCache($post_ID) |
|
| 115 | - { |
|
| 116 | - $post_related_cache = $this->getPostRelatedCache(); |
|
| 117 | - // if post is not being tracked |
|
| 118 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 119 | - // let's clean up some of the duplicate IDs that were getting added |
|
| 120 | - foreach ($post_related_cache as $other_post_ID => $cache_IDs) { |
|
| 121 | - // remove duplicates |
|
| 122 | - $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]); |
|
| 123 | - } |
|
| 124 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 125 | - return; |
|
| 126 | - } |
|
| 127 | - // get cache id prefixes for post, and delete their corresponding transients |
|
| 128 | - $this->clear($post_related_cache[ $post_ID ]); |
|
| 129 | - unset($post_related_cache[ $post_ID ]); |
|
| 130 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 131 | - } |
|
| 108 | + /** |
|
| 109 | + * callback hooked into the WordPress "save_post" action |
|
| 110 | + * deletes any cache content associated with the post |
|
| 111 | + * |
|
| 112 | + * @param int $post_ID [required] |
|
| 113 | + */ |
|
| 114 | + public function clearPostRelatedCache($post_ID) |
|
| 115 | + { |
|
| 116 | + $post_related_cache = $this->getPostRelatedCache(); |
|
| 117 | + // if post is not being tracked |
|
| 118 | + if (! isset($post_related_cache[ $post_ID ])) { |
|
| 119 | + // let's clean up some of the duplicate IDs that were getting added |
|
| 120 | + foreach ($post_related_cache as $other_post_ID => $cache_IDs) { |
|
| 121 | + // remove duplicates |
|
| 122 | + $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]); |
|
| 123 | + } |
|
| 124 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 125 | + return; |
|
| 126 | + } |
|
| 127 | + // get cache id prefixes for post, and delete their corresponding transients |
|
| 128 | + $this->clear($post_related_cache[ $post_ID ]); |
|
| 129 | + unset($post_related_cache[ $post_ID ]); |
|
| 130 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 131 | + } |
|
| 132 | 132 | } |
@@ -39,29 +39,29 @@ |
||
| 39 | 39 | protected function convertAscii($string) |
| 40 | 40 | { |
| 41 | 41 | // Replace Single Curly Quotes |
| 42 | - $search[] = chr(226) . chr(128) . chr(152); |
|
| 42 | + $search[] = chr(226).chr(128).chr(152); |
|
| 43 | 43 | $replace[] = "'"; |
| 44 | - $search[] = chr(226) . chr(128) . chr(153); |
|
| 44 | + $search[] = chr(226).chr(128).chr(153); |
|
| 45 | 45 | $replace[] = "'"; |
| 46 | 46 | // Replace Smart Double Curly Quotes |
| 47 | - $search[] = chr(226) . chr(128) . chr(156); |
|
| 47 | + $search[] = chr(226).chr(128).chr(156); |
|
| 48 | 48 | $replace[] = '"'; |
| 49 | - $search[] = chr(226) . chr(128) . chr(157); |
|
| 49 | + $search[] = chr(226).chr(128).chr(157); |
|
| 50 | 50 | $replace[] = '"'; |
| 51 | 51 | // Replace En Dash |
| 52 | - $search[] = chr(226) . chr(128) . chr(147); |
|
| 52 | + $search[] = chr(226).chr(128).chr(147); |
|
| 53 | 53 | $replace[] = '--'; |
| 54 | 54 | // Replace Em Dash |
| 55 | - $search[] = chr(226) . chr(128) . chr(148); |
|
| 55 | + $search[] = chr(226).chr(128).chr(148); |
|
| 56 | 56 | $replace[] = '---'; |
| 57 | 57 | // Replace Bullet |
| 58 | - $search[] = chr(226) . chr(128) . chr(162); |
|
| 58 | + $search[] = chr(226).chr(128).chr(162); |
|
| 59 | 59 | $replace[] = '*'; |
| 60 | 60 | // Replace Middle Dot |
| 61 | - $search[] = chr(194) . chr(183); |
|
| 61 | + $search[] = chr(194).chr(183); |
|
| 62 | 62 | $replace[] = '*'; |
| 63 | 63 | // Replace Ellipsis with three consecutive dots |
| 64 | - $search[] = chr(226) . chr(128) . chr(166); |
|
| 64 | + $search[] = chr(226).chr(128).chr(166); |
|
| 65 | 65 | $replace[] = '...'; |
| 66 | 66 | // Apply Replacements |
| 67 | 67 | $string = str_replace($search, $replace, $string); |
@@ -14,58 +14,58 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class AsciiOnly extends FormatterBase |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * Removes all non Ascii characters from string |
|
| 19 | - * |
|
| 20 | - * @param string|int|float $input anything easily cast into a string |
|
| 21 | - * @return string |
|
| 22 | - */ |
|
| 23 | - public function format($input) |
|
| 24 | - { |
|
| 25 | - // in case an int or float etc was passed in |
|
| 26 | - $input = (string) $input; |
|
| 27 | - $input = $this->convertAscii($input); |
|
| 28 | - return $input; |
|
| 29 | - } |
|
| 17 | + /** |
|
| 18 | + * Removes all non Ascii characters from string |
|
| 19 | + * |
|
| 20 | + * @param string|int|float $input anything easily cast into a string |
|
| 21 | + * @return string |
|
| 22 | + */ |
|
| 23 | + public function format($input) |
|
| 24 | + { |
|
| 25 | + // in case an int or float etc was passed in |
|
| 26 | + $input = (string) $input; |
|
| 27 | + $input = $this->convertAscii($input); |
|
| 28 | + return $input; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Taken from https://gist.github.com/jaywilliams/119517 |
|
| 34 | - * |
|
| 35 | - * @param $string |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 38 | - protected function convertAscii($string) |
|
| 39 | - { |
|
| 40 | - // Replace Single Curly Quotes |
|
| 41 | - $search[] = chr(226) . chr(128) . chr(152); |
|
| 42 | - $replace[] = "'"; |
|
| 43 | - $search[] = chr(226) . chr(128) . chr(153); |
|
| 44 | - $replace[] = "'"; |
|
| 45 | - // Replace Smart Double Curly Quotes |
|
| 46 | - $search[] = chr(226) . chr(128) . chr(156); |
|
| 47 | - $replace[] = '"'; |
|
| 48 | - $search[] = chr(226) . chr(128) . chr(157); |
|
| 49 | - $replace[] = '"'; |
|
| 50 | - // Replace En Dash |
|
| 51 | - $search[] = chr(226) . chr(128) . chr(147); |
|
| 52 | - $replace[] = '--'; |
|
| 53 | - // Replace Em Dash |
|
| 54 | - $search[] = chr(226) . chr(128) . chr(148); |
|
| 55 | - $replace[] = '---'; |
|
| 56 | - // Replace Bullet |
|
| 57 | - $search[] = chr(226) . chr(128) . chr(162); |
|
| 58 | - $replace[] = '*'; |
|
| 59 | - // Replace Middle Dot |
|
| 60 | - $search[] = chr(194) . chr(183); |
|
| 61 | - $replace[] = '*'; |
|
| 62 | - // Replace Ellipsis with three consecutive dots |
|
| 63 | - $search[] = chr(226) . chr(128) . chr(166); |
|
| 64 | - $replace[] = '...'; |
|
| 65 | - // Apply Replacements |
|
| 66 | - $string = str_replace($search, $replace, $string); |
|
| 67 | - // Remove any non-ASCII Characters |
|
| 68 | - $string = preg_replace("/[^\x01-\x7F]/", "", $string); |
|
| 69 | - return $string; |
|
| 70 | - } |
|
| 32 | + /** |
|
| 33 | + * Taken from https://gist.github.com/jaywilliams/119517 |
|
| 34 | + * |
|
| 35 | + * @param $string |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | + protected function convertAscii($string) |
|
| 39 | + { |
|
| 40 | + // Replace Single Curly Quotes |
|
| 41 | + $search[] = chr(226) . chr(128) . chr(152); |
|
| 42 | + $replace[] = "'"; |
|
| 43 | + $search[] = chr(226) . chr(128) . chr(153); |
|
| 44 | + $replace[] = "'"; |
|
| 45 | + // Replace Smart Double Curly Quotes |
|
| 46 | + $search[] = chr(226) . chr(128) . chr(156); |
|
| 47 | + $replace[] = '"'; |
|
| 48 | + $search[] = chr(226) . chr(128) . chr(157); |
|
| 49 | + $replace[] = '"'; |
|
| 50 | + // Replace En Dash |
|
| 51 | + $search[] = chr(226) . chr(128) . chr(147); |
|
| 52 | + $replace[] = '--'; |
|
| 53 | + // Replace Em Dash |
|
| 54 | + $search[] = chr(226) . chr(128) . chr(148); |
|
| 55 | + $replace[] = '---'; |
|
| 56 | + // Replace Bullet |
|
| 57 | + $search[] = chr(226) . chr(128) . chr(162); |
|
| 58 | + $replace[] = '*'; |
|
| 59 | + // Replace Middle Dot |
|
| 60 | + $search[] = chr(194) . chr(183); |
|
| 61 | + $replace[] = '*'; |
|
| 62 | + // Replace Ellipsis with three consecutive dots |
|
| 63 | + $search[] = chr(226) . chr(128) . chr(166); |
|
| 64 | + $replace[] = '...'; |
|
| 65 | + // Apply Replacements |
|
| 66 | + $string = str_replace($search, $replace, $string); |
|
| 67 | + // Remove any non-ASCII Characters |
|
| 68 | + $string = preg_replace("/[^\x01-\x7F]/", "", $string); |
|
| 69 | + return $string; |
|
| 70 | + } |
|
| 71 | 71 | } |
@@ -157,7 +157,7 @@ |
||
| 157 | 157 | */ |
| 158 | 158 | private function setType($type) |
| 159 | 159 | { |
| 160 | - if (! in_array($type, $this->types(), true)) { |
|
| 160 | + if ( ! in_array($type, $this->types(), true)) { |
|
| 161 | 161 | throw new InvalidDataTypeException( |
| 162 | 162 | '$type', |
| 163 | 163 | $type, |
@@ -13,253 +13,253 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class Notice implements NoticeInterface |
| 15 | 15 | { |
| 16 | - const ERROR = 'error'; |
|
| 17 | - |
|
| 18 | - const SUCCESS = 'success'; |
|
| 19 | - |
|
| 20 | - const ATTENTION = 'attention'; // alias for warning |
|
| 21 | - |
|
| 22 | - const INFORMATION = 'information'; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @var string $type |
|
| 26 | - */ |
|
| 27 | - private $type; |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var string $message |
|
| 32 | - */ |
|
| 33 | - private $message; |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var string $file |
|
| 38 | - */ |
|
| 39 | - private $file; |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * @var string $func |
|
| 44 | - */ |
|
| 45 | - private $func; |
|
| 46 | - |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @var string $line |
|
| 50 | - */ |
|
| 51 | - private $line; |
|
| 52 | - |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * @var boolean $dismissible |
|
| 56 | - */ |
|
| 57 | - private $dismissible; |
|
| 58 | - |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Notice constructor. |
|
| 62 | - * |
|
| 63 | - * @param string $type |
|
| 64 | - * @param string $message |
|
| 65 | - * @param bool $dismissible |
|
| 66 | - * @param string $file |
|
| 67 | - * @param string $func |
|
| 68 | - * @param string $line |
|
| 69 | - * @throws InvalidDataTypeException |
|
| 70 | - */ |
|
| 71 | - public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | - { |
|
| 73 | - $this->setType($type); |
|
| 74 | - $this->setMessage($message); |
|
| 75 | - $this->setDismissible($dismissible); |
|
| 76 | - $this->setFile($file); |
|
| 77 | - $this->setFunc($func); |
|
| 78 | - $this->setLine($line); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @return array |
|
| 84 | - */ |
|
| 85 | - private function types() |
|
| 86 | - { |
|
| 87 | - return (array) apply_filters( |
|
| 88 | - 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
| 89 | - array( |
|
| 90 | - Notice::ERROR, |
|
| 91 | - Notice::SUCCESS, |
|
| 92 | - Notice::ATTENTION, |
|
| 93 | - Notice::INFORMATION, |
|
| 94 | - ) |
|
| 95 | - ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * @return string |
|
| 101 | - */ |
|
| 102 | - public function type() |
|
| 103 | - { |
|
| 104 | - return $this->type; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * @return string |
|
| 110 | - */ |
|
| 111 | - public function message() |
|
| 112 | - { |
|
| 113 | - return $this->message; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * @return string |
|
| 119 | - */ |
|
| 120 | - public function file() |
|
| 121 | - { |
|
| 122 | - return $this->file; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 129 | - public function func() |
|
| 130 | - { |
|
| 131 | - return $this->func; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * @return string |
|
| 137 | - */ |
|
| 138 | - public function line() |
|
| 139 | - { |
|
| 140 | - return $this->line; |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * @return bool |
|
| 146 | - */ |
|
| 147 | - public function isDismissible() |
|
| 148 | - { |
|
| 149 | - return $this->dismissible; |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * @param string $type |
|
| 155 | - * @throws InvalidDataTypeException |
|
| 156 | - */ |
|
| 157 | - private function setType($type) |
|
| 158 | - { |
|
| 159 | - if (! in_array($type, $this->types(), true)) { |
|
| 160 | - throw new InvalidDataTypeException( |
|
| 161 | - '$type', |
|
| 162 | - $type, |
|
| 163 | - $this->invalidTypeMessage() |
|
| 164 | - ); |
|
| 165 | - } |
|
| 166 | - $this->type = $type; |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * gets the $invalid_type_message string |
|
| 172 | - */ |
|
| 173 | - private function invalidTypeMessage() |
|
| 174 | - { |
|
| 175 | - return apply_filters( |
|
| 176 | - 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
| 177 | - sprintf( |
|
| 178 | - esc_html__( |
|
| 179 | - ' one of the following notice types was expected: %1$s %2$s', |
|
| 180 | - 'event_espresso' |
|
| 181 | - ), |
|
| 182 | - '<br />', |
|
| 183 | - var_export($this->types(), true) |
|
| 184 | - ) |
|
| 185 | - ); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * @param string $message |
|
| 191 | - * @throws InvalidDataTypeException |
|
| 192 | - */ |
|
| 193 | - private function setMessage($message) |
|
| 194 | - { |
|
| 195 | - if (empty($message) || ! is_string($message)) { |
|
| 196 | - throw new InvalidDataTypeException( |
|
| 197 | - '$message', |
|
| 198 | - $message, |
|
| 199 | - esc_html__('non empty string', 'event_espresso') |
|
| 200 | - ); |
|
| 201 | - } |
|
| 202 | - $this->message = sanitize_text_field($message); |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * @param string $file |
|
| 208 | - * @throws InvalidDataTypeException |
|
| 209 | - */ |
|
| 210 | - private function setFile($file) |
|
| 211 | - { |
|
| 212 | - if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
| 213 | - throw new InvalidDataTypeException( |
|
| 214 | - '$file', |
|
| 215 | - $file, |
|
| 216 | - esc_html__('non empty string', 'event_espresso') |
|
| 217 | - ); |
|
| 218 | - } |
|
| 219 | - $this->file = sanitize_text_field($file); |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - |
|
| 223 | - /** |
|
| 224 | - * @param string $func |
|
| 225 | - * @throws InvalidDataTypeException |
|
| 226 | - */ |
|
| 227 | - private function setFunc($func) |
|
| 228 | - { |
|
| 229 | - if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
| 230 | - throw new InvalidDataTypeException( |
|
| 231 | - '$func', |
|
| 232 | - $func, |
|
| 233 | - esc_html__('non empty string', 'event_espresso') |
|
| 234 | - ); |
|
| 235 | - } |
|
| 236 | - $this->func = sanitize_text_field($func); |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * @param int $line |
|
| 242 | - * @throws InvalidDataTypeException |
|
| 243 | - */ |
|
| 244 | - private function setLine($line) |
|
| 245 | - { |
|
| 246 | - $line = absint($line); |
|
| 247 | - if ($this->type === Notice::ERROR && $line === 0) { |
|
| 248 | - throw new InvalidDataTypeException( |
|
| 249 | - '$line', |
|
| 250 | - $line, |
|
| 251 | - esc_html__('integer', 'event_espresso') |
|
| 252 | - ); |
|
| 253 | - } |
|
| 254 | - $this->line = sanitize_text_field($line); |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * @param boolean $dismissible |
|
| 260 | - */ |
|
| 261 | - private function setDismissible($dismissible = true) |
|
| 262 | - { |
|
| 263 | - $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
| 264 | - } |
|
| 16 | + const ERROR = 'error'; |
|
| 17 | + |
|
| 18 | + const SUCCESS = 'success'; |
|
| 19 | + |
|
| 20 | + const ATTENTION = 'attention'; // alias for warning |
|
| 21 | + |
|
| 22 | + const INFORMATION = 'information'; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @var string $type |
|
| 26 | + */ |
|
| 27 | + private $type; |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var string $message |
|
| 32 | + */ |
|
| 33 | + private $message; |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var string $file |
|
| 38 | + */ |
|
| 39 | + private $file; |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * @var string $func |
|
| 44 | + */ |
|
| 45 | + private $func; |
|
| 46 | + |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @var string $line |
|
| 50 | + */ |
|
| 51 | + private $line; |
|
| 52 | + |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * @var boolean $dismissible |
|
| 56 | + */ |
|
| 57 | + private $dismissible; |
|
| 58 | + |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Notice constructor. |
|
| 62 | + * |
|
| 63 | + * @param string $type |
|
| 64 | + * @param string $message |
|
| 65 | + * @param bool $dismissible |
|
| 66 | + * @param string $file |
|
| 67 | + * @param string $func |
|
| 68 | + * @param string $line |
|
| 69 | + * @throws InvalidDataTypeException |
|
| 70 | + */ |
|
| 71 | + public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | + { |
|
| 73 | + $this->setType($type); |
|
| 74 | + $this->setMessage($message); |
|
| 75 | + $this->setDismissible($dismissible); |
|
| 76 | + $this->setFile($file); |
|
| 77 | + $this->setFunc($func); |
|
| 78 | + $this->setLine($line); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @return array |
|
| 84 | + */ |
|
| 85 | + private function types() |
|
| 86 | + { |
|
| 87 | + return (array) apply_filters( |
|
| 88 | + 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
| 89 | + array( |
|
| 90 | + Notice::ERROR, |
|
| 91 | + Notice::SUCCESS, |
|
| 92 | + Notice::ATTENTION, |
|
| 93 | + Notice::INFORMATION, |
|
| 94 | + ) |
|
| 95 | + ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * @return string |
|
| 101 | + */ |
|
| 102 | + public function type() |
|
| 103 | + { |
|
| 104 | + return $this->type; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * @return string |
|
| 110 | + */ |
|
| 111 | + public function message() |
|
| 112 | + { |
|
| 113 | + return $this->message; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * @return string |
|
| 119 | + */ |
|
| 120 | + public function file() |
|
| 121 | + { |
|
| 122 | + return $this->file; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | + public function func() |
|
| 130 | + { |
|
| 131 | + return $this->func; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * @return string |
|
| 137 | + */ |
|
| 138 | + public function line() |
|
| 139 | + { |
|
| 140 | + return $this->line; |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * @return bool |
|
| 146 | + */ |
|
| 147 | + public function isDismissible() |
|
| 148 | + { |
|
| 149 | + return $this->dismissible; |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * @param string $type |
|
| 155 | + * @throws InvalidDataTypeException |
|
| 156 | + */ |
|
| 157 | + private function setType($type) |
|
| 158 | + { |
|
| 159 | + if (! in_array($type, $this->types(), true)) { |
|
| 160 | + throw new InvalidDataTypeException( |
|
| 161 | + '$type', |
|
| 162 | + $type, |
|
| 163 | + $this->invalidTypeMessage() |
|
| 164 | + ); |
|
| 165 | + } |
|
| 166 | + $this->type = $type; |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * gets the $invalid_type_message string |
|
| 172 | + */ |
|
| 173 | + private function invalidTypeMessage() |
|
| 174 | + { |
|
| 175 | + return apply_filters( |
|
| 176 | + 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
| 177 | + sprintf( |
|
| 178 | + esc_html__( |
|
| 179 | + ' one of the following notice types was expected: %1$s %2$s', |
|
| 180 | + 'event_espresso' |
|
| 181 | + ), |
|
| 182 | + '<br />', |
|
| 183 | + var_export($this->types(), true) |
|
| 184 | + ) |
|
| 185 | + ); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * @param string $message |
|
| 191 | + * @throws InvalidDataTypeException |
|
| 192 | + */ |
|
| 193 | + private function setMessage($message) |
|
| 194 | + { |
|
| 195 | + if (empty($message) || ! is_string($message)) { |
|
| 196 | + throw new InvalidDataTypeException( |
|
| 197 | + '$message', |
|
| 198 | + $message, |
|
| 199 | + esc_html__('non empty string', 'event_espresso') |
|
| 200 | + ); |
|
| 201 | + } |
|
| 202 | + $this->message = sanitize_text_field($message); |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * @param string $file |
|
| 208 | + * @throws InvalidDataTypeException |
|
| 209 | + */ |
|
| 210 | + private function setFile($file) |
|
| 211 | + { |
|
| 212 | + if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
| 213 | + throw new InvalidDataTypeException( |
|
| 214 | + '$file', |
|
| 215 | + $file, |
|
| 216 | + esc_html__('non empty string', 'event_espresso') |
|
| 217 | + ); |
|
| 218 | + } |
|
| 219 | + $this->file = sanitize_text_field($file); |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + |
|
| 223 | + /** |
|
| 224 | + * @param string $func |
|
| 225 | + * @throws InvalidDataTypeException |
|
| 226 | + */ |
|
| 227 | + private function setFunc($func) |
|
| 228 | + { |
|
| 229 | + if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
| 230 | + throw new InvalidDataTypeException( |
|
| 231 | + '$func', |
|
| 232 | + $func, |
|
| 233 | + esc_html__('non empty string', 'event_espresso') |
|
| 234 | + ); |
|
| 235 | + } |
|
| 236 | + $this->func = sanitize_text_field($func); |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * @param int $line |
|
| 242 | + * @throws InvalidDataTypeException |
|
| 243 | + */ |
|
| 244 | + private function setLine($line) |
|
| 245 | + { |
|
| 246 | + $line = absint($line); |
|
| 247 | + if ($this->type === Notice::ERROR && $line === 0) { |
|
| 248 | + throw new InvalidDataTypeException( |
|
| 249 | + '$line', |
|
| 250 | + $line, |
|
| 251 | + esc_html__('integer', 'event_espresso') |
|
| 252 | + ); |
|
| 253 | + } |
|
| 254 | + $this->line = sanitize_text_field($line); |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * @param boolean $dismissible |
|
| 260 | + */ |
|
| 261 | + private function setDismissible($dismissible = true) |
|
| 262 | + { |
|
| 263 | + $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
| 264 | + } |
|
| 265 | 265 | } |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | $base_code = '', |
| 73 | 73 | $reg_url_link = '' |
| 74 | 74 | ) { |
| 75 | - if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 75 | + if ( ! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | 76 | $this->reg_url_link = apply_filters( |
| 77 | 77 | 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
| 78 | 78 | $reg_url_link, |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | } |
| 95 | 95 | $this->reg_url_link = (string) apply_filters( |
| 96 | 96 | 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
| 97 | - $reg_count . '-' . md5($base_code . microtime()), |
|
| 97 | + $reg_count.'-'.md5($base_code.microtime()), |
|
| 98 | 98 | $reg_count, |
| 99 | 99 | $base_code, |
| 100 | 100 | $reg_url_link |
@@ -18,97 +18,97 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class RegUrlLink |
| 20 | 20 | { |
| 21 | - /* |
|
| 21 | + /* |
|
| 22 | 22 | * @var string $reg_url_link |
| 23 | 23 | */ |
| 24 | - private $reg_url_link; |
|
| 24 | + private $reg_url_link; |
|
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @param string $reg_url_link |
|
| 29 | - * @return RegUrlLink |
|
| 30 | - * @throws InvalidArgumentException |
|
| 31 | - */ |
|
| 32 | - public static function fromRegUrlLinkString($reg_url_link) |
|
| 33 | - { |
|
| 34 | - if (empty($reg_url_link) || ! is_string($reg_url_link)) { |
|
| 35 | - throw new InvalidArgumentException( |
|
| 36 | - esc_html__( |
|
| 37 | - 'You must supply a valid non-empty string to generate a reg_url_link.', |
|
| 38 | - 'event_espresso' |
|
| 39 | - ) |
|
| 40 | - ); |
|
| 41 | - } |
|
| 42 | - return new RegUrlLink(1, '', $reg_url_link); |
|
| 43 | - } |
|
| 27 | + /** |
|
| 28 | + * @param string $reg_url_link |
|
| 29 | + * @return RegUrlLink |
|
| 30 | + * @throws InvalidArgumentException |
|
| 31 | + */ |
|
| 32 | + public static function fromRegUrlLinkString($reg_url_link) |
|
| 33 | + { |
|
| 34 | + if (empty($reg_url_link) || ! is_string($reg_url_link)) { |
|
| 35 | + throw new InvalidArgumentException( |
|
| 36 | + esc_html__( |
|
| 37 | + 'You must supply a valid non-empty string to generate a reg_url_link.', |
|
| 38 | + 'event_espresso' |
|
| 39 | + ) |
|
| 40 | + ); |
|
| 41 | + } |
|
| 42 | + return new RegUrlLink(1, '', $reg_url_link); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @param EE_Registration $registration |
|
| 48 | - * @return RegUrlLink |
|
| 49 | - * @throws EntityNotFoundException |
|
| 50 | - * @throws EE_Error |
|
| 51 | - * @throws InvalidArgumentException |
|
| 52 | - */ |
|
| 53 | - public static function fromRegistration($registration) |
|
| 54 | - { |
|
| 55 | - return new RegUrlLink( |
|
| 56 | - $registration->count(), |
|
| 57 | - $registration->ticket_line_item() |
|
| 58 | - ); |
|
| 59 | - } |
|
| 46 | + /** |
|
| 47 | + * @param EE_Registration $registration |
|
| 48 | + * @return RegUrlLink |
|
| 49 | + * @throws EntityNotFoundException |
|
| 50 | + * @throws EE_Error |
|
| 51 | + * @throws InvalidArgumentException |
|
| 52 | + */ |
|
| 53 | + public static function fromRegistration($registration) |
|
| 54 | + { |
|
| 55 | + return new RegUrlLink( |
|
| 56 | + $registration->count(), |
|
| 57 | + $registration->ticket_line_item() |
|
| 58 | + ); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * CreateRegUrlLinkCommand constructor. |
|
| 64 | - * |
|
| 65 | - * @param int $reg_count |
|
| 66 | - * @param mixed $base_code |
|
| 67 | - * @param string $reg_url_link |
|
| 68 | - * @throws InvalidArgumentException |
|
| 69 | - */ |
|
| 70 | - public function __construct( |
|
| 71 | - $reg_count = 1, |
|
| 72 | - $base_code = '', |
|
| 73 | - $reg_url_link = '' |
|
| 74 | - ) { |
|
| 75 | - if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | - $this->reg_url_link = apply_filters( |
|
| 77 | - 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 78 | - $reg_url_link, |
|
| 79 | - $reg_count, |
|
| 80 | - $base_code, |
|
| 81 | - $reg_url_link |
|
| 82 | - ); |
|
| 83 | - return; |
|
| 84 | - } |
|
| 85 | - $reg_count = max(1, absint($reg_count)); |
|
| 86 | - $base_code = $base_code instanceof EE_Line_Item ? $base_code->code() : $base_code; |
|
| 87 | - if (empty($base_code) || ! is_string($base_code)) { |
|
| 88 | - throw new InvalidArgumentException( |
|
| 89 | - esc_html__( |
|
| 90 | - 'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.', |
|
| 91 | - 'event_espresso' |
|
| 92 | - ) |
|
| 93 | - ); |
|
| 94 | - } |
|
| 95 | - $this->reg_url_link = (string) apply_filters( |
|
| 96 | - 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 97 | - $reg_count . '-' . md5($base_code . microtime()), |
|
| 98 | - $reg_count, |
|
| 99 | - $base_code, |
|
| 100 | - $reg_url_link |
|
| 101 | - ); |
|
| 102 | - } |
|
| 62 | + /** |
|
| 63 | + * CreateRegUrlLinkCommand constructor. |
|
| 64 | + * |
|
| 65 | + * @param int $reg_count |
|
| 66 | + * @param mixed $base_code |
|
| 67 | + * @param string $reg_url_link |
|
| 68 | + * @throws InvalidArgumentException |
|
| 69 | + */ |
|
| 70 | + public function __construct( |
|
| 71 | + $reg_count = 1, |
|
| 72 | + $base_code = '', |
|
| 73 | + $reg_url_link = '' |
|
| 74 | + ) { |
|
| 75 | + if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | + $this->reg_url_link = apply_filters( |
|
| 77 | + 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 78 | + $reg_url_link, |
|
| 79 | + $reg_count, |
|
| 80 | + $base_code, |
|
| 81 | + $reg_url_link |
|
| 82 | + ); |
|
| 83 | + return; |
|
| 84 | + } |
|
| 85 | + $reg_count = max(1, absint($reg_count)); |
|
| 86 | + $base_code = $base_code instanceof EE_Line_Item ? $base_code->code() : $base_code; |
|
| 87 | + if (empty($base_code) || ! is_string($base_code)) { |
|
| 88 | + throw new InvalidArgumentException( |
|
| 89 | + esc_html__( |
|
| 90 | + 'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.', |
|
| 91 | + 'event_espresso' |
|
| 92 | + ) |
|
| 93 | + ); |
|
| 94 | + } |
|
| 95 | + $this->reg_url_link = (string) apply_filters( |
|
| 96 | + 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 97 | + $reg_count . '-' . md5($base_code . microtime()), |
|
| 98 | + $reg_count, |
|
| 99 | + $base_code, |
|
| 100 | + $reg_url_link |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Return the object as a string |
|
| 107 | - * |
|
| 108 | - * @return string |
|
| 109 | - */ |
|
| 110 | - public function __toString() |
|
| 111 | - { |
|
| 112 | - return $this->reg_url_link; |
|
| 113 | - } |
|
| 105 | + /** |
|
| 106 | + * Return the object as a string |
|
| 107 | + * |
|
| 108 | + * @return string |
|
| 109 | + */ |
|
| 110 | + public function __toString() |
|
| 111 | + { |
|
| 112 | + return $this->reg_url_link; |
|
| 113 | + } |
|
| 114 | 114 | } |