eventespresso /
event-espresso-core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like EE_Messages_Processor often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use EE_Messages_Processor, and based on these observations, apply Extract Interface, too.
| 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); } |
||
| 12 | class EE_Messages_Processor { |
||
| 13 | |||
| 14 | |||
| 15 | /** |
||
| 16 | * @type EE_Message_Resource_Manager $_message_resource_manager |
||
| 17 | */ |
||
| 18 | protected $_message_resource_manager; |
||
| 19 | |||
| 20 | /** |
||
| 21 | * @type EE_Messages_Queue |
||
| 22 | */ |
||
| 23 | protected $_queue; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * @type EE_Messages_Generator |
||
| 27 | */ |
||
| 28 | protected $_generator; |
||
| 29 | |||
| 30 | |||
| 31 | |||
| 32 | |||
| 33 | /** |
||
| 34 | * constructor |
||
| 35 | * |
||
| 36 | * @param EE_Message_Resource_Manager $message_resource_manager |
||
| 37 | */ |
||
| 38 | public function __construct( EE_Message_Resource_Manager $message_resource_manager ) { |
||
| 39 | $this->_message_resource_manager = $message_resource_manager; |
||
| 40 | $this->_init_queue_and_generator(); |
||
| 41 | } |
||
| 42 | |||
| 43 | |||
| 44 | |||
| 45 | |||
| 46 | /** |
||
| 47 | * This method sets (or resets) the various properties for use. |
||
| 48 | * |
||
| 49 | * - $_queue = holds the messages queue |
||
| 50 | * - $_generator = holds the messages generator |
||
| 51 | */ |
||
| 52 | protected function _init_queue_and_generator() { |
||
| 53 | $this->_generator = EE_Registry::factory( 'EE_Messages_Generator' ); |
||
| 54 | $this->_queue = $this->_generator->generation_queue(); |
||
| 55 | } |
||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | /** |
||
| 61 | * This returns the current set queue. |
||
| 62 | * @return EE_Messages_Queue |
||
| 63 | */ |
||
| 64 | public function get_queue() { |
||
| 65 | return $this->_queue; |
||
| 66 | } |
||
| 67 | |||
| 68 | |||
| 69 | /** |
||
| 70 | * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator. |
||
| 71 | * |
||
| 72 | * @param EE_Message[] $messages Array of EE_Message objects (optional) to build the queue with. |
||
| 73 | * @param bool $clear_queue Whether to ensure a fresh queue or not. |
||
| 74 | * |
||
| 75 | * @return bool|EE_Messages_Queue return false if nothing generated. This returns a new EE_Message_Queue with |
||
| 76 | * generated messages. |
||
| 77 | */ |
||
| 78 | public function batch_generate_from_queue( $messages = array(), $clear_queue = false ) { |
||
| 79 | if ( $this->_build_queue_for_generation( $messages, $clear_queue ) ) { |
||
| 80 | $new_queue = $this->_generator->generate(); |
||
| 81 | if ( $new_queue instanceof EE_Messages_Queue ) { |
||
| 82 | //unlock queue |
||
| 83 | $this->_queue->unlock_queue(); |
||
| 84 | $this->_queue->initiate_request_by_priority( 'send' ); |
||
| 85 | return $new_queue; |
||
| 86 | } |
||
| 87 | } |
||
| 88 | $this->_queue->unlock_queue(); |
||
| 89 | return false; |
||
| 90 | } |
||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | /** |
||
| 95 | * This method preps a queue for generation. |
||
| 96 | * |
||
| 97 | * @since 4.9.0 |
||
| 98 | * |
||
| 99 | * @param EE_Message[] $messages Array of EE_Message objects to build the queue with |
||
| 100 | * |
||
| 101 | * @param bool $clear_queue This indicates whether the existing queue should be dumped or not. |
||
| 102 | * |
||
| 103 | * @return bool true means queue prepped, false means there was a lock so no generation please. |
||
| 104 | */ |
||
| 105 | protected function _build_queue_for_generation( $messages = array(), $clear_queue = false ) { |
||
| 106 | |||
| 107 | if ( $clear_queue ) { |
||
| 108 | $this->_init_queue_and_generator(); |
||
| 109 | } |
||
| 110 | |||
| 111 | if ( $messages ) { |
||
|
|
|||
| 112 | //if generation is locked then get out now because that means processing is already happening. |
||
| 113 | if ( $this->_queue->is_locked() ) { |
||
| 114 | return false; |
||
| 115 | } |
||
| 116 | |||
| 117 | $this->_queue->lock_queue(); |
||
| 118 | $messages = is_array( $messages ) ? $messages : array( $messages ); |
||
| 119 | foreach ( $messages as $message ) { |
||
| 120 | if ( $message instanceof EE_Message ) { |
||
| 121 | $data = $message->all_extra_meta_array(); |
||
| 122 | $this->_queue->add( $message, $data ); |
||
| 123 | } |
||
| 124 | } |
||
| 125 | return true; |
||
| 126 | } else { |
||
| 127 | return $this->_queue->get_batch_to_generate(); |
||
| 128 | } |
||
| 129 | } |
||
| 130 | |||
| 131 | |||
| 132 | /** |
||
| 133 | * This method preps a queue for sending. |
||
| 134 | * |
||
| 135 | * @param EE_Message[] $messages |
||
| 136 | * @param bool $clear_queue Used to indicate whether to start with a fresh queue or not. |
||
| 137 | * |
||
| 138 | * @return bool true means queue prepped, false means there was a lock so no queue prepped. |
||
| 139 | */ |
||
| 140 | protected function _build_queue_for_sending( $messages, $clear_queue = false ) { |
||
| 141 | //if sending is locked then get out now because that means processing is already happening. |
||
| 142 | if ( $this->_queue->is_locked( EE_Messages_Queue::action_sending ) ) { |
||
| 143 | return false; |
||
| 144 | } |
||
| 145 | |||
| 146 | $this->_queue->lock_queue( EE_Messages_Queue::action_sending ); |
||
| 147 | |||
| 148 | if ( $clear_queue ) { |
||
| 149 | $this->_init_queue_and_generator(); |
||
| 150 | } |
||
| 151 | |||
| 152 | $messages = is_array( $messages ) ? $messages : array( $messages ); |
||
| 153 | |||
| 154 | foreach ( $messages as $message ) { |
||
| 155 | $this->_queue->add( $message ); |
||
| 156 | } |
||
| 157 | return true; |
||
| 158 | } |
||
| 159 | |||
| 160 | |||
| 161 | /** |
||
| 162 | * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls EE_Message_Queue::execute() |
||
| 163 | * to iterate and send unsent messages. |
||
| 164 | * |
||
| 165 | * @param EE_Message[] $messages If an array of messages is sent in then use it. |
||
| 166 | * |
||
| 167 | * @param bool $clear_queue Whether to initialize a new queue or keep the existing one. |
||
| 168 | * |
||
| 169 | * @return EE_Messages_Queue |
||
| 170 | */ |
||
| 171 | public function batch_send_from_queue( $messages = array(), $clear_queue = false ) { |
||
| 172 | |||
| 173 | if ( $messages && $this->_build_queue_for_sending( $messages, $clear_queue ) ) { |
||
| 174 | $this->_queue->execute(); |
||
| 175 | $this->_queue->unlock_queue( EE_Messages_Queue::action_sending ); |
||
| 176 | } else { |
||
| 177 | //get messages to send and execute. |
||
| 178 | $this->_queue->get_to_send_batch_and_send(); |
||
| 179 | } |
||
| 180 | //note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed |
||
| 181 | //messages in the queue and decide how to handle at that point. |
||
| 182 | return $this->_queue; |
||
| 183 | } |
||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | /** |
||
| 191 | * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the |
||
| 192 | * EE_Message_Queue with the generated messages for the caller to work with. Note, this does NOT save the generated |
||
| 193 | * messages in the queue, leaving it up to the caller to do so. |
||
| 194 | * |
||
| 195 | * @param EE_Message_To_Generate[] $messages_to_generate |
||
| 196 | * @return EE_Messages_Queue |
||
| 197 | */ |
||
| 198 | public function generate_and_return( $messages_to_generate ) { |
||
| 199 | $this->_init_queue_and_generator(); |
||
| 200 | $this->_queue_for_generation_loop( $messages_to_generate ); |
||
| 201 | return $this->_generator->generate( false ); |
||
| 202 | } |
||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | /** |
||
| 208 | * Executes the generator generate method on the current internal queue, and returns the generated queue. |
||
| 209 | * @param bool $persist Indicate whether to instruct the generator to persist the generated queue (true) or not (false). |
||
| 210 | * @return EE_Messages_Queue |
||
| 211 | */ |
||
| 212 | public function generate_queue( $persist = true ) { |
||
| 213 | return $this->_generator->generate( $persist ); |
||
| 214 | } |
||
| 215 | |||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | /** |
||
| 220 | * Queue for generation. Note this does NOT persist to the db. Client code should call get_message_repository()->save() if desire |
||
| 221 | * to persist. This method is provided to client code to decide what it wants to do with queued messages for generation. |
||
| 222 | * @param EE_Message_To_Generate $message_to_generate |
||
| 223 | * @param bool $test_send Whether this item is for a test send or not. |
||
| 224 | * @return EE_Messages_Queue |
||
| 225 | */ |
||
| 226 | public function queue_for_generation( EE_Message_To_Generate $message_to_generate, $test_send = false ) { |
||
| 231 | |||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | |||
| 237 | |||
| 238 | /** |
||
| 239 | * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the generation queue |
||
| 240 | * and then persists to storage. |
||
| 241 | * |
||
| 242 | * @param EE_Message_To_Generate[] $messages_to_generate |
||
| 243 | */ |
||
| 244 | public function batch_queue_for_generation_and_persist( $messages_to_generate ) { |
||
| 245 | $this->_init_queue_and_generator(); |
||
| 246 | $this->_queue_for_generation_loop( $messages_to_generate ); |
||
| 247 | $this->_queue->save(); |
||
| 248 | } |
||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | |||
| 253 | |||
| 254 | |||
| 255 | /** |
||
| 256 | * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the generation |
||
| 257 | * queue. Does NOT persist to storage (unless there is an error. |
||
| 258 | * Client code can retrieve the generated queue by calling EEM_Messages_Processor::get_queue() |
||
| 259 | * |
||
| 260 | * @param EE_Message_To_Generate[] $messages_to_generate |
||
| 261 | */ |
||
| 262 | public function batch_queue_for_generation_no_persist( $messages_to_generate ) { |
||
| 263 | $this->_init_queue_and_generator(); |
||
| 264 | $this->_queue_for_generation_loop( $messages_to_generate ); |
||
| 265 | } |
||
| 266 | |||
| 267 | |||
| 268 | |||
| 269 | |||
| 270 | /** |
||
| 271 | * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message |
||
| 272 | * objects. |
||
| 273 | * |
||
| 274 | * @param EE_Message_To_Generate[] $messages_to_generate |
||
| 275 | */ |
||
| 276 | protected function _queue_for_generation_loop( $messages_to_generate ) { |
||
| 277 | //make sure is in an array. |
||
| 278 | if ( ! is_array( $messages_to_generate ) ) { |
||
| 279 | $messages_to_generate = array( $messages_to_generate ); |
||
| 280 | } |
||
| 281 | |||
| 282 | foreach ( $messages_to_generate as $message_to_generate ) { |
||
| 283 | if ( $message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid() ) { |
||
| 284 | $this->queue_for_generation( $message_to_generate ); |
||
| 285 | } |
||
| 286 | } |
||
| 287 | } |
||
| 288 | |||
| 289 | |||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | /** |
||
| 294 | * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its |
||
| 295 | * queued for sending). |
||
| 296 | * @param EE_Message_To_Generate[] |
||
| 297 | * @return EE_Messages_Queue |
||
| 298 | */ |
||
| 299 | public function generate_and_queue_for_sending( $messages_to_generate ) { |
||
| 300 | $this->_init_queue_and_generator(); |
||
| 301 | $this->_queue_for_generation_loop( $messages_to_generate ); |
||
| 302 | return $this->_generator->generate( true ); |
||
| 303 | } |
||
| 304 | |||
| 305 | |||
| 306 | |||
| 307 | |||
| 308 | |||
| 309 | /** |
||
| 310 | * Generate for preview and execute right away. |
||
| 311 | * |
||
| 312 | * @param EE_Message_To_Generate $message_to_generate |
||
| 313 | * @param bool $test_send Whether this is a test send or not. |
||
| 314 | * @return EE_Messages_Queue | bool false if unable to generate otherwise the generated queue. |
||
| 315 | */ |
||
| 316 | public function generate_for_preview( EE_Message_To_Generate $message_to_generate, $test_send = false ) { |
||
| 342 | |||
| 343 | |||
| 344 | /** |
||
| 345 | * This queues for sending. |
||
| 346 | * The messenger send now method is also verified to see if sending immediately is requested. |
||
| 347 | * otherwise its just saved to the queue. |
||
| 348 | * @param EE_Message_To_Generate $message_to_generate |
||
| 349 | * @return bool true or false for success. |
||
| 350 | */ |
||
| 351 | public function queue_for_sending( EE_Message_To_Generate $message_to_generate ) { |
||
| 352 | if ( ! $message_to_generate->valid() ) { |
||
| 353 | return false; |
||
| 354 | } |
||
| 355 | $this->_init_queue_and_generator(); |
||
| 365 | |||
| 366 | |||
| 367 | /** |
||
| 368 | * This generates and sends from the given EE_Message_To_Generate class immediately. |
||
| 369 | * @param EE_Message_To_Generate $message_to_generate |
||
| 370 | * @return EE_Messages_Queue | null |
||
| 371 | */ |
||
| 372 | public function generate_and_send_now( EE_Message_To_Generate $message_to_generate ) { |
||
| 405 | |||
| 406 | |||
| 407 | |||
| 408 | |||
| 409 | /** |
||
| 410 | * Creates mtg objects for all active messengers and queues for generation. |
||
| 411 | * This method also calls the execute by priority method on the queue which will optionally kick off a new non-blocking |
||
| 412 | * request to complete the action if the priority for the message requires immediate action. |
||
| 413 | * @param string $message_type |
||
| 414 | * @param mixed $data The data being used for generation. |
||
| 415 | * @param bool $persist Whether to persist the queued messages to the db or not. |
||
| 416 | */ |
||
| 417 | public function generate_for_all_active_messengers( $message_type, $data, $persist = true ) { |
||
| 426 | |||
| 427 | |||
| 428 | |||
| 429 | |||
| 430 | /** |
||
| 431 | * This simply loops through all active messengers and takes care of setting up the |
||
| 432 | * EE_Message_To_Generate objects. |
||
| 433 | * @param $message_type |
||
| 434 | * @param $data |
||
| 435 | * |
||
| 436 | * @return EE_Message_To_Generate[] |
||
| 437 | */ |
||
| 438 | public function setup_mtgs_for_all_active_messengers( $message_type, $data ) { |
||
| 448 | |||
| 449 | |||
| 450 | |||
| 451 | |||
| 452 | /** |
||
| 453 | * This accepts an array of EE_Message::MSG_ID values and will use that to retrieve the objects from the database |
||
| 454 | * and send. |
||
| 455 | * @param array $message_ids |
||
| 456 | */ |
||
| 457 | public function setup_messages_from_ids_and_send( $message_ids ) { |
||
| 475 | |||
| 476 | |||
| 477 | |||
| 478 | /** |
||
| 479 | * This method checks for registration IDs in the request via the given key and creates the messages to generate |
||
| 480 | * objects from them, then returns the array of messages to generate objects. |
||
| 481 | * Note, this sets up registrations for the registration family of message types. |
||
| 482 | * |
||
| 483 | * @param string $registration_ids_key This is used to indicate what represents the registration ids in the request. |
||
| 484 | * |
||
| 485 | * @return EE_Message_To_Generate[] |
||
| 486 | */ |
||
| 487 | public function setup_messages_to_generate_from_registration_ids_in_request( $registration_ids_key = '_REG_ID' ) { |
||
| 522 | |||
| 523 | |||
| 524 | |||
| 525 | } //end class EE_Messages_Processor |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.