Date: Thu, 22 Mar 2018 14:54:16 -0300
Subject: [PATCH 11/21] Fixed includes/class-wc-emails.php PHPCS violations
---
includes/class-wc-emails.php | 295 +++++++++++++++++++++--------------
1 file changed, 177 insertions(+), 118 deletions(-)
diff --git a/includes/class-wc-emails.php b/includes/class-wc-emails.php
index 0ebf746b5c5..b1ef004ed9e 100644
--- a/includes/class-wc-emails.php
+++ b/includes/class-wc-emails.php
@@ -1,32 +1,40 @@
push_to_queue( array(
- 'filter' => current_filter(),
- 'args' => func_get_args(),
- ) );
+ self::$background_emailer->push_to_queue(
+ array(
+ 'filter' => current_filter(),
+ 'args' => func_get_args(),
+ )
+ );
} else {
call_user_func_array( array( __CLASS__, 'send_transactional_email' ), func_get_args() );
}
@@ -150,19 +162,18 @@ class WC_Emails {
do_action_ref_array( current_filter() . '_notification', $args );
} catch ( Exception $e ) {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
- trigger_error( 'Transactional email triggered fatal error for callback ' . current_filter(), E_USER_WARNING );
+ trigger_error( 'Transactional email triggered fatal error for callback ' . current_filter(), E_USER_WARNING ); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped, WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
}
}
}
/**
* Constructor for the email class hooks in all emails that can be sent.
- *
*/
public function __construct() {
$this->init();
- // Email Header, Footer and content hooks
+ // Email Header, Footer and content hooks.
add_action( 'woocommerce_email_header', array( $this, 'email_header' ) );
add_action( 'woocommerce_email_footer', array( $this, 'email_footer' ) );
add_action( 'woocommerce_email_order_details', array( $this, 'order_downloads' ), 10, 4 );
@@ -171,16 +182,16 @@ class WC_Emails {
add_action( 'woocommerce_email_customer_details', array( $this, 'customer_details' ), 10, 3 );
add_action( 'woocommerce_email_customer_details', array( $this, 'email_addresses' ), 20, 3 );
- // Hooks for sending emails during store events
+ // Hooks for sending emails during store events.
add_action( 'woocommerce_low_stock_notification', array( $this, 'low_stock' ) );
add_action( 'woocommerce_no_stock_notification', array( $this, 'no_stock' ) );
add_action( 'woocommerce_product_on_backorder_notification', array( $this, 'backorder' ) );
add_action( 'woocommerce_created_customer_notification', array( $this, 'customer_new_account' ), 10, 3 );
// Hook for replacing {site_title} in email-footer.
- add_filter( 'woocommerce_email_footer_text' , array( $this, 'email_footer_replace_site_title' ) );
+ add_filter( 'woocommerce_email_footer_text', array( $this, 'email_footer_replace_site_title' ) );
- // Let 3rd parties unhook the above via this hook
+ // Let 3rd parties unhook the above via this hook.
do_action( 'woocommerce_email', $this );
}
@@ -188,26 +199,26 @@ class WC_Emails {
* Init email classes.
*/
public function init() {
- // Include email classes
- include_once( dirname( __FILE__ ) . '/emails/class-wc-email.php' );
+ // Include email classes.
+ include_once dirname( __FILE__ ) . '/emails/class-wc-email.php';
- $this->emails['WC_Email_New_Order'] = include( 'emails/class-wc-email-new-order.php' );
- $this->emails['WC_Email_Cancelled_Order'] = include( 'emails/class-wc-email-cancelled-order.php' );
- $this->emails['WC_Email_Failed_Order'] = include( 'emails/class-wc-email-failed-order.php' );
- $this->emails['WC_Email_Customer_On_Hold_Order'] = include( 'emails/class-wc-email-customer-on-hold-order.php' );
- $this->emails['WC_Email_Customer_Processing_Order'] = include( 'emails/class-wc-email-customer-processing-order.php' );
- $this->emails['WC_Email_Customer_Completed_Order'] = include( 'emails/class-wc-email-customer-completed-order.php' );
- $this->emails['WC_Email_Customer_Refunded_Order'] = include( 'emails/class-wc-email-customer-refunded-order.php' );
- $this->emails['WC_Email_Customer_Invoice'] = include( 'emails/class-wc-email-customer-invoice.php' );
- $this->emails['WC_Email_Customer_Note'] = include( 'emails/class-wc-email-customer-note.php' );
- $this->emails['WC_Email_Customer_Reset_Password'] = include( 'emails/class-wc-email-customer-reset-password.php' );
- $this->emails['WC_Email_Customer_New_Account'] = include( 'emails/class-wc-email-customer-new-account.php' );
+ $this->emails['WC_Email_New_Order'] = include 'emails/class-wc-email-new-order.php';
+ $this->emails['WC_Email_Cancelled_Order'] = include 'emails/class-wc-email-cancelled-order.php';
+ $this->emails['WC_Email_Failed_Order'] = include 'emails/class-wc-email-failed-order.php';
+ $this->emails['WC_Email_Customer_On_Hold_Order'] = include 'emails/class-wc-email-customer-on-hold-order.php';
+ $this->emails['WC_Email_Customer_Processing_Order'] = include 'emails/class-wc-email-customer-processing-order.php';
+ $this->emails['WC_Email_Customer_Completed_Order'] = include 'emails/class-wc-email-customer-completed-order.php';
+ $this->emails['WC_Email_Customer_Refunded_Order'] = include 'emails/class-wc-email-customer-refunded-order.php';
+ $this->emails['WC_Email_Customer_Invoice'] = include 'emails/class-wc-email-customer-invoice.php';
+ $this->emails['WC_Email_Customer_Note'] = include 'emails/class-wc-email-customer-note.php';
+ $this->emails['WC_Email_Customer_Reset_Password'] = include 'emails/class-wc-email-customer-reset-password.php';
+ $this->emails['WC_Email_Customer_New_Account'] = include 'emails/class-wc-email-customer-new-account.php';
$this->emails = apply_filters( 'woocommerce_email_classes', $this->emails );
- // include css inliner
+ // include css inliner.
if ( ! class_exists( 'Emogrifier' ) && class_exists( 'DOMDocument' ) ) {
- include_once( dirname( __FILE__ ) . '/libraries/class-emogrifier.php' );
+ include_once dirname( __FILE__ ) . '/libraries/class-emogrifier.php';
}
}
@@ -241,7 +252,7 @@ class WC_Emails {
/**
* Get the email header.
*
- * @param mixed $email_heading heading for the email
+ * @param mixed $email_heading Heading for the email.
*/
public function email_header( $email_heading ) {
wc_get_template( 'emails/email-header.php', array( 'email_heading' => $email_heading ) );
@@ -280,7 +291,7 @@ class WC_Emails {
do_action( 'woocommerce_email_header', $email_heading, null );
- echo wpautop( wptexturize( $message ) );
+ echo wpautop( wptexturize( $message ) ); // WPCS: XSS ok.
do_action( 'woocommerce_email_footer', null );
@@ -293,15 +304,15 @@ class WC_Emails {
/**
* Send the email.
*
- * @param mixed $to
- * @param mixed $subject
- * @param mixed $message
- * @param string $headers (default: "Content-Type: text/html\r\n")
- * @param string $attachments (default: "")
+ * @param mixed $to Receiver.
+ * @param mixed $subject Email subject.
+ * @param mixed $message Message.
+ * @param string $headers Email headers (default: "Content-Type: text/html\r\n").
+ * @param string $attachments Attachments (default: "").
* @return bool
*/
- public function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = "" ) {
- // Send
+ public function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = '' ) {
+ // Send.
$email = new WC_Email();
return $email->send( $to, $subject, $message, $headers, $attachments );
}
@@ -309,7 +320,7 @@ class WC_Emails {
/**
* Prepare and send the customer invoice email on demand.
*
- * @param int|WC_Order $order
+ * @param int|WC_Order $order Order instance or ID.
*/
public function customer_invoice( $order ) {
$email = $this->emails['WC_Email_Customer_Invoice'];
@@ -324,9 +335,9 @@ class WC_Emails {
/**
* Customer new account welcome email.
*
- * @param int $customer_id
- * @param array $new_customer_data
- * @param bool $password_generated
+ * @param int $customer_id Customer ID.
+ * @param array $new_customer_data New customer data.
+ * @param bool $password_generated If password is generated.
*/
public function customer_new_account( $customer_id, $new_customer_data = array(), $password_generated = false ) {
if ( ! $customer_id ) {
@@ -342,16 +353,30 @@ class WC_Emails {
/**
* Show the order details table
*
- * @param WC_Order $order
- * @param bool $sent_to_admin
- * @param bool $plain_text
- * @param string $email
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
+ * @param string $email Email address.
*/
public function order_details( $order, $sent_to_admin = false, $plain_text = false, $email = '' ) {
if ( $plain_text ) {
- wc_get_template( 'emails/plain/email-order-details.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email ) );
+ wc_get_template(
+ 'emails/plain/email-order-details.php', array(
+ 'order' => $order,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
} else {
- wc_get_template( 'emails/email-order-details.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email ) );
+ wc_get_template(
+ 'emails/email-order-details.php', array(
+ 'order' => $order,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
}
}
@@ -359,10 +384,10 @@ class WC_Emails {
* Show order downloads in a table.
*
* @since 3.2.0
- * @param WC_Order $order
- * @param bool $sent_to_admin
- * @param bool $plain_text
- * @param string $email
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
+ * @param string $email Email address.
*/
public function order_downloads( $order, $sent_to_admin = false, $plain_text = false, $email = '' ) {
$show_downloads = $order->has_downloadable_item() && $order->is_download_permitted() && ! $sent_to_admin;
@@ -372,25 +397,45 @@ class WC_Emails {
}
$downloads = $order->get_downloadable_items();
- $columns = apply_filters( 'woocommerce_email_downloads_columns', array(
- 'download-product' => __( 'Product', 'woocommerce' ),
- 'download-expires' => __( 'Expires', 'woocommerce' ),
- 'download-file' => __( 'Download', 'woocommerce' ),
- ) );
+ $columns = apply_filters(
+ 'woocommerce_email_downloads_columns', array(
+ 'download-product' => __( 'Product', 'woocommerce' ),
+ 'download-expires' => __( 'Expires', 'woocommerce' ),
+ 'download-file' => __( 'Download', 'woocommerce' ),
+ )
+ );
if ( $plain_text ) {
- wc_get_template( 'emails/plain/email-downloads.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email, 'downloads' => $downloads, 'columns' => $columns ) );
+ wc_get_template(
+ 'emails/plain/email-downloads.php', array(
+ 'order' => $order,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ 'downloads' => $downloads,
+ 'columns' => $columns,
+ )
+ );
} else {
- wc_get_template( 'emails/email-downloads.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email, 'downloads' => $downloads, 'columns' => $columns ) );
+ wc_get_template(
+ 'emails/email-downloads.php', array(
+ 'order' => $order,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ 'downloads' => $downloads,
+ 'columns' => $columns,
+ )
+ );
}
}
/**
* Add order meta to email templates.
*
- * @param mixed $order
- * @param bool $sent_to_admin (default: false)
- * @param bool $plain_text (default: false)
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
*/
public function order_meta( $order, $sent_to_admin = false, $plain_text = false ) {
$fields = apply_filters( 'woocommerce_email_order_meta_fields', array(), $sent_to_admin, $order );
@@ -421,14 +466,14 @@ class WC_Emails {
foreach ( $fields as $field ) {
if ( isset( $field['label'] ) && isset( $field['value'] ) && $field['value'] ) {
- echo $field['label'] . ': ' . $field['value'] . "\n";
+ echo $field['label'] . ': ' . $field['value'] . "\n"; // WPCS: XSS ok.
}
}
} else {
foreach ( $fields as $field ) {
if ( isset( $field['label'] ) && isset( $field['value'] ) && $field['value'] ) {
- echo '' . $field['label'] . ': ' . $field['value'] . '
';
+ echo '' . $field['label'] . ': ' . $field['value'] . '
'; // WPCS: XSS ok.
}
}
}
@@ -437,7 +482,8 @@ class WC_Emails {
/**
* Is customer detail field valid?
- * @param array $field
+ *
+ * @param array $field Field data to check if is valid.
* @return boolean
*/
public function customer_detail_field_is_valid( $field ) {
@@ -449,10 +495,9 @@ class WC_Emails {
*
* In versions prior to 3.2 this was used for notes, phone and email but this data has moved.
*
- * @param WC_Order $order
- * @param bool $sent_to_admin (default: false)
- * @param bool $plain_text (default: false)
- * @return string
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
*/
public function customer_details( $order, $sent_to_admin = false, $plain_text = false ) {
if ( ! is_a( $order, 'WC_Order' ) ) {
@@ -473,23 +518,34 @@ class WC_Emails {
/**
* Get the email addresses.
*
- * @param WC_Order $order
- * @param bool $sent_to_admin
- * @param bool $plain_text
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
*/
public function email_addresses( $order, $sent_to_admin = false, $plain_text = false ) {
if ( ! is_a( $order, 'WC_Order' ) ) {
return;
}
if ( $plain_text ) {
- wc_get_template( 'emails/plain/email-addresses.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin ) );
+ wc_get_template(
+ 'emails/plain/email-addresses.php', array(
+ 'order' => $order,
+ 'sent_to_admin' => $sent_to_admin,
+ )
+ );
} else {
- wc_get_template( 'emails/email-addresses.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin ) );
+ wc_get_template(
+ 'emails/email-addresses.php', array(
+ 'order' => $order,
+ 'sent_to_admin' => $sent_to_admin,
+ )
+ );
}
}
/**
* Get blog name formatted for emails.
+ *
* @return string
*/
private function get_blogname() {
@@ -499,7 +555,7 @@ class WC_Emails {
/**
* Low stock notification email.
*
- * @param WC_Product $product
+ * @param WC_Product $product Product instance.
*/
public function low_stock( $product ) {
if ( 'no' === get_option( 'woocommerce_notify_low_stock', 'yes' ) ) {
@@ -507,8 +563,8 @@ class WC_Emails {
}
$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product low in stock', 'woocommerce' ) );
- /* translators: 1: product name 2: items in stock */
$message = sprintf(
+ /* translators: 1: product name 2: items in stock */
__( '%1$s is low in stock. There are %2$d left.', 'woocommerce' ),
html_entity_decode( strip_tags( $product->get_formatted_name() ), ENT_QUOTES, get_bloginfo( 'charset' ) ),
html_entity_decode( strip_tags( $product->get_stock_quantity() ) )
@@ -526,7 +582,7 @@ class WC_Emails {
/**
* No stock notification email.
*
- * @param WC_Product $product
+ * @param WC_Product $product Product instance.
*/
public function no_stock( $product ) {
if ( 'no' === get_option( 'woocommerce_notify_no_stock', 'yes' ) ) {
@@ -549,14 +605,16 @@ class WC_Emails {
/**
* Backorder notification email.
*
- * @param array $args
+ * @param array $args Arguments.
*/
public function backorder( $args ) {
- $args = wp_parse_args( $args, array(
- 'product' => '',
- 'quantity' => '',
- 'order_id' => '',
- ) );
+ $args = wp_parse_args(
+ $args, array(
+ 'product' => '',
+ 'quantity' => '',
+ 'order_id' => '',
+ )
+ );
$order = wc_get_order( $args['order_id'] );
if (
@@ -569,8 +627,9 @@ class WC_Emails {
}
$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product backorder', 'woocommerce' ) );
+ /* translators: 1: product quantity 2: product name 3: order number */
$message = sprintf( __( '%1$s units of %2$s have been backordered in order #%3$s.', 'woocommerce' ), $args['quantity'], html_entity_decode( strip_tags( $args['product']->get_formatted_name() ), ENT_QUOTES, get_bloginfo( 'charset' ) ), $order->get_order_number() );
-
+
wp_mail(
apply_filters( 'woocommerce_email_recipient_backorder', get_option( 'woocommerce_stock_email_recipient' ), $args ),
apply_filters( 'woocommerce_email_subject_backorder', $subject, $args ),
@@ -587,9 +646,9 @@ class WC_Emails {
* @see WC_Structured_Data::generate_order_data()
*
* @since 2.6.0
- * @param mixed $order
- * @param bool $sent_to_admin (default: false)
- * @param bool $plain_text (default: false)
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
*/
public function order_schema_markup( $order, $sent_to_admin = false, $plain_text = false ) {
wc_deprecated_function( 'WC_Emails::order_schema_markup', '3.0', 'WC_Structured_Data::generate_order_data' );
From 809ca5e0fcf62f10d270bb90efa22b02f2853913 Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:07:06 -0300
Subject: [PATCH 12/21] Fixed includes/class-wc-product-attribute.php PHPCS
violations
---
includes/class-wc-product-attribute.php | 87 ++++++++++++-------------
1 file changed, 43 insertions(+), 44 deletions(-)
diff --git a/includes/class-wc-product-attribute.php b/includes/class-wc-product-attribute.php
index 4dc117dede3..bf68696f171 100644
--- a/includes/class-wc-product-attribute.php
+++ b/includes/class-wc-product-attribute.php
@@ -1,18 +1,19 @@
data, array(
- 'is_visible' => $this->get_visible() ? 1 : 0,
- 'is_variation' => $this->get_variation() ? 1 : 0,
- 'is_taxonomy' => $this->is_taxonomy() ? 1 : 0,
- 'value' => $this->is_taxonomy() ? '' : wc_implode_text_attributes( $this->get_options() ),
- ) );
+ return array_merge(
+ $this->data, array(
+ 'is_visible' => $this->get_visible() ? 1 : 0,
+ 'is_variation' => $this->get_variation() ? 1 : 0,
+ 'is_taxonomy' => $this->is_taxonomy() ? 1 : 0,
+ 'value' => $this->is_taxonomy() ? '' : wc_implode_text_attributes( $this->get_options() ),
+ )
+ );
}
/*
@@ -139,7 +142,7 @@ class WC_Product_Attribute implements ArrayAccess {
/**
* Set ID (this is the attribute ID).
*
- * @param int $value
+ * @param int $value Attribute ID.
*/
public function set_id( $value ) {
$this->data['id'] = absint( $value );
@@ -148,7 +151,7 @@ class WC_Product_Attribute implements ArrayAccess {
/**
* Set name (this is the attribute name or taxonomy).
*
- * @param int $value
+ * @param int $value Attribute name.
*/
public function set_name( $value ) {
$this->data['name'] = $value;
@@ -157,7 +160,7 @@ class WC_Product_Attribute implements ArrayAccess {
/**
* Set options.
*
- * @param array $value
+ * @param array $value Attribute options.
*/
public function set_options( $value ) {
$this->data['options'] = $value;
@@ -166,7 +169,7 @@ class WC_Product_Attribute implements ArrayAccess {
/**
* Set position.
*
- * @param int $value
+ * @param int $value Attribute position.
*/
public function set_position( $value ) {
$this->data['position'] = absint( $value );
@@ -175,7 +178,7 @@ class WC_Product_Attribute implements ArrayAccess {
/**
* Set if visible.
*
- * @param bool $value
+ * @param bool $value If is visible on Product's additional info tab.
*/
public function set_visible( $value ) {
$this->data['visible'] = wc_string_to_bool( $value );
@@ -184,7 +187,7 @@ class WC_Product_Attribute implements ArrayAccess {
/**
* Set if variation.
*
- * @param bool $value
+ * @param bool $value If is used for variations.
*/
public function set_variation( $value ) {
$this->data['variation'] = wc_string_to_bool( $value );
@@ -257,26 +260,22 @@ class WC_Product_Attribute implements ArrayAccess {
*/
/**
- * offsetGet.
+ * OffsetGet.
*
- * @param string $offset
+ * @param string $offset Offset.
* @return mixed
*/
public function offsetGet( $offset ) {
switch ( $offset ) {
- case 'is_variation' :
+ case 'is_variation':
return $this->get_variation() ? 1 : 0;
- break;
- case 'is_visible' :
+ case 'is_visible':
return $this->get_visible() ? 1 : 0;
- break;
- case 'is_taxonomy' :
+ case 'is_taxonomy':
return $this->is_taxonomy() ? 1 : 0;
- break;
- case 'value' :
+ case 'value':
return $this->is_taxonomy() ? '' : wc_implode_text_attributes( $this->get_options() );
- break;
- default :
+ default:
if ( is_callable( array( $this, "get_$offset" ) ) ) {
return $this->{"get_$offset"}();
}
@@ -286,23 +285,23 @@ class WC_Product_Attribute implements ArrayAccess {
}
/**
- * offsetSet.
+ * OffsetSet.
*
- * @param string $offset
- * @param mixed $value
+ * @param string $offset Offset.
+ * @param mixed $value Value.
*/
public function offsetSet( $offset, $value ) {
switch ( $offset ) {
- case 'is_variation' :
+ case 'is_variation':
$this->set_variation( $value );
break;
- case 'is_visible' :
+ case 'is_visible':
$this->set_visible( $value );
break;
- case 'value' :
+ case 'value':
$this->set_options( $value );
break;
- default :
+ default:
if ( is_callable( array( $this, "set_$offset" ) ) ) {
return $this->{"set_$offset"}( $value );
}
@@ -311,19 +310,19 @@ class WC_Product_Attribute implements ArrayAccess {
}
/**
- * offsetUnset.
+ * OffsetUnset.
*
- * @param string $offset
+ * @param string $offset Offset.
*/
public function offsetUnset( $offset ) {}
/**
- * offsetExists.
+ * OffsetExists.
*
- * @param string $offset
+ * @param string $offset Offset.
* @return bool
*/
public function offsetExists( $offset ) {
- return in_array( $offset, array_merge( array( 'is_variation', 'is_visible', 'is_taxonomy', 'value' ), array_keys( $this->data ) ) );
+ return in_array( $offset, array_merge( array( 'is_variation', 'is_visible', 'is_taxonomy', 'value' ), array_keys( $this->data ) ), true );
}
}
From 475e0c734fc6c90cd9b9ac026633010d310ce62f Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:10:22 -0300
Subject: [PATCH 13/21] Fixed includes/class-wc-product-download.php PHPCS
violations
---
includes/class-wc-product-download.php | 81 ++++++++++++++++----------
1 file changed, 51 insertions(+), 30 deletions(-)
diff --git a/includes/class-wc-product-download.php b/includes/class-wc-product-download.php
index 2dd49f7ee37..d4f3db702f1 100644
--- a/includes/class-wc-product-download.php
+++ b/includes/class-wc-product-download.php
@@ -1,31 +1,34 @@
'',
- 'name' => '',
- 'file' => '',
+ 'id' => '',
+ 'name' => '',
+ 'file' => '',
);
/**
* Returns all data for this object.
+ *
* @return array
*/
public function get_data() {
@@ -34,6 +37,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get allowed mime types.
+ *
* @return array
*/
public function get_allowed_mime_types() {
@@ -42,6 +46,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get type of file path set.
+ *
* @param string $file_path optional.
* @return string absolute, relative, or shortcode.
*/
@@ -58,6 +63,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get file type.
+ *
* @return string
*/
public function get_file_type() {
@@ -67,26 +73,29 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get file extension.
+ *
* @return string
*/
public function get_file_extension() {
- $parsed_url = parse_url( $this->get_file(), PHP_URL_PATH );
+ $parsed_url = wp_parse_url( $this->get_file(), PHP_URL_PATH );
return pathinfo( $parsed_url, PATHINFO_EXTENSION );
}
/**
* Check if file is allowed.
+ *
* @return boolean
*/
public function is_allowed_filetype() {
if ( 'relative' !== $this->get_type_of_file_path() ) {
return true;
}
- return ! $this->get_file_extension() || in_array( $this->get_file_type(), $this->get_allowed_mime_types() );
+ return ! $this->get_file_extension() || in_array( $this->get_file_type(), $this->get_allowed_mime_types(), true );
}
/**
* Validate file exists.
+ *
* @return boolean
*/
public function file_exists() {
@@ -110,7 +119,8 @@ class WC_Product_Download implements ArrayAccess {
/**
* Set ID.
- * @param string $value
+ *
+ * @param string $value Download ID.
*/
public function set_id( $value ) {
$this->data['id'] = wc_clean( $value );
@@ -118,7 +128,8 @@ class WC_Product_Download implements ArrayAccess {
/**
* Set name.
- * @param string $value
+ *
+ * @param string $value Download name.
*/
public function set_name( $value ) {
$this->data['name'] = wc_clean( $value );
@@ -126,8 +137,9 @@ class WC_Product_Download implements ArrayAccess {
/**
* Set previous_hash.
+ *
* @deprecated 3.3.0 No longer using filename based hashing to keep track of files.
- * @param string $value
+ * @param string $value Previous hash.
*/
public function set_previous_hash( $value ) {
wc_deprecated_function( __FUNCTION__, '3.3' );
@@ -136,11 +148,12 @@ class WC_Product_Download implements ArrayAccess {
/**
* Set file.
- * @param string $value
+ *
+ * @param string $value File.
*/
public function set_file( $value ) {
switch ( $this->get_type_of_file_path( $value ) ) {
- case 'absolute' :
+ case 'absolute':
$this->data['file'] = esc_url_raw( $value );
break;
default:
@@ -157,6 +170,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get id.
+ *
* @return string
*/
public function get_id() {
@@ -165,6 +179,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get name.
+ *
* @return string
*/
public function get_name() {
@@ -173,6 +188,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get previous_hash.
+ *
* @deprecated 3.3.0 No longer using filename based hashing to keep track of files.
* @return string
*/
@@ -183,6 +199,7 @@ class WC_Product_Download implements ArrayAccess {
/**
* Get file.
+ *
* @return string
*/
public function get_file() {
@@ -196,13 +213,14 @@ class WC_Product_Download implements ArrayAccess {
*/
/**
- * offsetGet
- * @param string $offset
+ * OffsetGet.
+ *
+ * @param string $offset Offset.
* @return mixed
*/
public function offsetGet( $offset ) {
switch ( $offset ) {
- default :
+ default:
if ( is_callable( array( $this, "get_$offset" ) ) ) {
return $this->{"get_$offset"}();
}
@@ -212,13 +230,14 @@ class WC_Product_Download implements ArrayAccess {
}
/**
- * offsetSet
- * @param string $offset
- * @param mixed $value
+ * OffsetSet.
+ *
+ * @param string $offset Offset.
+ * @param mixed $value Value.
*/
public function offsetSet( $offset, $value ) {
switch ( $offset ) {
- default :
+ default:
if ( is_callable( array( $this, "set_$offset" ) ) ) {
return $this->{"set_$offset"}( $value );
}
@@ -227,17 +246,19 @@ class WC_Product_Download implements ArrayAccess {
}
/**
- * offsetUnset
- * @param string $offset
+ * OffsetUnset.
+ *
+ * @param string $offset Offset.
*/
public function offsetUnset( $offset ) {}
/**
- * offsetExists
- * @param string $offset
+ * OffsetExists.
+ *
+ * @param string $offset Offset.
* @return bool
*/
public function offsetExists( $offset ) {
- return in_array( $offset, array_keys( $this->data ) );
+ return in_array( $offset, array_keys( $this->data ), true );
}
}
From 6eada732b88f34bc37669eca6c9b66010c8d5611 Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:26:09 -0300
Subject: [PATCH 14/21] Fixed includes/class-wc-product-external.php PHPCS
violations
---
includes/class-wc-product-external.php | 28 +++++++++++++-------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/includes/class-wc-product-external.php b/includes/class-wc-product-external.php
index 114059d9907..6083f89584f 100644
--- a/includes/class-wc-product-external.php
+++ b/includes/class-wc-product-external.php
@@ -1,18 +1,17 @@
set_prop( 'manage_stock', false );
@@ -111,7 +111,7 @@ class WC_Product_External extends WC_Product {
*
* @since 3.0.0
*
- * @param string $stock_status
+ * @param string $stock_status Stock status.
*/
public function set_stock_status( $stock_status = '' ) {
$this->set_prop( 'stock_status', 'instock' );
From 73a56469ef4285d7a903971ceafd3d032754b5a6 Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:36:07 -0300
Subject: [PATCH 15/21] Fixed includes/class-wc-product-factory.php PHPCS
violations
---
includes/class-wc-product-factory.php | 38 +++++++++++++--------------
1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/includes/class-wc-product-factory.php b/includes/class-wc-product-factory.php
index 8626900b0f0..7b60c6eae2f 100644
--- a/includes/class-wc-product-factory.php
+++ b/includes/class-wc-product-factory.php
@@ -1,31 +1,31 @@
get_product_id( $product_id ) ) {
+ $product_id = $this->get_product_id( $product_id );
+
+ if ( ! $product_id ) {
return false;
}
@@ -53,8 +53,8 @@ class WC_Product_Factory {
* Gets a product classname and allows filtering. Returns WC_Product_Simple if the class does not exist.
*
* @since 3.0.0
- * @param int $product_id
- * @param string $product_type
+ * @param int $product_id Product ID.
+ * @param string $product_type Product type.
* @return string
*/
public static function get_product_classname( $product_id, $product_type ) {
@@ -71,7 +71,7 @@ class WC_Product_Factory {
* Get the product type for a product.
*
* @since 3.0.0
- * @param int $product_id
+ * @param int $product_id Product ID.
* @return string|false
*/
public static function get_product_type( $product_id ) {
@@ -87,7 +87,7 @@ class WC_Product_Factory {
/**
* Create a WC coding standards compliant class name e.g. WC_Product_Type_Class instead of WC_Product_type-class.
*
- * @param string $product_type
+ * @param string $product_type Product type.
* @return string|false
*/
public static function get_classname_from_product_type( $product_type ) {
@@ -97,8 +97,8 @@ class WC_Product_Factory {
/**
* Get the product ID depending on what was passed.
*
- * @since 3.0.0
- * @param mixed $product
+ * @since 3.0.0
+ * @param WC_Product|WP_Post|int|bool $product Product instance, post instance, numeric or false to use global $post.
* @return int|bool false on failure
*/
private function get_product_id( $product ) {
From dfeb867a04d862d3203591d5db28f257b351cffb Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:37:29 -0300
Subject: [PATCH 16/21] Fixed includes/class-wc-product-grouped.php PHPCS
violations
---
includes/class-wc-product-grouped.php | 25 +++++++++----------------
1 file changed, 9 insertions(+), 16 deletions(-)
diff --git a/includes/class-wc-product-grouped.php b/includes/class-wc-product-grouped.php
index cf350f2d8c3..80b11b3dd7a 100644
--- a/includes/class-wc-product-grouped.php
+++ b/includes/class-wc-product-grouped.php
@@ -1,22 +1,17 @@
Date: Thu, 22 Mar 2018 15:41:53 -0300
Subject: [PATCH 17/21] Fixed includes/class-wc-product-query.php PHPCS
violations
---
includes/class-wc-product-query.php | 92 +++++++++++++++--------------
1 file changed, 48 insertions(+), 44 deletions(-)
diff --git a/includes/class-wc-product-query.php b/includes/class-wc-product-query.php
index 59244506cbe..d6780241cb0 100644
--- a/includes/class-wc-product-query.php
+++ b/includes/class-wc-product-query.php
@@ -1,73 +1,77 @@
array( 'draft', 'pending', 'private', 'publish' ),
- 'type' => array_merge( array_keys( wc_get_product_types() ) ),
- 'limit' => get_option( 'posts_per_page' ),
- 'include' => array(),
- 'date_created' => '',
- 'date_modified' => '',
- 'featured' => '',
- 'visibility' => '',
- 'sku' => '',
- 'price' => '',
- 'regular_price' => '',
- 'sale_price' => '',
- 'date_on_sale_from' => '',
- 'date_on_sale_to' => '',
- 'total_sales' => '',
- 'tax_status' => '',
- 'tax_class' => '',
- 'manage_stock' => '',
- 'stock_quantity' => '',
- 'stock_status' => '',
- 'backorders' => '',
- 'sold_individually' => '',
- 'weight' => '',
- 'length' => '',
- 'width' => '',
- 'height' => '',
- 'reviews_allowed' => '',
- 'virtual' => '',
- 'downloadable' => '',
- 'category' => array(),
- 'tag' => array(),
- 'shipping_class' => array(),
- 'download_limit' => '',
- 'download_expiry' => '',
- 'average_rating' => '',
- 'review_count' => '',
+ 'status' => array( 'draft', 'pending', 'private', 'publish' ),
+ 'type' => array_merge( array_keys( wc_get_product_types() ) ),
+ 'limit' => get_option( 'posts_per_page' ),
+ 'include' => array(),
+ 'date_created' => '',
+ 'date_modified' => '',
+ 'featured' => '',
+ 'visibility' => '',
+ 'sku' => '',
+ 'price' => '',
+ 'regular_price' => '',
+ 'sale_price' => '',
+ 'date_on_sale_from' => '',
+ 'date_on_sale_to' => '',
+ 'total_sales' => '',
+ 'tax_status' => '',
+ 'tax_class' => '',
+ 'manage_stock' => '',
+ 'stock_quantity' => '',
+ 'stock_status' => '',
+ 'backorders' => '',
+ 'sold_individually' => '',
+ 'weight' => '',
+ 'length' => '',
+ 'width' => '',
+ 'height' => '',
+ 'reviews_allowed' => '',
+ 'virtual' => '',
+ 'downloadable' => '',
+ 'category' => array(),
+ 'tag' => array(),
+ 'shipping_class' => array(),
+ 'download_limit' => '',
+ 'download_expiry' => '',
+ 'average_rating' => '',
+ 'review_count' => '',
)
);
}
/**
* Get products matching the current query vars.
+ *
* @return array|object of WC_Product objects
*/
public function get_products() {
- $args = apply_filters( 'woocommerce_product_object_query_args', $this->get_query_vars() );
+ $args = apply_filters( 'woocommerce_product_object_query_args', $this->get_query_vars() );
$results = WC_Data_Store::load( 'product' )->query( $args );
return apply_filters( 'woocommerce_product_object_query', $results, $args );
}
From 8470a691a727cfc46e4fc0f37627bed608c1e43d Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:43:51 -0300
Subject: [PATCH 18/21] Fixed includes/class-wc-product-simple.php PHPCS
violations
---
includes/class-wc-product-simple.php | 21 ++++++++++-----------
1 file changed, 10 insertions(+), 11 deletions(-)
diff --git a/includes/class-wc-product-simple.php b/includes/class-wc-product-simple.php
index 742166d46de..e736b4064c0 100644
--- a/includes/class-wc-product-simple.php
+++ b/includes/class-wc-product-simple.php
@@ -1,33 +1,32 @@
supports[] = 'ajax_add_to_cart';
+ $this->supports[] = 'ajax_add_to_cart';
parent::__construct( $product );
}
/**
* Get internal type.
+ *
* @return string
*/
public function get_type() {
From b2e33b3fb99a8e20041f5f807574d057454ef9e7 Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:47:50 -0300
Subject: [PATCH 19/21] Fixed includes/class-wc-product-variable.php PHPCS
violations
---
includes/class-wc-product-variable.php | 148 ++++++++++++-------------
1 file changed, 69 insertions(+), 79 deletions(-)
diff --git a/includes/class-wc-product-variable.php b/includes/class-wc-product-variable.php
index 4123c5d876b..c737207b5ad 100644
--- a/includes/class-wc-product-variable.php
+++ b/includes/class-wc-product-variable.php
@@ -1,17 +1,17 @@
get_children() as $child_id ) {
$variation = wc_get_product( $child_id );
- // Hide out of stock variations if 'Hide out of stock items from the catalog' is checked
+ // Hide out of stock variations if 'Hide out of stock items from the catalog' is checked.
if ( ! $variation || ! $variation->exists() || ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) && ! $variation->is_in_stock() ) ) {
continue;
}
@@ -299,10 +289,9 @@ class WC_Product_Variable extends WC_Product {
/**
* Returns an array of data for a variation. Used in the add to cart form.
+ *
* @since 2.4.0
- *
- * @param WC_Product $variation Variation product object or ID
- *
+ * @param WC_Product $variation Variation product object or ID.
* @return array|bool
*/
public function get_available_variation( $variation ) {
@@ -313,34 +302,36 @@ class WC_Product_Variable extends WC_Product {
return false;
}
// See if prices should be shown for each variation after selection.
- $show_variation_price = apply_filters( 'woocommerce_show_variation_price', $variation->get_price() === "" || $this->get_variation_sale_price( 'min' ) !== $this->get_variation_sale_price( 'max' ) || $this->get_variation_regular_price( 'min' ) !== $this->get_variation_regular_price( 'max' ), $this, $variation );
+ $show_variation_price = apply_filters( 'woocommerce_show_variation_price', $variation->get_price() === '' || $this->get_variation_sale_price( 'min' ) !== $this->get_variation_sale_price( 'max' ) || $this->get_variation_regular_price( 'min' ) !== $this->get_variation_regular_price( 'max' ), $this, $variation );
- return apply_filters( 'woocommerce_available_variation', array(
- 'attributes' => $variation->get_variation_attributes(),
- 'availability_html' => wc_get_stock_html( $variation ),
- 'backorders_allowed' => $variation->backorders_allowed(),
- 'dimensions' => $variation->get_dimensions( false ),
- 'dimensions_html' => wc_format_dimensions( $variation->get_dimensions( false ) ),
- 'display_price' => wc_get_price_to_display( $variation ),
- 'display_regular_price' => wc_get_price_to_display( $variation, array( 'price' => $variation->get_regular_price() ) ),
- 'image' => wc_get_product_attachment_props( $variation->get_image_id() ),
- 'image_id' => $variation->get_image_id(),
- 'is_downloadable' => $variation->is_downloadable(),
- 'is_in_stock' => $variation->is_in_stock(),
- 'is_purchasable' => $variation->is_purchasable(),
- 'is_sold_individually' => $variation->is_sold_individually() ? 'yes' : 'no',
- 'is_virtual' => $variation->is_virtual(),
- 'max_qty' => 0 < $variation->get_max_purchase_quantity() ? $variation->get_max_purchase_quantity() : '',
- 'min_qty' => $variation->get_min_purchase_quantity(),
- 'price_html' => $show_variation_price ? '' . $variation->get_price_html() . '' : '',
- 'sku' => $variation->get_sku(),
- 'variation_description' => wc_format_content( $variation->get_description() ),
- 'variation_id' => $variation->get_id(),
- 'variation_is_active' => $variation->variation_is_active(),
- 'variation_is_visible' => $variation->variation_is_visible(),
- 'weight' => $variation->get_weight(),
- 'weight_html' => wc_format_weight( $variation->get_weight() ),
- ), $this, $variation );
+ return apply_filters(
+ 'woocommerce_available_variation', array(
+ 'attributes' => $variation->get_variation_attributes(),
+ 'availability_html' => wc_get_stock_html( $variation ),
+ 'backorders_allowed' => $variation->backorders_allowed(),
+ 'dimensions' => $variation->get_dimensions( false ),
+ 'dimensions_html' => wc_format_dimensions( $variation->get_dimensions( false ) ),
+ 'display_price' => wc_get_price_to_display( $variation ),
+ 'display_regular_price' => wc_get_price_to_display( $variation, array( 'price' => $variation->get_regular_price() ) ),
+ 'image' => wc_get_product_attachment_props( $variation->get_image_id() ),
+ 'image_id' => $variation->get_image_id(),
+ 'is_downloadable' => $variation->is_downloadable(),
+ 'is_in_stock' => $variation->is_in_stock(),
+ 'is_purchasable' => $variation->is_purchasable(),
+ 'is_sold_individually' => $variation->is_sold_individually() ? 'yes' : 'no',
+ 'is_virtual' => $variation->is_virtual(),
+ 'max_qty' => 0 < $variation->get_max_purchase_quantity() ? $variation->get_max_purchase_quantity() : '',
+ 'min_qty' => $variation->get_min_purchase_quantity(),
+ 'price_html' => $show_variation_price ? '' . $variation->get_price_html() . '' : '',
+ 'sku' => $variation->get_sku(),
+ 'variation_description' => wc_format_content( $variation->get_description() ),
+ 'variation_id' => $variation->get_id(),
+ 'variation_is_active' => $variation->variation_is_active(),
+ 'variation_is_visible' => $variation->variation_is_visible(),
+ 'weight' => $variation->get_weight(),
+ 'weight_html' => wc_format_weight( $variation->get_weight() ),
+ ), $this, $variation
+ );
}
/*
@@ -353,8 +344,7 @@ class WC_Product_Variable extends WC_Product {
* Sets an array of variation attributes.
*
* @since 3.0.0
- *
- * @param array
+ * @param array $variation_attributes Attributes list.
*/
public function set_variation_attributes( $variation_attributes ) {
$this->variation_attributes = $variation_attributes;
@@ -364,8 +354,7 @@ class WC_Product_Variable extends WC_Product {
* Sets an array of children for the product.
*
* @since 3.0.0
- *
- * @param array
+ * @param array $children Childre products.
*/
public function set_children( $children ) {
$this->children = array_filter( wp_parse_id_list( (array) $children ) );
@@ -375,8 +364,7 @@ class WC_Product_Variable extends WC_Product {
* Sets an array of visible children only.
*
* @since 3.0.0
- *
- * @param array
+ * @param array $visible_children List of visible children products.
*/
public function set_visible_children( $visible_children ) {
$this->visible_children = array_filter( wp_parse_id_list( (array) $visible_children ) );
@@ -390,6 +378,7 @@ class WC_Product_Variable extends WC_Product {
/**
* Ensure properties are set correctly before save.
+ *
* @since 3.0.0
*/
public function validate_props() {
@@ -454,8 +443,7 @@ class WC_Product_Variable extends WC_Product {
/**
* Returns whether or not the product is on sale.
*
- * @param string $context What the value is for. Valid values are view and edit.
- *
+ * @param string $context What the value is for. Valid values are view and edit. What the value is for. Valid values are view and edit.
* @return bool
*/
public function is_on_sale( $context = 'view' ) {
@@ -467,6 +455,7 @@ class WC_Product_Variable extends WC_Product {
/**
* Is a child in stock?
+ *
* @return boolean
*/
public function child_is_in_stock() {
@@ -485,6 +474,7 @@ class WC_Product_Variable extends WC_Product {
/**
* Does a child have a weight set?
+ *
* @return boolean
*/
public function child_has_weight() {
@@ -501,6 +491,7 @@ class WC_Product_Variable extends WC_Product {
/**
* Does a child have dimensions set?
+ *
* @return boolean
*/
public function child_has_dimensions() {
@@ -555,8 +546,7 @@ class WC_Product_Variable extends WC_Product {
* upwards (from child to parent) when the variation is saved.
*
* @param WC_Product|int $product Product object or ID for which you wish to sync.
- * @param bool $save If true, the product object will be saved to the DB before returning it.
- *
+ * @param bool $save If true, the product object will be saved to the DB before returning it.
* @return WC_Product Synced product object.
*/
public static function sync( $product, $save = true ) {
@@ -575,10 +565,12 @@ class WC_Product_Variable extends WC_Product {
$product->save();
}
- wc_do_deprecated_action( 'woocommerce_variable_product_sync', array(
- $product->get_id(),
- $product->get_visible_children()
- ), '3.0', 'woocommerce_variable_product_sync_data, woocommerce_new_product or woocommerce_update_product' );
+ wc_do_deprecated_action(
+ 'woocommerce_variable_product_sync', array(
+ $product->get_id(),
+ $product->get_visible_children(),
+ ), '3.0', 'woocommerce_variable_product_sync_data, woocommerce_new_product or woocommerce_update_product'
+ );
}
return $product;
@@ -588,8 +580,7 @@ class WC_Product_Variable extends WC_Product {
* Sync parent stock status with the status of all children and save.
*
* @param WC_Product|int $product Product object or ID for which you wish to sync.
- * @param bool $save If true, the product object will be saved to the DB before returning it.
- *
+ * @param bool $save If true, the product object will be saved to the DB before returning it.
* @return WC_Product Synced product object.
*/
public static function sync_stock_status( $product, $save = true ) {
@@ -611,8 +602,7 @@ class WC_Product_Variable extends WC_Product {
/**
* Sort an associativate array of $variation_id => $price pairs in order of min and max prices.
*
- * @param array $prices Associativate array of $variation_id => $price pairs
- *
+ * @param array $prices Associativate array of $variation_id => $price pairs.
* @return array
*/
protected function sort_variation_prices( $prices ) {
From 930591808bfacb8fe556c84aad8f1f2f9002e737 Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 15:49:01 -0300
Subject: [PATCH 20/21] Fixed includes/class-wc-product-variation.php PHPCS
violations
---
includes/class-wc-product-variation.php | 44 ++++++++++++-------------
1 file changed, 22 insertions(+), 22 deletions(-)
diff --git a/includes/class-wc-product-variation.php b/includes/class-wc-product-variation.php
index 45f57473db1..f87d895daec 100644
--- a/includes/class-wc-product-variation.php
+++ b/includes/class-wc-product-variation.php
@@ -1,24 +1,17 @@
get_variation_attributes() );
+ $data_keys = array_map( 'wc_variation_attribute_name', wp_list_pluck( $item_object['item_meta_array'], 'key' ) );
+ $data_values = wp_list_pluck( $item_object['item_meta_array'], 'value' );
+ $data = array_intersect_key( array_combine( $data_keys, $data_values ), $this->get_variation_attributes() );
} else {
- $data = $this->get_variation_attributes();
+ $data = $this->get_variation_attributes();
}
return add_query_arg( array_map( 'urlencode', array_filter( $data ) ), $url );
@@ -182,7 +175,14 @@ class WC_Product_Variation extends WC_Product_Simple {
* @return string
*/
public function add_to_cart_url() {
- $url = $this->is_purchasable() ? remove_query_arg( 'added-to-cart', add_query_arg( array( 'variation_id' => $this->get_id(), 'add-to-cart' => $this->get_parent_id() ), $this->get_permalink() ) ) : $this->get_permalink();
+ $url = $this->is_purchasable() ? remove_query_arg(
+ 'added-to-cart', add_query_arg(
+ array(
+ 'variation_id' => $this->get_id(),
+ 'add-to-cart' => $this->get_parent_id(),
+ ), $this->get_permalink()
+ )
+ ) : $this->get_permalink();
return apply_filters( 'woocommerce_product_add_to_cart_url', $url, $this );
}
@@ -504,7 +504,7 @@ class WC_Product_Variation extends WC_Product_Simple {
* @return array valid tax classes
*/
protected function get_valid_tax_classes() {
- $valid_classes = WC_Tax::get_tax_class_slugs();
+ $valid_classes = WC_Tax::get_tax_class_slugs();
$valid_classes[] = 'parent';
return $valid_classes;
From 027789271db8977be235a1b703514701afa18f6f Mon Sep 17 00:00:00 2001
From: Claudio Sanches
Date: Thu, 22 Mar 2018 16:01:03 -0300
Subject: [PATCH 21/21] Fixed includes/class-wc-frontend-scripts.php PHPCS
violations
---
includes/class-wc-frontend-scripts.php | 320 +++++++++++++------------
1 file changed, 164 insertions(+), 156 deletions(-)
diff --git a/includes/class-wc-frontend-scripts.php b/includes/class-wc-frontend-scripts.php
index 30bc4cd0f3a..48777f8ef4a 100644
--- a/includes/class-wc-frontend-scripts.php
+++ b/includes/class-wc-frontend-scripts.php
@@ -2,11 +2,8 @@
/**
* Handle frontend scripts
*
- * @class WC_Frontend_Scripts
- * @version 2.3.0
- * @package WooCommerce/Classes/
- * @category Class
- * @author WooThemes
+ * @package WooCommerce/Classes
+ * @version 2.3.0
*/
if ( ! defined( 'ABSPATH' ) ) {
@@ -14,24 +11,27 @@ if ( ! defined( 'ABSPATH' ) ) {
}
/**
- * WC_Frontend_Scripts Class.
+ * Frontend scripts class.
*/
class WC_Frontend_Scripts {
/**
* Contains an array of script handles registered by WC.
+ *
* @var array
*/
private static $scripts = array();
/**
* Contains an array of script handles registered by WC.
+ *
* @var array
*/
private static $styles = array();
/**
* Contains an array of script handles localized by WC.
+ *
* @var array
*/
private static $wp_localize_scripts = array();
@@ -51,36 +51,37 @@ class WC_Frontend_Scripts {
* @return array
*/
public static function get_styles() {
- return apply_filters( 'woocommerce_enqueue_styles', array(
- 'woocommerce-layout' => array(
- 'src' => self::get_asset_url( 'assets/css/woocommerce-layout.css' ),
- 'deps' => '',
- 'version' => WC_VERSION,
- 'media' => 'all',
- 'has_rtl' => true,
- ),
- 'woocommerce-smallscreen' => array(
- 'src' => self::get_asset_url( 'assets/css/woocommerce-smallscreen.css' ),
- 'deps' => 'woocommerce-layout',
- 'version' => WC_VERSION,
- 'media' => 'only screen and (max-width: ' . apply_filters( 'woocommerce_style_smallscreen_breakpoint', $breakpoint = '768px' ) . ')',
- 'has_rtl' => true,
- ),
- 'woocommerce-general' => array(
- 'src' => self::get_asset_url( 'assets/css/woocommerce.css' ),
- 'deps' => '',
- 'version' => WC_VERSION,
- 'media' => 'all',
- 'has_rtl' => true,
- ),
- ) );
+ return apply_filters(
+ 'woocommerce_enqueue_styles', array(
+ 'woocommerce-layout' => array(
+ 'src' => self::get_asset_url( 'assets/css/woocommerce-layout.css' ),
+ 'deps' => '',
+ 'version' => WC_VERSION,
+ 'media' => 'all',
+ 'has_rtl' => true,
+ ),
+ 'woocommerce-smallscreen' => array(
+ 'src' => self::get_asset_url( 'assets/css/woocommerce-smallscreen.css' ),
+ 'deps' => 'woocommerce-layout',
+ 'version' => WC_VERSION,
+ 'media' => 'only screen and (max-width: ' . apply_filters( 'woocommerce_style_smallscreen_breakpoint', '768px' ) . ')',
+ 'has_rtl' => true,
+ ),
+ 'woocommerce-general' => array(
+ 'src' => self::get_asset_url( 'assets/css/woocommerce.css' ),
+ 'deps' => '',
+ 'version' => WC_VERSION,
+ 'media' => 'all',
+ 'has_rtl' => true,
+ ),
+ )
+ );
}
/**
* Return asset URL.
*
- * @param string $path
- *
+ * @param string $path Assets path.
* @return string
*/
private static function get_asset_url( $path ) {
@@ -91,12 +92,11 @@ class WC_Frontend_Scripts {
* Register a script for use.
*
* @uses wp_register_script()
- * @access private
- * @param string $handle
- * @param string $path
- * @param string[] $deps
- * @param string $version
- * @param boolean $in_footer
+ * @param string $handle Name of the script. Should be unique.
+ * @param string $path Full URL of the script, or path of the script relative to the WordPress root directory.
+ * @param string[] $deps An array of registered script handles this script depends on.
+ * @param string $version String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added.
+ * @param boolean $in_footer Whether to enqueue the script before