AyeCode /
invoicing
@@ -1,7 +1,8 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | // don't load directly |
| 3 | -if ( !defined('ABSPATH') ) |
|
| 3 | +if ( !defined('ABSPATH') ) { |
|
| 4 | 4 | die('-1'); |
| 5 | +} |
|
| 5 | 6 | |
| 6 | 7 | if ( !isset( $email_heading ) ) { |
| 7 | 8 | global $email_heading; |
@@ -1,19 +1,19 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | // don't load directly |
| 3 | -if ( !defined('ABSPATH') ) |
|
| 3 | +if (!defined('ABSPATH')) |
|
| 4 | 4 | die('-1'); |
| 5 | 5 | |
| 6 | -if ( !isset( $email_heading ) ) { |
|
| 6 | +if (!isset($email_heading)) { |
|
| 7 | 7 | global $email_heading; |
| 8 | 8 | } |
| 9 | 9 | ?> |
| 10 | 10 | <!DOCTYPE html> |
| 11 | 11 | <html dir="<?php echo is_rtl() ? 'rtl' : 'ltr'?>"> |
| 12 | 12 | <head> |
| 13 | - <meta http-equiv="Content-Type" content="text/html; charset=<?php bloginfo( 'charset' ); ?>" /> |
|
| 13 | + <meta http-equiv="Content-Type" content="text/html; charset=<?php bloginfo('charset'); ?>" /> |
|
| 14 | 14 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
| 15 | 15 | <meta name="robots" content="noindex,nofollow"> |
| 16 | - <title><?php echo esc_html( wpinv_get_blogname() ); ?></title> |
|
| 16 | + <title><?php echo esc_html(wpinv_get_blogname()); ?></title> |
|
| 17 | 17 | </head> |
| 18 | 18 | <body <?php echo is_rtl() ? 'rightmargin' : 'leftmargin'; ?>="0" marginwidth="0" topmargin="0" marginheight="0" offset="0"> |
| 19 | 19 | <div id="wrapper" dir="<?php echo is_rtl() ? 'rtl' : 'ltr'?>"> |
@@ -22,20 +22,20 @@ discard block |
||
| 22 | 22 | <td align="center" valign="top"> |
| 23 | 23 | <div id="template_header_image"> |
| 24 | 24 | <?php |
| 25 | - if ( $img = wpinv_get_option( 'email_header_image', '' ) ) { |
|
| 26 | - echo '<p style="margin-top:0;"><img style="max-width:100%" src="' . esc_url( $img ) . '" alt="' . esc_attr( wpinv_get_blogname() ) . '" /></p>'; |
|
| 25 | + if ($img = wpinv_get_option('email_header_image', '')) { |
|
| 26 | + echo '<p style="margin-top:0;"><img style="max-width:100%" src="' . esc_url($img) . '" alt="' . esc_attr(wpinv_get_blogname()) . '" /></p>'; |
|
| 27 | 27 | } |
| 28 | 28 | ?> |
| 29 | 29 | </div> |
| 30 | 30 | <table border="0" cellpadding="0" cellspacing="0" width="100%" id="template_container"> |
| 31 | - <?php if ( !empty( $email_heading ) ) { ?> |
|
| 31 | + <?php if (!empty($email_heading)) { ?> |
|
| 32 | 32 | <tr> |
| 33 | 33 | <td align="center" valign="top"> |
| 34 | 34 | <!-- Header --> |
| 35 | 35 | <table border="0" cellpadding="0" cellspacing="0" width="100%" id="template_header"> |
| 36 | 36 | <tr> |
| 37 | 37 | <td id="header_wrapper"> |
| 38 | - <h1><?php echo esc_html( $email_heading ); ?></h1> |
|
| 38 | + <h1><?php echo esc_html($email_heading); ?></h1> |
|
| 39 | 39 | </td> |
| 40 | 40 | </tr> |
| 41 | 41 | </table> |
@@ -1,7 +1,8 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | // don't load directly |
| 3 | -if ( !defined('ABSPATH') ) |
|
| 3 | +if ( !defined('ABSPATH') ) { |
|
| 4 | 4 | die('-1'); |
| 5 | +} |
|
| 5 | 6 | |
| 6 | 7 | do_action( 'wpinv_email_before_billing_details', $invoice ); ?> |
| 7 | 8 | <div id="wpinv-email-billing"> |
@@ -1,41 +1,41 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | // don't load directly |
| 3 | -if ( !defined('ABSPATH') ) |
|
| 3 | +if (!defined('ABSPATH')) |
|
| 4 | 4 | die('-1'); |
| 5 | 5 | |
| 6 | -do_action( 'wpinv_email_before_billing_details', $invoice ); ?> |
|
| 6 | +do_action('wpinv_email_before_billing_details', $invoice); ?> |
|
| 7 | 7 | <div id="wpinv-email-billing"> |
| 8 | - <h3 class="wpinv-address-t"><?php echo apply_filters( 'wpinv_email_billing_title', __( 'Billing Details', 'invoicing' ) ); ?></h3> |
|
| 8 | + <h3 class="wpinv-address-t"><?php echo apply_filters('wpinv_email_billing_title', __('Billing Details', 'invoicing')); ?></h3> |
|
| 9 | 9 | |
| 10 | 10 | <table class="table table-bordered table-sm wpi-billing-details"> |
| 11 | 11 | <tbody> |
| 12 | - <?php do_action( 'wpinv_email_billing_fields_first', $invoice ); ?> |
|
| 12 | + <?php do_action('wpinv_email_billing_fields_first', $invoice); ?> |
|
| 13 | 13 | <tr class="wpi-receipt-name"> |
| 14 | - <th class="text-left"><?php _e( 'Name', 'invoicing' ); ?></th> |
|
| 15 | - <td><?php if ( $sent_to_admin && $invoice->get_user_id() ) { ?><a href="<?php echo esc_url( add_query_arg( 'user_id', $invoice->get_user_id(), self_admin_url( 'user-edit.php' ) ) ) ;?>"><?php echo esc_html( $invoice->get_user_full_name() ); ?></a><?php } else { echo esc_html( $invoice->get_user_full_name() ); } ?></td> |
|
| 14 | + <th class="text-left"><?php _e('Name', 'invoicing'); ?></th> |
|
| 15 | + <td><?php if ($sent_to_admin && $invoice->get_user_id()) { ?><a href="<?php echo esc_url(add_query_arg('user_id', $invoice->get_user_id(), self_admin_url('user-edit.php'))); ?>"><?php echo esc_html($invoice->get_user_full_name()); ?></a><?php } else { echo esc_html($invoice->get_user_full_name()); } ?></td> |
|
| 16 | 16 | </tr> |
| 17 | 17 | <tr class="wpi-receipt-email"> |
| 18 | - <th class="text-left"><?php _e( 'Email', 'invoicing' ); ?></th> |
|
| 19 | - <td><?php echo sanitize_email( $invoice->get_email() ) ;?></td> |
|
| 18 | + <th class="text-left"><?php _e('Email', 'invoicing'); ?></th> |
|
| 19 | + <td><?php echo sanitize_email($invoice->get_email()); ?></td> |
|
| 20 | 20 | </tr> |
| 21 | - <?php if ( $invoice->get_company() ) { ?> |
|
| 21 | + <?php if ($invoice->get_company()) { ?> |
|
| 22 | 22 | <tr class="wpi-receipt-company"> |
| 23 | - <th class="text-left"><?php _e( 'Company', 'invoicing' ); ?></th> |
|
| 24 | - <td><?php echo esc_html( $invoice->get_company() ) ;?></td> |
|
| 23 | + <th class="text-left"><?php _e('Company', 'invoicing'); ?></th> |
|
| 24 | + <td><?php echo esc_html($invoice->get_company()); ?></td> |
|
| 25 | 25 | </tr> |
| 26 | 26 | <?php } ?> |
| 27 | 27 | <tr class="wpi-receipt-address"> |
| 28 | - <th class="text-left"><?php _e( 'Address', 'invoicing' ); ?></th> |
|
| 29 | - <td><?php echo wp_kses_post( wpinv_get_invoice_address_markup( $invoice->get_user_info() ) ) ;?></td> |
|
| 28 | + <th class="text-left"><?php _e('Address', 'invoicing'); ?></th> |
|
| 29 | + <td><?php echo wp_kses_post(wpinv_get_invoice_address_markup($invoice->get_user_info())); ?></td> |
|
| 30 | 30 | </tr> |
| 31 | - <?php if ( $invoice->get_phone() ) { ?> |
|
| 31 | + <?php if ($invoice->get_phone()) { ?> |
|
| 32 | 32 | <tr class="wpi-receipt-phone"> |
| 33 | - <th class="text-left"><?php _e( 'Phone', 'invoicing' ); ?></th> |
|
| 34 | - <td><?php echo esc_html( $invoice->get_phone() ) ;?></td> |
|
| 33 | + <th class="text-left"><?php _e('Phone', 'invoicing'); ?></th> |
|
| 34 | + <td><?php echo esc_html($invoice->get_phone()); ?></td> |
|
| 35 | 35 | </tr> |
| 36 | 36 | <?php } ?> |
| 37 | - <?php do_action( 'wpinv_email_billing_fields_last', $invoice ); ?> |
|
| 37 | + <?php do_action('wpinv_email_billing_fields_last', $invoice); ?> |
|
| 38 | 38 | </tbody> |
| 39 | 39 | </table> |
| 40 | 40 | </div> |
| 41 | -<?php do_action( 'wpinv_email_after_billing_details', $invoice ); ?> |
|
| 42 | 41 | \ No newline at end of file |
| 42 | +<?php do_action('wpinv_email_after_billing_details', $invoice); ?> |
|
| 43 | 43 | \ No newline at end of file |
@@ -310,7 +310,7 @@ discard block |
||
| 310 | 310 | if ( !wpinv_is_gateway_active( $enabled_gateway ) && !empty( $gateways ) ) { |
| 311 | 311 | if(wpinv_is_gateway_active( wpinv_get_default_gateway()) ){ |
| 312 | 312 | $enabled_gateway = wpinv_get_default_gateway(); |
| 313 | - }else{ |
|
| 313 | + } else{ |
|
| 314 | 314 | $enabled_gateway = $gateways[0]; |
| 315 | 315 | } |
| 316 | 316 | |
@@ -336,8 +336,9 @@ discard block |
||
| 336 | 336 | |
| 337 | 337 | $payments = new WP_Query( $args ); |
| 338 | 338 | |
| 339 | - if( $payments ) |
|
| 340 | - $ret = $payments->post_count; |
|
| 339 | + if( $payments ) { |
|
| 340 | + $ret = $payments->post_count; |
|
| 341 | + } |
|
| 341 | 342 | return $ret; |
| 342 | 343 | } |
| 343 | 344 | |
@@ -276,26 +276,26 @@ discard block |
||
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | function wpinv_get_chosen_gateway( $invoice_id = 0 ) { |
| 279 | - $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
| 279 | + $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
| 280 | 280 | |
| 281 | 281 | $chosen = false; |
| 282 | 282 | if ( $invoice_id > 0 && $invoice = wpinv_get_invoice( $invoice_id ) ) { |
| 283 | 283 | $chosen = $invoice->get_gateway(); |
| 284 | 284 | } |
| 285 | 285 | |
| 286 | - $chosen = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen; |
|
| 286 | + $chosen = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen; |
|
| 287 | 287 | |
| 288 | - if ( false !== $chosen ) { |
|
| 289 | - $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen ); |
|
| 290 | - } |
|
| 288 | + if ( false !== $chosen ) { |
|
| 289 | + $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen ); |
|
| 290 | + } |
|
| 291 | 291 | |
| 292 | - if ( ! empty ( $chosen ) ) { |
|
| 293 | - $enabled_gateway = urldecode( $chosen ); |
|
| 294 | - } else if ( !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) { |
|
| 295 | - $enabled_gateway = 'manual'; |
|
| 296 | - } else { |
|
| 297 | - $enabled_gateway = wpinv_get_default_gateway(); |
|
| 298 | - } |
|
| 292 | + if ( ! empty ( $chosen ) ) { |
|
| 293 | + $enabled_gateway = urldecode( $chosen ); |
|
| 294 | + } else if ( !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) { |
|
| 295 | + $enabled_gateway = 'manual'; |
|
| 296 | + } else { |
|
| 297 | + $enabled_gateway = wpinv_get_default_gateway(); |
|
| 298 | + } |
|
| 299 | 299 | |
| 300 | 300 | if ( !wpinv_is_gateway_active( $enabled_gateway ) && !empty( $gateways ) ) { |
| 301 | 301 | if(wpinv_is_gateway_active( wpinv_get_default_gateway()) ){ |
@@ -306,7 +306,7 @@ discard block |
||
| 306 | 306 | |
| 307 | 307 | } |
| 308 | 308 | |
| 309 | - return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway ); |
|
| 309 | + return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway ); |
|
| 310 | 310 | } |
| 311 | 311 | |
| 312 | 312 | function wpinv_record_gateway_error( $title = '', $message = '' ) { |
@@ -314,21 +314,21 @@ discard block |
||
| 314 | 314 | } |
| 315 | 315 | |
| 316 | 316 | function wpinv_count_sales_by_gateway( $gateway_id = 'paypal', $status = 'publish' ) { |
| 317 | - $ret = 0; |
|
| 318 | - $args = array( |
|
| 319 | - 'meta_key' => '_wpinv_gateway', |
|
| 320 | - 'meta_value' => $gateway_id, |
|
| 321 | - 'nopaging' => true, |
|
| 322 | - 'post_type' => 'wpi_invoice', |
|
| 323 | - 'post_status' => $status, |
|
| 324 | - 'fields' => 'ids' |
|
| 325 | - ); |
|
| 326 | - |
|
| 327 | - $payments = new WP_Query( $args ); |
|
| 328 | - |
|
| 329 | - if( $payments ) |
|
| 330 | - $ret = $payments->post_count; |
|
| 331 | - return $ret; |
|
| 317 | + $ret = 0; |
|
| 318 | + $args = array( |
|
| 319 | + 'meta_key' => '_wpinv_gateway', |
|
| 320 | + 'meta_value' => $gateway_id, |
|
| 321 | + 'nopaging' => true, |
|
| 322 | + 'post_type' => 'wpi_invoice', |
|
| 323 | + 'post_status' => $status, |
|
| 324 | + 'fields' => 'ids' |
|
| 325 | + ); |
|
| 326 | + |
|
| 327 | + $payments = new WP_Query( $args ); |
|
| 328 | + |
|
| 329 | + if( $payments ) |
|
| 330 | + $ret = $payments->post_count; |
|
| 331 | + return $ret; |
|
| 332 | 332 | } |
| 333 | 333 | |
| 334 | 334 | /** |
@@ -3,7 +3,7 @@ discard block |
||
| 3 | 3 | * Contains gateway functions. |
| 4 | 4 | * |
| 5 | 5 | */ |
| 6 | -defined( 'ABSPATH' ) || exit; |
|
| 6 | +defined('ABSPATH') || exit; |
|
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | 9 | * Returns an array of payment gateways. |
@@ -11,30 +11,30 @@ discard block |
||
| 11 | 11 | * @return array |
| 12 | 12 | */ |
| 13 | 13 | function wpinv_get_payment_gateways() { |
| 14 | - return apply_filters( 'wpinv_payment_gateways', array() ); |
|
| 14 | + return apply_filters('wpinv_payment_gateways', array()); |
|
| 15 | 15 | } |
| 16 | 16 | |
| 17 | -function wpinv_payment_gateway_titles( $all_gateways ) { |
|
| 17 | +function wpinv_payment_gateway_titles($all_gateways) { |
|
| 18 | 18 | |
| 19 | 19 | $options = wpinv_get_options(); |
| 20 | 20 | $gateways = array(); |
| 21 | - foreach ( $all_gateways as $key => $gateway ) { |
|
| 22 | - if ( !empty( $options[$key . '_title'] ) ) { |
|
| 23 | - $all_gateways[$key]['checkout_label'] = __( $options[$key . '_title'], 'invoicing' ); |
|
| 21 | + foreach ($all_gateways as $key => $gateway) { |
|
| 22 | + if (!empty($options[$key . '_title'])) { |
|
| 23 | + $all_gateways[$key]['checkout_label'] = __($options[$key . '_title'], 'invoicing'); |
|
| 24 | 24 | } |
| 25 | 25 | |
| 26 | - $gateways[$key] = isset( $options[$key . '_ordering'] ) ? $options[$key . '_ordering'] : ( isset( $gateway['ordering'] ) ? $gateway['ordering'] : '' ); |
|
| 26 | + $gateways[$key] = isset($options[$key . '_ordering']) ? $options[$key . '_ordering'] : (isset($gateway['ordering']) ? $gateway['ordering'] : ''); |
|
| 27 | 27 | } |
| 28 | 28 | |
| 29 | - asort( $gateways ); |
|
| 29 | + asort($gateways); |
|
| 30 | 30 | |
| 31 | - foreach ( $gateways as $gateway => $key ) { |
|
| 31 | + foreach ($gateways as $gateway => $key) { |
|
| 32 | 32 | $gateways[$gateway] = $all_gateways[$gateway]; |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | 35 | return $gateways; |
| 36 | 36 | } |
| 37 | -add_filter( 'wpinv_payment_gateways', 'wpinv_payment_gateway_titles', 1000, 1 ); |
|
| 37 | +add_filter('wpinv_payment_gateways', 'wpinv_payment_gateway_titles', 1000, 1); |
|
| 38 | 38 | |
| 39 | 39 | /** |
| 40 | 40 | * Returns an array of enabled gateways. |
@@ -42,38 +42,38 @@ discard block |
||
| 42 | 42 | * @param bool $sort |
| 43 | 43 | * @return array |
| 44 | 44 | */ |
| 45 | -function wpinv_get_enabled_payment_gateways( $sort = false ) { |
|
| 45 | +function wpinv_get_enabled_payment_gateways($sort = false) { |
|
| 46 | 46 | |
| 47 | 47 | $enabled = array(); |
| 48 | 48 | |
| 49 | - foreach ( wpinv_get_payment_gateways() as $gateway => $data ) { |
|
| 49 | + foreach (wpinv_get_payment_gateways() as $gateway => $data) { |
|
| 50 | 50 | |
| 51 | - if ( (int) wpinv_get_option( "{$gateway}_active", $gateway === 'manual' ) === 1 ) { |
|
| 52 | - $enabled[ $gateway ] = $data; |
|
| 51 | + if ((int) wpinv_get_option("{$gateway}_active", $gateway === 'manual') === 1) { |
|
| 52 | + $enabled[$gateway] = $data; |
|
| 53 | 53 | } |
| 54 | 54 | |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - if ( true === $sort ) { |
|
| 58 | - uasort( $enabled, 'wpinv_sort_gateway_order' ); |
|
| 57 | + if (true === $sort) { |
|
| 58 | + uasort($enabled, 'wpinv_sort_gateway_order'); |
|
| 59 | 59 | |
| 60 | 60 | // Reorder our gateways so the default is first |
| 61 | 61 | $default_gateway_id = wpinv_get_default_gateway(); |
| 62 | - if ( isset( $enabled[ $default_gateway_id ] ) ) { |
|
| 62 | + if (isset($enabled[$default_gateway_id])) { |
|
| 63 | 63 | $default_gateway = array( |
| 64 | - $default_gateway_id => $enabled[ $default_gateway_id ] |
|
| 64 | + $default_gateway_id => $enabled[$default_gateway_id] |
|
| 65 | 65 | ); |
| 66 | 66 | |
| 67 | - unset( $enabled[ $default_gateway_id ] ); |
|
| 68 | - $enabled = array_merge( $default_gateway, $enabled ); |
|
| 67 | + unset($enabled[$default_gateway_id]); |
|
| 68 | + $enabled = array_merge($default_gateway, $enabled); |
|
| 69 | 69 | } |
| 70 | 70 | |
| 71 | 71 | } |
| 72 | 72 | |
| 73 | - return apply_filters( 'wpinv_enabled_payment_gateways', $enabled ); |
|
| 73 | + return apply_filters('wpinv_enabled_payment_gateways', $enabled); |
|
| 74 | 74 | } |
| 75 | 75 | |
| 76 | -function wpinv_sort_gateway_order( $a, $b ) { |
|
| 76 | +function wpinv_sort_gateway_order($a, $b) { |
|
| 77 | 77 | return $a['ordering'] - $b['ordering']; |
| 78 | 78 | } |
| 79 | 79 | |
@@ -83,9 +83,9 @@ discard block |
||
| 83 | 83 | * @param string $gateway |
| 84 | 84 | * @return bool |
| 85 | 85 | */ |
| 86 | -function wpinv_is_gateway_active( $gateway ) { |
|
| 87 | - $is_active = (int) wpinv_get_option( "{$gateway}_active", $gateway === 'manual' ) === 1 ; |
|
| 88 | - return apply_filters( 'wpinv_is_gateway_active', $is_active, $gateway ); |
|
| 86 | +function wpinv_is_gateway_active($gateway) { |
|
| 87 | + $is_active = (int) wpinv_get_option("{$gateway}_active", $gateway === 'manual') === 1; |
|
| 88 | + return apply_filters('wpinv_is_gateway_active', $is_active, $gateway); |
|
| 89 | 89 | } |
| 90 | 90 | |
| 91 | 91 | /** |
@@ -94,11 +94,11 @@ discard block |
||
| 94 | 94 | * @return string|false |
| 95 | 95 | */ |
| 96 | 96 | function wpinv_get_default_gateway() { |
| 97 | - $default = wpinv_get_option( 'default_gateway' ); |
|
| 97 | + $default = wpinv_get_option('default_gateway'); |
|
| 98 | 98 | $gateways = wpinv_get_enabled_payment_gateways(); |
| 99 | - $default = ! empty( $default ) && isset( $gateways[ $default ] ) ? $default : false; |
|
| 99 | + $default = !empty($default) && isset($gateways[$default]) ? $default : false; |
|
| 100 | 100 | |
| 101 | - return apply_filters( 'wpinv_default_gateway', $default ); |
|
| 101 | + return apply_filters('wpinv_default_gateway', $default); |
|
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | /** |
@@ -107,17 +107,17 @@ discard block |
||
| 107 | 107 | * @param string $gateway The gateway to key. |
| 108 | 108 | * @return string |
| 109 | 109 | */ |
| 110 | -function wpinv_get_gateway_admin_label( $gateway ) { |
|
| 110 | +function wpinv_get_gateway_admin_label($gateway) { |
|
| 111 | 111 | |
| 112 | - if ( empty( $gateway ) || 'none' == $gateway ) { |
|
| 113 | - return esc_html__( 'No Gateway', 'invoicing' ); |
|
| 112 | + if (empty($gateway) || 'none' == $gateway) { |
|
| 113 | + return esc_html__('No Gateway', 'invoicing'); |
|
| 114 | 114 | } |
| 115 | 115 | |
| 116 | 116 | $gateways = wpinv_get_payment_gateways(); |
| 117 | - $label = isset( $gateways[ $gateway ] ) ? $gateways[ $gateway ]['admin_label'] : $gateway; |
|
| 118 | - $gateway = apply_filters( 'wpinv_gateway_admin_label', $label, $gateway ); |
|
| 117 | + $label = isset($gateways[$gateway]) ? $gateways[$gateway]['admin_label'] : $gateway; |
|
| 118 | + $gateway = apply_filters('wpinv_gateway_admin_label', $label, $gateway); |
|
| 119 | 119 | |
| 120 | - return wpinv_clean( $gateway ); |
|
| 120 | + return wpinv_clean($gateway); |
|
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | /** |
@@ -125,48 +125,48 @@ discard block |
||
| 125 | 125 | * |
| 126 | 126 | * @param string $gateway |
| 127 | 127 | */ |
| 128 | -function wpinv_get_gateway_description( $gateway ) { |
|
| 128 | +function wpinv_get_gateway_description($gateway) { |
|
| 129 | 129 | |
| 130 | 130 | $options = wpinv_get_options(); |
| 131 | - $description = ! empty( $options[$gateway . '_desc'] ) ? $options[$gateway . '_desc'] : ''; |
|
| 131 | + $description = !empty($options[$gateway . '_desc']) ? $options[$gateway . '_desc'] : ''; |
|
| 132 | 132 | |
| 133 | - return apply_filters( 'wpinv_gateway_description', $description, $gateway ); |
|
| 133 | + return apply_filters('wpinv_gateway_description', $description, $gateway); |
|
| 134 | 134 | } |
| 135 | 135 | |
| 136 | -function wpinv_get_gateway_button_label( $gateway ) { |
|
| 137 | - return apply_filters( 'wpinv_gateway_' . $gateway . '_button_label', '' ); |
|
| 136 | +function wpinv_get_gateway_button_label($gateway) { |
|
| 137 | + return apply_filters('wpinv_gateway_' . $gateway . '_button_label', ''); |
|
| 138 | 138 | } |
| 139 | 139 | |
| 140 | -function wpinv_get_gateway_checkout_label( $gateway ) { |
|
| 140 | +function wpinv_get_gateway_checkout_label($gateway) { |
|
| 141 | 141 | $gateways = wpinv_get_payment_gateways(); |
| 142 | - $label = isset( $gateways[ $gateway ] ) ? $gateways[ $gateway ]['checkout_label'] : $gateway; |
|
| 142 | + $label = isset($gateways[$gateway]) ? $gateways[$gateway]['checkout_label'] : $gateway; |
|
| 143 | 143 | |
| 144 | - if ( $gateway == 'none' ) { |
|
| 145 | - $label = __( 'None', 'invoicing' ); |
|
| 144 | + if ($gateway == 'none') { |
|
| 145 | + $label = __('None', 'invoicing'); |
|
| 146 | 146 | } |
| 147 | 147 | |
| 148 | - return apply_filters( 'wpinv_gateway_checkout_label', ucfirst( $label ), $gateway ); |
|
| 148 | + return apply_filters('wpinv_gateway_checkout_label', ucfirst($label), $gateway); |
|
| 149 | 149 | } |
| 150 | 150 | |
| 151 | -function wpinv_settings_sections_gateways( $settings ) { |
|
| 151 | +function wpinv_settings_sections_gateways($settings) { |
|
| 152 | 152 | $gateways = wpinv_get_payment_gateways(); |
| 153 | - ksort( $gateways ); |
|
| 153 | + ksort($gateways); |
|
| 154 | 154 | |
| 155 | - foreach ( $gateways as $key => $gateway ) { |
|
| 156 | - $settings[ $key ] = $gateway['admin_label']; |
|
| 155 | + foreach ($gateways as $key => $gateway) { |
|
| 156 | + $settings[$key] = $gateway['admin_label']; |
|
| 157 | 157 | } |
| 158 | 158 | |
| 159 | 159 | return $settings; |
| 160 | 160 | } |
| 161 | -add_filter( 'wpinv_settings_sections_gateways', 'wpinv_settings_sections_gateways', 10, 1 ); |
|
| 161 | +add_filter('wpinv_settings_sections_gateways', 'wpinv_settings_sections_gateways', 10, 1); |
|
| 162 | 162 | |
| 163 | 163 | /** |
| 164 | 164 | * Adds GateWay settings. |
| 165 | 165 | */ |
| 166 | -function wpinv_settings_gateways( $settings ) { |
|
| 166 | +function wpinv_settings_gateways($settings) { |
|
| 167 | 167 | |
| 168 | 168 | // Loop through each gateway. |
| 169 | - foreach ( wpinv_get_payment_gateways() as $key => $gateway ) { |
|
| 169 | + foreach (wpinv_get_payment_gateways() as $key => $gateway) { |
|
| 170 | 170 | |
| 171 | 171 | $gateway_settings = array( |
| 172 | 172 | |
@@ -174,7 +174,7 @@ discard block |
||
| 174 | 174 | "{$key}_header" => array( |
| 175 | 175 | |
| 176 | 176 | 'id' => "{$key}_gateway_header", |
| 177 | - 'name' => '<h3>' . wp_sprintf( __( '%s Settings', 'invoicing' ), $gateway['admin_label'] ) . '</h3>', |
|
| 177 | + 'name' => '<h3>' . wp_sprintf(__('%s Settings', 'invoicing'), $gateway['admin_label']) . '</h3>', |
|
| 178 | 178 | 'custom' => $key, |
| 179 | 179 | 'type' => 'gateway_header', |
| 180 | 180 | |
@@ -183,8 +183,8 @@ discard block |
||
| 183 | 183 | // Activate/Deactivate a gateway. |
| 184 | 184 | "{$key}_active" => array( |
| 185 | 185 | 'id' => $key . '_active', |
| 186 | - 'name' => __( 'Activate', 'invoicing' ), |
|
| 187 | - 'desc' => wp_sprintf( __( 'Enable %s', 'invoicing' ), $gateway['admin_label'] ), |
|
| 186 | + 'name' => __('Activate', 'invoicing'), |
|
| 187 | + 'desc' => wp_sprintf(__('Enable %s', 'invoicing'), $gateway['admin_label']), |
|
| 188 | 188 | 'type' => 'checkbox', |
| 189 | 189 | 'std' => $key === 'manual' ? '1' : '0', |
| 190 | 190 | ), |
@@ -192,8 +192,8 @@ discard block |
||
| 192 | 192 | // Activate/Deactivate sandbox. |
| 193 | 193 | "{$key}_sandbox" => array( |
| 194 | 194 | 'id' => $key . '_sandbox', |
| 195 | - 'name' => __( 'Sandbox', 'invoicing' ), |
|
| 196 | - 'desc' => __( 'Enable sandbox to test payments', 'invoicing' ), |
|
| 195 | + 'name' => __('Sandbox', 'invoicing'), |
|
| 196 | + 'desc' => __('Enable sandbox to test payments', 'invoicing'), |
|
| 197 | 197 | 'type' => 'checkbox', |
| 198 | 198 | 'std' => '1', |
| 199 | 199 | ), |
@@ -201,40 +201,40 @@ discard block |
||
| 201 | 201 | // Checkout title. |
| 202 | 202 | "{$key}_title" => array( |
| 203 | 203 | 'id' => $key . '_title', |
| 204 | - 'name' => __( 'Checkout Title', 'invoicing' ), |
|
| 205 | - 'std' => isset( $gateway['checkout_label'] ) ? $gateway['checkout_label'] : '', |
|
| 204 | + 'name' => __('Checkout Title', 'invoicing'), |
|
| 205 | + 'std' => isset($gateway['checkout_label']) ? $gateway['checkout_label'] : '', |
|
| 206 | 206 | 'type' => 'text', |
| 207 | 207 | ), |
| 208 | 208 | |
| 209 | 209 | // Checkout description. |
| 210 | 210 | "{$key}_desc" => array( |
| 211 | 211 | 'id' => $key . '_desc', |
| 212 | - 'name' => __( 'Checkout Description', 'invoicing' ), |
|
| 213 | - 'std' => apply_filters( "getpaid_default_{$key}_checkout_description", '' ), |
|
| 212 | + 'name' => __('Checkout Description', 'invoicing'), |
|
| 213 | + 'std' => apply_filters("getpaid_default_{$key}_checkout_description", ''), |
|
| 214 | 214 | 'type' => 'text', |
| 215 | 215 | ), |
| 216 | 216 | |
| 217 | 217 | // Checkout order. |
| 218 | 218 | "{$key}_ordering" => array( |
| 219 | 219 | 'id' => $key . '_ordering', |
| 220 | - 'name' => __( 'Priority', 'invoicing' ), |
|
| 221 | - 'std' => apply_filters( "getpaid_default_{$key}_checkout_description", '' ), |
|
| 220 | + 'name' => __('Priority', 'invoicing'), |
|
| 221 | + 'std' => apply_filters("getpaid_default_{$key}_checkout_description", ''), |
|
| 222 | 222 | 'type' => 'number', |
| 223 | 223 | 'step' => '1', |
| 224 | 224 | 'min' => '0', |
| 225 | 225 | 'max' => '100000', |
| 226 | - 'std' => isset( $gateway['ordering'] ) ? $gateway['ordering'] : '10', |
|
| 226 | + 'std' => isset($gateway['ordering']) ? $gateway['ordering'] : '10', |
|
| 227 | 227 | ), |
| 228 | 228 | |
| 229 | 229 | ); |
| 230 | 230 | |
| 231 | 231 | // Maybe remove the sandbox. |
| 232 | - if ( ! getpaid_payment_gateway_supports( $key, 'sandbox' ) ) { |
|
| 233 | - unset( $gateway_settings["{$key}_sandbox"] ); |
|
| 232 | + if (!getpaid_payment_gateway_supports($key, 'sandbox')) { |
|
| 233 | + unset($gateway_settings["{$key}_sandbox"]); |
|
| 234 | 234 | } |
| 235 | 235 | |
| 236 | - $gateway_settings = apply_filters( 'wpinv_gateway_settings', $gateway_settings, $key, $gateway ); |
|
| 237 | - $gateway_settings = apply_filters( 'wpinv_gateway_settings_' . $key, $gateway_settings, $gateway ); |
|
| 236 | + $gateway_settings = apply_filters('wpinv_gateway_settings', $gateway_settings, $key, $gateway); |
|
| 237 | + $gateway_settings = apply_filters('wpinv_gateway_settings_' . $key, $gateway_settings, $gateway); |
|
| 238 | 238 | |
| 239 | 239 | $settings[$key] = $gateway_settings; |
| 240 | 240 | } |
@@ -242,10 +242,10 @@ discard block |
||
| 242 | 242 | return $settings; |
| 243 | 243 | |
| 244 | 244 | } |
| 245 | -add_filter( 'wpinv_settings_gateways', 'wpinv_settings_gateways', 10, 1 ); |
|
| 245 | +add_filter('wpinv_settings_gateways', 'wpinv_settings_gateways', 10, 1); |
|
| 246 | 246 | |
| 247 | -function wpinv_gateway_header_callback( $args ) { |
|
| 248 | - echo '<input type="hidden" id="wpinv_settings[save_gateway]" name="wpinv_settings[save_gateway]" value="' . esc_attr( $args['custom'] ) . '" />'; |
|
| 247 | +function wpinv_gateway_header_callback($args) { |
|
| 248 | + echo '<input type="hidden" id="wpinv_settings[save_gateway]" name="wpinv_settings[save_gateway]" value="' . esc_attr($args['custom']) . '" />'; |
|
| 249 | 249 | } |
| 250 | 250 | |
| 251 | 251 | /** |
@@ -256,61 +256,61 @@ discard block |
||
| 256 | 256 | * @return bool |
| 257 | 257 | * @since 2.3.0 |
| 258 | 258 | */ |
| 259 | -function getpaid_payment_gateway_supports( $gateway, $feature ) { |
|
| 259 | +function getpaid_payment_gateway_supports($gateway, $feature) { |
|
| 260 | 260 | |
| 261 | 261 | $supports = false; |
| 262 | 262 | |
| 263 | - $supports = apply_filters( "getpaid_{$gateway}_supports_{$feature}", false ); |
|
| 263 | + $supports = apply_filters("getpaid_{$gateway}_supports_{$feature}", false); |
|
| 264 | 264 | |
| 265 | 265 | // Backwards compatibility. |
| 266 | - $supports = apply_filters( "wpinv_{$gateway}_supports_{$feature}", $supports ); |
|
| 267 | - $supports = apply_filters( "wpinv_{$gateway}_support_{$feature}", $supports ); |
|
| 266 | + $supports = apply_filters("wpinv_{$gateway}_supports_{$feature}", $supports); |
|
| 267 | + $supports = apply_filters("wpinv_{$gateway}_support_{$feature}", $supports); |
|
| 268 | 268 | |
| 269 | - $supports = apply_filters( "getpaid_gateway_supports_{$feature}", $supports, $gateway ); |
|
| 270 | - $supports = apply_filters( 'getpaid_payment_gateway_supports', $supports, $feature, $gateway ); |
|
| 269 | + $supports = apply_filters("getpaid_gateway_supports_{$feature}", $supports, $gateway); |
|
| 270 | + $supports = apply_filters('getpaid_payment_gateway_supports', $supports, $feature, $gateway); |
|
| 271 | 271 | |
| 272 | 272 | return $supports; |
| 273 | 273 | } |
| 274 | 274 | |
| 275 | -function wpinv_get_chosen_gateway( $invoice_id = 0 ) { |
|
| 276 | - $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
| 275 | +function wpinv_get_chosen_gateway($invoice_id = 0) { |
|
| 276 | + $gateways = array_keys(wpinv_get_enabled_payment_gateways()); |
|
| 277 | 277 | |
| 278 | 278 | $chosen = false; |
| 279 | - if ( $invoice_id > 0 && $invoice = wpinv_get_invoice( $invoice_id ) ) { |
|
| 279 | + if ($invoice_id > 0 && $invoice = wpinv_get_invoice($invoice_id)) { |
|
| 280 | 280 | $chosen = $invoice->get_gateway(); |
| 281 | 281 | } |
| 282 | 282 | |
| 283 | - $chosen = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen; |
|
| 283 | + $chosen = isset($_REQUEST['payment-mode']) ? sanitize_text_field($_REQUEST['payment-mode']) : $chosen; |
|
| 284 | 284 | |
| 285 | - if ( false !== $chosen ) { |
|
| 286 | - $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen ); |
|
| 285 | + if (false !== $chosen) { |
|
| 286 | + $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen); |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | - if ( ! empty ( $chosen ) ) { |
|
| 290 | - $enabled_gateway = urldecode( $chosen ); |
|
| 291 | - } else if ( !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) { |
|
| 289 | + if (!empty ($chosen)) { |
|
| 290 | + $enabled_gateway = urldecode($chosen); |
|
| 291 | + } else if (!empty($invoice) && (float) $invoice->get_subtotal() <= 0) { |
|
| 292 | 292 | $enabled_gateway = 'manual'; |
| 293 | 293 | } else { |
| 294 | 294 | $enabled_gateway = wpinv_get_default_gateway(); |
| 295 | 295 | } |
| 296 | 296 | |
| 297 | - if ( !wpinv_is_gateway_active( $enabled_gateway ) && !empty( $gateways ) ) { |
|
| 298 | - if(wpinv_is_gateway_active( wpinv_get_default_gateway()) ){ |
|
| 297 | + if (!wpinv_is_gateway_active($enabled_gateway) && !empty($gateways)) { |
|
| 298 | + if (wpinv_is_gateway_active(wpinv_get_default_gateway())) { |
|
| 299 | 299 | $enabled_gateway = wpinv_get_default_gateway(); |
| 300 | - }else{ |
|
| 300 | + } else { |
|
| 301 | 301 | $enabled_gateway = $gateways[0]; |
| 302 | 302 | } |
| 303 | 303 | |
| 304 | 304 | } |
| 305 | 305 | |
| 306 | - return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway ); |
|
| 306 | + return apply_filters('wpinv_chosen_gateway', $enabled_gateway); |
|
| 307 | 307 | } |
| 308 | 308 | |
| 309 | -function wpinv_record_gateway_error( $title = '', $message = '' ) { |
|
| 310 | - return wpinv_error_log( $message, $title ); |
|
| 309 | +function wpinv_record_gateway_error($title = '', $message = '') { |
|
| 310 | + return wpinv_error_log($message, $title); |
|
| 311 | 311 | } |
| 312 | 312 | |
| 313 | -function wpinv_count_sales_by_gateway( $gateway_id = 'paypal', $status = 'publish' ) { |
|
| 313 | +function wpinv_count_sales_by_gateway($gateway_id = 'paypal', $status = 'publish') { |
|
| 314 | 314 | $ret = 0; |
| 315 | 315 | $args = array( |
| 316 | 316 | 'meta_key' => '_wpinv_gateway', |
@@ -321,9 +321,9 @@ discard block |
||
| 321 | 321 | 'fields' => 'ids' |
| 322 | 322 | ); |
| 323 | 323 | |
| 324 | - $payments = new WP_Query( $args ); |
|
| 324 | + $payments = new WP_Query($args); |
|
| 325 | 325 | |
| 326 | - if( $payments ) |
|
| 326 | + if ($payments) |
|
| 327 | 327 | $ret = $payments->post_count; |
| 328 | 328 | return $ret; |
| 329 | 329 | } |
@@ -331,11 +331,11 @@ discard block |
||
| 331 | 331 | /** |
| 332 | 332 | * Displays the ipn url field. |
| 333 | 333 | */ |
| 334 | -function wpinv_ipn_url_callback( $args ) { |
|
| 335 | - $sanitize_id = esc_attr( wpinv_sanitize_key( $args['id'] ) ); |
|
| 334 | +function wpinv_ipn_url_callback($args) { |
|
| 335 | + $sanitize_id = esc_attr(wpinv_sanitize_key($args['id'])); |
|
| 336 | 336 | |
| 337 | - echo '<input class="regular-text" type="text" ' . ( $args['readonly'] ? ' readonly' : '' ) . ' value="' . esc_attr( $args['std'] ) . '" name="wpinv_settings[' . $sanitize_id . ']" id="wpinv_settings[' . $sanitize_id . ']" onClick="this.select()">'; |
|
| 338 | - echo '<label for="wpinv_settings[' . $sanitize_id . ']">' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
| 337 | + echo '<input class="regular-text" type="text" ' . ($args['readonly'] ? ' readonly' : '') . ' value="' . esc_attr($args['std']) . '" name="wpinv_settings[' . $sanitize_id . ']" id="wpinv_settings[' . $sanitize_id . ']" onClick="this.select()">'; |
|
| 338 | + echo '<label for="wpinv_settings[' . $sanitize_id . ']">' . wp_kses_post($args['desc']) . '</label>'; |
|
| 339 | 339 | |
| 340 | 340 | } |
| 341 | 341 | |
@@ -346,10 +346,10 @@ discard block |
||
| 346 | 346 | * |
| 347 | 347 | * @return bool |
| 348 | 348 | */ |
| 349 | -function wpinv_is_test_mode( $gateway = '' ) { |
|
| 350 | - $sandbox = empty( $gateway ) ? false : wpinv_get_option( "{$gateway}_sandbox", true ); |
|
| 351 | - $supports = getpaid_payment_gateway_supports( $gateway, 'sandbox' ); |
|
| 352 | - return apply_filters( 'wpinv_is_test_mode', $sandbox && $supports, $gateway ); |
|
| 349 | +function wpinv_is_test_mode($gateway = '') { |
|
| 350 | + $sandbox = empty($gateway) ? false : wpinv_get_option("{$gateway}_sandbox", true); |
|
| 351 | + $supports = getpaid_payment_gateway_supports($gateway, 'sandbox'); |
|
| 352 | + return apply_filters('wpinv_is_test_mode', $sandbox && $supports, $gateway); |
|
| 353 | 353 | } |
| 354 | 354 | |
| 355 | 355 | /** |
@@ -360,7 +360,7 @@ discard block |
||
| 360 | 360 | * |
| 361 | 361 | * @return string |
| 362 | 362 | */ |
| 363 | -function wpinv_get_ipn_url( $gateway = false, $args = array() ) { |
|
| 363 | +function wpinv_get_ipn_url($gateway = false, $args = array()) { |
|
| 364 | 364 | $args = wp_parse_args( |
| 365 | 365 | array( |
| 366 | 366 | 'wpi-listener' => 'IPN', |
@@ -369,7 +369,7 @@ discard block |
||
| 369 | 369 | $args |
| 370 | 370 | ); |
| 371 | 371 | |
| 372 | - return apply_filters( 'wpinv_ipn_url', add_query_arg( $args, home_url( 'index.php' ) ), $gateway, $args ); |
|
| 372 | + return apply_filters('wpinv_ipn_url', add_query_arg($args, home_url('index.php')), $gateway, $args); |
|
| 373 | 373 | |
| 374 | 374 | } |
| 375 | 375 | |
@@ -380,34 +380,34 @@ discard block |
||
| 380 | 380 | * |
| 381 | 381 | * @return string |
| 382 | 382 | */ |
| 383 | -function getpaid_get_non_query_string_ipn_url( $gateway ) { |
|
| 384 | - $gateway = wpinv_sanitize_key( $gateway ); |
|
| 385 | - return home_url( "getpaid-ipn/$gateway" ); |
|
| 383 | +function getpaid_get_non_query_string_ipn_url($gateway) { |
|
| 384 | + $gateway = wpinv_sanitize_key($gateway); |
|
| 385 | + return home_url("getpaid-ipn/$gateway"); |
|
| 386 | 386 | } |
| 387 | 387 | |
| 388 | 388 | |
| 389 | 389 | /** |
| 390 | 390 | * Retrieves request data with slashes removed slashes. |
| 391 | 391 | */ |
| 392 | -function wpinv_get_post_data( $method = 'request' ) { |
|
| 392 | +function wpinv_get_post_data($method = 'request') { |
|
| 393 | 393 | |
| 394 | - if ( $method == 'post' ) { |
|
| 395 | - return wp_kses_post_deep( wp_unslash( $_POST ) ); |
|
| 394 | + if ($method == 'post') { |
|
| 395 | + return wp_kses_post_deep(wp_unslash($_POST)); |
|
| 396 | 396 | } |
| 397 | 397 | |
| 398 | - if ( $method == 'get' ) { |
|
| 399 | - return wp_kses_post_deep( wp_unslash( $_GET ) ); |
|
| 398 | + if ($method == 'get') { |
|
| 399 | + return wp_kses_post_deep(wp_unslash($_GET)); |
|
| 400 | 400 | } |
| 401 | 401 | |
| 402 | - return wp_kses_post_deep( wp_unslash( $_REQUEST ) ); |
|
| 402 | + return wp_kses_post_deep(wp_unslash($_REQUEST)); |
|
| 403 | 403 | |
| 404 | 404 | } |
| 405 | 405 | |
| 406 | 406 | /** |
| 407 | 407 | * Checks if a given gateway supports subscription payments. |
| 408 | 408 | */ |
| 409 | -function wpinv_gateway_support_subscription( $gateway ) { |
|
| 410 | - return getpaid_payment_gateway_supports( $gateway, 'subscription' ); |
|
| 409 | +function wpinv_gateway_support_subscription($gateway) { |
|
| 410 | + return getpaid_payment_gateway_supports($gateway, 'subscription'); |
|
| 411 | 411 | } |
| 412 | 412 | |
| 413 | 413 | /** |
@@ -416,14 +416,14 @@ discard block |
||
| 416 | 416 | * @param array $gateways an array of gateways. |
| 417 | 417 | * @param GetPaid_Payment_Form $form payment form. |
| 418 | 418 | */ |
| 419 | -function wpinv_payment_gateways_on_cart( $gateways, $form ) { |
|
| 419 | +function wpinv_payment_gateways_on_cart($gateways, $form) { |
|
| 420 | 420 | |
| 421 | - if ( $form->is_recurring() ) { |
|
| 421 | + if ($form->is_recurring()) { |
|
| 422 | 422 | |
| 423 | - foreach ( array_keys( $gateways ) as $gateway ) { |
|
| 423 | + foreach (array_keys($gateways) as $gateway) { |
|
| 424 | 424 | |
| 425 | - if ( ! wpinv_gateway_support_subscription( $gateway ) ) { |
|
| 426 | - unset( $gateways[$gateway] ); |
|
| 425 | + if (!wpinv_gateway_support_subscription($gateway)) { |
|
| 426 | + unset($gateways[$gateway]); |
|
| 427 | 427 | } |
| 428 | 428 | |
| 429 | 429 | } |
@@ -432,4 +432,4 @@ discard block |
||
| 432 | 432 | |
| 433 | 433 | return $gateways; |
| 434 | 434 | } |
| 435 | -add_filter( 'getpaid_payment_form_gateways', 'wpinv_payment_gateways_on_cart', 10, 2 ); |
|
| 435 | +add_filter('getpaid_payment_form_gateways', 'wpinv_payment_gateways_on_cart', 10, 2); |
|
@@ -9,780 +9,780 @@ |
||
| 9 | 9 | * @author Roman Ožana <[email protected]> |
| 10 | 10 | */ |
| 11 | 11 | class Emogrifier { |
| 12 | - /** |
|
| 13 | - * @var string |
|
| 14 | - */ |
|
| 15 | - const ENCODING = 'UTF-8'; |
|
| 16 | - |
|
| 17 | - /** |
|
| 18 | - * @var integer |
|
| 19 | - */ |
|
| 20 | - const CACHE_KEY_CSS = 0; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * @var integer |
|
| 24 | - */ |
|
| 25 | - const CACHE_KEY_SELECTOR = 1; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @var integer |
|
| 29 | - */ |
|
| 30 | - const CACHE_KEY_XPATH = 2; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var integer |
|
| 34 | - */ |
|
| 35 | - const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * for calculating nth-of-type and nth-child selectors. |
|
| 39 | - * |
|
| 40 | - * @var integer |
|
| 41 | - */ |
|
| 42 | - const INDEX = 0; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * for calculating nth-of-type and nth-child selectors. |
|
| 46 | - * |
|
| 47 | - * @var integer |
|
| 48 | - */ |
|
| 49 | - const MULTIPLIER = 1; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 54 | - const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 59 | - const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * @var string |
|
| 63 | - */ |
|
| 64 | - private $html = ''; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @var string |
|
| 68 | - */ |
|
| 69 | - private $css = ''; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @var array<string> |
|
| 73 | - */ |
|
| 74 | - private $unprocessableHtmlTags = array('wbr'); |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * @var array<array> |
|
| 78 | - */ |
|
| 79 | - private $caches = array( |
|
| 80 | - self::CACHE_KEY_CSS => array(), |
|
| 81 | - self::CACHE_KEY_SELECTOR => array(), |
|
| 82 | - self::CACHE_KEY_XPATH => array(), |
|
| 83 | - self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
| 84 | - ); |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * the visited nodes with the XPath paths as array keys. |
|
| 88 | - * |
|
| 89 | - * @var array<\DOMNode> |
|
| 90 | - */ |
|
| 91 | - private $visitedNodes = array(); |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
| 95 | - * as key/value pairs for the inner array. |
|
| 96 | - * |
|
| 97 | - * @var array<array><string> |
|
| 98 | - */ |
|
| 99 | - private $styleAttributesForNodes = array(); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * This attribute applies to the case where you want to preserve your original text encoding. |
|
| 103 | - * |
|
| 104 | - * By default, emogrifier translates your text into HTML entities for two reasons: |
|
| 105 | - * |
|
| 106 | - * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
| 107 | - * |
|
| 108 | - * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
| 109 | - * |
|
| 110 | - * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
| 111 | - * |
|
| 112 | - * @var boolean |
|
| 113 | - */ |
|
| 114 | - public $preserveEncoding = false; |
|
| 115 | - |
|
| 116 | - public static $_media = ''; |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * The constructor. |
|
| 120 | - * |
|
| 121 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 122 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 123 | - */ |
|
| 124 | - public function __construct($html = '', $css = '') { |
|
| 125 | - $this->setHtml($html); |
|
| 126 | - $this->setCss($css); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * The destructor. |
|
| 131 | - */ |
|
| 132 | - public function __destruct() { |
|
| 133 | - $this->purgeVisitedNodes(); |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Sets the HTML to emogrify. |
|
| 138 | - * |
|
| 139 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 140 | - */ |
|
| 141 | - public function setHtml($html = '') { |
|
| 142 | - $this->html = $html; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Sets the CSS to merge with the HTML. |
|
| 147 | - * |
|
| 148 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 149 | - */ |
|
| 150 | - public function setCss($css = '') { |
|
| 151 | - $this->css = $css; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Clears all caches. |
|
| 156 | - */ |
|
| 157 | - private function clearAllCaches() { |
|
| 158 | - $this->clearCache(self::CACHE_KEY_CSS); |
|
| 159 | - $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
| 160 | - $this->clearCache(self::CACHE_KEY_XPATH); |
|
| 161 | - $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Clears a single cache by key. |
|
| 166 | - * |
|
| 167 | - * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
| 168 | - * |
|
| 169 | - * @throws InvalidArgumentException |
|
| 170 | - */ |
|
| 171 | - private function clearCache($key) { |
|
| 172 | - $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 173 | - if (!in_array($key, $allowedCacheKeys, true)) { |
|
| 174 | - throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - $this->caches[$key] = array(); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Purges the visited nodes. |
|
| 182 | - */ |
|
| 183 | - private function purgeVisitedNodes() { |
|
| 184 | - $this->visitedNodes = array(); |
|
| 185 | - $this->styleAttributesForNodes = array(); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Marks a tag for removal. |
|
| 190 | - * |
|
| 191 | - * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
| 192 | - * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
| 193 | - * |
|
| 194 | - * Note: The tags will not be removed if they have any content. |
|
| 195 | - * |
|
| 196 | - * @param string $tagName the tag name, e.g., "p" |
|
| 197 | - */ |
|
| 198 | - public function addUnprocessableHtmlTag($tagName) { |
|
| 199 | - $this->unprocessableHtmlTags[] = $tagName; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Drops a tag from the removal list. |
|
| 204 | - * |
|
| 205 | - * @param string $tagName the tag name, e.g., "p" |
|
| 206 | - */ |
|
| 207 | - public function removeUnprocessableHtmlTag($tagName) { |
|
| 208 | - $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
| 209 | - if ($key !== false) { |
|
| 210 | - unset($this->unprocessableHtmlTags[$key]); |
|
| 211 | - } |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Applies the CSS you submit to the HTML you submit. |
|
| 216 | - * |
|
| 217 | - * This method places the CSS inline. |
|
| 218 | - * |
|
| 219 | - * @return string |
|
| 220 | - * |
|
| 221 | - * @throws BadMethodCallException |
|
| 222 | - */ |
|
| 223 | - public function emogrify() { |
|
| 224 | - if ($this->html === '') { |
|
| 225 | - throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - $xmlDocument = $this->createXmlDocument(); |
|
| 229 | - $xpath = new DOMXPath($xmlDocument); |
|
| 230 | - $this->clearAllCaches(); |
|
| 231 | - |
|
| 232 | - // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
| 233 | - // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
| 234 | - // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
| 235 | - $this->purgeVisitedNodes(); |
|
| 236 | - |
|
| 237 | - $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
| 238 | - if ($nodesWithStyleAttributes !== false) { |
|
| 239 | - /** @var $nodeWithStyleAttribute DOMNode */ |
|
| 240 | - foreach ($nodesWithStyleAttributes as $node) { |
|
| 241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 242 | - |
|
| 243 | - // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
| 244 | - $nodePath = $node->getNodePath(); |
|
| 245 | - if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
| 246 | - $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
| 247 | - $this->visitedNodes[$nodePath] = $node; |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - $node->setAttribute('style', $normalizedOriginalStyle); |
|
| 251 | - } |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - // grab any existing style blocks from the html and append them to the existing CSS |
|
| 255 | - // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
| 256 | - $allCss = $this->css; |
|
| 257 | - |
|
| 258 | - $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
| 259 | - |
|
| 260 | - $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
| 261 | - self::$_media = ''; // reset |
|
| 262 | - |
|
| 263 | - $cssKey = md5($cssParts['css']); |
|
| 264 | - if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
| 265 | - // process the CSS file for selectors and definitions |
|
| 266 | - preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
| 267 | - |
|
| 268 | - $allSelectors = array(); |
|
| 269 | - foreach ($matches as $key => $selectorString) { |
|
| 270 | - // if there is a blank definition, skip |
|
| 271 | - if (!strlen(trim($selectorString[2]))) { |
|
| 272 | - continue; |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - // else split by commas and duplicate attributes so we can sort by selector precedence |
|
| 276 | - $selectors = explode(',', $selectorString[1]); |
|
| 277 | - foreach ($selectors as $selector) { |
|
| 278 | - // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
| 279 | - if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
| 280 | - continue; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - $allSelectors[] = array('selector' => trim($selector), |
|
| 284 | - 'attributes' => trim($selectorString[2]), |
|
| 285 | - // keep track of where it appears in the file, since order is important |
|
| 286 | - 'line' => $key, |
|
| 287 | - ); |
|
| 288 | - } |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - // now sort the selectors by precedence |
|
| 292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 293 | - |
|
| 294 | - $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
| 298 | - // query the body for the xpath selector |
|
| 299 | - $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
| 300 | - |
|
| 301 | - /** @var $node \DOMNode */ |
|
| 302 | - foreach ($nodesMatchingCssSelectors as $node) { |
|
| 303 | - // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
| 304 | - if ($node->hasAttribute('style')) { |
|
| 305 | - // break it up into an associative array |
|
| 306 | - $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 307 | - } else { |
|
| 308 | - $oldStyleDeclarations = array(); |
|
| 309 | - } |
|
| 310 | - $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
| 311 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
| 312 | - } |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - // now iterate through the nodes that contained inline styles in the original HTML |
|
| 316 | - foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
| 317 | - $node = $this->visitedNodes[$nodePath]; |
|
| 318 | - $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 319 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - // This removes styles from your email that contain display:none. |
|
| 323 | - // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
| 324 | - // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
| 325 | - // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
| 326 | - $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
| 327 | - // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
| 328 | - // we don't try to call removeChild on a nonexistent child node |
|
| 329 | - if ($nodesWithStyleDisplayNone->length > 0) { |
|
| 330 | - /** @var $node \DOMNode */ |
|
| 331 | - foreach ($nodesWithStyleDisplayNone as $node) { |
|
| 332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 333 | - $node->parentNode->removeChild($node); |
|
| 334 | - } |
|
| 335 | - } |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
| 339 | - |
|
| 340 | - if ($this->preserveEncoding) { |
|
| 341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 343 | - } else { |
|
| 344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 345 | - } |
|
| 346 | - } else { |
|
| 347 | - return $xmlDocument->saveHTML(); |
|
| 348 | - } |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - public function strtolower(array $m) { |
|
| 352 | - return strtolower($m[0]); |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * This method merges old or existing name/value array with new name/value array. |
|
| 358 | - * and then generates a string of the combined style suitable for placing inline. |
|
| 359 | - * This becomes the single point for CSS string generation allowing for consistent. |
|
| 360 | - * CSS output no matter where the CSS originally came from. |
|
| 361 | - * @param array $oldStyles |
|
| 362 | - * @param array $newStyles |
|
| 363 | - * @return string |
|
| 364 | - */ |
|
| 365 | - private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
| 366 | - $combinedStyles = array_merge($oldStyles, $newStyles); |
|
| 367 | - $style = ''; |
|
| 368 | - foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
| 369 | - $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
| 370 | - } |
|
| 371 | - return trim($style); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * Copies the media part from CSS array parts to $xmlDocument. |
|
| 377 | - * |
|
| 378 | - * @param array $cssParts |
|
| 379 | - * @param DOMDocument $xmlDocument |
|
| 380 | - */ |
|
| 381 | - public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
| 382 | - if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
| 383 | - $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
| 384 | - } |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Returns CSS content. |
|
| 389 | - * |
|
| 390 | - * @param DOMXPath $xpath |
|
| 391 | - * @return string |
|
| 392 | - */ |
|
| 393 | - private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
| 394 | - $styleNodes = $xpath->query('//style'); |
|
| 395 | - |
|
| 396 | - if ($styleNodes === false) { |
|
| 397 | - return ''; |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - $css = ''; |
|
| 401 | - /** @var $styleNode DOMNode */ |
|
| 402 | - foreach ($styleNodes as $styleNode) { |
|
| 403 | - $css .= "\n\n" . $styleNode->nodeValue; |
|
| 404 | - $styleNode->parentNode->removeChild($styleNode); |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - return $css; |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Adds a style element with $css to $document. |
|
| 412 | - * |
|
| 413 | - * @param DOMDocument $document |
|
| 414 | - * @param string $css |
|
| 415 | - */ |
|
| 416 | - private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
| 417 | - $styleElement = $document->createElement('style', $css); |
|
| 418 | - $styleAttribute = $document->createAttribute('type'); |
|
| 419 | - $styleAttribute->value = 'text/css'; |
|
| 420 | - $styleElement->appendChild($styleAttribute); |
|
| 421 | - |
|
| 422 | - $head = $this->getOrCreateHeadElement($document); |
|
| 423 | - $head->appendChild($styleElement); |
|
| 424 | - } |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * Returns the existing or creates a new head element in $document. |
|
| 428 | - * |
|
| 429 | - * @param DOMDocument $document |
|
| 430 | - * @return DOMNode the head element |
|
| 431 | - */ |
|
| 432 | - private function getOrCreateHeadElement(DOMDocument $document) { |
|
| 433 | - $head = $document->getElementsByTagName('head')->item(0); |
|
| 434 | - |
|
| 435 | - if ($head === null) { |
|
| 436 | - $head = $document->createElement('head'); |
|
| 437 | - $html = $document->getElementsByTagName('html')->item(0); |
|
| 438 | - $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - return $head; |
|
| 442 | - } |
|
| 443 | - |
|
| 444 | - /** |
|
| 445 | - * Splits input CSS code to an array where: |
|
| 446 | - * |
|
| 447 | - * - key "css" will be contains clean CSS code. |
|
| 448 | - * - key "media" will be contains all valuable media queries. |
|
| 449 | - * |
|
| 450 | - * Example: |
|
| 451 | - * |
|
| 452 | - * The CSS code. |
|
| 453 | - * |
|
| 454 | - * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
| 455 | - * |
|
| 456 | - * will be parsed into the following array: |
|
| 457 | - * |
|
| 458 | - * "css" => "h1 { color:red; }" |
|
| 459 | - * "media" => "@media { h1 {}}" |
|
| 460 | - * |
|
| 461 | - * @param string $css |
|
| 462 | - * @return array |
|
| 463 | - */ |
|
| 464 | - private function splitCssAndMediaQuery($css) { |
|
| 465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 466 | - |
|
| 467 | - // filter the CSS |
|
| 468 | - $search = array( |
|
| 469 | - // get rid of css comment code |
|
| 470 | - '/\\/\\*.*\\*\\//sU', |
|
| 471 | - // strip out any import directives |
|
| 472 | - '/^\\s*@import\\s[^;]+;/misU', |
|
| 473 | - // strip remains media enclosures |
|
| 474 | - '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
| 475 | - ); |
|
| 476 | - |
|
| 477 | - $replace = array( |
|
| 478 | - '', |
|
| 479 | - '', |
|
| 480 | - '', |
|
| 481 | - ); |
|
| 482 | - |
|
| 483 | - // clean CSS before output |
|
| 484 | - $css = preg_replace($search, $replace, $css); |
|
| 485 | - |
|
| 486 | - return array('css' => $css, 'media' => self::$_media); |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - private function _media_concat( $matches ) { |
|
| 490 | - self::$_media .= $matches[0]; |
|
| 491 | - } |
|
| 492 | - |
|
| 493 | - /** |
|
| 494 | - * Creates a DOMDocument instance with the current HTML. |
|
| 495 | - * |
|
| 496 | - * @return DOMDocument |
|
| 497 | - */ |
|
| 498 | - private function createXmlDocument() { |
|
| 499 | - $xmlDocument = new DOMDocument; |
|
| 500 | - $xmlDocument->encoding = self::ENCODING; |
|
| 501 | - $xmlDocument->strictErrorChecking = false; |
|
| 502 | - $xmlDocument->formatOutput = true; |
|
| 503 | - $libXmlState = libxml_use_internal_errors(true); |
|
| 504 | - $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
| 505 | - libxml_clear_errors(); |
|
| 506 | - libxml_use_internal_errors($libXmlState); |
|
| 507 | - $xmlDocument->normalizeDocument(); |
|
| 508 | - |
|
| 509 | - return $xmlDocument; |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
| 514 | - * |
|
| 515 | - * @return string the unified HTML |
|
| 516 | - * |
|
| 517 | - * @throws BadMethodCallException |
|
| 518 | - */ |
|
| 519 | - private function getUnifiedHtml() { |
|
| 520 | - if (!empty($this->unprocessableHtmlTags)) { |
|
| 521 | - $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
| 522 | - $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
| 523 | - } else { |
|
| 524 | - $bodyWithoutUnprocessableTags = $this->html; |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 529 | - } else { |
|
| 530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 531 | - } |
|
| 532 | - } |
|
| 533 | - |
|
| 534 | - /** |
|
| 535 | - * @param array $a |
|
| 536 | - * @param array $b |
|
| 537 | - * |
|
| 538 | - * @return integer |
|
| 539 | - */ |
|
| 540 | - private function sortBySelectorPrecedence(array $a, array $b) { |
|
| 541 | - $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
| 542 | - $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
| 543 | - |
|
| 544 | - // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
| 545 | - // selectors with greater precedence get sorted last. |
|
| 546 | - // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
| 547 | - // arithmetic operators. |
|
| 548 | - // @see http://forge.typo3.org/issues/55605 |
|
| 549 | - $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
| 550 | - $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
| 551 | - return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
| 552 | - } |
|
| 553 | - |
|
| 554 | - /** |
|
| 555 | - * @param string $selector |
|
| 556 | - * |
|
| 557 | - * @return integer |
|
| 558 | - */ |
|
| 559 | - private function getCssSelectorPrecedence($selector) { |
|
| 560 | - $selectorKey = md5($selector); |
|
| 561 | - if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
| 562 | - $precedence = 0; |
|
| 563 | - $value = 100; |
|
| 564 | - // ids: worth 100, classes: worth 10, elements: worth 1 |
|
| 565 | - $search = array('\\#','\\.',''); |
|
| 566 | - |
|
| 567 | - foreach ($search as $s) { |
|
| 568 | - if (trim($selector == '')) { |
|
| 569 | - break; |
|
| 570 | - } |
|
| 571 | - $number = 0; |
|
| 572 | - $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
| 573 | - $precedence += ($value * $number); |
|
| 574 | - $value /= 10; |
|
| 575 | - } |
|
| 576 | - $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
| 577 | - } |
|
| 578 | - |
|
| 579 | - return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
| 580 | - } |
|
| 581 | - |
|
| 582 | - /** |
|
| 583 | - * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
| 584 | - * |
|
| 585 | - * @see http://plasmasturm.org/log/444/ |
|
| 586 | - * |
|
| 587 | - * @param string $paramCssSelector |
|
| 588 | - * |
|
| 589 | - * @return string |
|
| 590 | - */ |
|
| 591 | - private function translateCssToXpath($paramCssSelector) { |
|
| 592 | - $cssSelector = ' ' . $paramCssSelector . ' '; |
|
| 593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 594 | - $cssSelector = trim($cssSelector); |
|
| 595 | - $xpathKey = md5($cssSelector); |
|
| 596 | - if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
| 597 | - // returns an Xpath selector |
|
| 598 | - $search = array( |
|
| 599 | - // Matches any element that is a child of parent. |
|
| 600 | - '/\\s+>\\s+/', |
|
| 601 | - // Matches any element that is an adjacent sibling. |
|
| 602 | - '/\\s+\\+\\s+/', |
|
| 603 | - // Matches any element that is a descendant of an parent element element. |
|
| 604 | - '/\\s+/', |
|
| 605 | - // first-child pseudo-selector |
|
| 606 | - '/([^\\/]+):first-child/i', |
|
| 607 | - // last-child pseudo-selector |
|
| 608 | - '/([^\\/]+):last-child/i', |
|
| 609 | - // Matches attribute only selector |
|
| 610 | - '/^\\[(\\w+)\\]/', |
|
| 611 | - // Matches element with attribute |
|
| 612 | - '/(\\w)\\[(\\w+)\\]/', |
|
| 613 | - // Matches element with EXACT attribute |
|
| 614 | - '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
| 615 | - ); |
|
| 616 | - $replace = array( |
|
| 617 | - '/', |
|
| 618 | - '/following-sibling::*[1]/self::', |
|
| 619 | - '//', |
|
| 620 | - '*[1]/self::\\1', |
|
| 621 | - '*[last()]/self::\\1', |
|
| 622 | - '*[@\\1]', |
|
| 623 | - '\\1[@\\2]', |
|
| 624 | - '\\1[@\\2="\\3"]', |
|
| 625 | - ); |
|
| 626 | - |
|
| 627 | - $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
| 628 | - |
|
| 629 | - $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
| 630 | - $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
| 631 | - |
|
| 632 | - // Advanced selectors are going to require a bit more advanced emogrification. |
|
| 633 | - // When we required PHP 5.3, we could do this with closures. |
|
| 634 | - $cssSelector = preg_replace_callback( |
|
| 635 | - '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 636 | - array($this, 'translateNthChild'), $cssSelector |
|
| 637 | - ); |
|
| 638 | - $cssSelector = preg_replace_callback( |
|
| 639 | - '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 640 | - array($this, 'translateNthOfType'), $cssSelector |
|
| 641 | - ); |
|
| 642 | - |
|
| 643 | - $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
| 644 | - } |
|
| 645 | - return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
| 646 | - } |
|
| 647 | - |
|
| 648 | - /** |
|
| 649 | - * @param array $match |
|
| 650 | - * |
|
| 651 | - * @return string |
|
| 652 | - */ |
|
| 653 | - private function matchIdAttributes(array $match) { |
|
| 654 | - return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * @param array $match |
|
| 659 | - * |
|
| 660 | - * @return string |
|
| 661 | - */ |
|
| 662 | - private function matchClassAttributes(array $match) { |
|
| 663 | - return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
| 664 | - implode( |
|
| 665 | - '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
| 666 | - explode('.', substr($match[2], 1)) |
|
| 667 | - ) . '"," "))]'; |
|
| 668 | - } |
|
| 669 | - |
|
| 670 | - /** |
|
| 671 | - * @param array $match |
|
| 672 | - * |
|
| 673 | - * @return string |
|
| 674 | - */ |
|
| 675 | - private function translateNthChild(array $match) { |
|
| 676 | - $result = $this->parseNth($match); |
|
| 677 | - |
|
| 678 | - if (isset($result[self::MULTIPLIER])) { |
|
| 679 | - if ($result[self::MULTIPLIER] < 0) { |
|
| 680 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 681 | - return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 682 | - } else { |
|
| 683 | - return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 684 | - } |
|
| 685 | - } else { |
|
| 686 | - return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
| 687 | - } |
|
| 688 | - } |
|
| 689 | - |
|
| 690 | - /** |
|
| 691 | - * @param array $match |
|
| 692 | - * |
|
| 693 | - * @return string |
|
| 694 | - */ |
|
| 695 | - private function translateNthOfType(array $match) { |
|
| 696 | - $result = $this->parseNth($match); |
|
| 697 | - |
|
| 698 | - if (isset($result[self::MULTIPLIER])) { |
|
| 699 | - if ($result[self::MULTIPLIER] < 0) { |
|
| 700 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 701 | - return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 702 | - } else { |
|
| 703 | - return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 704 | - } |
|
| 705 | - } else { |
|
| 706 | - return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
| 707 | - } |
|
| 708 | - } |
|
| 709 | - |
|
| 710 | - /** |
|
| 711 | - * @param array $match |
|
| 712 | - * |
|
| 713 | - * @return array |
|
| 714 | - */ |
|
| 715 | - private function parseNth(array $match) { |
|
| 716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 717 | - $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
| 718 | - return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
| 719 | - } elseif (stripos($match[2], 'n') === false) { |
|
| 720 | - // if there is a multiplier |
|
| 721 | - $index = intval(str_replace(' ', '', $match[2])); |
|
| 722 | - return array(self::INDEX => $index); |
|
| 723 | - } else { |
|
| 724 | - if (isset($match[3])) { |
|
| 725 | - $multipleTerm = str_replace($match[3], '', $match[2]); |
|
| 726 | - $index = intval(str_replace(' ', '', $match[3])); |
|
| 727 | - } else { |
|
| 728 | - $multipleTerm = $match[2]; |
|
| 729 | - $index = 0; |
|
| 730 | - } |
|
| 731 | - |
|
| 732 | - $multiplier = str_ireplace('n', '', $multipleTerm); |
|
| 733 | - |
|
| 734 | - if (!strlen($multiplier)) { |
|
| 735 | - $multiplier = 1; |
|
| 736 | - } elseif ($multiplier == 0) { |
|
| 737 | - return array(self::INDEX => $index); |
|
| 738 | - } else { |
|
| 739 | - $multiplier = intval($multiplier); |
|
| 740 | - } |
|
| 741 | - |
|
| 742 | - while ($index < 0) { |
|
| 743 | - $index += abs($multiplier); |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
| 747 | - } |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Parses a CSS declaration block into property name/value pairs. |
|
| 752 | - * |
|
| 753 | - * Example: |
|
| 754 | - * |
|
| 755 | - * The declaration block. |
|
| 756 | - * |
|
| 757 | - * "color: #000; font-weight: bold;". |
|
| 758 | - * |
|
| 759 | - * will be parsed into the following array: |
|
| 760 | - * |
|
| 761 | - * "color" => "#000" |
|
| 762 | - * "font-weight" => "bold" |
|
| 763 | - * |
|
| 764 | - * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
| 765 | - * |
|
| 766 | - * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
| 767 | - */ |
|
| 768 | - private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
| 769 | - if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
| 770 | - return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
| 771 | - } |
|
| 772 | - |
|
| 773 | - $properties = array(); |
|
| 774 | - $declarations = explode(';', $cssDeclarationBlock); |
|
| 775 | - foreach ($declarations as $declaration) { |
|
| 776 | - $matches = array(); |
|
| 777 | - if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
| 778 | - continue; |
|
| 779 | - } |
|
| 780 | - $propertyName = strtolower($matches[1]); |
|
| 781 | - $propertyValue = $matches[2]; |
|
| 782 | - $properties[$propertyName] = $propertyValue; |
|
| 783 | - } |
|
| 784 | - $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
| 785 | - |
|
| 786 | - return $properties; |
|
| 787 | - } |
|
| 12 | + /** |
|
| 13 | + * @var string |
|
| 14 | + */ |
|
| 15 | + const ENCODING = 'UTF-8'; |
|
| 16 | + |
|
| 17 | + /** |
|
| 18 | + * @var integer |
|
| 19 | + */ |
|
| 20 | + const CACHE_KEY_CSS = 0; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * @var integer |
|
| 24 | + */ |
|
| 25 | + const CACHE_KEY_SELECTOR = 1; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @var integer |
|
| 29 | + */ |
|
| 30 | + const CACHE_KEY_XPATH = 2; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var integer |
|
| 34 | + */ |
|
| 35 | + const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * for calculating nth-of-type and nth-child selectors. |
|
| 39 | + * |
|
| 40 | + * @var integer |
|
| 41 | + */ |
|
| 42 | + const INDEX = 0; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * for calculating nth-of-type and nth-child selectors. |
|
| 46 | + * |
|
| 47 | + * @var integer |
|
| 48 | + */ |
|
| 49 | + const MULTIPLIER = 1; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | + const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | + const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * @var string |
|
| 63 | + */ |
|
| 64 | + private $html = ''; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @var string |
|
| 68 | + */ |
|
| 69 | + private $css = ''; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @var array<string> |
|
| 73 | + */ |
|
| 74 | + private $unprocessableHtmlTags = array('wbr'); |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * @var array<array> |
|
| 78 | + */ |
|
| 79 | + private $caches = array( |
|
| 80 | + self::CACHE_KEY_CSS => array(), |
|
| 81 | + self::CACHE_KEY_SELECTOR => array(), |
|
| 82 | + self::CACHE_KEY_XPATH => array(), |
|
| 83 | + self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
| 84 | + ); |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * the visited nodes with the XPath paths as array keys. |
|
| 88 | + * |
|
| 89 | + * @var array<\DOMNode> |
|
| 90 | + */ |
|
| 91 | + private $visitedNodes = array(); |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
| 95 | + * as key/value pairs for the inner array. |
|
| 96 | + * |
|
| 97 | + * @var array<array><string> |
|
| 98 | + */ |
|
| 99 | + private $styleAttributesForNodes = array(); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * This attribute applies to the case where you want to preserve your original text encoding. |
|
| 103 | + * |
|
| 104 | + * By default, emogrifier translates your text into HTML entities for two reasons: |
|
| 105 | + * |
|
| 106 | + * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
| 107 | + * |
|
| 108 | + * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
| 109 | + * |
|
| 110 | + * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
| 111 | + * |
|
| 112 | + * @var boolean |
|
| 113 | + */ |
|
| 114 | + public $preserveEncoding = false; |
|
| 115 | + |
|
| 116 | + public static $_media = ''; |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * The constructor. |
|
| 120 | + * |
|
| 121 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 122 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 123 | + */ |
|
| 124 | + public function __construct($html = '', $css = '') { |
|
| 125 | + $this->setHtml($html); |
|
| 126 | + $this->setCss($css); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * The destructor. |
|
| 131 | + */ |
|
| 132 | + public function __destruct() { |
|
| 133 | + $this->purgeVisitedNodes(); |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Sets the HTML to emogrify. |
|
| 138 | + * |
|
| 139 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 140 | + */ |
|
| 141 | + public function setHtml($html = '') { |
|
| 142 | + $this->html = $html; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Sets the CSS to merge with the HTML. |
|
| 147 | + * |
|
| 148 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 149 | + */ |
|
| 150 | + public function setCss($css = '') { |
|
| 151 | + $this->css = $css; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Clears all caches. |
|
| 156 | + */ |
|
| 157 | + private function clearAllCaches() { |
|
| 158 | + $this->clearCache(self::CACHE_KEY_CSS); |
|
| 159 | + $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
| 160 | + $this->clearCache(self::CACHE_KEY_XPATH); |
|
| 161 | + $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Clears a single cache by key. |
|
| 166 | + * |
|
| 167 | + * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
| 168 | + * |
|
| 169 | + * @throws InvalidArgumentException |
|
| 170 | + */ |
|
| 171 | + private function clearCache($key) { |
|
| 172 | + $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 173 | + if (!in_array($key, $allowedCacheKeys, true)) { |
|
| 174 | + throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + $this->caches[$key] = array(); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Purges the visited nodes. |
|
| 182 | + */ |
|
| 183 | + private function purgeVisitedNodes() { |
|
| 184 | + $this->visitedNodes = array(); |
|
| 185 | + $this->styleAttributesForNodes = array(); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Marks a tag for removal. |
|
| 190 | + * |
|
| 191 | + * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
| 192 | + * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
| 193 | + * |
|
| 194 | + * Note: The tags will not be removed if they have any content. |
|
| 195 | + * |
|
| 196 | + * @param string $tagName the tag name, e.g., "p" |
|
| 197 | + */ |
|
| 198 | + public function addUnprocessableHtmlTag($tagName) { |
|
| 199 | + $this->unprocessableHtmlTags[] = $tagName; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Drops a tag from the removal list. |
|
| 204 | + * |
|
| 205 | + * @param string $tagName the tag name, e.g., "p" |
|
| 206 | + */ |
|
| 207 | + public function removeUnprocessableHtmlTag($tagName) { |
|
| 208 | + $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
| 209 | + if ($key !== false) { |
|
| 210 | + unset($this->unprocessableHtmlTags[$key]); |
|
| 211 | + } |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Applies the CSS you submit to the HTML you submit. |
|
| 216 | + * |
|
| 217 | + * This method places the CSS inline. |
|
| 218 | + * |
|
| 219 | + * @return string |
|
| 220 | + * |
|
| 221 | + * @throws BadMethodCallException |
|
| 222 | + */ |
|
| 223 | + public function emogrify() { |
|
| 224 | + if ($this->html === '') { |
|
| 225 | + throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + $xmlDocument = $this->createXmlDocument(); |
|
| 229 | + $xpath = new DOMXPath($xmlDocument); |
|
| 230 | + $this->clearAllCaches(); |
|
| 231 | + |
|
| 232 | + // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
| 233 | + // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
| 234 | + // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
| 235 | + $this->purgeVisitedNodes(); |
|
| 236 | + |
|
| 237 | + $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
| 238 | + if ($nodesWithStyleAttributes !== false) { |
|
| 239 | + /** @var $nodeWithStyleAttribute DOMNode */ |
|
| 240 | + foreach ($nodesWithStyleAttributes as $node) { |
|
| 241 | + $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 242 | + |
|
| 243 | + // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
| 244 | + $nodePath = $node->getNodePath(); |
|
| 245 | + if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
| 246 | + $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
| 247 | + $this->visitedNodes[$nodePath] = $node; |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + $node->setAttribute('style', $normalizedOriginalStyle); |
|
| 251 | + } |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + // grab any existing style blocks from the html and append them to the existing CSS |
|
| 255 | + // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
| 256 | + $allCss = $this->css; |
|
| 257 | + |
|
| 258 | + $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
| 259 | + |
|
| 260 | + $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
| 261 | + self::$_media = ''; // reset |
|
| 262 | + |
|
| 263 | + $cssKey = md5($cssParts['css']); |
|
| 264 | + if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
| 265 | + // process the CSS file for selectors and definitions |
|
| 266 | + preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
| 267 | + |
|
| 268 | + $allSelectors = array(); |
|
| 269 | + foreach ($matches as $key => $selectorString) { |
|
| 270 | + // if there is a blank definition, skip |
|
| 271 | + if (!strlen(trim($selectorString[2]))) { |
|
| 272 | + continue; |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + // else split by commas and duplicate attributes so we can sort by selector precedence |
|
| 276 | + $selectors = explode(',', $selectorString[1]); |
|
| 277 | + foreach ($selectors as $selector) { |
|
| 278 | + // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
| 279 | + if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
| 280 | + continue; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + $allSelectors[] = array('selector' => trim($selector), |
|
| 284 | + 'attributes' => trim($selectorString[2]), |
|
| 285 | + // keep track of where it appears in the file, since order is important |
|
| 286 | + 'line' => $key, |
|
| 287 | + ); |
|
| 288 | + } |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + // now sort the selectors by precedence |
|
| 292 | + usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 293 | + |
|
| 294 | + $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
| 298 | + // query the body for the xpath selector |
|
| 299 | + $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
| 300 | + |
|
| 301 | + /** @var $node \DOMNode */ |
|
| 302 | + foreach ($nodesMatchingCssSelectors as $node) { |
|
| 303 | + // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
| 304 | + if ($node->hasAttribute('style')) { |
|
| 305 | + // break it up into an associative array |
|
| 306 | + $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 307 | + } else { |
|
| 308 | + $oldStyleDeclarations = array(); |
|
| 309 | + } |
|
| 310 | + $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
| 311 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
| 312 | + } |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + // now iterate through the nodes that contained inline styles in the original HTML |
|
| 316 | + foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
| 317 | + $node = $this->visitedNodes[$nodePath]; |
|
| 318 | + $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 319 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + // This removes styles from your email that contain display:none. |
|
| 323 | + // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
| 324 | + // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
| 325 | + // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
| 326 | + $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
| 327 | + // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
| 328 | + // we don't try to call removeChild on a nonexistent child node |
|
| 329 | + if ($nodesWithStyleDisplayNone->length > 0) { |
|
| 330 | + /** @var $node \DOMNode */ |
|
| 331 | + foreach ($nodesWithStyleDisplayNone as $node) { |
|
| 332 | + if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 333 | + $node->parentNode->removeChild($node); |
|
| 334 | + } |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
| 339 | + |
|
| 340 | + if ($this->preserveEncoding) { |
|
| 341 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | + return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 343 | + } else { |
|
| 344 | + return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 345 | + } |
|
| 346 | + } else { |
|
| 347 | + return $xmlDocument->saveHTML(); |
|
| 348 | + } |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + public function strtolower(array $m) { |
|
| 352 | + return strtolower($m[0]); |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * This method merges old or existing name/value array with new name/value array. |
|
| 358 | + * and then generates a string of the combined style suitable for placing inline. |
|
| 359 | + * This becomes the single point for CSS string generation allowing for consistent. |
|
| 360 | + * CSS output no matter where the CSS originally came from. |
|
| 361 | + * @param array $oldStyles |
|
| 362 | + * @param array $newStyles |
|
| 363 | + * @return string |
|
| 364 | + */ |
|
| 365 | + private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
| 366 | + $combinedStyles = array_merge($oldStyles, $newStyles); |
|
| 367 | + $style = ''; |
|
| 368 | + foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
| 369 | + $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
| 370 | + } |
|
| 371 | + return trim($style); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * Copies the media part from CSS array parts to $xmlDocument. |
|
| 377 | + * |
|
| 378 | + * @param array $cssParts |
|
| 379 | + * @param DOMDocument $xmlDocument |
|
| 380 | + */ |
|
| 381 | + public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
| 382 | + if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
| 383 | + $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
| 384 | + } |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Returns CSS content. |
|
| 389 | + * |
|
| 390 | + * @param DOMXPath $xpath |
|
| 391 | + * @return string |
|
| 392 | + */ |
|
| 393 | + private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
| 394 | + $styleNodes = $xpath->query('//style'); |
|
| 395 | + |
|
| 396 | + if ($styleNodes === false) { |
|
| 397 | + return ''; |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + $css = ''; |
|
| 401 | + /** @var $styleNode DOMNode */ |
|
| 402 | + foreach ($styleNodes as $styleNode) { |
|
| 403 | + $css .= "\n\n" . $styleNode->nodeValue; |
|
| 404 | + $styleNode->parentNode->removeChild($styleNode); |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + return $css; |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Adds a style element with $css to $document. |
|
| 412 | + * |
|
| 413 | + * @param DOMDocument $document |
|
| 414 | + * @param string $css |
|
| 415 | + */ |
|
| 416 | + private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
| 417 | + $styleElement = $document->createElement('style', $css); |
|
| 418 | + $styleAttribute = $document->createAttribute('type'); |
|
| 419 | + $styleAttribute->value = 'text/css'; |
|
| 420 | + $styleElement->appendChild($styleAttribute); |
|
| 421 | + |
|
| 422 | + $head = $this->getOrCreateHeadElement($document); |
|
| 423 | + $head->appendChild($styleElement); |
|
| 424 | + } |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * Returns the existing or creates a new head element in $document. |
|
| 428 | + * |
|
| 429 | + * @param DOMDocument $document |
|
| 430 | + * @return DOMNode the head element |
|
| 431 | + */ |
|
| 432 | + private function getOrCreateHeadElement(DOMDocument $document) { |
|
| 433 | + $head = $document->getElementsByTagName('head')->item(0); |
|
| 434 | + |
|
| 435 | + if ($head === null) { |
|
| 436 | + $head = $document->createElement('head'); |
|
| 437 | + $html = $document->getElementsByTagName('html')->item(0); |
|
| 438 | + $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + return $head; |
|
| 442 | + } |
|
| 443 | + |
|
| 444 | + /** |
|
| 445 | + * Splits input CSS code to an array where: |
|
| 446 | + * |
|
| 447 | + * - key "css" will be contains clean CSS code. |
|
| 448 | + * - key "media" will be contains all valuable media queries. |
|
| 449 | + * |
|
| 450 | + * Example: |
|
| 451 | + * |
|
| 452 | + * The CSS code. |
|
| 453 | + * |
|
| 454 | + * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
| 455 | + * |
|
| 456 | + * will be parsed into the following array: |
|
| 457 | + * |
|
| 458 | + * "css" => "h1 { color:red; }" |
|
| 459 | + * "media" => "@media { h1 {}}" |
|
| 460 | + * |
|
| 461 | + * @param string $css |
|
| 462 | + * @return array |
|
| 463 | + */ |
|
| 464 | + private function splitCssAndMediaQuery($css) { |
|
| 465 | + $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 466 | + |
|
| 467 | + // filter the CSS |
|
| 468 | + $search = array( |
|
| 469 | + // get rid of css comment code |
|
| 470 | + '/\\/\\*.*\\*\\//sU', |
|
| 471 | + // strip out any import directives |
|
| 472 | + '/^\\s*@import\\s[^;]+;/misU', |
|
| 473 | + // strip remains media enclosures |
|
| 474 | + '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
| 475 | + ); |
|
| 476 | + |
|
| 477 | + $replace = array( |
|
| 478 | + '', |
|
| 479 | + '', |
|
| 480 | + '', |
|
| 481 | + ); |
|
| 482 | + |
|
| 483 | + // clean CSS before output |
|
| 484 | + $css = preg_replace($search, $replace, $css); |
|
| 485 | + |
|
| 486 | + return array('css' => $css, 'media' => self::$_media); |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + private function _media_concat( $matches ) { |
|
| 490 | + self::$_media .= $matches[0]; |
|
| 491 | + } |
|
| 492 | + |
|
| 493 | + /** |
|
| 494 | + * Creates a DOMDocument instance with the current HTML. |
|
| 495 | + * |
|
| 496 | + * @return DOMDocument |
|
| 497 | + */ |
|
| 498 | + private function createXmlDocument() { |
|
| 499 | + $xmlDocument = new DOMDocument; |
|
| 500 | + $xmlDocument->encoding = self::ENCODING; |
|
| 501 | + $xmlDocument->strictErrorChecking = false; |
|
| 502 | + $xmlDocument->formatOutput = true; |
|
| 503 | + $libXmlState = libxml_use_internal_errors(true); |
|
| 504 | + $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
| 505 | + libxml_clear_errors(); |
|
| 506 | + libxml_use_internal_errors($libXmlState); |
|
| 507 | + $xmlDocument->normalizeDocument(); |
|
| 508 | + |
|
| 509 | + return $xmlDocument; |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
| 514 | + * |
|
| 515 | + * @return string the unified HTML |
|
| 516 | + * |
|
| 517 | + * @throws BadMethodCallException |
|
| 518 | + */ |
|
| 519 | + private function getUnifiedHtml() { |
|
| 520 | + if (!empty($this->unprocessableHtmlTags)) { |
|
| 521 | + $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
| 522 | + $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
| 523 | + } else { |
|
| 524 | + $bodyWithoutUnprocessableTags = $this->html; |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | + return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 529 | + } else { |
|
| 530 | + return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 531 | + } |
|
| 532 | + } |
|
| 533 | + |
|
| 534 | + /** |
|
| 535 | + * @param array $a |
|
| 536 | + * @param array $b |
|
| 537 | + * |
|
| 538 | + * @return integer |
|
| 539 | + */ |
|
| 540 | + private function sortBySelectorPrecedence(array $a, array $b) { |
|
| 541 | + $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
| 542 | + $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
| 543 | + |
|
| 544 | + // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
| 545 | + // selectors with greater precedence get sorted last. |
|
| 546 | + // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
| 547 | + // arithmetic operators. |
|
| 548 | + // @see http://forge.typo3.org/issues/55605 |
|
| 549 | + $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
| 550 | + $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
| 551 | + return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
| 552 | + } |
|
| 553 | + |
|
| 554 | + /** |
|
| 555 | + * @param string $selector |
|
| 556 | + * |
|
| 557 | + * @return integer |
|
| 558 | + */ |
|
| 559 | + private function getCssSelectorPrecedence($selector) { |
|
| 560 | + $selectorKey = md5($selector); |
|
| 561 | + if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
| 562 | + $precedence = 0; |
|
| 563 | + $value = 100; |
|
| 564 | + // ids: worth 100, classes: worth 10, elements: worth 1 |
|
| 565 | + $search = array('\\#','\\.',''); |
|
| 566 | + |
|
| 567 | + foreach ($search as $s) { |
|
| 568 | + if (trim($selector == '')) { |
|
| 569 | + break; |
|
| 570 | + } |
|
| 571 | + $number = 0; |
|
| 572 | + $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
| 573 | + $precedence += ($value * $number); |
|
| 574 | + $value /= 10; |
|
| 575 | + } |
|
| 576 | + $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
| 577 | + } |
|
| 578 | + |
|
| 579 | + return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
| 580 | + } |
|
| 581 | + |
|
| 582 | + /** |
|
| 583 | + * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
| 584 | + * |
|
| 585 | + * @see http://plasmasturm.org/log/444/ |
|
| 586 | + * |
|
| 587 | + * @param string $paramCssSelector |
|
| 588 | + * |
|
| 589 | + * @return string |
|
| 590 | + */ |
|
| 591 | + private function translateCssToXpath($paramCssSelector) { |
|
| 592 | + $cssSelector = ' ' . $paramCssSelector . ' '; |
|
| 593 | + $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 594 | + $cssSelector = trim($cssSelector); |
|
| 595 | + $xpathKey = md5($cssSelector); |
|
| 596 | + if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
| 597 | + // returns an Xpath selector |
|
| 598 | + $search = array( |
|
| 599 | + // Matches any element that is a child of parent. |
|
| 600 | + '/\\s+>\\s+/', |
|
| 601 | + // Matches any element that is an adjacent sibling. |
|
| 602 | + '/\\s+\\+\\s+/', |
|
| 603 | + // Matches any element that is a descendant of an parent element element. |
|
| 604 | + '/\\s+/', |
|
| 605 | + // first-child pseudo-selector |
|
| 606 | + '/([^\\/]+):first-child/i', |
|
| 607 | + // last-child pseudo-selector |
|
| 608 | + '/([^\\/]+):last-child/i', |
|
| 609 | + // Matches attribute only selector |
|
| 610 | + '/^\\[(\\w+)\\]/', |
|
| 611 | + // Matches element with attribute |
|
| 612 | + '/(\\w)\\[(\\w+)\\]/', |
|
| 613 | + // Matches element with EXACT attribute |
|
| 614 | + '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
| 615 | + ); |
|
| 616 | + $replace = array( |
|
| 617 | + '/', |
|
| 618 | + '/following-sibling::*[1]/self::', |
|
| 619 | + '//', |
|
| 620 | + '*[1]/self::\\1', |
|
| 621 | + '*[last()]/self::\\1', |
|
| 622 | + '*[@\\1]', |
|
| 623 | + '\\1[@\\2]', |
|
| 624 | + '\\1[@\\2="\\3"]', |
|
| 625 | + ); |
|
| 626 | + |
|
| 627 | + $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
| 628 | + |
|
| 629 | + $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
| 630 | + $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
| 631 | + |
|
| 632 | + // Advanced selectors are going to require a bit more advanced emogrification. |
|
| 633 | + // When we required PHP 5.3, we could do this with closures. |
|
| 634 | + $cssSelector = preg_replace_callback( |
|
| 635 | + '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 636 | + array($this, 'translateNthChild'), $cssSelector |
|
| 637 | + ); |
|
| 638 | + $cssSelector = preg_replace_callback( |
|
| 639 | + '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 640 | + array($this, 'translateNthOfType'), $cssSelector |
|
| 641 | + ); |
|
| 642 | + |
|
| 643 | + $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
| 644 | + } |
|
| 645 | + return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
| 646 | + } |
|
| 647 | + |
|
| 648 | + /** |
|
| 649 | + * @param array $match |
|
| 650 | + * |
|
| 651 | + * @return string |
|
| 652 | + */ |
|
| 653 | + private function matchIdAttributes(array $match) { |
|
| 654 | + return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * @param array $match |
|
| 659 | + * |
|
| 660 | + * @return string |
|
| 661 | + */ |
|
| 662 | + private function matchClassAttributes(array $match) { |
|
| 663 | + return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
| 664 | + implode( |
|
| 665 | + '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
| 666 | + explode('.', substr($match[2], 1)) |
|
| 667 | + ) . '"," "))]'; |
|
| 668 | + } |
|
| 669 | + |
|
| 670 | + /** |
|
| 671 | + * @param array $match |
|
| 672 | + * |
|
| 673 | + * @return string |
|
| 674 | + */ |
|
| 675 | + private function translateNthChild(array $match) { |
|
| 676 | + $result = $this->parseNth($match); |
|
| 677 | + |
|
| 678 | + if (isset($result[self::MULTIPLIER])) { |
|
| 679 | + if ($result[self::MULTIPLIER] < 0) { |
|
| 680 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 681 | + return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 682 | + } else { |
|
| 683 | + return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 684 | + } |
|
| 685 | + } else { |
|
| 686 | + return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
| 687 | + } |
|
| 688 | + } |
|
| 689 | + |
|
| 690 | + /** |
|
| 691 | + * @param array $match |
|
| 692 | + * |
|
| 693 | + * @return string |
|
| 694 | + */ |
|
| 695 | + private function translateNthOfType(array $match) { |
|
| 696 | + $result = $this->parseNth($match); |
|
| 697 | + |
|
| 698 | + if (isset($result[self::MULTIPLIER])) { |
|
| 699 | + if ($result[self::MULTIPLIER] < 0) { |
|
| 700 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 701 | + return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 702 | + } else { |
|
| 703 | + return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 704 | + } |
|
| 705 | + } else { |
|
| 706 | + return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
| 707 | + } |
|
| 708 | + } |
|
| 709 | + |
|
| 710 | + /** |
|
| 711 | + * @param array $match |
|
| 712 | + * |
|
| 713 | + * @return array |
|
| 714 | + */ |
|
| 715 | + private function parseNth(array $match) { |
|
| 716 | + if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 717 | + $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
| 718 | + return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
| 719 | + } elseif (stripos($match[2], 'n') === false) { |
|
| 720 | + // if there is a multiplier |
|
| 721 | + $index = intval(str_replace(' ', '', $match[2])); |
|
| 722 | + return array(self::INDEX => $index); |
|
| 723 | + } else { |
|
| 724 | + if (isset($match[3])) { |
|
| 725 | + $multipleTerm = str_replace($match[3], '', $match[2]); |
|
| 726 | + $index = intval(str_replace(' ', '', $match[3])); |
|
| 727 | + } else { |
|
| 728 | + $multipleTerm = $match[2]; |
|
| 729 | + $index = 0; |
|
| 730 | + } |
|
| 731 | + |
|
| 732 | + $multiplier = str_ireplace('n', '', $multipleTerm); |
|
| 733 | + |
|
| 734 | + if (!strlen($multiplier)) { |
|
| 735 | + $multiplier = 1; |
|
| 736 | + } elseif ($multiplier == 0) { |
|
| 737 | + return array(self::INDEX => $index); |
|
| 738 | + } else { |
|
| 739 | + $multiplier = intval($multiplier); |
|
| 740 | + } |
|
| 741 | + |
|
| 742 | + while ($index < 0) { |
|
| 743 | + $index += abs($multiplier); |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
| 747 | + } |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Parses a CSS declaration block into property name/value pairs. |
|
| 752 | + * |
|
| 753 | + * Example: |
|
| 754 | + * |
|
| 755 | + * The declaration block. |
|
| 756 | + * |
|
| 757 | + * "color: #000; font-weight: bold;". |
|
| 758 | + * |
|
| 759 | + * will be parsed into the following array: |
|
| 760 | + * |
|
| 761 | + * "color" => "#000" |
|
| 762 | + * "font-weight" => "bold" |
|
| 763 | + * |
|
| 764 | + * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
| 765 | + * |
|
| 766 | + * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
| 767 | + */ |
|
| 768 | + private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
| 769 | + if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
| 770 | + return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
| 771 | + } |
|
| 772 | + |
|
| 773 | + $properties = array(); |
|
| 774 | + $declarations = explode(';', $cssDeclarationBlock); |
|
| 775 | + foreach ($declarations as $declaration) { |
|
| 776 | + $matches = array(); |
|
| 777 | + if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
| 778 | + continue; |
|
| 779 | + } |
|
| 780 | + $propertyName = strtolower($matches[1]); |
|
| 781 | + $propertyValue = $matches[2]; |
|
| 782 | + $properties[$propertyName] = $propertyValue; |
|
| 783 | + } |
|
| 784 | + $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
| 785 | + |
|
| 786 | + return $properties; |
|
| 787 | + } |
|
| 788 | 788 | } |
@@ -238,7 +238,7 @@ discard block |
||
| 238 | 238 | if ($nodesWithStyleAttributes !== false) { |
| 239 | 239 | /** @var $nodeWithStyleAttribute DOMNode */ |
| 240 | 240 | foreach ($nodesWithStyleAttributes as $node) { |
| 241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 241 | + $normalizedOriginalStyle = preg_replace_callback('/[A-z\\-]+(?=\\:)/S', array($this, 'strtolower'), $node->getAttribute('style')); |
|
| 242 | 242 | |
| 243 | 243 | // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
| 244 | 244 | $nodePath = $node->getNodePath(); |
@@ -289,7 +289,7 @@ discard block |
||
| 289 | 289 | } |
| 290 | 290 | |
| 291 | 291 | // now sort the selectors by precedence |
| 292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 292 | + usort($allSelectors, array($this, 'sortBySelectorPrecedence')); |
|
| 293 | 293 | |
| 294 | 294 | $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
| 295 | 295 | } |
@@ -329,7 +329,7 @@ discard block |
||
| 329 | 329 | if ($nodesWithStyleDisplayNone->length > 0) { |
| 330 | 330 | /** @var $node \DOMNode */ |
| 331 | 331 | foreach ($nodesWithStyleDisplayNone as $node) { |
| 332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 332 | + if ($node->parentNode && is_callable(array($node->parentNode, 'removeChild'))) { |
|
| 333 | 333 | $node->parentNode->removeChild($node); |
| 334 | 334 | } |
| 335 | 335 | } |
@@ -338,10 +338,10 @@ discard block |
||
| 338 | 338 | $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
| 339 | 339 | |
| 340 | 340 | if ($this->preserveEncoding) { |
| 341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 341 | + if (function_exists('mb_convert_encoding')) { |
|
| 342 | + return mb_convert_encoding($xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES'); |
|
| 343 | 343 | } else { |
| 344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 344 | + return htmlspecialchars_decode(utf8_encode(html_entity_decode($xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING))); |
|
| 345 | 345 | } |
| 346 | 346 | } else { |
| 347 | 347 | return $xmlDocument->saveHTML(); |
@@ -462,7 +462,7 @@ discard block |
||
| 462 | 462 | * @return array |
| 463 | 463 | */ |
| 464 | 464 | private function splitCssAndMediaQuery($css) { |
| 465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 465 | + $css = preg_replace_callback('#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array($this, '_media_concat'), $css); |
|
| 466 | 466 | |
| 467 | 467 | // filter the CSS |
| 468 | 468 | $search = array( |
@@ -486,7 +486,7 @@ discard block |
||
| 486 | 486 | return array('css' => $css, 'media' => self::$_media); |
| 487 | 487 | } |
| 488 | 488 | |
| 489 | - private function _media_concat( $matches ) { |
|
| 489 | + private function _media_concat($matches) { |
|
| 490 | 490 | self::$_media .= $matches[0]; |
| 491 | 491 | } |
| 492 | 492 | |
@@ -524,10 +524,10 @@ discard block |
||
| 524 | 524 | $bodyWithoutUnprocessableTags = $this->html; |
| 525 | 525 | } |
| 526 | 526 | |
| 527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 527 | + if (function_exists('mb_convert_encoding')) { |
|
| 528 | + return mb_convert_encoding($bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING); |
|
| 529 | 529 | } else { |
| 530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 530 | + return htmlspecialchars_decode(utf8_decode(htmlentities($bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false))); |
|
| 531 | 531 | } |
| 532 | 532 | } |
| 533 | 533 | |
@@ -562,7 +562,7 @@ discard block |
||
| 562 | 562 | $precedence = 0; |
| 563 | 563 | $value = 100; |
| 564 | 564 | // ids: worth 100, classes: worth 10, elements: worth 1 |
| 565 | - $search = array('\\#','\\.',''); |
|
| 565 | + $search = array('\\#', '\\.', ''); |
|
| 566 | 566 | |
| 567 | 567 | foreach ($search as $s) { |
| 568 | 568 | if (trim($selector == '')) { |
@@ -590,7 +590,7 @@ discard block |
||
| 590 | 590 | */ |
| 591 | 591 | private function translateCssToXpath($paramCssSelector) { |
| 592 | 592 | $cssSelector = ' ' . $paramCssSelector . ' '; |
| 593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 593 | + $cssSelector = preg_replace_callback('/\s+\w+\s+/', array($this, 'strtolower'), $cssSelector); |
|
| 594 | 594 | $cssSelector = trim($cssSelector); |
| 595 | 595 | $xpathKey = md5($cssSelector); |
| 596 | 596 | if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
@@ -713,7 +713,7 @@ discard block |
||
| 713 | 713 | * @return array |
| 714 | 714 | */ |
| 715 | 715 | private function parseNth(array $match) { |
| 716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 716 | + if (in_array(strtolower($match[2]), array('even', 'odd'))) { |
|
| 717 | 717 | $index = strtolower($match[2]) == 'even' ? 0 : 1; |
| 718 | 718 | return array(self::MULTIPLIER => 2, self::INDEX => $index); |
| 719 | 719 | } elseif (stripos($match[2], 'n') === false) { |
@@ -5,237 +5,237 @@ |
||
| 5 | 5 | |
| 6 | 6 | abstract class Wpinv_DB { |
| 7 | 7 | |
| 8 | - /** |
|
| 9 | - * The name of our database table |
|
| 10 | - * |
|
| 11 | - * @access public |
|
| 12 | - * @since 1.0.0 |
|
| 13 | - */ |
|
| 14 | - public $table_name; |
|
| 15 | - |
|
| 16 | - /** |
|
| 17 | - * The version of our database table |
|
| 18 | - * |
|
| 19 | - * @access public |
|
| 20 | - * @since 1.0.0 |
|
| 21 | - */ |
|
| 22 | - public $version; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * The name of the primary column |
|
| 26 | - * |
|
| 27 | - * @access public |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - */ |
|
| 30 | - public $primary_key; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Get things started |
|
| 34 | - * |
|
| 35 | - * @access public |
|
| 36 | - * @since 1.0.0 |
|
| 37 | - */ |
|
| 38 | - public function __construct() {} |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Whitelist of columns |
|
| 42 | - * |
|
| 43 | - * @access public |
|
| 44 | - * @since 1.0.0 |
|
| 45 | - * @return array |
|
| 46 | - */ |
|
| 47 | - public function get_columns() { |
|
| 48 | - return array(); |
|
| 49 | - } |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Default column values |
|
| 53 | - * |
|
| 54 | - * @access public |
|
| 55 | - * @since 1.0.0 |
|
| 56 | - * @return array |
|
| 57 | - */ |
|
| 58 | - public function get_column_defaults() { |
|
| 59 | - return array(); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * Retrieve a row by the primary key |
|
| 64 | - * |
|
| 65 | - * @access public |
|
| 66 | - * @since 1.0.0 |
|
| 67 | - * @return object |
|
| 68 | - */ |
|
| 69 | - public function get( $row_id ) { |
|
| 70 | - global $wpdb; |
|
| 71 | - return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Retrieve a row by a specific column / value |
|
| 76 | - * |
|
| 77 | - * @access public |
|
| 78 | - * @since 1.0.0 |
|
| 79 | - * @return object |
|
| 80 | - */ |
|
| 81 | - public function get_by( $column, $row_id ) { |
|
| 82 | - global $wpdb; |
|
| 83 | - $column = esc_sql( $column ); |
|
| 84 | - return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id ) ); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Retrieve a specific column's value by the primary key |
|
| 89 | - * |
|
| 90 | - * @access public |
|
| 91 | - * @since 1.0.0 |
|
| 92 | - * @return string |
|
| 93 | - */ |
|
| 94 | - public function get_column( $column, $row_id ) { |
|
| 95 | - global $wpdb; |
|
| 96 | - $column = esc_sql( $column ); |
|
| 97 | - return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) ); |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * Retrieve a specific column's value by the the specified column / value |
|
| 102 | - * |
|
| 103 | - * @access public |
|
| 104 | - * @since 1.0.0 |
|
| 105 | - * @return string |
|
| 106 | - */ |
|
| 107 | - public function get_column_by( $column, $column_where, $column_value ) { |
|
| 108 | - global $wpdb; |
|
| 109 | - $column_where = esc_sql( $column_where ); |
|
| 110 | - $column = esc_sql( $column ); |
|
| 111 | - return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value ) ); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * Insert a new row |
|
| 116 | - * |
|
| 117 | - * @access public |
|
| 118 | - * @since 1.0.0 |
|
| 119 | - * @return int |
|
| 120 | - */ |
|
| 121 | - public function insert( $data, $type = '' ) { |
|
| 122 | - global $wpdb; |
|
| 123 | - |
|
| 124 | - // Set default values |
|
| 125 | - $data = wp_parse_args( $data, $this->get_column_defaults() ); |
|
| 126 | - |
|
| 127 | - do_action( 'wpinv_pre_insert_' . $type, $data ); |
|
| 128 | - |
|
| 129 | - // Initialise column format array |
|
| 130 | - $column_formats = $this->get_columns(); |
|
| 131 | - |
|
| 132 | - // Force fields to lower case |
|
| 133 | - $data = array_change_key_case( $data ); |
|
| 134 | - |
|
| 135 | - // White list columns |
|
| 136 | - $data = array_intersect_key( $data, $column_formats ); |
|
| 137 | - |
|
| 138 | - // Reorder $column_formats to match the order of columns given in $data |
|
| 139 | - $data_keys = array_keys( $data ); |
|
| 140 | - $column_formats = array_merge( array_flip( $data_keys ), $column_formats ); |
|
| 141 | - |
|
| 142 | - $wpdb->insert( $this->table_name, $data, $column_formats ); |
|
| 143 | - $wpdb_insert_id = $wpdb->insert_id; |
|
| 144 | - |
|
| 145 | - do_action( 'wpinv_post_insert_' . $type, $wpdb_insert_id, $data ); |
|
| 146 | - |
|
| 147 | - return $wpdb_insert_id; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * Update a row |
|
| 152 | - * |
|
| 153 | - * @access public |
|
| 154 | - * @since 1.0.0 |
|
| 155 | - * @return bool |
|
| 156 | - */ |
|
| 157 | - public function update( $row_id, $data = array(), $where = '' ) { |
|
| 158 | - |
|
| 159 | - global $wpdb; |
|
| 160 | - |
|
| 161 | - // Row ID must be positive integer |
|
| 162 | - $row_id = absint( $row_id ); |
|
| 163 | - |
|
| 164 | - if( empty( $row_id ) ) { |
|
| 165 | - return false; |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - if( empty( $where ) ) { |
|
| 169 | - $where = $this->primary_key; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - // Initialise column format array |
|
| 173 | - $column_formats = $this->get_columns(); |
|
| 174 | - |
|
| 175 | - // Force fields to lower case |
|
| 176 | - $data = array_change_key_case( $data ); |
|
| 177 | - |
|
| 178 | - // White list columns |
|
| 179 | - $data = array_intersect_key( $data, $column_formats ); |
|
| 180 | - |
|
| 181 | - // Reorder $column_formats to match the order of columns given in $data |
|
| 182 | - $data_keys = array_keys( $data ); |
|
| 183 | - $column_formats = array_merge( array_flip( $data_keys ), $column_formats ); |
|
| 184 | - |
|
| 185 | - if ( false === $wpdb->update( $this->table_name, $data, array( $where => $row_id ), $column_formats ) ) { |
|
| 186 | - return false; |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - return true; |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Delete a row identified by the primary key |
|
| 194 | - * |
|
| 195 | - * @access public |
|
| 196 | - * @since 1.0.0 |
|
| 197 | - * @return bool |
|
| 198 | - */ |
|
| 199 | - public function delete( $row_id = 0 ) { |
|
| 200 | - |
|
| 201 | - global $wpdb; |
|
| 202 | - |
|
| 203 | - // Row ID must be positive integer |
|
| 204 | - $row_id = absint( $row_id ); |
|
| 205 | - |
|
| 206 | - if( empty( $row_id ) ) { |
|
| 207 | - return false; |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id ) ) ) { |
|
| 211 | - return false; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - return true; |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * Check if the given table exists |
|
| 219 | - * |
|
| 220 | - * @since 2.4 |
|
| 221 | - * @param string $table The table name |
|
| 222 | - * @return bool If the table name exists |
|
| 223 | - */ |
|
| 224 | - public function table_exists( $table ) { |
|
| 225 | - global $wpdb; |
|
| 226 | - $table = sanitize_text_field( $table ); |
|
| 227 | - |
|
| 228 | - return $wpdb->get_var( $wpdb->prepare( "SHOW TABLES LIKE '%s'", $table ) ) === $table; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * Check if the table was ever installed |
|
| 233 | - * |
|
| 234 | - * @since 2.4 |
|
| 235 | - * @return bool Returns if the customers table was installed and upgrade routine run |
|
| 236 | - */ |
|
| 237 | - public function installed() { |
|
| 238 | - return $this->table_exists( $this->table_name ); |
|
| 239 | - } |
|
| 8 | + /** |
|
| 9 | + * The name of our database table |
|
| 10 | + * |
|
| 11 | + * @access public |
|
| 12 | + * @since 1.0.0 |
|
| 13 | + */ |
|
| 14 | + public $table_name; |
|
| 15 | + |
|
| 16 | + /** |
|
| 17 | + * The version of our database table |
|
| 18 | + * |
|
| 19 | + * @access public |
|
| 20 | + * @since 1.0.0 |
|
| 21 | + */ |
|
| 22 | + public $version; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * The name of the primary column |
|
| 26 | + * |
|
| 27 | + * @access public |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + */ |
|
| 30 | + public $primary_key; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Get things started |
|
| 34 | + * |
|
| 35 | + * @access public |
|
| 36 | + * @since 1.0.0 |
|
| 37 | + */ |
|
| 38 | + public function __construct() {} |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Whitelist of columns |
|
| 42 | + * |
|
| 43 | + * @access public |
|
| 44 | + * @since 1.0.0 |
|
| 45 | + * @return array |
|
| 46 | + */ |
|
| 47 | + public function get_columns() { |
|
| 48 | + return array(); |
|
| 49 | + } |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Default column values |
|
| 53 | + * |
|
| 54 | + * @access public |
|
| 55 | + * @since 1.0.0 |
|
| 56 | + * @return array |
|
| 57 | + */ |
|
| 58 | + public function get_column_defaults() { |
|
| 59 | + return array(); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * Retrieve a row by the primary key |
|
| 64 | + * |
|
| 65 | + * @access public |
|
| 66 | + * @since 1.0.0 |
|
| 67 | + * @return object |
|
| 68 | + */ |
|
| 69 | + public function get( $row_id ) { |
|
| 70 | + global $wpdb; |
|
| 71 | + return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Retrieve a row by a specific column / value |
|
| 76 | + * |
|
| 77 | + * @access public |
|
| 78 | + * @since 1.0.0 |
|
| 79 | + * @return object |
|
| 80 | + */ |
|
| 81 | + public function get_by( $column, $row_id ) { |
|
| 82 | + global $wpdb; |
|
| 83 | + $column = esc_sql( $column ); |
|
| 84 | + return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id ) ); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Retrieve a specific column's value by the primary key |
|
| 89 | + * |
|
| 90 | + * @access public |
|
| 91 | + * @since 1.0.0 |
|
| 92 | + * @return string |
|
| 93 | + */ |
|
| 94 | + public function get_column( $column, $row_id ) { |
|
| 95 | + global $wpdb; |
|
| 96 | + $column = esc_sql( $column ); |
|
| 97 | + return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) ); |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * Retrieve a specific column's value by the the specified column / value |
|
| 102 | + * |
|
| 103 | + * @access public |
|
| 104 | + * @since 1.0.0 |
|
| 105 | + * @return string |
|
| 106 | + */ |
|
| 107 | + public function get_column_by( $column, $column_where, $column_value ) { |
|
| 108 | + global $wpdb; |
|
| 109 | + $column_where = esc_sql( $column_where ); |
|
| 110 | + $column = esc_sql( $column ); |
|
| 111 | + return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value ) ); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * Insert a new row |
|
| 116 | + * |
|
| 117 | + * @access public |
|
| 118 | + * @since 1.0.0 |
|
| 119 | + * @return int |
|
| 120 | + */ |
|
| 121 | + public function insert( $data, $type = '' ) { |
|
| 122 | + global $wpdb; |
|
| 123 | + |
|
| 124 | + // Set default values |
|
| 125 | + $data = wp_parse_args( $data, $this->get_column_defaults() ); |
|
| 126 | + |
|
| 127 | + do_action( 'wpinv_pre_insert_' . $type, $data ); |
|
| 128 | + |
|
| 129 | + // Initialise column format array |
|
| 130 | + $column_formats = $this->get_columns(); |
|
| 131 | + |
|
| 132 | + // Force fields to lower case |
|
| 133 | + $data = array_change_key_case( $data ); |
|
| 134 | + |
|
| 135 | + // White list columns |
|
| 136 | + $data = array_intersect_key( $data, $column_formats ); |
|
| 137 | + |
|
| 138 | + // Reorder $column_formats to match the order of columns given in $data |
|
| 139 | + $data_keys = array_keys( $data ); |
|
| 140 | + $column_formats = array_merge( array_flip( $data_keys ), $column_formats ); |
|
| 141 | + |
|
| 142 | + $wpdb->insert( $this->table_name, $data, $column_formats ); |
|
| 143 | + $wpdb_insert_id = $wpdb->insert_id; |
|
| 144 | + |
|
| 145 | + do_action( 'wpinv_post_insert_' . $type, $wpdb_insert_id, $data ); |
|
| 146 | + |
|
| 147 | + return $wpdb_insert_id; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * Update a row |
|
| 152 | + * |
|
| 153 | + * @access public |
|
| 154 | + * @since 1.0.0 |
|
| 155 | + * @return bool |
|
| 156 | + */ |
|
| 157 | + public function update( $row_id, $data = array(), $where = '' ) { |
|
| 158 | + |
|
| 159 | + global $wpdb; |
|
| 160 | + |
|
| 161 | + // Row ID must be positive integer |
|
| 162 | + $row_id = absint( $row_id ); |
|
| 163 | + |
|
| 164 | + if( empty( $row_id ) ) { |
|
| 165 | + return false; |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + if( empty( $where ) ) { |
|
| 169 | + $where = $this->primary_key; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + // Initialise column format array |
|
| 173 | + $column_formats = $this->get_columns(); |
|
| 174 | + |
|
| 175 | + // Force fields to lower case |
|
| 176 | + $data = array_change_key_case( $data ); |
|
| 177 | + |
|
| 178 | + // White list columns |
|
| 179 | + $data = array_intersect_key( $data, $column_formats ); |
|
| 180 | + |
|
| 181 | + // Reorder $column_formats to match the order of columns given in $data |
|
| 182 | + $data_keys = array_keys( $data ); |
|
| 183 | + $column_formats = array_merge( array_flip( $data_keys ), $column_formats ); |
|
| 184 | + |
|
| 185 | + if ( false === $wpdb->update( $this->table_name, $data, array( $where => $row_id ), $column_formats ) ) { |
|
| 186 | + return false; |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + return true; |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Delete a row identified by the primary key |
|
| 194 | + * |
|
| 195 | + * @access public |
|
| 196 | + * @since 1.0.0 |
|
| 197 | + * @return bool |
|
| 198 | + */ |
|
| 199 | + public function delete( $row_id = 0 ) { |
|
| 200 | + |
|
| 201 | + global $wpdb; |
|
| 202 | + |
|
| 203 | + // Row ID must be positive integer |
|
| 204 | + $row_id = absint( $row_id ); |
|
| 205 | + |
|
| 206 | + if( empty( $row_id ) ) { |
|
| 207 | + return false; |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id ) ) ) { |
|
| 211 | + return false; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + return true; |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * Check if the given table exists |
|
| 219 | + * |
|
| 220 | + * @since 2.4 |
|
| 221 | + * @param string $table The table name |
|
| 222 | + * @return bool If the table name exists |
|
| 223 | + */ |
|
| 224 | + public function table_exists( $table ) { |
|
| 225 | + global $wpdb; |
|
| 226 | + $table = sanitize_text_field( $table ); |
|
| 227 | + |
|
| 228 | + return $wpdb->get_var( $wpdb->prepare( "SHOW TABLES LIKE '%s'", $table ) ) === $table; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * Check if the table was ever installed |
|
| 233 | + * |
|
| 234 | + * @since 2.4 |
|
| 235 | + * @return bool Returns if the customers table was installed and upgrade routine run |
|
| 236 | + */ |
|
| 237 | + public function installed() { |
|
| 238 | + return $this->table_exists( $this->table_name ); |
|
| 239 | + } |
|
| 240 | 240 | |
| 241 | 241 | } |
@@ -1,7 +1,7 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | // Exit if accessed directly |
| 4 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 4 | +if (!defined('ABSPATH')) exit; |
|
| 5 | 5 | |
| 6 | 6 | abstract class Wpinv_DB { |
| 7 | 7 | |
@@ -66,9 +66,9 @@ discard block |
||
| 66 | 66 | * @since 1.0.0 |
| 67 | 67 | * @return object |
| 68 | 68 | */ |
| 69 | - public function get( $row_id ) { |
|
| 69 | + public function get($row_id) { |
|
| 70 | 70 | global $wpdb; |
| 71 | - return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) ); |
|
| 71 | + return $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id)); |
|
| 72 | 72 | } |
| 73 | 73 | |
| 74 | 74 | /** |
@@ -78,10 +78,10 @@ discard block |
||
| 78 | 78 | * @since 1.0.0 |
| 79 | 79 | * @return object |
| 80 | 80 | */ |
| 81 | - public function get_by( $column, $row_id ) { |
|
| 81 | + public function get_by($column, $row_id) { |
|
| 82 | 82 | global $wpdb; |
| 83 | - $column = esc_sql( $column ); |
|
| 84 | - return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id ) ); |
|
| 83 | + $column = esc_sql($column); |
|
| 84 | + return $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id)); |
|
| 85 | 85 | } |
| 86 | 86 | |
| 87 | 87 | /** |
@@ -91,10 +91,10 @@ discard block |
||
| 91 | 91 | * @since 1.0.0 |
| 92 | 92 | * @return string |
| 93 | 93 | */ |
| 94 | - public function get_column( $column, $row_id ) { |
|
| 94 | + public function get_column($column, $row_id) { |
|
| 95 | 95 | global $wpdb; |
| 96 | - $column = esc_sql( $column ); |
|
| 97 | - return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) ); |
|
| 96 | + $column = esc_sql($column); |
|
| 97 | + return $wpdb->get_var($wpdb->prepare("SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id)); |
|
| 98 | 98 | } |
| 99 | 99 | |
| 100 | 100 | /** |
@@ -104,11 +104,11 @@ discard block |
||
| 104 | 104 | * @since 1.0.0 |
| 105 | 105 | * @return string |
| 106 | 106 | */ |
| 107 | - public function get_column_by( $column, $column_where, $column_value ) { |
|
| 107 | + public function get_column_by($column, $column_where, $column_value) { |
|
| 108 | 108 | global $wpdb; |
| 109 | - $column_where = esc_sql( $column_where ); |
|
| 110 | - $column = esc_sql( $column ); |
|
| 111 | - return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value ) ); |
|
| 109 | + $column_where = esc_sql($column_where); |
|
| 110 | + $column = esc_sql($column); |
|
| 111 | + return $wpdb->get_var($wpdb->prepare("SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value)); |
|
| 112 | 112 | } |
| 113 | 113 | |
| 114 | 114 | /** |
@@ -118,31 +118,31 @@ discard block |
||
| 118 | 118 | * @since 1.0.0 |
| 119 | 119 | * @return int |
| 120 | 120 | */ |
| 121 | - public function insert( $data, $type = '' ) { |
|
| 121 | + public function insert($data, $type = '') { |
|
| 122 | 122 | global $wpdb; |
| 123 | 123 | |
| 124 | 124 | // Set default values |
| 125 | - $data = wp_parse_args( $data, $this->get_column_defaults() ); |
|
| 125 | + $data = wp_parse_args($data, $this->get_column_defaults()); |
|
| 126 | 126 | |
| 127 | - do_action( 'wpinv_pre_insert_' . $type, $data ); |
|
| 127 | + do_action('wpinv_pre_insert_' . $type, $data); |
|
| 128 | 128 | |
| 129 | 129 | // Initialise column format array |
| 130 | 130 | $column_formats = $this->get_columns(); |
| 131 | 131 | |
| 132 | 132 | // Force fields to lower case |
| 133 | - $data = array_change_key_case( $data ); |
|
| 133 | + $data = array_change_key_case($data); |
|
| 134 | 134 | |
| 135 | 135 | // White list columns |
| 136 | - $data = array_intersect_key( $data, $column_formats ); |
|
| 136 | + $data = array_intersect_key($data, $column_formats); |
|
| 137 | 137 | |
| 138 | 138 | // Reorder $column_formats to match the order of columns given in $data |
| 139 | - $data_keys = array_keys( $data ); |
|
| 140 | - $column_formats = array_merge( array_flip( $data_keys ), $column_formats ); |
|
| 139 | + $data_keys = array_keys($data); |
|
| 140 | + $column_formats = array_merge(array_flip($data_keys), $column_formats); |
|
| 141 | 141 | |
| 142 | - $wpdb->insert( $this->table_name, $data, $column_formats ); |
|
| 142 | + $wpdb->insert($this->table_name, $data, $column_formats); |
|
| 143 | 143 | $wpdb_insert_id = $wpdb->insert_id; |
| 144 | 144 | |
| 145 | - do_action( 'wpinv_post_insert_' . $type, $wpdb_insert_id, $data ); |
|
| 145 | + do_action('wpinv_post_insert_' . $type, $wpdb_insert_id, $data); |
|
| 146 | 146 | |
| 147 | 147 | return $wpdb_insert_id; |
| 148 | 148 | } |
@@ -154,18 +154,18 @@ discard block |
||
| 154 | 154 | * @since 1.0.0 |
| 155 | 155 | * @return bool |
| 156 | 156 | */ |
| 157 | - public function update( $row_id, $data = array(), $where = '' ) { |
|
| 157 | + public function update($row_id, $data = array(), $where = '') { |
|
| 158 | 158 | |
| 159 | 159 | global $wpdb; |
| 160 | 160 | |
| 161 | 161 | // Row ID must be positive integer |
| 162 | - $row_id = absint( $row_id ); |
|
| 162 | + $row_id = absint($row_id); |
|
| 163 | 163 | |
| 164 | - if( empty( $row_id ) ) { |
|
| 164 | + if (empty($row_id)) { |
|
| 165 | 165 | return false; |
| 166 | 166 | } |
| 167 | 167 | |
| 168 | - if( empty( $where ) ) { |
|
| 168 | + if (empty($where)) { |
|
| 169 | 169 | $where = $this->primary_key; |
| 170 | 170 | } |
| 171 | 171 | |
@@ -173,16 +173,16 @@ discard block |
||
| 173 | 173 | $column_formats = $this->get_columns(); |
| 174 | 174 | |
| 175 | 175 | // Force fields to lower case |
| 176 | - $data = array_change_key_case( $data ); |
|
| 176 | + $data = array_change_key_case($data); |
|
| 177 | 177 | |
| 178 | 178 | // White list columns |
| 179 | - $data = array_intersect_key( $data, $column_formats ); |
|
| 179 | + $data = array_intersect_key($data, $column_formats); |
|
| 180 | 180 | |
| 181 | 181 | // Reorder $column_formats to match the order of columns given in $data |
| 182 | - $data_keys = array_keys( $data ); |
|
| 183 | - $column_formats = array_merge( array_flip( $data_keys ), $column_formats ); |
|
| 182 | + $data_keys = array_keys($data); |
|
| 183 | + $column_formats = array_merge(array_flip($data_keys), $column_formats); |
|
| 184 | 184 | |
| 185 | - if ( false === $wpdb->update( $this->table_name, $data, array( $where => $row_id ), $column_formats ) ) { |
|
| 185 | + if (false === $wpdb->update($this->table_name, $data, array($where => $row_id), $column_formats)) { |
|
| 186 | 186 | return false; |
| 187 | 187 | } |
| 188 | 188 | |
@@ -196,18 +196,18 @@ discard block |
||
| 196 | 196 | * @since 1.0.0 |
| 197 | 197 | * @return bool |
| 198 | 198 | */ |
| 199 | - public function delete( $row_id = 0 ) { |
|
| 199 | + public function delete($row_id = 0) { |
|
| 200 | 200 | |
| 201 | 201 | global $wpdb; |
| 202 | 202 | |
| 203 | 203 | // Row ID must be positive integer |
| 204 | - $row_id = absint( $row_id ); |
|
| 204 | + $row_id = absint($row_id); |
|
| 205 | 205 | |
| 206 | - if( empty( $row_id ) ) { |
|
| 206 | + if (empty($row_id)) { |
|
| 207 | 207 | return false; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id ) ) ) { |
|
| 210 | + if (false === $wpdb->query($wpdb->prepare("DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id))) { |
|
| 211 | 211 | return false; |
| 212 | 212 | } |
| 213 | 213 | |
@@ -221,11 +221,11 @@ discard block |
||
| 221 | 221 | * @param string $table The table name |
| 222 | 222 | * @return bool If the table name exists |
| 223 | 223 | */ |
| 224 | - public function table_exists( $table ) { |
|
| 224 | + public function table_exists($table) { |
|
| 225 | 225 | global $wpdb; |
| 226 | - $table = sanitize_text_field( $table ); |
|
| 226 | + $table = sanitize_text_field($table); |
|
| 227 | 227 | |
| 228 | - return $wpdb->get_var( $wpdb->prepare( "SHOW TABLES LIKE '%s'", $table ) ) === $table; |
|
| 228 | + return $wpdb->get_var($wpdb->prepare("SHOW TABLES LIKE '%s'", $table)) === $table; |
|
| 229 | 229 | } |
| 230 | 230 | |
| 231 | 231 | /** |
@@ -235,7 +235,7 @@ discard block |
||
| 235 | 235 | * @return bool Returns if the customers table was installed and upgrade routine run |
| 236 | 236 | */ |
| 237 | 237 | public function installed() { |
| 238 | - return $this->table_exists( $this->table_name ); |
|
| 238 | + return $this->table_exists($this->table_name); |
|
| 239 | 239 | } |
| 240 | 240 | |
| 241 | 241 | } |
@@ -1,7 +1,9 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | // Exit if accessed directly |
| 4 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 4 | +if ( ! defined( 'ABSPATH' ) ) { |
|
| 5 | + exit; |
|
| 6 | +} |
|
| 5 | 7 | |
| 6 | 8 | abstract class Wpinv_DB { |
| 7 | 9 | |
@@ -1,5 +1,5 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 2 | +if (!defined('ABSPATH')) { |
|
| 3 | 3 | exit; // Exit if accessed directly |
| 4 | 4 | } |
| 5 | 5 | |
@@ -14,18 +14,18 @@ discard block |
||
| 14 | 14 | * Hook in methods. |
| 15 | 15 | */ |
| 16 | 16 | public static function init() { |
| 17 | - add_action( 'init', array( __CLASS__, 'init_hooks' ), 0 ); |
|
| 18 | - add_action( 'admin_notices', array( __CLASS__, 'notices' ) ); |
|
| 17 | + add_action('init', array(__CLASS__, 'init_hooks'), 0); |
|
| 18 | + add_action('admin_notices', array(__CLASS__, 'notices')); |
|
| 19 | 19 | } |
| 20 | 20 | |
| 21 | 21 | public static function init_hooks() { |
| 22 | - if ( false === ( $page_uris = get_transient( 'wpinv_cache_excluded_uris' ) ) ) { |
|
| 23 | - $checkout_page = wpinv_get_option( 'checkout_page', '' ); |
|
| 24 | - $success_page = wpinv_get_option( 'success_page', '' ); |
|
| 25 | - $failure_page = wpinv_get_option( 'failure_page', '' ); |
|
| 26 | - $history_page = wpinv_get_option( 'invoice_history_page', '' ); |
|
| 27 | - $subscr_page = wpinv_get_option( 'invoice_subscription_page', '' ); |
|
| 28 | - if ( empty( $checkout_page ) || empty( $success_page ) || empty( $failure_page ) || empty( $history_page ) || empty( $subscr_page ) ) { |
|
| 22 | + if (false === ($page_uris = get_transient('wpinv_cache_excluded_uris'))) { |
|
| 23 | + $checkout_page = wpinv_get_option('checkout_page', ''); |
|
| 24 | + $success_page = wpinv_get_option('success_page', ''); |
|
| 25 | + $failure_page = wpinv_get_option('failure_page', ''); |
|
| 26 | + $history_page = wpinv_get_option('invoice_history_page', ''); |
|
| 27 | + $subscr_page = wpinv_get_option('invoice_subscription_page', ''); |
|
| 28 | + if (empty($checkout_page) || empty($success_page) || empty($failure_page) || empty($history_page) || empty($subscr_page)) { |
|
| 29 | 29 | return; |
| 30 | 30 | } |
| 31 | 31 | |
@@ -39,34 +39,34 @@ discard block |
||
| 39 | 39 | $page_uris[] = 'p=' . $subscr_page; |
| 40 | 40 | |
| 41 | 41 | // Exclude permalinks |
| 42 | - $checkout_page = get_post( $checkout_page ); |
|
| 43 | - $success_page = get_post( $success_page ); |
|
| 44 | - $failure_page = get_post( $failure_page ); |
|
| 45 | - $history_page = get_post( $history_page ); |
|
| 46 | - $subscr_page = get_post( $subscr_page ); |
|
| 42 | + $checkout_page = get_post($checkout_page); |
|
| 43 | + $success_page = get_post($success_page); |
|
| 44 | + $failure_page = get_post($failure_page); |
|
| 45 | + $history_page = get_post($history_page); |
|
| 46 | + $subscr_page = get_post($subscr_page); |
|
| 47 | 47 | |
| 48 | - if ( ! is_null( $checkout_page ) ) { |
|
| 48 | + if (!is_null($checkout_page)) { |
|
| 49 | 49 | $page_uris[] = '/' . $checkout_page->post_name; |
| 50 | 50 | } |
| 51 | - if ( ! is_null( $success_page ) ) { |
|
| 51 | + if (!is_null($success_page)) { |
|
| 52 | 52 | $page_uris[] = '/' . $success_page->post_name; |
| 53 | 53 | } |
| 54 | - if ( ! is_null( $failure_page ) ) { |
|
| 54 | + if (!is_null($failure_page)) { |
|
| 55 | 55 | $page_uris[] = '/' . $failure_page->post_name; |
| 56 | 56 | } |
| 57 | - if ( ! is_null( $history_page ) ) { |
|
| 57 | + if (!is_null($history_page)) { |
|
| 58 | 58 | $page_uris[] = '/' . $history_page->post_name; |
| 59 | 59 | } |
| 60 | - if ( ! is_null( $subscr_page ) ) { |
|
| 60 | + if (!is_null($subscr_page)) { |
|
| 61 | 61 | $page_uris[] = '/' . $subscr_page->post_name; |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - set_transient( 'wpinv_cache_excluded_uris', $page_uris ); |
|
| 64 | + set_transient('wpinv_cache_excluded_uris', $page_uris); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | - if ( is_array( $page_uris ) ) { |
|
| 68 | - foreach( $page_uris as $uri ) { |
|
| 69 | - if ( strstr( $_SERVER['REQUEST_URI'], $uri ) ) { |
|
| 67 | + if (is_array($page_uris)) { |
|
| 68 | + foreach ($page_uris as $uri) { |
|
| 69 | + if (strstr($_SERVER['REQUEST_URI'], $uri)) { |
|
| 70 | 70 | self::nocache(); |
| 71 | 71 | break; |
| 72 | 72 | } |
@@ -79,14 +79,14 @@ discard block |
||
| 79 | 79 | * @access private |
| 80 | 80 | */ |
| 81 | 81 | private static function nocache() { |
| 82 | - if ( ! defined( 'DONOTCACHEPAGE' ) ) { |
|
| 83 | - define( "DONOTCACHEPAGE", true ); |
|
| 82 | + if (!defined('DONOTCACHEPAGE')) { |
|
| 83 | + define("DONOTCACHEPAGE", true); |
|
| 84 | 84 | } |
| 85 | - if ( ! defined( 'DONOTCACHEOBJECT' ) ) { |
|
| 86 | - define( "DONOTCACHEOBJECT", true ); |
|
| 85 | + if (!defined('DONOTCACHEOBJECT')) { |
|
| 86 | + define("DONOTCACHEOBJECT", true); |
|
| 87 | 87 | } |
| 88 | - if ( ! defined( 'DONOTCACHEDB' ) ) { |
|
| 89 | - define( "DONOTCACHEDB", true ); |
|
| 88 | + if (!defined('DONOTCACHEDB')) { |
|
| 89 | + define("DONOTCACHEDB", true); |
|
| 90 | 90 | } |
| 91 | 91 | nocache_headers(); |
| 92 | 92 | } |
@@ -95,18 +95,18 @@ discard block |
||
| 95 | 95 | * notices function. |
| 96 | 96 | */ |
| 97 | 97 | public static function notices() { |
| 98 | - if ( ! function_exists( 'w3tc_pgcache_flush' ) || ! function_exists( 'w3_instance' ) ) { |
|
| 98 | + if (!function_exists('w3tc_pgcache_flush') || !function_exists('w3_instance')) { |
|
| 99 | 99 | return; |
| 100 | 100 | } |
| 101 | 101 | |
| 102 | - $config = w3_instance( 'W3_Config' ); |
|
| 103 | - $enabled = $config->get_integer( 'dbcache.enabled' ); |
|
| 104 | - $settings = array_map( 'trim', $config->get_array( 'dbcache.reject.sql' ) ); |
|
| 102 | + $config = w3_instance('W3_Config'); |
|
| 103 | + $enabled = $config->get_integer('dbcache.enabled'); |
|
| 104 | + $settings = array_map('trim', $config->get_array('dbcache.reject.sql')); |
|
| 105 | 105 | |
| 106 | - if ( $enabled && ! in_array( '_wp_session_', $settings ) ) { |
|
| 106 | + if ($enabled && !in_array('_wp_session_', $settings)) { |
|
| 107 | 107 | ?> |
| 108 | 108 | <div class="error"> |
| 109 | - <p><?php printf( __( 'In order for <strong>database caching</strong> to work with Invoicing you must add %1$s to the "Ignored Query Strings" option in <a href="%2$s">W3 Total Cache settings</a>.', 'invoicing' ), '<code>_wp_session_</code>', admin_url( 'admin.php?page=w3tc_dbcache' ) ); ?></p> |
|
| 109 | + <p><?php printf(__('In order for <strong>database caching</strong> to work with Invoicing you must add %1$s to the "Ignored Query Strings" option in <a href="%2$s">W3 Total Cache settings</a>.', 'invoicing'), '<code>_wp_session_</code>', admin_url('admin.php?page=w3tc_dbcache')); ?></p> |
|
| 110 | 110 | </div> |
| 111 | 111 | <?php |
| 112 | 112 | } |
@@ -79,7 +79,7 @@ |
||
| 79 | 79 | |
| 80 | 80 | if(empty($count)){ |
| 81 | 81 | $output .= __('No Invoice(s)','invoicing'); |
| 82 | - }else{ |
|
| 82 | + } else{ |
|
| 83 | 83 | $link_url = admin_url( "edit.php?post_type=wpi_invoice&author=".absint($user_id) ); |
| 84 | 84 | $link_text = sprintf( __('Invoices ( %d )', 'invoicing'), $count ); |
| 85 | 85 | $output .= "<a href='$link_url' >$link_text</a>"; |
@@ -7,15 +7,15 @@ discard block |
||
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | 9 | // MUST have WordPress. |
| 10 | -if ( !defined( 'WPINC' ) ) { |
|
| 11 | - exit( 'Do NOT access this file directly: ' . basename( __FILE__ ) ); |
|
| 10 | +if (!defined('WPINC')) { |
|
| 11 | + exit('Do NOT access this file directly: ' . basename(__FILE__)); |
|
| 12 | 12 | } |
| 13 | 13 | |
| 14 | 14 | class WPInv_Admin_Users { |
| 15 | 15 | private static $instance; |
| 16 | 16 | |
| 17 | 17 | public static function run() { |
| 18 | - if ( !isset( self::$instance ) && !( self::$instance instanceof WPInv_Admin_Users ) ) { |
|
| 18 | + if (!isset(self::$instance) && !(self::$instance instanceof WPInv_Admin_Users)) { |
|
| 19 | 19 | self::$instance = new WPInv_Admin_Users; |
| 20 | 20 | } |
| 21 | 21 | |
@@ -23,8 +23,8 @@ discard block |
||
| 23 | 23 | } |
| 24 | 24 | |
| 25 | 25 | public function __construct() { |
| 26 | - add_filter( 'manage_users_columns', array( $this, 'wpinv_add_user_column') ); |
|
| 27 | - add_filter( 'manage_users_custom_column', array( $this, 'wpinv_user_column_content') , 10, 3 ); |
|
| 26 | + add_filter('manage_users_columns', array($this, 'wpinv_add_user_column')); |
|
| 27 | + add_filter('manage_users_custom_column', array($this, 'wpinv_user_column_content'), 10, 3); |
|
| 28 | 28 | } |
| 29 | 29 | |
| 30 | 30 | /** |
@@ -34,8 +34,8 @@ discard block |
||
| 34 | 34 | * |
| 35 | 35 | * @return mixed |
| 36 | 36 | */ |
| 37 | - public function wpinv_add_user_column( $column ) { |
|
| 38 | - $column['wpinvoicing'] = __('Invoicing','invoicing'); |
|
| 37 | + public function wpinv_add_user_column($column) { |
|
| 38 | + $column['wpinvoicing'] = __('Invoicing', 'invoicing'); |
|
| 39 | 39 | return $column; |
| 40 | 40 | } |
| 41 | 41 | |
@@ -48,10 +48,10 @@ discard block |
||
| 48 | 48 | * |
| 49 | 49 | * @return string |
| 50 | 50 | */ |
| 51 | - function wpinv_user_column_content( $val, $column_name, $user_id ) { |
|
| 51 | + function wpinv_user_column_content($val, $column_name, $user_id) { |
|
| 52 | 52 | switch ($column_name) { |
| 53 | 53 | case 'wpinvoicing' : |
| 54 | - return $this->get_user_invoices( $user_id ); |
|
| 54 | + return $this->get_user_invoices($user_id); |
|
| 55 | 55 | break; |
| 56 | 56 | default: |
| 57 | 57 | } |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | * |
| 66 | 66 | * @return string |
| 67 | 67 | */ |
| 68 | - public function get_user_invoices($user_id){ |
|
| 68 | + public function get_user_invoices($user_id) { |
|
| 69 | 69 | $output = ''; |
| 70 | 70 | $wp_query_args = array( |
| 71 | 71 | 'post_type' => 'wpi_invoice', |
@@ -77,14 +77,14 @@ discard block |
||
| 77 | 77 | |
| 78 | 78 | $wp_query_args = apply_filters('wpinv_get_user_invoices_args', $wp_query_args, $user_id); |
| 79 | 79 | |
| 80 | - $invoices = new WP_Query( $wp_query_args ); |
|
| 81 | - $count = absint( $invoices->found_posts ); |
|
| 80 | + $invoices = new WP_Query($wp_query_args); |
|
| 81 | + $count = absint($invoices->found_posts); |
|
| 82 | 82 | |
| 83 | - if(empty($count)){ |
|
| 84 | - $output .= __('No Invoice(s)','invoicing'); |
|
| 85 | - }else{ |
|
| 86 | - $link_url = admin_url( "edit.php?post_type=wpi_invoice&author=".absint($user_id) ); |
|
| 87 | - $link_text = sprintf( __('Invoices ( %d )', 'invoicing'), $count ); |
|
| 83 | + if (empty($count)) { |
|
| 84 | + $output .= __('No Invoice(s)', 'invoicing'); |
|
| 85 | + } else { |
|
| 86 | + $link_url = admin_url("edit.php?post_type=wpi_invoice&author=" . absint($user_id)); |
|
| 87 | + $link_text = sprintf(__('Invoices ( %d )', 'invoicing'), $count); |
|
| 88 | 88 | $output .= "<a href='$link_url' >$link_text</a>"; |
| 89 | 89 | } |
| 90 | 90 | |
@@ -15,12 +15,12 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | |
| 17 | 17 | if ( ! defined( 'ABSPATH' ) ) { |
| 18 | - exit; |
|
| 18 | + exit; |
|
| 19 | 19 | } |
| 20 | 20 | |
| 21 | 21 | if ( ! class_exists( 'WP_Super_Duper' ) ) { |
| 22 | - // include the class if needed |
|
| 23 | - include_once( dirname( __FILE__ ) . "/wp-super-duper.php" ); |
|
| 22 | + // include the class if needed |
|
| 23 | + include_once( dirname( __FILE__ ) . "/wp-super-duper.php" ); |
|
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | /* |
@@ -14,21 +14,21 @@ |
||
| 14 | 14 | * Tested up to: 5.3 |
| 15 | 15 | */ |
| 16 | 16 | |
| 17 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 17 | +if (!defined('ABSPATH')) { |
|
| 18 | 18 | exit; |
| 19 | 19 | } |
| 20 | 20 | |
| 21 | -if ( ! class_exists( 'WP_Super_Duper' ) ) { |
|
| 21 | +if (!class_exists('WP_Super_Duper')) { |
|
| 22 | 22 | // include the class if needed |
| 23 | - include_once( dirname( __FILE__ ) . "/wp-super-duper.php" ); |
|
| 23 | + include_once(dirname(__FILE__) . "/wp-super-duper.php"); |
|
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | /* |
| 27 | 27 | * Hello world example. |
| 28 | 28 | */ |
| 29 | -include_once( dirname( __FILE__ ) . "/hello-world.php" ); |
|
| 29 | +include_once(dirname(__FILE__) . "/hello-world.php"); |
|
| 30 | 30 | |
| 31 | 31 | /* |
| 32 | 32 | * Map example. |
| 33 | 33 | */ |
| 34 | -include_once( dirname( __FILE__ ) . "/map.php" ); |
|
| 34 | +include_once(dirname(__FILE__) . "/map.php"); |
|
@@ -3,241 +3,241 @@ |
||
| 3 | 3 | class SD_Map extends WP_Super_Duper { |
| 4 | 4 | |
| 5 | 5 | |
| 6 | - public $arguments; |
|
| 7 | - |
|
| 8 | - /** |
|
| 9 | - * Sets up the widgets name etc |
|
| 10 | - */ |
|
| 11 | - public function __construct() { |
|
| 12 | - |
|
| 13 | - $options = array( |
|
| 14 | - 'textdomain' => 'super-duper', |
|
| 15 | - // textdomain of the plugin/theme (used to prefix the Gutenberg block) |
|
| 16 | - 'block-icon' => 'admin-site', |
|
| 17 | - // Dash icon name for the block: https://developer.wordpress.org/resource/dashicons/#arrow-right |
|
| 18 | - 'block-category' => 'widgets', |
|
| 19 | - // the category for the block, 'common', 'formatting', 'layout', 'widgets', 'embed'. |
|
| 20 | - 'block-keywords' => "['map','super','google']", |
|
| 21 | - // used in the block search, MAX 3 |
|
| 22 | - 'block-output' => array( // the block visual output elements as an array |
|
| 23 | - array( |
|
| 24 | - 'element' => 'p', |
|
| 25 | - 'content' => __('A Google API key is required to use this block, we recommend installing our plugin which makes it easy and sets it globally, or you can set a key in the block settings sidebar: ','super-duper'), |
|
| 26 | - //'element_require' => '"1"=='.get_option( 'rgmk_google_map_api_key', '"0"') ? '"0"' : '"1"', |
|
| 27 | - 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 28 | - ), |
|
| 29 | - array( |
|
| 30 | - 'element' => 'a', |
|
| 31 | - 'content' => __('API KEY for Google Maps','super-duper'), |
|
| 32 | - 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 33 | - 'href' => 'https://wordpress.org/plugins/api-key-for-google-maps/', |
|
| 34 | - ), |
|
| 35 | - array( |
|
| 36 | - 'element' => 'img', |
|
| 37 | - 'class' => '[%className%]', |
|
| 38 | - //'content' => 'Hello: [%after_text%]' // block properties can be added by wrapping them in [%name%] |
|
| 39 | - 'element_require' => '[%type%]=="image"', |
|
| 40 | - 'src' => get_option( 'rgmk_google_map_api_key', false) ? "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=".get_option( 'rgmk_google_map_api_key') : "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=[%api_key%]" |
|
| 41 | - ), |
|
| 42 | - array( |
|
| 43 | - 'element' => 'div', |
|
| 44 | - 'class' => 'sd-map-iframe-cover', |
|
| 45 | - 'style' => '{overflow:"hidden", position:"relative"}', |
|
| 46 | - array( |
|
| 47 | - 'element' => 'iframe', |
|
| 48 | - 'title' => __( 'Placeholderx', 'super-duper' ), |
|
| 49 | - 'class' => '[%className%]', |
|
| 50 | - 'width' => '[%width%]', |
|
| 51 | - 'height' => '[%height%]', |
|
| 52 | - 'frameborder' => '0', |
|
| 53 | - 'allowfullscreen' => 'true', |
|
| 54 | - 'style' => '{border:0}', |
|
| 55 | - 'element_require' => '[%type%]!="image"', |
|
| 56 | - 'src' => get_option( 'rgmk_google_map_api_key', false) ? "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=".get_option( 'rgmk_google_map_api_key') : "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=[%api_key%]" |
|
| 57 | - ), |
|
| 58 | - ), |
|
| 59 | - array( |
|
| 60 | - 'element' => 'style', |
|
| 61 | - 'content' => '.sd-map-iframe-cover:hover:before {background: #4a4a4a88; content: "'.__("Click here, Settings are in the block settings sidebar","super-duper").'";} .sd-map-iframe-cover:before{cursor: pointer; content: ""; width: 100%; height: 100%; position: absolute; top: 0; bottom: 0;padding-top: 33%; text-align: center; color: #fff; font-size: 20px; font-weight: bold;}', |
|
| 62 | - 'element_require' => '[%type%]!="image"', |
|
| 63 | - ), |
|
| 64 | - ), |
|
| 65 | - 'class_name' => __CLASS__, |
|
| 66 | - // The calling class name |
|
| 67 | - 'base_id' => 'sd_map', |
|
| 68 | - // this is used as the widget id and the shortcode id. |
|
| 69 | - 'name' => __( 'Map', 'super-duper' ), |
|
| 70 | - // the name of the widget/block |
|
| 71 | - 'widget_ops' => array( |
|
| 72 | - 'classname' => 'sd-map-class', |
|
| 73 | - // widget class |
|
| 74 | - 'description' => esc_html__( 'This is an example that will take a text parameter and output it after `Hello:`.', 'hello-world' ), |
|
| 75 | - // widget description |
|
| 76 | - ), |
|
| 77 | - 'arguments' => array( // these are the arguments that will be used in the widget, shortcode and block settings. |
|
| 78 | - 'type' => array( |
|
| 79 | - 'title' => __('Map Type:', 'geodirectory'), |
|
| 80 | - 'desc' => __('Select the map type to use.', 'geodirectory'), |
|
| 81 | - 'type' => 'select', |
|
| 82 | - 'options' => array( |
|
| 83 | - "image" => __('Static Image', 'geodirectory'), |
|
| 84 | - "place" => __('Place', 'geodirectory'), |
|
| 6 | + public $arguments; |
|
| 7 | + |
|
| 8 | + /** |
|
| 9 | + * Sets up the widgets name etc |
|
| 10 | + */ |
|
| 11 | + public function __construct() { |
|
| 12 | + |
|
| 13 | + $options = array( |
|
| 14 | + 'textdomain' => 'super-duper', |
|
| 15 | + // textdomain of the plugin/theme (used to prefix the Gutenberg block) |
|
| 16 | + 'block-icon' => 'admin-site', |
|
| 17 | + // Dash icon name for the block: https://developer.wordpress.org/resource/dashicons/#arrow-right |
|
| 18 | + 'block-category' => 'widgets', |
|
| 19 | + // the category for the block, 'common', 'formatting', 'layout', 'widgets', 'embed'. |
|
| 20 | + 'block-keywords' => "['map','super','google']", |
|
| 21 | + // used in the block search, MAX 3 |
|
| 22 | + 'block-output' => array( // the block visual output elements as an array |
|
| 23 | + array( |
|
| 24 | + 'element' => 'p', |
|
| 25 | + 'content' => __('A Google API key is required to use this block, we recommend installing our plugin which makes it easy and sets it globally, or you can set a key in the block settings sidebar: ','super-duper'), |
|
| 26 | + //'element_require' => '"1"=='.get_option( 'rgmk_google_map_api_key', '"0"') ? '"0"' : '"1"', |
|
| 27 | + 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 28 | + ), |
|
| 29 | + array( |
|
| 30 | + 'element' => 'a', |
|
| 31 | + 'content' => __('API KEY for Google Maps','super-duper'), |
|
| 32 | + 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 33 | + 'href' => 'https://wordpress.org/plugins/api-key-for-google-maps/', |
|
| 34 | + ), |
|
| 35 | + array( |
|
| 36 | + 'element' => 'img', |
|
| 37 | + 'class' => '[%className%]', |
|
| 38 | + //'content' => 'Hello: [%after_text%]' // block properties can be added by wrapping them in [%name%] |
|
| 39 | + 'element_require' => '[%type%]=="image"', |
|
| 40 | + 'src' => get_option( 'rgmk_google_map_api_key', false) ? "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=".get_option( 'rgmk_google_map_api_key') : "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=[%api_key%]" |
|
| 41 | + ), |
|
| 42 | + array( |
|
| 43 | + 'element' => 'div', |
|
| 44 | + 'class' => 'sd-map-iframe-cover', |
|
| 45 | + 'style' => '{overflow:"hidden", position:"relative"}', |
|
| 46 | + array( |
|
| 47 | + 'element' => 'iframe', |
|
| 48 | + 'title' => __( 'Placeholderx', 'super-duper' ), |
|
| 49 | + 'class' => '[%className%]', |
|
| 50 | + 'width' => '[%width%]', |
|
| 51 | + 'height' => '[%height%]', |
|
| 52 | + 'frameborder' => '0', |
|
| 53 | + 'allowfullscreen' => 'true', |
|
| 54 | + 'style' => '{border:0}', |
|
| 55 | + 'element_require' => '[%type%]!="image"', |
|
| 56 | + 'src' => get_option( 'rgmk_google_map_api_key', false) ? "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=".get_option( 'rgmk_google_map_api_key') : "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=[%api_key%]" |
|
| 57 | + ), |
|
| 58 | + ), |
|
| 59 | + array( |
|
| 60 | + 'element' => 'style', |
|
| 61 | + 'content' => '.sd-map-iframe-cover:hover:before {background: #4a4a4a88; content: "'.__("Click here, Settings are in the block settings sidebar","super-duper").'";} .sd-map-iframe-cover:before{cursor: pointer; content: ""; width: 100%; height: 100%; position: absolute; top: 0; bottom: 0;padding-top: 33%; text-align: center; color: #fff; font-size: 20px; font-weight: bold;}', |
|
| 62 | + 'element_require' => '[%type%]!="image"', |
|
| 63 | + ), |
|
| 64 | + ), |
|
| 65 | + 'class_name' => __CLASS__, |
|
| 66 | + // The calling class name |
|
| 67 | + 'base_id' => 'sd_map', |
|
| 68 | + // this is used as the widget id and the shortcode id. |
|
| 69 | + 'name' => __( 'Map', 'super-duper' ), |
|
| 70 | + // the name of the widget/block |
|
| 71 | + 'widget_ops' => array( |
|
| 72 | + 'classname' => 'sd-map-class', |
|
| 73 | + // widget class |
|
| 74 | + 'description' => esc_html__( 'This is an example that will take a text parameter and output it after `Hello:`.', 'hello-world' ), |
|
| 75 | + // widget description |
|
| 76 | + ), |
|
| 77 | + 'arguments' => array( // these are the arguments that will be used in the widget, shortcode and block settings. |
|
| 78 | + 'type' => array( |
|
| 79 | + 'title' => __('Map Type:', 'geodirectory'), |
|
| 80 | + 'desc' => __('Select the map type to use.', 'geodirectory'), |
|
| 81 | + 'type' => 'select', |
|
| 82 | + 'options' => array( |
|
| 83 | + "image" => __('Static Image', 'geodirectory'), |
|
| 84 | + "place" => __('Place', 'geodirectory'), |
|
| 85 | 85 | // "directions" => __('Directions', 'geodirectory'), |
| 86 | 86 | // "search" => __('Search', 'geodirectory'), |
| 87 | 87 | // "view" => __('View', 'geodirectory'), |
| 88 | 88 | // "streetview" => __('Streetview', 'geodirectory'), |
| 89 | - ), |
|
| 90 | - 'default' => 'image', |
|
| 91 | - 'desc_tip' => true, |
|
| 92 | - 'advanced' => false |
|
| 93 | - ), |
|
| 94 | - 'location' => array( |
|
| 95 | - 'type' => 'text', |
|
| 96 | - 'title' => __( 'Location:', 'geodirectory' ), |
|
| 97 | - 'desc' => __( 'Enter the location to show on the map, place, city, zip code or GPS.', 'geodirectory' ), |
|
| 98 | - 'placeholder' => 'Place, city, zip code or GPS', |
|
| 99 | - 'desc_tip' => true, |
|
| 100 | - 'default' => 'Ireland', |
|
| 101 | - 'advanced' => false |
|
| 102 | - ), |
|
| 103 | - 'static_width' => array( |
|
| 104 | - 'type' => 'number', |
|
| 105 | - 'title' => __( 'Width:', 'geodirectory' ), |
|
| 106 | - 'desc' => __( 'This is the width of the map, for static maps you can only use px values.', 'geodirectory' ), |
|
| 107 | - 'placeholder' => '600', |
|
| 108 | - 'desc_tip' => true, |
|
| 109 | - 'default' => '600', |
|
| 110 | - 'custom_attributes' => array( |
|
| 111 | - 'max' => '2000', |
|
| 112 | - 'min' => '100', |
|
| 113 | - ), |
|
| 114 | - 'element_require' => '[%type%]=="image"', |
|
| 115 | - 'advanced' => false |
|
| 116 | - ), |
|
| 117 | - 'static_height' => array( |
|
| 118 | - 'type' => 'number', |
|
| 119 | - 'title' => __( 'Height:', 'geodirectory' ), |
|
| 120 | - 'desc' => __( 'This is the height of the map, for static maps you can only use px values.', 'geodirectory' ), |
|
| 121 | - 'placeholder' => '400', |
|
| 122 | - 'desc_tip' => true, |
|
| 123 | - 'default' => '400', |
|
| 124 | - 'custom_attributes' => array( |
|
| 125 | - 'max' => '2000', |
|
| 126 | - 'min' => '100', |
|
| 127 | - 'required' => 'required', |
|
| 128 | - ), |
|
| 129 | - 'element_require' => '[%type%]=="image"', |
|
| 130 | - 'advanced' => false |
|
| 131 | - ), |
|
| 132 | - 'width' => array( |
|
| 133 | - 'type' => 'text', |
|
| 134 | - 'title' => __( 'Width:', 'geodirectory' ), |
|
| 135 | - 'desc' => __( 'This is the width of the map, you can use % or px here.', 'geodirectory' ), |
|
| 136 | - 'placeholder' => '100%', |
|
| 137 | - 'desc_tip' => true, |
|
| 138 | - 'default' => '100%', |
|
| 139 | - 'element_require' => '[%type%]!="image"', |
|
| 140 | - 'advanced' => false |
|
| 141 | - ), |
|
| 142 | - 'height' => array( |
|
| 143 | - 'type' => 'text', |
|
| 144 | - 'title' => __( 'Height:', 'geodirectory' ), |
|
| 145 | - 'desc' => __( 'This is the height of the map, you can use %, px or vh here.', 'geodirectory' ), |
|
| 146 | - 'placeholder' => '425px', |
|
| 147 | - 'desc_tip' => true, |
|
| 148 | - 'default' => '425px', |
|
| 149 | - 'element_require' => '[%type%]!="image"', |
|
| 150 | - 'advanced' => false |
|
| 151 | - ), |
|
| 152 | - 'maptype' => array( |
|
| 153 | - 'type' => 'select', |
|
| 154 | - 'title' => __( 'Mapview:', 'geodirectory' ), |
|
| 155 | - 'desc' => __( 'This is the type of map view that will be used by default.', 'geodirectory' ), |
|
| 156 | - 'options' => array( |
|
| 157 | - "roadmap" => __( 'Road Map', 'geodirectory' ), |
|
| 158 | - "satellite" => __( 'Satellite Map', 'geodirectory' ), |
|
| 89 | + ), |
|
| 90 | + 'default' => 'image', |
|
| 91 | + 'desc_tip' => true, |
|
| 92 | + 'advanced' => false |
|
| 93 | + ), |
|
| 94 | + 'location' => array( |
|
| 95 | + 'type' => 'text', |
|
| 96 | + 'title' => __( 'Location:', 'geodirectory' ), |
|
| 97 | + 'desc' => __( 'Enter the location to show on the map, place, city, zip code or GPS.', 'geodirectory' ), |
|
| 98 | + 'placeholder' => 'Place, city, zip code or GPS', |
|
| 99 | + 'desc_tip' => true, |
|
| 100 | + 'default' => 'Ireland', |
|
| 101 | + 'advanced' => false |
|
| 102 | + ), |
|
| 103 | + 'static_width' => array( |
|
| 104 | + 'type' => 'number', |
|
| 105 | + 'title' => __( 'Width:', 'geodirectory' ), |
|
| 106 | + 'desc' => __( 'This is the width of the map, for static maps you can only use px values.', 'geodirectory' ), |
|
| 107 | + 'placeholder' => '600', |
|
| 108 | + 'desc_tip' => true, |
|
| 109 | + 'default' => '600', |
|
| 110 | + 'custom_attributes' => array( |
|
| 111 | + 'max' => '2000', |
|
| 112 | + 'min' => '100', |
|
| 113 | + ), |
|
| 114 | + 'element_require' => '[%type%]=="image"', |
|
| 115 | + 'advanced' => false |
|
| 116 | + ), |
|
| 117 | + 'static_height' => array( |
|
| 118 | + 'type' => 'number', |
|
| 119 | + 'title' => __( 'Height:', 'geodirectory' ), |
|
| 120 | + 'desc' => __( 'This is the height of the map, for static maps you can only use px values.', 'geodirectory' ), |
|
| 121 | + 'placeholder' => '400', |
|
| 122 | + 'desc_tip' => true, |
|
| 123 | + 'default' => '400', |
|
| 124 | + 'custom_attributes' => array( |
|
| 125 | + 'max' => '2000', |
|
| 126 | + 'min' => '100', |
|
| 127 | + 'required' => 'required', |
|
| 128 | + ), |
|
| 129 | + 'element_require' => '[%type%]=="image"', |
|
| 130 | + 'advanced' => false |
|
| 131 | + ), |
|
| 132 | + 'width' => array( |
|
| 133 | + 'type' => 'text', |
|
| 134 | + 'title' => __( 'Width:', 'geodirectory' ), |
|
| 135 | + 'desc' => __( 'This is the width of the map, you can use % or px here.', 'geodirectory' ), |
|
| 136 | + 'placeholder' => '100%', |
|
| 137 | + 'desc_tip' => true, |
|
| 138 | + 'default' => '100%', |
|
| 139 | + 'element_require' => '[%type%]!="image"', |
|
| 140 | + 'advanced' => false |
|
| 141 | + ), |
|
| 142 | + 'height' => array( |
|
| 143 | + 'type' => 'text', |
|
| 144 | + 'title' => __( 'Height:', 'geodirectory' ), |
|
| 145 | + 'desc' => __( 'This is the height of the map, you can use %, px or vh here.', 'geodirectory' ), |
|
| 146 | + 'placeholder' => '425px', |
|
| 147 | + 'desc_tip' => true, |
|
| 148 | + 'default' => '425px', |
|
| 149 | + 'element_require' => '[%type%]!="image"', |
|
| 150 | + 'advanced' => false |
|
| 151 | + ), |
|
| 152 | + 'maptype' => array( |
|
| 153 | + 'type' => 'select', |
|
| 154 | + 'title' => __( 'Mapview:', 'geodirectory' ), |
|
| 155 | + 'desc' => __( 'This is the type of map view that will be used by default.', 'geodirectory' ), |
|
| 156 | + 'options' => array( |
|
| 157 | + "roadmap" => __( 'Road Map', 'geodirectory' ), |
|
| 158 | + "satellite" => __( 'Satellite Map', 'geodirectory' ), |
|
| 159 | 159 | // "hybrid" => __( 'Hybrid Map', 'geodirectory' ), |
| 160 | 160 | // "terrain" => __( 'Terrain Map', 'geodirectory' ), |
| 161 | - ), |
|
| 162 | - 'desc_tip' => true, |
|
| 163 | - 'default' => 'roadmap', |
|
| 164 | - 'advanced' => true |
|
| 165 | - ), |
|
| 166 | - 'zoom' => array( |
|
| 167 | - 'type' => 'select', |
|
| 168 | - 'title' => __( 'Zoom level:', 'geodirectory' ), |
|
| 169 | - 'desc' => __( 'This is the zoom level of the map, `auto` is recommended.', 'geodirectory' ), |
|
| 170 | - 'options' => range( 1, 19 ), |
|
| 171 | - 'placeholder' => '', |
|
| 172 | - 'desc_tip' => true, |
|
| 173 | - 'default' => '7', |
|
| 174 | - 'advanced' => true |
|
| 175 | - ), |
|
| 176 | - 'api_key' => array( |
|
| 177 | - 'type' => 'text', |
|
| 178 | - 'title' => __( 'Api Key:', 'geodirectory' ), |
|
| 179 | - 'desc' => __( 'This is the height of the map, you can use %, px or vh here.', 'geodirectory' ), |
|
| 180 | - 'placeholder' => '', |
|
| 181 | - 'desc_tip' => true, |
|
| 182 | - 'default' => '', |
|
| 183 | - 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1', |
|
| 184 | - 'advanced' => false |
|
| 185 | - ), |
|
| 186 | - ) |
|
| 187 | - ); |
|
| 188 | - |
|
| 189 | - parent::__construct( $options ); |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * This is the output function for the widget, shortcode and block (front end). |
|
| 195 | - * |
|
| 196 | - * @param array $args The arguments values. |
|
| 197 | - * @param array $widget_args The widget arguments when used. |
|
| 198 | - * @param string $content The shortcode content argument |
|
| 199 | - * |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 203 | - |
|
| 204 | - // options |
|
| 205 | - $defaults = array( |
|
| 206 | - 'type' => 'image', // image, place |
|
| 207 | - 'location' => 'Ireland', |
|
| 208 | - 'static_width' => '600', |
|
| 209 | - 'static_height' => '400', |
|
| 210 | - 'width'=> '100%', |
|
| 211 | - 'height'=> '425px', |
|
| 212 | - 'maptype' => 'roadmap', |
|
| 213 | - 'zoom' => '7', |
|
| 214 | - 'api_key' => 'AIzaSyBK3ZcmK0ljxl5agNyJNQh_G24Thq1btuE', |
|
| 215 | - ); |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 219 | - */ |
|
| 220 | - $args = wp_parse_args($args, $defaults ); |
|
| 221 | - |
|
| 222 | - $output = ''; |
|
| 223 | - |
|
| 224 | - |
|
| 225 | - // check if we have a global API key |
|
| 226 | - $args['api_key'] = get_option( 'rgmk_google_map_api_key', false ) ? get_option( 'rgmk_google_map_api_key' ) : $args['api_key']; |
|
| 227 | - |
|
| 228 | - if($args['type']=='image'){ |
|
| 229 | - $output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&size=".esc_attr($args['static_width'])."x".esc_attr($args['static_height'])."&key=".esc_attr($args['api_key'])."' />"; |
|
| 230 | - }else{ |
|
| 231 | - $output .= "<iframe width='".esc_attr($args['width'])."' height='".esc_attr($args['height'])."' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/".esc_attr($args['type'])."?q=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&key=".esc_attr($args['api_key'])."' ></iframe> "; |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - return $output; |
|
| 235 | - |
|
| 236 | - } |
|
| 161 | + ), |
|
| 162 | + 'desc_tip' => true, |
|
| 163 | + 'default' => 'roadmap', |
|
| 164 | + 'advanced' => true |
|
| 165 | + ), |
|
| 166 | + 'zoom' => array( |
|
| 167 | + 'type' => 'select', |
|
| 168 | + 'title' => __( 'Zoom level:', 'geodirectory' ), |
|
| 169 | + 'desc' => __( 'This is the zoom level of the map, `auto` is recommended.', 'geodirectory' ), |
|
| 170 | + 'options' => range( 1, 19 ), |
|
| 171 | + 'placeholder' => '', |
|
| 172 | + 'desc_tip' => true, |
|
| 173 | + 'default' => '7', |
|
| 174 | + 'advanced' => true |
|
| 175 | + ), |
|
| 176 | + 'api_key' => array( |
|
| 177 | + 'type' => 'text', |
|
| 178 | + 'title' => __( 'Api Key:', 'geodirectory' ), |
|
| 179 | + 'desc' => __( 'This is the height of the map, you can use %, px or vh here.', 'geodirectory' ), |
|
| 180 | + 'placeholder' => '', |
|
| 181 | + 'desc_tip' => true, |
|
| 182 | + 'default' => '', |
|
| 183 | + 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1', |
|
| 184 | + 'advanced' => false |
|
| 185 | + ), |
|
| 186 | + ) |
|
| 187 | + ); |
|
| 188 | + |
|
| 189 | + parent::__construct( $options ); |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * This is the output function for the widget, shortcode and block (front end). |
|
| 195 | + * |
|
| 196 | + * @param array $args The arguments values. |
|
| 197 | + * @param array $widget_args The widget arguments when used. |
|
| 198 | + * @param string $content The shortcode content argument |
|
| 199 | + * |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 203 | + |
|
| 204 | + // options |
|
| 205 | + $defaults = array( |
|
| 206 | + 'type' => 'image', // image, place |
|
| 207 | + 'location' => 'Ireland', |
|
| 208 | + 'static_width' => '600', |
|
| 209 | + 'static_height' => '400', |
|
| 210 | + 'width'=> '100%', |
|
| 211 | + 'height'=> '425px', |
|
| 212 | + 'maptype' => 'roadmap', |
|
| 213 | + 'zoom' => '7', |
|
| 214 | + 'api_key' => 'AIzaSyBK3ZcmK0ljxl5agNyJNQh_G24Thq1btuE', |
|
| 215 | + ); |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 219 | + */ |
|
| 220 | + $args = wp_parse_args($args, $defaults ); |
|
| 221 | + |
|
| 222 | + $output = ''; |
|
| 223 | + |
|
| 224 | + |
|
| 225 | + // check if we have a global API key |
|
| 226 | + $args['api_key'] = get_option( 'rgmk_google_map_api_key', false ) ? get_option( 'rgmk_google_map_api_key' ) : $args['api_key']; |
|
| 227 | + |
|
| 228 | + if($args['type']=='image'){ |
|
| 229 | + $output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&size=".esc_attr($args['static_width'])."x".esc_attr($args['static_height'])."&key=".esc_attr($args['api_key'])."' />"; |
|
| 230 | + }else{ |
|
| 231 | + $output .= "<iframe width='".esc_attr($args['width'])."' height='".esc_attr($args['height'])."' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/".esc_attr($args['type'])."?q=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&key=".esc_attr($args['api_key'])."' ></iframe> "; |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + return $output; |
|
| 235 | + |
|
| 236 | + } |
|
| 237 | 237 | |
| 238 | 238 | } |
| 239 | 239 | |
| 240 | 240 | // register it. |
| 241 | 241 | add_action( 'widgets_init', function () { |
| 242 | - register_widget( 'SD_Map' ); |
|
| 242 | + register_widget( 'SD_Map' ); |
|
| 243 | 243 | } ); |
@@ -22,14 +22,14 @@ discard block |
||
| 22 | 22 | 'block-output' => array( // the block visual output elements as an array |
| 23 | 23 | array( |
| 24 | 24 | 'element' => 'p', |
| 25 | - 'content' => __('A Google API key is required to use this block, we recommend installing our plugin which makes it easy and sets it globally, or you can set a key in the block settings sidebar: ','super-duper'), |
|
| 25 | + 'content' => __('A Google API key is required to use this block, we recommend installing our plugin which makes it easy and sets it globally, or you can set a key in the block settings sidebar: ', 'super-duper'), |
|
| 26 | 26 | //'element_require' => '"1"=='.get_option( 'rgmk_google_map_api_key', '"0"') ? '"0"' : '"1"', |
| 27 | - 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 27 | + 'element_require' => get_option('rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 28 | 28 | ), |
| 29 | 29 | array( |
| 30 | 30 | 'element' => 'a', |
| 31 | - 'content' => __('API KEY for Google Maps','super-duper'), |
|
| 32 | - 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 31 | + 'content' => __('API KEY for Google Maps', 'super-duper'), |
|
| 32 | + 'element_require' => get_option('rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""', |
|
| 33 | 33 | 'href' => 'https://wordpress.org/plugins/api-key-for-google-maps/', |
| 34 | 34 | ), |
| 35 | 35 | array( |
@@ -37,7 +37,7 @@ discard block |
||
| 37 | 37 | 'class' => '[%className%]', |
| 38 | 38 | //'content' => 'Hello: [%after_text%]' // block properties can be added by wrapping them in [%name%] |
| 39 | 39 | 'element_require' => '[%type%]=="image"', |
| 40 | - 'src' => get_option( 'rgmk_google_map_api_key', false) ? "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=".get_option( 'rgmk_google_map_api_key') : "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=[%api_key%]" |
|
| 40 | + 'src' => get_option('rgmk_google_map_api_key', false) ? "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=" . get_option('rgmk_google_map_api_key') : "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=[%api_key%]" |
|
| 41 | 41 | ), |
| 42 | 42 | array( |
| 43 | 43 | 'element' => 'div', |
@@ -45,7 +45,7 @@ discard block |
||
| 45 | 45 | 'style' => '{overflow:"hidden", position:"relative"}', |
| 46 | 46 | array( |
| 47 | 47 | 'element' => 'iframe', |
| 48 | - 'title' => __( 'Placeholderx', 'super-duper' ), |
|
| 48 | + 'title' => __('Placeholderx', 'super-duper'), |
|
| 49 | 49 | 'class' => '[%className%]', |
| 50 | 50 | 'width' => '[%width%]', |
| 51 | 51 | 'height' => '[%height%]', |
@@ -53,12 +53,12 @@ discard block |
||
| 53 | 53 | 'allowfullscreen' => 'true', |
| 54 | 54 | 'style' => '{border:0}', |
| 55 | 55 | 'element_require' => '[%type%]!="image"', |
| 56 | - 'src' => get_option( 'rgmk_google_map_api_key', false) ? "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=".get_option( 'rgmk_google_map_api_key') : "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=[%api_key%]" |
|
| 56 | + 'src' => get_option('rgmk_google_map_api_key', false) ? "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=" . get_option('rgmk_google_map_api_key') : "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=[%api_key%]" |
|
| 57 | 57 | ), |
| 58 | 58 | ), |
| 59 | 59 | array( |
| 60 | 60 | 'element' => 'style', |
| 61 | - 'content' => '.sd-map-iframe-cover:hover:before {background: #4a4a4a88; content: "'.__("Click here, Settings are in the block settings sidebar","super-duper").'";} .sd-map-iframe-cover:before{cursor: pointer; content: ""; width: 100%; height: 100%; position: absolute; top: 0; bottom: 0;padding-top: 33%; text-align: center; color: #fff; font-size: 20px; font-weight: bold;}', |
|
| 61 | + 'content' => '.sd-map-iframe-cover:hover:before {background: #4a4a4a88; content: "' . __("Click here, Settings are in the block settings sidebar", "super-duper") . '";} .sd-map-iframe-cover:before{cursor: pointer; content: ""; width: 100%; height: 100%; position: absolute; top: 0; bottom: 0;padding-top: 33%; text-align: center; color: #fff; font-size: 20px; font-weight: bold;}', |
|
| 62 | 62 | 'element_require' => '[%type%]!="image"', |
| 63 | 63 | ), |
| 64 | 64 | ), |
@@ -66,12 +66,12 @@ discard block |
||
| 66 | 66 | // The calling class name |
| 67 | 67 | 'base_id' => 'sd_map', |
| 68 | 68 | // this is used as the widget id and the shortcode id. |
| 69 | - 'name' => __( 'Map', 'super-duper' ), |
|
| 69 | + 'name' => __('Map', 'super-duper'), |
|
| 70 | 70 | // the name of the widget/block |
| 71 | 71 | 'widget_ops' => array( |
| 72 | 72 | 'classname' => 'sd-map-class', |
| 73 | 73 | // widget class |
| 74 | - 'description' => esc_html__( 'This is an example that will take a text parameter and output it after `Hello:`.', 'hello-world' ), |
|
| 74 | + 'description' => esc_html__('This is an example that will take a text parameter and output it after `Hello:`.', 'hello-world'), |
|
| 75 | 75 | // widget description |
| 76 | 76 | ), |
| 77 | 77 | 'arguments' => array( // these are the arguments that will be used in the widget, shortcode and block settings. |
@@ -93,8 +93,8 @@ discard block |
||
| 93 | 93 | ), |
| 94 | 94 | 'location' => array( |
| 95 | 95 | 'type' => 'text', |
| 96 | - 'title' => __( 'Location:', 'geodirectory' ), |
|
| 97 | - 'desc' => __( 'Enter the location to show on the map, place, city, zip code or GPS.', 'geodirectory' ), |
|
| 96 | + 'title' => __('Location:', 'geodirectory'), |
|
| 97 | + 'desc' => __('Enter the location to show on the map, place, city, zip code or GPS.', 'geodirectory'), |
|
| 98 | 98 | 'placeholder' => 'Place, city, zip code or GPS', |
| 99 | 99 | 'desc_tip' => true, |
| 100 | 100 | 'default' => 'Ireland', |
@@ -102,8 +102,8 @@ discard block |
||
| 102 | 102 | ), |
| 103 | 103 | 'static_width' => array( |
| 104 | 104 | 'type' => 'number', |
| 105 | - 'title' => __( 'Width:', 'geodirectory' ), |
|
| 106 | - 'desc' => __( 'This is the width of the map, for static maps you can only use px values.', 'geodirectory' ), |
|
| 105 | + 'title' => __('Width:', 'geodirectory'), |
|
| 106 | + 'desc' => __('This is the width of the map, for static maps you can only use px values.', 'geodirectory'), |
|
| 107 | 107 | 'placeholder' => '600', |
| 108 | 108 | 'desc_tip' => true, |
| 109 | 109 | 'default' => '600', |
@@ -116,8 +116,8 @@ discard block |
||
| 116 | 116 | ), |
| 117 | 117 | 'static_height' => array( |
| 118 | 118 | 'type' => 'number', |
| 119 | - 'title' => __( 'Height:', 'geodirectory' ), |
|
| 120 | - 'desc' => __( 'This is the height of the map, for static maps you can only use px values.', 'geodirectory' ), |
|
| 119 | + 'title' => __('Height:', 'geodirectory'), |
|
| 120 | + 'desc' => __('This is the height of the map, for static maps you can only use px values.', 'geodirectory'), |
|
| 121 | 121 | 'placeholder' => '400', |
| 122 | 122 | 'desc_tip' => true, |
| 123 | 123 | 'default' => '400', |
@@ -131,8 +131,8 @@ discard block |
||
| 131 | 131 | ), |
| 132 | 132 | 'width' => array( |
| 133 | 133 | 'type' => 'text', |
| 134 | - 'title' => __( 'Width:', 'geodirectory' ), |
|
| 135 | - 'desc' => __( 'This is the width of the map, you can use % or px here.', 'geodirectory' ), |
|
| 134 | + 'title' => __('Width:', 'geodirectory'), |
|
| 135 | + 'desc' => __('This is the width of the map, you can use % or px here.', 'geodirectory'), |
|
| 136 | 136 | 'placeholder' => '100%', |
| 137 | 137 | 'desc_tip' => true, |
| 138 | 138 | 'default' => '100%', |
@@ -141,8 +141,8 @@ discard block |
||
| 141 | 141 | ), |
| 142 | 142 | 'height' => array( |
| 143 | 143 | 'type' => 'text', |
| 144 | - 'title' => __( 'Height:', 'geodirectory' ), |
|
| 145 | - 'desc' => __( 'This is the height of the map, you can use %, px or vh here.', 'geodirectory' ), |
|
| 144 | + 'title' => __('Height:', 'geodirectory'), |
|
| 145 | + 'desc' => __('This is the height of the map, you can use %, px or vh here.', 'geodirectory'), |
|
| 146 | 146 | 'placeholder' => '425px', |
| 147 | 147 | 'desc_tip' => true, |
| 148 | 148 | 'default' => '425px', |
@@ -151,11 +151,11 @@ discard block |
||
| 151 | 151 | ), |
| 152 | 152 | 'maptype' => array( |
| 153 | 153 | 'type' => 'select', |
| 154 | - 'title' => __( 'Mapview:', 'geodirectory' ), |
|
| 155 | - 'desc' => __( 'This is the type of map view that will be used by default.', 'geodirectory' ), |
|
| 154 | + 'title' => __('Mapview:', 'geodirectory'), |
|
| 155 | + 'desc' => __('This is the type of map view that will be used by default.', 'geodirectory'), |
|
| 156 | 156 | 'options' => array( |
| 157 | - "roadmap" => __( 'Road Map', 'geodirectory' ), |
|
| 158 | - "satellite" => __( 'Satellite Map', 'geodirectory' ), |
|
| 157 | + "roadmap" => __('Road Map', 'geodirectory'), |
|
| 158 | + "satellite" => __('Satellite Map', 'geodirectory'), |
|
| 159 | 159 | // "hybrid" => __( 'Hybrid Map', 'geodirectory' ), |
| 160 | 160 | // "terrain" => __( 'Terrain Map', 'geodirectory' ), |
| 161 | 161 | ), |
@@ -165,9 +165,9 @@ discard block |
||
| 165 | 165 | ), |
| 166 | 166 | 'zoom' => array( |
| 167 | 167 | 'type' => 'select', |
| 168 | - 'title' => __( 'Zoom level:', 'geodirectory' ), |
|
| 169 | - 'desc' => __( 'This is the zoom level of the map, `auto` is recommended.', 'geodirectory' ), |
|
| 170 | - 'options' => range( 1, 19 ), |
|
| 168 | + 'title' => __('Zoom level:', 'geodirectory'), |
|
| 169 | + 'desc' => __('This is the zoom level of the map, `auto` is recommended.', 'geodirectory'), |
|
| 170 | + 'options' => range(1, 19), |
|
| 171 | 171 | 'placeholder' => '', |
| 172 | 172 | 'desc_tip' => true, |
| 173 | 173 | 'default' => '7', |
@@ -175,18 +175,18 @@ discard block |
||
| 175 | 175 | ), |
| 176 | 176 | 'api_key' => array( |
| 177 | 177 | 'type' => 'text', |
| 178 | - 'title' => __( 'Api Key:', 'geodirectory' ), |
|
| 179 | - 'desc' => __( 'This is the height of the map, you can use %, px or vh here.', 'geodirectory' ), |
|
| 178 | + 'title' => __('Api Key:', 'geodirectory'), |
|
| 179 | + 'desc' => __('This is the height of the map, you can use %, px or vh here.', 'geodirectory'), |
|
| 180 | 180 | 'placeholder' => '', |
| 181 | 181 | 'desc_tip' => true, |
| 182 | 182 | 'default' => '', |
| 183 | - 'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1', |
|
| 183 | + 'element_require' => get_option('rgmk_google_map_api_key', false) ? '1==0' : '1==1', |
|
| 184 | 184 | 'advanced' => false |
| 185 | 185 | ), |
| 186 | 186 | ) |
| 187 | 187 | ); |
| 188 | 188 | |
| 189 | - parent::__construct( $options ); |
|
| 189 | + parent::__construct($options); |
|
| 190 | 190 | } |
| 191 | 191 | |
| 192 | 192 | |
@@ -199,7 +199,7 @@ discard block |
||
| 199 | 199 | * |
| 200 | 200 | * @return string |
| 201 | 201 | */ |
| 202 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 202 | + public function output($args = array(), $widget_args = array(), $content = '') { |
|
| 203 | 203 | |
| 204 | 204 | // options |
| 205 | 205 | $defaults = array( |
@@ -217,18 +217,18 @@ discard block |
||
| 217 | 217 | /** |
| 218 | 218 | * Parse incoming $args into an array and merge it with $defaults |
| 219 | 219 | */ |
| 220 | - $args = wp_parse_args($args, $defaults ); |
|
| 220 | + $args = wp_parse_args($args, $defaults); |
|
| 221 | 221 | |
| 222 | 222 | $output = ''; |
| 223 | 223 | |
| 224 | 224 | |
| 225 | 225 | // check if we have a global API key |
| 226 | - $args['api_key'] = get_option( 'rgmk_google_map_api_key', false ) ? get_option( 'rgmk_google_map_api_key' ) : $args['api_key']; |
|
| 226 | + $args['api_key'] = get_option('rgmk_google_map_api_key', false) ? get_option('rgmk_google_map_api_key') : $args['api_key']; |
|
| 227 | 227 | |
| 228 | - if($args['type']=='image'){ |
|
| 229 | - $output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&size=".esc_attr($args['static_width'])."x".esc_attr($args['static_height'])."&key=".esc_attr($args['api_key'])."' />"; |
|
| 230 | - }else{ |
|
| 231 | - $output .= "<iframe width='".esc_attr($args['width'])."' height='".esc_attr($args['height'])."' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/".esc_attr($args['type'])."?q=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&key=".esc_attr($args['api_key'])."' ></iframe> "; |
|
| 228 | + if ($args['type'] == 'image') { |
|
| 229 | + $output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=" . esc_attr($args['location']) . "&maptype=" . esc_attr($args['maptype']) . "&zoom=" . esc_attr($args['zoom']) . "&size=" . esc_attr($args['static_width']) . "x" . esc_attr($args['static_height']) . "&key=" . esc_attr($args['api_key']) . "' />"; |
|
| 230 | + } else { |
|
| 231 | + $output .= "<iframe width='" . esc_attr($args['width']) . "' height='" . esc_attr($args['height']) . "' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/" . esc_attr($args['type']) . "?q=" . esc_attr($args['location']) . "&maptype=" . esc_attr($args['maptype']) . "&zoom=" . esc_attr($args['zoom']) . "&key=" . esc_attr($args['api_key']) . "' ></iframe> "; |
|
| 232 | 232 | } |
| 233 | 233 | |
| 234 | 234 | return $output; |
@@ -238,6 +238,6 @@ discard block |
||
| 238 | 238 | } |
| 239 | 239 | |
| 240 | 240 | // register it. |
| 241 | -add_action( 'widgets_init', function () { |
|
| 242 | - register_widget( 'SD_Map' ); |
|
| 241 | +add_action('widgets_init', function() { |
|
| 242 | + register_widget('SD_Map'); |
|
| 243 | 243 | } ); |
@@ -227,7 +227,7 @@ |
||
| 227 | 227 | |
| 228 | 228 | if($args['type']=='image'){ |
| 229 | 229 | $output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&size=".esc_attr($args['static_width'])."x".esc_attr($args['static_height'])."&key=".esc_attr($args['api_key'])."' />"; |
| 230 | - }else{ |
|
| 230 | + } else{ |
|
| 231 | 231 | $output .= "<iframe width='".esc_attr($args['width'])."' height='".esc_attr($args['height'])."' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/".esc_attr($args['type'])."?q=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&key=".esc_attr($args['api_key'])."' ></iframe> "; |
| 232 | 232 | } |
| 233 | 233 | |
