@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
| 55 | 55 | $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
| 56 | 56 | $response = $obj->create_job($this->_job_parameters); |
| 57 | - if (! $response instanceof JobStepResponse) { |
|
| 57 | + if ( ! $response instanceof JobStepResponse) { |
|
| 58 | 58 | throw new BatchRequestException( |
| 59 | 59 | sprintf( |
| 60 | 60 | __( |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | ); |
| 67 | 67 | } |
| 68 | 68 | $success = $this->_job_parameters->save(true); |
| 69 | - if (! $success) { |
|
| 69 | + if ( ! $success) { |
|
| 70 | 70 | throw new BatchRequestException( |
| 71 | 71 | sprintf( |
| 72 | 72 | __( |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
| 103 | 103 | // continue it |
| 104 | 104 | $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
| 105 | - if (! $response instanceof JobStepResponse) { |
|
| 105 | + if ( ! $response instanceof JobStepResponse) { |
|
| 106 | 106 | throw new BatchRequestException( |
| 107 | 107 | sprintf( |
| 108 | 108 | __( |
@@ -131,7 +131,7 @@ discard block |
||
| 131 | 131 | */ |
| 132 | 132 | public function instantiate_batch_job_handler_from_classname($classname) |
| 133 | 133 | { |
| 134 | - if (! class_exists($classname)) { |
|
| 134 | + if ( ! class_exists($classname)) { |
|
| 135 | 135 | throw new BatchRequestException( |
| 136 | 136 | sprintf( |
| 137 | 137 | __( |
@@ -143,7 +143,7 @@ discard block |
||
| 143 | 143 | ); |
| 144 | 144 | } |
| 145 | 145 | $obj = new $classname; |
| 146 | - if (! $obj instanceof JobHandlerInterface) { |
|
| 146 | + if ( ! $obj instanceof JobHandlerInterface) { |
|
| 147 | 147 | throw new BatchRequestException( |
| 148 | 148 | sprintf( |
| 149 | 149 | __( |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
| 174 | 174 | // continue it |
| 175 | 175 | $response = $handler_obj->cleanup_job($job_parameters); |
| 176 | - if (! $response instanceof JobStepResponse) { |
|
| 176 | + if ( ! $response instanceof JobStepResponse) { |
|
| 177 | 177 | throw new BatchRequestException( |
| 178 | 178 | sprintf( |
| 179 | 179 | __( |
@@ -203,7 +203,7 @@ discard block |
||
| 203 | 203 | */ |
| 204 | 204 | protected function _get_error_response(\Exception $exception, $method_name) |
| 205 | 205 | { |
| 206 | - if (! $this->_job_parameters instanceof JobParameters) { |
|
| 206 | + if ( ! $this->_job_parameters instanceof JobParameters) { |
|
| 207 | 207 | $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
| 208 | 208 | } |
| 209 | 209 | $this->_job_parameters->set_status(JobParameters::status_error); |
@@ -215,7 +215,7 @@ discard block |
||
| 215 | 215 | 'event_espresso' |
| 216 | 216 | ), |
| 217 | 217 | get_class($exception), |
| 218 | - 'BatchRunner::' . $method_name . '()', |
|
| 218 | + 'BatchRunner::'.$method_name.'()', |
|
| 219 | 219 | $exception->getMessage(), |
| 220 | 220 | $exception->getTraceAsString() |
| 221 | 221 | ) |
@@ -23,203 +23,203 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | class BatchRequestProcessor |
| 25 | 25 | { |
| 26 | - // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 27 | - // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 28 | - /** |
|
| 29 | - * Current job's ID (if assigned) |
|
| 30 | - * |
|
| 31 | - * @var string|null |
|
| 32 | - */ |
|
| 33 | - protected $_job_id; |
|
| 26 | + // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 27 | + // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 28 | + /** |
|
| 29 | + * Current job's ID (if assigned) |
|
| 30 | + * |
|
| 31 | + * @var string|null |
|
| 32 | + */ |
|
| 33 | + protected $_job_id; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Current job's parameters |
|
| 37 | - * |
|
| 38 | - * @var JobParameters|null |
|
| 39 | - */ |
|
| 40 | - protected $_job_parameters; |
|
| 35 | + /** |
|
| 36 | + * Current job's parameters |
|
| 37 | + * |
|
| 38 | + * @var JobParameters|null |
|
| 39 | + */ |
|
| 40 | + protected $_job_parameters; |
|
| 41 | 41 | |
| 42 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 43 | - /** |
|
| 44 | - * Creates a job for the specified batch handler class (which should be autoloaded) |
|
| 45 | - * and the specified request data |
|
| 46 | - * |
|
| 47 | - * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface |
|
| 48 | - * @param array $request_data to be used by the batch job handler |
|
| 49 | - * @return JobStepResponse |
|
| 50 | - */ |
|
| 51 | - public function create_job($batch_job_handler_class, $request_data) |
|
| 52 | - { |
|
| 53 | - try { |
|
| 54 | - $this->_job_id = wp_generate_password(15, false); |
|
| 55 | - $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
|
| 56 | - $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
|
| 57 | - $response = $obj->create_job($this->_job_parameters); |
|
| 58 | - if (! $response instanceof JobStepResponse) { |
|
| 59 | - throw new BatchRequestException( |
|
| 60 | - sprintf( |
|
| 61 | - __( |
|
| 62 | - 'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception', |
|
| 63 | - 'event_espresso' |
|
| 64 | - ), |
|
| 65 | - wp_json_encode($request_data) |
|
| 66 | - ) |
|
| 67 | - ); |
|
| 68 | - } |
|
| 69 | - $success = $this->_job_parameters->save(true); |
|
| 70 | - if (! $success) { |
|
| 71 | - throw new BatchRequestException( |
|
| 72 | - sprintf( |
|
| 73 | - __( |
|
| 74 | - 'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s', |
|
| 75 | - 'event_espresso' |
|
| 76 | - ), |
|
| 77 | - $this->_job_id, |
|
| 78 | - wp_json_encode($request_data) |
|
| 79 | - ) |
|
| 80 | - ); |
|
| 81 | - } |
|
| 82 | - } catch (\Exception $e) { |
|
| 83 | - $response = $this->_get_error_response($e, 'create_job'); |
|
| 84 | - } |
|
| 85 | - return $response; |
|
| 86 | - } |
|
| 42 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 43 | + /** |
|
| 44 | + * Creates a job for the specified batch handler class (which should be autoloaded) |
|
| 45 | + * and the specified request data |
|
| 46 | + * |
|
| 47 | + * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface |
|
| 48 | + * @param array $request_data to be used by the batch job handler |
|
| 49 | + * @return JobStepResponse |
|
| 50 | + */ |
|
| 51 | + public function create_job($batch_job_handler_class, $request_data) |
|
| 52 | + { |
|
| 53 | + try { |
|
| 54 | + $this->_job_id = wp_generate_password(15, false); |
|
| 55 | + $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
|
| 56 | + $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
|
| 57 | + $response = $obj->create_job($this->_job_parameters); |
|
| 58 | + if (! $response instanceof JobStepResponse) { |
|
| 59 | + throw new BatchRequestException( |
|
| 60 | + sprintf( |
|
| 61 | + __( |
|
| 62 | + 'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception', |
|
| 63 | + 'event_espresso' |
|
| 64 | + ), |
|
| 65 | + wp_json_encode($request_data) |
|
| 66 | + ) |
|
| 67 | + ); |
|
| 68 | + } |
|
| 69 | + $success = $this->_job_parameters->save(true); |
|
| 70 | + if (! $success) { |
|
| 71 | + throw new BatchRequestException( |
|
| 72 | + sprintf( |
|
| 73 | + __( |
|
| 74 | + 'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s', |
|
| 75 | + 'event_espresso' |
|
| 76 | + ), |
|
| 77 | + $this->_job_id, |
|
| 78 | + wp_json_encode($request_data) |
|
| 79 | + ) |
|
| 80 | + ); |
|
| 81 | + } |
|
| 82 | + } catch (\Exception $e) { |
|
| 83 | + $response = $this->_get_error_response($e, 'create_job'); |
|
| 84 | + } |
|
| 85 | + return $response; |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Retrieves the job's arguments |
|
| 91 | - * |
|
| 92 | - * @param string $job_id |
|
| 93 | - * @param int $batch_size |
|
| 94 | - * @return JobStepResponse |
|
| 95 | - */ |
|
| 96 | - public function continue_job($job_id, $batch_size = 50) |
|
| 97 | - { |
|
| 98 | - try { |
|
| 99 | - $this->_job_id = $job_id; |
|
| 100 | - $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size; |
|
| 101 | - // get the corresponding WordPress option for the job |
|
| 102 | - $this->_job_parameters = JobParameters::load($this->_job_id); |
|
| 103 | - $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
|
| 104 | - // continue it |
|
| 105 | - $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
|
| 106 | - if (! $response instanceof JobStepResponse) { |
|
| 107 | - throw new BatchRequestException( |
|
| 108 | - sprintf( |
|
| 109 | - __( |
|
| 110 | - 'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 111 | - 'event_espresso' |
|
| 112 | - ), |
|
| 113 | - $this->_job_id |
|
| 114 | - ) |
|
| 115 | - ); |
|
| 116 | - } |
|
| 117 | - $this->_job_parameters->save(); |
|
| 118 | - } catch (\Exception $e) { |
|
| 119 | - $response = $this->_get_error_response($e, 'continue_job'); |
|
| 120 | - } |
|
| 121 | - return $response; |
|
| 122 | - } |
|
| 89 | + /** |
|
| 90 | + * Retrieves the job's arguments |
|
| 91 | + * |
|
| 92 | + * @param string $job_id |
|
| 93 | + * @param int $batch_size |
|
| 94 | + * @return JobStepResponse |
|
| 95 | + */ |
|
| 96 | + public function continue_job($job_id, $batch_size = 50) |
|
| 97 | + { |
|
| 98 | + try { |
|
| 99 | + $this->_job_id = $job_id; |
|
| 100 | + $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size; |
|
| 101 | + // get the corresponding WordPress option for the job |
|
| 102 | + $this->_job_parameters = JobParameters::load($this->_job_id); |
|
| 103 | + $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
|
| 104 | + // continue it |
|
| 105 | + $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
|
| 106 | + if (! $response instanceof JobStepResponse) { |
|
| 107 | + throw new BatchRequestException( |
|
| 108 | + sprintf( |
|
| 109 | + __( |
|
| 110 | + 'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 111 | + 'event_espresso' |
|
| 112 | + ), |
|
| 113 | + $this->_job_id |
|
| 114 | + ) |
|
| 115 | + ); |
|
| 116 | + } |
|
| 117 | + $this->_job_parameters->save(); |
|
| 118 | + } catch (\Exception $e) { |
|
| 119 | + $response = $this->_get_error_response($e, 'continue_job'); |
|
| 120 | + } |
|
| 121 | + return $response; |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Instantiates an object of type $classname, which implements |
|
| 127 | - * JobHandlerInterface |
|
| 128 | - * |
|
| 129 | - * @param string $classname |
|
| 130 | - * @return JobHandlerInterface |
|
| 131 | - * @throws BatchRequestException |
|
| 132 | - */ |
|
| 133 | - public function instantiate_batch_job_handler_from_classname($classname) |
|
| 134 | - { |
|
| 135 | - if (! class_exists($classname)) { |
|
| 136 | - throw new BatchRequestException( |
|
| 137 | - sprintf( |
|
| 138 | - __( |
|
| 139 | - 'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.', |
|
| 140 | - 'event_espresso' |
|
| 141 | - ), |
|
| 142 | - $classname |
|
| 143 | - ) |
|
| 144 | - ); |
|
| 145 | - } |
|
| 146 | - $obj = new $classname; |
|
| 147 | - if (! $obj instanceof JobHandlerInterface) { |
|
| 148 | - throw new BatchRequestException( |
|
| 149 | - sprintf( |
|
| 150 | - __( |
|
| 151 | - 'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job', |
|
| 152 | - 'event_espresso' |
|
| 153 | - ), |
|
| 154 | - $classname |
|
| 155 | - ) |
|
| 156 | - ); |
|
| 157 | - } |
|
| 158 | - return $obj; |
|
| 159 | - } |
|
| 125 | + /** |
|
| 126 | + * Instantiates an object of type $classname, which implements |
|
| 127 | + * JobHandlerInterface |
|
| 128 | + * |
|
| 129 | + * @param string $classname |
|
| 130 | + * @return JobHandlerInterface |
|
| 131 | + * @throws BatchRequestException |
|
| 132 | + */ |
|
| 133 | + public function instantiate_batch_job_handler_from_classname($classname) |
|
| 134 | + { |
|
| 135 | + if (! class_exists($classname)) { |
|
| 136 | + throw new BatchRequestException( |
|
| 137 | + sprintf( |
|
| 138 | + __( |
|
| 139 | + 'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.', |
|
| 140 | + 'event_espresso' |
|
| 141 | + ), |
|
| 142 | + $classname |
|
| 143 | + ) |
|
| 144 | + ); |
|
| 145 | + } |
|
| 146 | + $obj = new $classname; |
|
| 147 | + if (! $obj instanceof JobHandlerInterface) { |
|
| 148 | + throw new BatchRequestException( |
|
| 149 | + sprintf( |
|
| 150 | + __( |
|
| 151 | + 'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job', |
|
| 152 | + 'event_espresso' |
|
| 153 | + ), |
|
| 154 | + $classname |
|
| 155 | + ) |
|
| 156 | + ); |
|
| 157 | + } |
|
| 158 | + return $obj; |
|
| 159 | + } |
|
| 160 | 160 | |
| 161 | 161 | |
| 162 | - /** |
|
| 163 | - * Forces a job to be cleaned up |
|
| 164 | - * |
|
| 165 | - * @param string $job_id |
|
| 166 | - * @return JobStepResponse |
|
| 167 | - * @throws BatchRequestException |
|
| 168 | - */ |
|
| 169 | - public function cleanup_job($job_id) |
|
| 170 | - { |
|
| 171 | - try { |
|
| 172 | - $this->_job_id = $job_id; |
|
| 173 | - $job_parameters = JobParameters::load($this->_job_id); |
|
| 174 | - $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
|
| 175 | - // continue it |
|
| 176 | - $response = $handler_obj->cleanup_job($job_parameters); |
|
| 177 | - if (! $response instanceof JobStepResponse) { |
|
| 178 | - throw new BatchRequestException( |
|
| 179 | - sprintf( |
|
| 180 | - __( |
|
| 181 | - 'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 182 | - 'event_espresso' |
|
| 183 | - ), |
|
| 184 | - $this->_job_id |
|
| 185 | - ) |
|
| 186 | - ); |
|
| 187 | - } |
|
| 188 | - $job_parameters->set_status(JobParameters::status_cleaned_up); |
|
| 189 | - $job_parameters->delete(); |
|
| 190 | - return $response; |
|
| 191 | - } catch (\Exception $e) { |
|
| 192 | - $response = $this->_get_error_response($e, 'cleanup_job'); |
|
| 193 | - } |
|
| 194 | - return $response; |
|
| 195 | - } |
|
| 162 | + /** |
|
| 163 | + * Forces a job to be cleaned up |
|
| 164 | + * |
|
| 165 | + * @param string $job_id |
|
| 166 | + * @return JobStepResponse |
|
| 167 | + * @throws BatchRequestException |
|
| 168 | + */ |
|
| 169 | + public function cleanup_job($job_id) |
|
| 170 | + { |
|
| 171 | + try { |
|
| 172 | + $this->_job_id = $job_id; |
|
| 173 | + $job_parameters = JobParameters::load($this->_job_id); |
|
| 174 | + $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
|
| 175 | + // continue it |
|
| 176 | + $response = $handler_obj->cleanup_job($job_parameters); |
|
| 177 | + if (! $response instanceof JobStepResponse) { |
|
| 178 | + throw new BatchRequestException( |
|
| 179 | + sprintf( |
|
| 180 | + __( |
|
| 181 | + 'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 182 | + 'event_espresso' |
|
| 183 | + ), |
|
| 184 | + $this->_job_id |
|
| 185 | + ) |
|
| 186 | + ); |
|
| 187 | + } |
|
| 188 | + $job_parameters->set_status(JobParameters::status_cleaned_up); |
|
| 189 | + $job_parameters->delete(); |
|
| 190 | + return $response; |
|
| 191 | + } catch (\Exception $e) { |
|
| 192 | + $response = $this->_get_error_response($e, 'cleanup_job'); |
|
| 193 | + } |
|
| 194 | + return $response; |
|
| 195 | + } |
|
| 196 | 196 | |
| 197 | 197 | |
| 198 | - /** |
|
| 199 | - * Creates a valid JobStepResponse object from an exception and method name. |
|
| 200 | - * |
|
| 201 | - * @param \Exception $exception |
|
| 202 | - * @param string $method_name |
|
| 203 | - * @return JobStepResponse |
|
| 204 | - */ |
|
| 205 | - protected function _get_error_response(\Exception $exception, $method_name) |
|
| 206 | - { |
|
| 207 | - if (! $this->_job_parameters instanceof JobParameters) { |
|
| 208 | - $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
|
| 209 | - } |
|
| 210 | - $this->_job_parameters->set_status(JobParameters::status_error); |
|
| 211 | - return new JobStepResponse( |
|
| 212 | - $this->_job_parameters, |
|
| 213 | - sprintf( |
|
| 214 | - __( |
|
| 215 | - 'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s', |
|
| 216 | - 'event_espresso' |
|
| 217 | - ), |
|
| 218 | - get_class($exception), |
|
| 219 | - 'BatchRunner::' . $method_name . '()', |
|
| 220 | - $exception->getMessage(), |
|
| 221 | - $exception->getTraceAsString() |
|
| 222 | - ) |
|
| 223 | - ); |
|
| 224 | - } |
|
| 198 | + /** |
|
| 199 | + * Creates a valid JobStepResponse object from an exception and method name. |
|
| 200 | + * |
|
| 201 | + * @param \Exception $exception |
|
| 202 | + * @param string $method_name |
|
| 203 | + * @return JobStepResponse |
|
| 204 | + */ |
|
| 205 | + protected function _get_error_response(\Exception $exception, $method_name) |
|
| 206 | + { |
|
| 207 | + if (! $this->_job_parameters instanceof JobParameters) { |
|
| 208 | + $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
|
| 209 | + } |
|
| 210 | + $this->_job_parameters->set_status(JobParameters::status_error); |
|
| 211 | + return new JobStepResponse( |
|
| 212 | + $this->_job_parameters, |
|
| 213 | + sprintf( |
|
| 214 | + __( |
|
| 215 | + 'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s', |
|
| 216 | + 'event_espresso' |
|
| 217 | + ), |
|
| 218 | + get_class($exception), |
|
| 219 | + 'BatchRunner::' . $method_name . '()', |
|
| 220 | + $exception->getMessage(), |
|
| 221 | + $exception->getTraceAsString() |
|
| 222 | + ) |
|
| 223 | + ); |
|
| 224 | + } |
|
| 225 | 225 | } |
@@ -4,63 +4,63 @@ |
||
| 4 | 4 | |
| 5 | 5 | interface HasSchemaInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * Returns whatever is set as the nicename for the object. |
|
| 9 | - * |
|
| 10 | - * @return string |
|
| 11 | - */ |
|
| 12 | - public function getSchemaDescription(); |
|
| 7 | + /** |
|
| 8 | + * Returns whatever is set as the nicename for the object. |
|
| 9 | + * |
|
| 10 | + * @return string |
|
| 11 | + */ |
|
| 12 | + public function getSchemaDescription(); |
|
| 13 | 13 | |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Returns whatever is set as the $_schema_type property for the object. |
|
| 17 | - * Note: this will automatically add 'null' to the schema if the object is_nullable() |
|
| 18 | - * |
|
| 19 | - * @return string|array |
|
| 20 | - */ |
|
| 21 | - public function getSchemaType(); |
|
| 15 | + /** |
|
| 16 | + * Returns whatever is set as the $_schema_type property for the object. |
|
| 17 | + * Note: this will automatically add 'null' to the schema if the object is_nullable() |
|
| 18 | + * |
|
| 19 | + * @return string|array |
|
| 20 | + */ |
|
| 21 | + public function getSchemaType(); |
|
| 22 | 22 | |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * This is usually present when the $_schema_type property is 'object'. Any child classes will need to override |
|
| 26 | - * this method and return the properties for the schema. |
|
| 27 | - * The reason this is not a property on the class is because there may be filters set on the values for the property |
|
| 28 | - * that won't be exposed on construct. For example enum type schemas may have the enum values filtered. |
|
| 29 | - * |
|
| 30 | - * @return array |
|
| 31 | - */ |
|
| 32 | - public function getSchemaProperties(); |
|
| 24 | + /** |
|
| 25 | + * This is usually present when the $_schema_type property is 'object'. Any child classes will need to override |
|
| 26 | + * this method and return the properties for the schema. |
|
| 27 | + * The reason this is not a property on the class is because there may be filters set on the values for the property |
|
| 28 | + * that won't be exposed on construct. For example enum type schemas may have the enum values filtered. |
|
| 29 | + * |
|
| 30 | + * @return array |
|
| 31 | + */ |
|
| 32 | + public function getSchemaProperties(); |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * If a child class has enum values, they should override this method and provide a simple array |
|
| 36 | - * of the enum values. |
|
| 37 | - * The reason this is not a property on the class is because there may be filterable enum values that |
|
| 38 | - * are set on the instantiated object that could be filtered after construct. |
|
| 39 | - * |
|
| 40 | - * @return array |
|
| 41 | - */ |
|
| 42 | - public function getSchemaEnum(); |
|
| 34 | + /** |
|
| 35 | + * If a child class has enum values, they should override this method and provide a simple array |
|
| 36 | + * of the enum values. |
|
| 37 | + * The reason this is not a property on the class is because there may be filterable enum values that |
|
| 38 | + * are set on the instantiated object that could be filtered after construct. |
|
| 39 | + * |
|
| 40 | + * @return array |
|
| 41 | + */ |
|
| 42 | + public function getSchemaEnum(); |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * This returns the value of the $_schema_format property on the object. |
|
| 46 | - * |
|
| 47 | - * @return string |
|
| 48 | - */ |
|
| 49 | - public function getSchemaFormat(); |
|
| 44 | + /** |
|
| 45 | + * This returns the value of the $_schema_format property on the object. |
|
| 46 | + * |
|
| 47 | + * @return string |
|
| 48 | + */ |
|
| 49 | + public function getSchemaFormat(); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * This returns the value of the $_schema_readonly property on the object. |
|
| 53 | - * |
|
| 54 | - * @return bool |
|
| 55 | - */ |
|
| 56 | - public function getSchemaReadonly(); |
|
| 51 | + /** |
|
| 52 | + * This returns the value of the $_schema_readonly property on the object. |
|
| 53 | + * |
|
| 54 | + * @return bool |
|
| 55 | + */ |
|
| 56 | + public function getSchemaReadonly(); |
|
| 57 | 57 | |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * This returns elements used to represent this field in the json schema. |
|
| 61 | - * |
|
| 62 | - * @link http://json-schema.org/ |
|
| 63 | - * @return array |
|
| 64 | - */ |
|
| 65 | - public function getSchema(); |
|
| 59 | + /** |
|
| 60 | + * This returns elements used to represent this field in the json schema. |
|
| 61 | + * |
|
| 62 | + * @link http://json-schema.org/ |
|
| 63 | + * @return array |
|
| 64 | + */ |
|
| 65 | + public function getSchema(); |
|
| 66 | 66 | } |
@@ -12,9 +12,9 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | interface CaffeinatedInterface |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Used to indicate when functionality is caffeinated or not. |
|
| 17 | - * @return bool |
|
| 18 | - */ |
|
| 19 | - public function isCaffeinated(); |
|
| 15 | + /** |
|
| 16 | + * Used to indicate when functionality is caffeinated or not. |
|
| 17 | + * @return bool |
|
| 18 | + */ |
|
| 19 | + public function isCaffeinated(); |
|
| 20 | 20 | } |
@@ -5,8 +5,8 @@ |
||
| 5 | 5 | interface SessionIdentifierInterface |
| 6 | 6 | { |
| 7 | 7 | |
| 8 | - /** |
|
| 9 | - * @return string |
|
| 10 | - */ |
|
| 11 | - public function id(); |
|
| 8 | + /** |
|
| 9 | + * @return string |
|
| 10 | + */ |
|
| 11 | + public function id(); |
|
| 12 | 12 | } |
@@ -16,45 +16,45 @@ |
||
| 16 | 16 | class CancelRegistrationService |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * @var CancelTicketLineItemService $cancel_ticket_line_item_service |
|
| 21 | - */ |
|
| 22 | - private $cancel_ticket_line_item_service; |
|
| 23 | - |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * Command constructor |
|
| 27 | - * |
|
| 28 | - * @param CancelTicketLineItemService $cancel_ticket_line_item_service |
|
| 29 | - */ |
|
| 30 | - public function __construct(CancelTicketLineItemService $cancel_ticket_line_item_service) |
|
| 31 | - { |
|
| 32 | - $this->cancel_ticket_line_item_service = $cancel_ticket_line_item_service; |
|
| 33 | - } |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @param \EE_Registration $registration |
|
| 38 | - * @param bool $cancel_ticket_line_item |
|
| 39 | - */ |
|
| 40 | - public function cancelRegistrationAndTicketLineItem(\EE_Registration $registration, $cancel_ticket_line_item = true) |
|
| 41 | - { |
|
| 42 | - // first cancel the original line item for the registration's ticket |
|
| 43 | - if ($cancel_ticket_line_item) { |
|
| 44 | - $this->cancel_ticket_line_item_service->forRegistration($registration); |
|
| 45 | - } |
|
| 46 | - $this->cancelRegistrationOnly($registration); |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @param \EE_Registration $registration |
|
| 52 | - * @throws \EE_Error |
|
| 53 | - */ |
|
| 54 | - public function cancelRegistrationOnly(\EE_Registration $registration) |
|
| 55 | - { |
|
| 56 | - // now cancel the registration itself |
|
| 57 | - $registration->set_status(\EEM_Registration::status_id_cancelled); |
|
| 58 | - $registration->save(); |
|
| 59 | - } |
|
| 19 | + /** |
|
| 20 | + * @var CancelTicketLineItemService $cancel_ticket_line_item_service |
|
| 21 | + */ |
|
| 22 | + private $cancel_ticket_line_item_service; |
|
| 23 | + |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * Command constructor |
|
| 27 | + * |
|
| 28 | + * @param CancelTicketLineItemService $cancel_ticket_line_item_service |
|
| 29 | + */ |
|
| 30 | + public function __construct(CancelTicketLineItemService $cancel_ticket_line_item_service) |
|
| 31 | + { |
|
| 32 | + $this->cancel_ticket_line_item_service = $cancel_ticket_line_item_service; |
|
| 33 | + } |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @param \EE_Registration $registration |
|
| 38 | + * @param bool $cancel_ticket_line_item |
|
| 39 | + */ |
|
| 40 | + public function cancelRegistrationAndTicketLineItem(\EE_Registration $registration, $cancel_ticket_line_item = true) |
|
| 41 | + { |
|
| 42 | + // first cancel the original line item for the registration's ticket |
|
| 43 | + if ($cancel_ticket_line_item) { |
|
| 44 | + $this->cancel_ticket_line_item_service->forRegistration($registration); |
|
| 45 | + } |
|
| 46 | + $this->cancelRegistrationOnly($registration); |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @param \EE_Registration $registration |
|
| 52 | + * @throws \EE_Error |
|
| 53 | + */ |
|
| 54 | + public function cancelRegistrationOnly(\EE_Registration $registration) |
|
| 55 | + { |
|
| 56 | + // now cancel the registration itself |
|
| 57 | + $registration->set_status(\EEM_Registration::status_id_cancelled); |
|
| 58 | + $registration->save(); |
|
| 59 | + } |
|
| 60 | 60 | } |
@@ -15,23 +15,23 @@ |
||
| 15 | 15 | class UpdateRegistrationService extends DomainService |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @param \EE_Registration $registration |
|
| 20 | - * @return bool |
|
| 21 | - */ |
|
| 22 | - public function updateRegistrationAndTransaction(\EE_Registration $registration) |
|
| 23 | - { |
|
| 24 | - $transaction = $registration->transaction(); |
|
| 25 | - // reset transaction status back to incomplete |
|
| 26 | - $transaction->set_status(\EEM_Transaction::incomplete_status_code); |
|
| 27 | - // update transaction and all line item totals and subtotals |
|
| 28 | - $transaction->total_line_item()->recalculate_total_including_taxes(); |
|
| 29 | - // maybe update status, but don't save transaction just yet |
|
| 30 | - $transaction->update_status_based_on_total_paid(); |
|
| 31 | - /** @type \EE_Registration_Processor $registration_processor */ |
|
| 32 | - $registration_processor = \EE_Registry::instance()->load_class('Registration_Processor'); |
|
| 33 | - $registration_processor->update_registration_final_prices($transaction); |
|
| 34 | - $registration_processor->update_registration_status_and_trigger_notifications($registration); |
|
| 35 | - return true; |
|
| 36 | - } |
|
| 18 | + /** |
|
| 19 | + * @param \EE_Registration $registration |
|
| 20 | + * @return bool |
|
| 21 | + */ |
|
| 22 | + public function updateRegistrationAndTransaction(\EE_Registration $registration) |
|
| 23 | + { |
|
| 24 | + $transaction = $registration->transaction(); |
|
| 25 | + // reset transaction status back to incomplete |
|
| 26 | + $transaction->set_status(\EEM_Transaction::incomplete_status_code); |
|
| 27 | + // update transaction and all line item totals and subtotals |
|
| 28 | + $transaction->total_line_item()->recalculate_total_including_taxes(); |
|
| 29 | + // maybe update status, but don't save transaction just yet |
|
| 30 | + $transaction->update_status_based_on_total_paid(); |
|
| 31 | + /** @type \EE_Registration_Processor $registration_processor */ |
|
| 32 | + $registration_processor = \EE_Registry::instance()->load_class('Registration_Processor'); |
|
| 33 | + $registration_processor->update_registration_final_prices($transaction); |
|
| 34 | + $registration_processor->update_registration_status_and_trigger_notifications($registration); |
|
| 35 | + return true; |
|
| 36 | + } |
|
| 37 | 37 | } |
@@ -15,19 +15,19 @@ |
||
| 15 | 15 | class WordPress extends Basic |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @param string $email_address |
|
| 20 | - * @return boolean |
|
| 21 | - * @throws EmailValidationException |
|
| 22 | - */ |
|
| 23 | - public function validate($email_address) |
|
| 24 | - { |
|
| 25 | - parent::validate($email_address); |
|
| 26 | - if (! is_email($email_address)) { |
|
| 27 | - throw new EmailValidationException( |
|
| 28 | - esc_html__('The email address provided is not valid.', 'event_espresso') |
|
| 29 | - ); |
|
| 30 | - } |
|
| 31 | - return true; |
|
| 32 | - } |
|
| 18 | + /** |
|
| 19 | + * @param string $email_address |
|
| 20 | + * @return boolean |
|
| 21 | + * @throws EmailValidationException |
|
| 22 | + */ |
|
| 23 | + public function validate($email_address) |
|
| 24 | + { |
|
| 25 | + parent::validate($email_address); |
|
| 26 | + if (! is_email($email_address)) { |
|
| 27 | + throw new EmailValidationException( |
|
| 28 | + esc_html__('The email address provided is not valid.', 'event_espresso') |
|
| 29 | + ); |
|
| 30 | + } |
|
| 31 | + return true; |
|
| 32 | + } |
|
| 33 | 33 | } |
@@ -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 | ); |
@@ -15,26 +15,26 @@ |
||
| 15 | 15 | class International extends Basic |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @param string $email_address |
|
| 20 | - * @return bool |
|
| 21 | - * @throws \EventEspresso\core\domain\services\validation\email\EmailValidationException |
|
| 22 | - */ |
|
| 23 | - public function validate($email_address) |
|
| 24 | - { |
|
| 25 | - parent::validate($email_address); |
|
| 26 | - if (// plz see http://stackoverflow.com/a/24817336 re: the following regex |
|
| 27 | - ! preg_match( |
|
| 28 | - // @codingStandardsIgnoreStart |
|
| 29 | - '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u', |
|
| 30 | - // @codingStandardsIgnoreEnd |
|
| 31 | - $email_address |
|
| 32 | - ) |
|
| 33 | - ) { |
|
| 34 | - throw new EmailValidationException( |
|
| 35 | - esc_html__('Email address is invalid.', 'event_espresso') |
|
| 36 | - ); |
|
| 37 | - } |
|
| 38 | - return true; |
|
| 39 | - } |
|
| 18 | + /** |
|
| 19 | + * @param string $email_address |
|
| 20 | + * @return bool |
|
| 21 | + * @throws \EventEspresso\core\domain\services\validation\email\EmailValidationException |
|
| 22 | + */ |
|
| 23 | + public function validate($email_address) |
|
| 24 | + { |
|
| 25 | + parent::validate($email_address); |
|
| 26 | + if (// plz see http://stackoverflow.com/a/24817336 re: the following regex |
|
| 27 | + ! preg_match( |
|
| 28 | + // @codingStandardsIgnoreStart |
|
| 29 | + '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u', |
|
| 30 | + // @codingStandardsIgnoreEnd |
|
| 31 | + $email_address |
|
| 32 | + ) |
|
| 33 | + ) { |
|
| 34 | + throw new EmailValidationException( |
|
| 35 | + esc_html__('Email address is invalid.', 'event_espresso') |
|
| 36 | + ); |
|
| 37 | + } |
|
| 38 | + return true; |
|
| 39 | + } |
|
| 40 | 40 | } |
@@ -16,65 +16,65 @@ |
||
| 16 | 16 | class EmailValidationService implements EmailValidatorInterface |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * @var EE_Registration_Config $registration_config |
|
| 21 | - */ |
|
| 22 | - protected $registration_config; |
|
| 19 | + /** |
|
| 20 | + * @var EE_Registration_Config $registration_config |
|
| 21 | + */ |
|
| 22 | + protected $registration_config; |
|
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @var Loader $loader |
|
| 26 | - */ |
|
| 27 | - protected $loader; |
|
| 24 | + /** |
|
| 25 | + * @var Loader $loader |
|
| 26 | + */ |
|
| 27 | + protected $loader; |
|
| 28 | 28 | |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * EmailValidationService constructor. |
|
| 32 | - * Accepts an \EE_Config as an argument. |
|
| 33 | - * |
|
| 34 | - * @param EE_Registration_Config $config |
|
| 35 | - * @param Loader $loader |
|
| 36 | - */ |
|
| 37 | - public function __construct(EE_Registration_Config $config, Loader $loader) |
|
| 38 | - { |
|
| 39 | - $this->registration_config = $config; |
|
| 40 | - $this->loader = $loader; |
|
| 41 | - } |
|
| 30 | + /** |
|
| 31 | + * EmailValidationService constructor. |
|
| 32 | + * Accepts an \EE_Config as an argument. |
|
| 33 | + * |
|
| 34 | + * @param EE_Registration_Config $config |
|
| 35 | + * @param Loader $loader |
|
| 36 | + */ |
|
| 37 | + public function __construct(EE_Registration_Config $config, Loader $loader) |
|
| 38 | + { |
|
| 39 | + $this->registration_config = $config; |
|
| 40 | + $this->loader = $loader; |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Validates the email address. If it's invalid, an EmailValidationException |
|
| 46 | - * is thrown that describes why its invalid. |
|
| 47 | - * |
|
| 48 | - * @param string $email_address |
|
| 49 | - * @return boolean |
|
| 50 | - * @throws EmailValidationException |
|
| 51 | - */ |
|
| 52 | - public function validate($email_address) |
|
| 53 | - { |
|
| 54 | - // pick the correct validator according to the config |
|
| 55 | - switch ($this->registration_config->email_validation_level) { |
|
| 56 | - case 'basic': |
|
| 57 | - $validator = $this->loader->getShared( |
|
| 58 | - 'EventEspresso\core\domain\services\validation\email\strategies\Basic' |
|
| 59 | - ); |
|
| 60 | - break; |
|
| 61 | - case 'i18n': |
|
| 62 | - $validator = $this->loader->getShared( |
|
| 63 | - 'EventEspresso\core\domain\services\validation\email\strategies\International' |
|
| 64 | - ); |
|
| 65 | - break; |
|
| 66 | - case 'i18n_dns': |
|
| 67 | - $validator = $this->loader->getShared( |
|
| 68 | - 'EventEspresso\core\domain\services\validation\email\strategies\InternationalDNS' |
|
| 69 | - ); |
|
| 70 | - break; |
|
| 71 | - case 'wp_default': |
|
| 72 | - default: |
|
| 73 | - $validator = $this->loader->getShared( |
|
| 74 | - 'EventEspresso\core\domain\services\validation\email\strategies\WordPress' |
|
| 75 | - ); |
|
| 76 | - break; |
|
| 77 | - } |
|
| 78 | - return $validator->validate($email_address); |
|
| 79 | - } |
|
| 44 | + /** |
|
| 45 | + * Validates the email address. If it's invalid, an EmailValidationException |
|
| 46 | + * is thrown that describes why its invalid. |
|
| 47 | + * |
|
| 48 | + * @param string $email_address |
|
| 49 | + * @return boolean |
|
| 50 | + * @throws EmailValidationException |
|
| 51 | + */ |
|
| 52 | + public function validate($email_address) |
|
| 53 | + { |
|
| 54 | + // pick the correct validator according to the config |
|
| 55 | + switch ($this->registration_config->email_validation_level) { |
|
| 56 | + case 'basic': |
|
| 57 | + $validator = $this->loader->getShared( |
|
| 58 | + 'EventEspresso\core\domain\services\validation\email\strategies\Basic' |
|
| 59 | + ); |
|
| 60 | + break; |
|
| 61 | + case 'i18n': |
|
| 62 | + $validator = $this->loader->getShared( |
|
| 63 | + 'EventEspresso\core\domain\services\validation\email\strategies\International' |
|
| 64 | + ); |
|
| 65 | + break; |
|
| 66 | + case 'i18n_dns': |
|
| 67 | + $validator = $this->loader->getShared( |
|
| 68 | + 'EventEspresso\core\domain\services\validation\email\strategies\InternationalDNS' |
|
| 69 | + ); |
|
| 70 | + break; |
|
| 71 | + case 'wp_default': |
|
| 72 | + default: |
|
| 73 | + $validator = $this->loader->getShared( |
|
| 74 | + 'EventEspresso\core\domain\services\validation\email\strategies\WordPress' |
|
| 75 | + ); |
|
| 76 | + break; |
|
| 77 | + } |
|
| 78 | + return $validator->validate($email_address); |
|
| 79 | + } |
|
| 80 | 80 | } |