AyeCode /
invoicing
| Total Complexity | 55 |
| Total Lines | 481 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 0 | Features | 0 |
Complex classes like GetPaid_Invoice_Notification_Emails 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.
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 GetPaid_Invoice_Notification_Emails, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class GetPaid_Invoice_Notification_Emails { |
||
| 14 | |||
| 15 | /** |
||
| 16 | * The array of invoice email actions. |
||
| 17 | * |
||
| 18 | * @param array |
||
| 19 | */ |
||
| 20 | public $invoice_actions; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Class constructor |
||
| 24 | * |
||
| 25 | */ |
||
| 26 | public function __construct() { |
||
| 27 | |||
| 28 | $this->invoice_actions = apply_filters( |
||
| 29 | 'getpaid_notification_email_invoice_triggers', |
||
| 30 | array( |
||
| 31 | 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
||
| 32 | 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
||
| 33 | 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
||
| 34 | 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
||
| 35 | 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
||
| 36 | 'getpaid_invoice_status_publish' => 'completed_invoice', |
||
| 37 | 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
||
| 38 | 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
||
| 39 | 'getpaid_new_customer_note' => 'user_note', |
||
| 40 | 'getpaid_daily_maintenance' => 'overdue', |
||
| 41 | ) |
||
| 42 | ); |
||
| 43 | |||
| 44 | $this->init_hooks(); |
||
| 45 | |||
| 46 | } |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Registers email hooks. |
||
| 50 | */ |
||
| 51 | public function init_hooks() { |
||
| 52 | |||
| 53 | add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
||
| 54 | add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
||
| 55 | |||
| 56 | foreach ( $this->invoice_actions as $hook => $email_type ) { |
||
| 57 | $this->init_email_type_hook( $hook, $email_type ); |
||
| 58 | } |
||
| 59 | } |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Registers an email hook for an invoice action. |
||
| 63 | * |
||
| 64 | * @param string $hook |
||
| 65 | * @param string|array $email_type |
||
| 66 | */ |
||
| 67 | public function init_email_type_hook( $hook, $email_type ) { |
||
| 86 | } |
||
| 87 | |||
| 88 | } |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Filters invoice merge tags. |
||
| 92 | * |
||
| 93 | * @param array $merge_tags |
||
| 94 | * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
||
| 95 | */ |
||
| 96 | public function invoice_merge_tags( $merge_tags, $object ) { |
||
| 113 | |||
| 114 | } |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Generates invoice merge tags. |
||
| 118 | * |
||
| 119 | * @param WPInv_Invoice $invoice |
||
| 120 | * @return array |
||
| 121 | */ |
||
| 122 | public function get_invoice_merge_tags( $invoice ) { |
||
| 168 | } |
||
| 169 | |||
| 170 | /** |
||
| 171 | * Helper function to send an email. |
||
| 172 | * |
||
| 173 | * @param WPInv_Invoice $invoice |
||
| 174 | * @param GetPaid_Notification_Email $email |
||
| 175 | * @param string $type |
||
| 176 | * @param string|array $recipients |
||
| 177 | * @param array $extra_args Extra template args. |
||
| 178 | */ |
||
| 179 | public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
||
| 180 | |||
| 181 | do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
||
| 182 | |||
| 183 | $skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' ); |
||
| 184 | if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) { |
||
| 185 | return; |
||
| 186 | } |
||
| 187 | |||
| 188 | $mailer = new GetPaid_Notification_Email_Sender(); |
||
| 189 | $merge_tags = $email->get_merge_tags(); |
||
| 190 | |||
| 191 | $result = $mailer->send( |
||
| 192 | apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
||
| 193 | $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
||
| 194 | $email->get_content( $merge_tags, $extra_args ), |
||
| 195 | $email->get_attachments() |
||
| 196 | ); |
||
| 197 | |||
| 198 | // Maybe send a copy to the admin. |
||
| 199 | if ( $email->include_admin_bcc() ) { |
||
| 200 | $mailer->send( |
||
| 201 | wpinv_get_admin_email(), |
||
|
Bug
introduced
by
|
|||
| 202 | $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
||
| 203 | $email->get_content( $merge_tags ), |
||
| 204 | $email->get_attachments() |
||
| 205 | ); |
||
| 206 | } |
||
| 207 | |||
| 208 | if ( $result ) { |
||
| 209 | $invoice->add_system_note( |
||
| 210 | sprintf( |
||
| 211 | __( 'Successfully sent %s notification email to %s.', 'invoicing' ), |
||
| 212 | sanitize_key( $type ), |
||
| 213 | $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' ) |
||
| 214 | ) |
||
| 215 | ); |
||
| 216 | } else { |
||
| 217 | $invoice->add_system_note( |
||
| 218 | sprintf( |
||
| 219 | __( 'Failed sending %s notification email to %s.', 'invoicing' ), |
||
| 220 | sanitize_key( $type ), |
||
| 221 | $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' ) |
||
| 222 | ) |
||
| 223 | ); |
||
| 224 | } |
||
| 225 | |||
| 226 | do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
||
| 227 | |||
| 228 | return $result; |
||
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Also send emails to any cc users. |
||
| 233 | * |
||
| 234 | * @param array $recipients |
||
| 235 | * @param GetPaid_Notification_Email $email |
||
| 236 | */ |
||
| 237 | public function filter_email_recipients( $recipients, $email ) { |
||
| 238 | |||
| 239 | if ( ! $email->is_admin_email() ) { |
||
| 240 | $cc = $email->object->get_email_cc(); |
||
| 241 | |||
| 242 | if ( ! empty( $cc ) ) { |
||
| 243 | $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
||
| 244 | $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
||
| 245 | } |
||
| 246 | |||
| 247 | } |
||
| 248 | |||
| 249 | return $recipients; |
||
| 250 | |||
| 251 | } |
||
| 252 | |||
| 253 | /** |
||
| 254 | * Sends a new invoice notification. |
||
| 255 | * |
||
| 256 | * @param WPInv_Invoice $invoice |
||
| 257 | */ |
||
| 258 | public function new_invoice( $invoice ) { |
||
| 259 | |||
| 260 | // Only send this email for invoices created via the admin page. |
||
| 261 | if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
||
| 262 | return; |
||
| 263 | } |
||
| 264 | |||
| 265 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 266 | $recipient = wpinv_get_admin_email(); |
||
| 267 | |||
| 268 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 269 | |||
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Sends a cancelled invoice notification. |
||
| 274 | * |
||
| 275 | * @param WPInv_Invoice $invoice |
||
| 276 | */ |
||
| 277 | public function cancelled_invoice( $invoice ) { |
||
| 278 | |||
| 279 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 280 | $recipient = wpinv_get_admin_email(); |
||
| 281 | |||
| 282 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 283 | |||
| 284 | } |
||
| 285 | |||
| 286 | /** |
||
| 287 | * Sends a failed invoice notification. |
||
| 288 | * |
||
| 289 | * @param WPInv_Invoice $invoice |
||
| 290 | */ |
||
| 291 | public function failed_invoice( $invoice ) { |
||
| 292 | |||
| 293 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 294 | $recipient = wpinv_get_admin_email(); |
||
| 295 | |||
| 296 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 297 | |||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Sends a notification whenever an invoice is put on hold. |
||
| 302 | * |
||
| 303 | * @param WPInv_Invoice $invoice |
||
| 304 | */ |
||
| 305 | public function onhold_invoice( $invoice ) { |
||
| 306 | |||
| 307 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 308 | $recipient = $invoice->get_email(); |
||
| 309 | |||
| 310 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 311 | |||
| 312 | } |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Sends a notification whenever an invoice is marked as processing payment. |
||
| 316 | * |
||
| 317 | * @param WPInv_Invoice $invoice |
||
| 318 | */ |
||
| 319 | public function processing_invoice( $invoice ) { |
||
| 320 | |||
| 321 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 322 | $recipient = $invoice->get_email(); |
||
| 323 | |||
| 324 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 325 | |||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Sends a notification whenever an invoice is paid. |
||
| 330 | * |
||
| 331 | * @param WPInv_Invoice $invoice |
||
| 332 | */ |
||
| 333 | public function completed_invoice( $invoice ) { |
||
| 334 | |||
| 335 | // (Maybe) abort if it is a renewal invoice. |
||
| 336 | if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
||
| 337 | return; |
||
| 338 | } |
||
| 339 | |||
| 340 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 341 | $recipient = $invoice->get_email(); |
||
| 342 | |||
| 343 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 344 | |||
| 345 | } |
||
| 346 | |||
| 347 | /** |
||
| 348 | * Sends a notification whenever an invoice is refunded. |
||
| 349 | * |
||
| 350 | * @param WPInv_Invoice $invoice |
||
| 351 | */ |
||
| 352 | public function refunded_invoice( $invoice ) { |
||
| 353 | |||
| 354 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 355 | $recipient = $invoice->get_email(); |
||
| 356 | |||
| 357 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 358 | |||
| 359 | } |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Notifies a user about new invoices |
||
| 363 | * |
||
| 364 | * @param WPInv_Invoice $invoice |
||
| 365 | * @param bool $force |
||
| 366 | */ |
||
| 367 | public function user_invoice( $invoice, $force = false ) { |
||
| 368 | |||
| 369 | if ( ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) { |
||
| 370 | return; |
||
| 371 | } |
||
| 372 | |||
| 373 | // Only send this email for invoices created via the admin page. |
||
| 374 | if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) { |
||
| 375 | return; |
||
| 376 | } |
||
| 377 | |||
| 378 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 379 | $recipient = $invoice->get_email(); |
||
| 380 | |||
| 381 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
||
| 382 | |||
| 383 | } |
||
| 384 | |||
| 385 | /** |
||
| 386 | * Checks if an invoice is a payment form invoice. |
||
| 387 | * |
||
| 388 | * @param int $invoice |
||
| 389 | * @return bool |
||
| 390 | */ |
||
| 391 | public function is_payment_form_invoice( $invoice ) { |
||
| 392 | $is_payment_form_invoice = empty( $_GET['getpaid-admin-action'] ) && ( 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ) || 'geodirectory' == get_post_meta( $invoice, 'wpinv_created_via', true ) ); |
||
| 393 | return apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice ); |
||
| 394 | } |
||
| 395 | |||
| 396 | /** |
||
| 397 | * Notifies admin about new invoice notes |
||
| 398 | * |
||
| 399 | * @param WPInv_Invoice $invoice |
||
| 400 | * @param string $note |
||
| 401 | */ |
||
| 402 | public function user_note( $invoice, $note ) { |
||
| 403 | |||
| 404 | $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
||
| 405 | $recipient = $invoice->get_email(); |
||
| 406 | |||
| 407 | return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
||
| 408 | |||
| 409 | } |
||
| 410 | |||
| 411 | /** |
||
| 412 | * (Force) Sends overdue notices. |
||
| 413 | * |
||
| 414 | * @param WPInv_Invoice $invoice |
||
| 415 | */ |
||
| 416 | public function force_send_overdue_notice( $invoice ) { |
||
| 419 | } |
||
| 420 | |||
| 421 | /** |
||
| 422 | * Sends overdue notices. |
||
| 423 | * |
||
| 424 | * @TODO: Create an invoices query class. |
||
| 425 | */ |
||
| 426 | public function overdue() { |
||
| 460 | } |
||
| 461 | |||
| 462 | } |
||
| 463 | |||
| 464 | } |
||
| 465 | |||
| 466 | } |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Calculates the date query for an invoices query |
||
| 470 | * |
||
| 471 | * @param array $reminder_days |
||
| 472 | * @return string |
||
| 473 | */ |
||
| 474 | public function get_date_query( $reminder_days ) { |
||
| 498 |
Loading history...