605 lines
18 KiB
PHP
605 lines
18 KiB
PHP
<?php
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Product Variation Class
|
|
*
|
|
* The WooCommerce product variation class handles product variation data.
|
|
*
|
|
* @class WC_Product_Variation
|
|
* @version 2.2.0
|
|
* @package WooCommerce/Classes
|
|
* @category Class
|
|
* @author WooThemes
|
|
*/
|
|
class WC_Product_Variation extends WC_Product {
|
|
|
|
/** @public int ID of the variable product. */
|
|
public $variation_id;
|
|
|
|
/** @public object Parent Variable product object. */
|
|
public $parent;
|
|
|
|
/** @public string Stores the shipping class of the variation. */
|
|
public $variation_shipping_class = false;
|
|
|
|
/** @public int Stores the shipping class ID of the variation. */
|
|
public $variation_shipping_class_id = false;
|
|
|
|
/** @public unused vars @deprecated in 2.2 */
|
|
public $variation_has_sku = true;
|
|
public $variation_has_length = true;
|
|
public $variation_has_width = true;
|
|
public $variation_has_height = true;
|
|
public $variation_has_weight = true;
|
|
public $variation_has_tax_class = true;
|
|
public $variation_has_downloadable_files = true;
|
|
|
|
/** @private array List of meta keys which apply to variations */
|
|
public $variation_level_meta_keys = array(
|
|
'manage_stock',
|
|
'stock_status',
|
|
'stock',
|
|
'backorders',
|
|
'sku',
|
|
'downloadable_files',
|
|
'weight',
|
|
'length',
|
|
'height',
|
|
'downloadable',
|
|
'virtual',
|
|
'tax_class',
|
|
'sale_price_dates_from',
|
|
'sale_price_dates_to',
|
|
'price',
|
|
'regular_price',
|
|
'sale_price'
|
|
);
|
|
|
|
/**
|
|
* Loads required variation data.
|
|
*
|
|
* @access public
|
|
* @param int $variation_id ID of the variation to load
|
|
* @param array $args Array of the arguments containing parent product data
|
|
*/
|
|
public function __construct( $variation, $args = array() ) {
|
|
if ( is_object( $variation ) ) {
|
|
$this->variation_id = absint( $variation->ID );
|
|
} else {
|
|
$this->variation_id = absint( $variation );
|
|
}
|
|
|
|
/* Get main product data from parent (args) */
|
|
$this->id = ! empty( $args['parent_id'] ) ? intval( $args['parent_id'] ) : wp_get_post_parent_id( $this->variation_id );
|
|
|
|
// The post doesn't have a parent id, therefore its invalid.
|
|
if ( empty( $this->id ) ) {
|
|
return;
|
|
}
|
|
|
|
$this->product_type = 'variation';
|
|
$this->parent = ! empty( $args['parent'] ) ? $args['parent'] : get_product( $this->id );
|
|
$this->post = ! empty( $this->parent->post ) ? $this->parent->post : array();
|
|
}
|
|
|
|
/**
|
|
* __isset function.
|
|
*
|
|
* @access public
|
|
* @param mixed $key
|
|
* @return bool
|
|
*/
|
|
public function __isset( $key ) {
|
|
if ( in_array( $key, $this->variation_level_meta_keys ) ) {
|
|
return metadata_exists( 'post', $this->variation_id, '_' . $key ) || metadata_exists( 'post', $this->id, '_' . $key );
|
|
} else {
|
|
return metadata_exists( 'post', $this->id, '_' . $key );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get method returns variation meta data if set, otherwise in most cases the data from the parent.
|
|
*
|
|
* @access public
|
|
* @param string $key
|
|
* @return mixed
|
|
*/
|
|
public function __get( $key ) {
|
|
if ( in_array( $key, $this->variation_level_meta_keys ) ) {
|
|
|
|
// Get values or default if not set (no)
|
|
if ( in_array( $key, array( 'downloadable', 'virtual', 'manage_stock' ) ) ) {
|
|
$value = ( $value = get_post_meta( $this->variation_id, '_' . $key, true ) ) ? $value : 'no';
|
|
|
|
// Data which must be set (not null), otherwise use parent data
|
|
} elseif ( in_array( $key , array( 'tax_class', 'backorders' ) ) ) {
|
|
$value = metadata_exists( 'post', $this->variation_id, '_' . $key ) ? get_post_meta( $this->variation_id, '_' . $key, true ) : get_post_meta( $this->id, '_' . $key, true );
|
|
|
|
// Data which is only at variation level - no inheritance
|
|
} elseif ( in_array( $key , array( 'price', 'regular_price', 'sale_price', 'sale_price_dates_to', 'sale_price_dates_from' ) ) ) {
|
|
$value = ( $value = get_post_meta( $this->variation_id, '_' . $key, true ) ) ? $value : '';
|
|
|
|
} elseif ( 'stock' === $key ) {
|
|
$value = ( $value = get_post_meta( $this->variation_id, '_stock', true ) ) ? $value : 0;
|
|
|
|
} else {
|
|
$value = ( $value = get_post_meta( $this->variation_id, '_' . $key, true ) ) ? $value : get_post_meta( $this->id, '_' . $key, true );
|
|
}
|
|
|
|
} elseif ( 'variation_data' === $key ) {
|
|
$all_meta = get_post_meta( $this->variation_id );
|
|
|
|
// Get the variation attributes from meta
|
|
foreach ( $all_meta as $name => $value ) {
|
|
if ( ! strstr( $name, 'attribute_' ) ) {
|
|
continue;
|
|
}
|
|
$this->variation_data[ $name ] = sanitize_title( $value[0] );
|
|
}
|
|
return $this->variation_data;
|
|
|
|
} elseif ( 'variation_has_stock' === $key ) {
|
|
return $this->managing_stock();
|
|
|
|
} else {
|
|
$value = parent::__get( $key );
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product post exists.
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
public function exists() {
|
|
return ! empty( $this->id );
|
|
}
|
|
|
|
/**
|
|
* Wrapper for get_permalink. Adds this variations attributes to the URL.
|
|
* @return string
|
|
*/
|
|
public function get_permalink() {
|
|
return add_query_arg( array_filter( $this->variation_data ), get_permalink( $this->id ) );
|
|
}
|
|
|
|
/**
|
|
* Get the add to url used mainly in loops.
|
|
*
|
|
* @access public
|
|
* @return string
|
|
*/
|
|
public function add_to_cart_url() {
|
|
$url = $this->is_purchasable() && $this->is_in_stock() ? remove_query_arg( 'added-to-cart', add_query_arg( array_merge( array( 'variation_id' => $this->variation_id, 'add-to-cart' => $this->id ), $this->variation_data ) ) ) : get_permalink( $this->id );
|
|
|
|
return apply_filters( 'woocommerce_product_add_to_cart_url', $url, $this );
|
|
}
|
|
|
|
/**
|
|
* Get the add to cart button text
|
|
*
|
|
* @access public
|
|
* @return string
|
|
*/
|
|
public function add_to_cart_text() {
|
|
$text = $this->is_purchasable() && $this->is_in_stock() ? __( 'Add to cart', 'woocommerce' ) : __( 'Read More', 'woocommerce' );
|
|
|
|
return apply_filters( 'woocommerce_product_add_to_cart_text', $text, $this );
|
|
}
|
|
|
|
/**
|
|
* Checks if this particular variation is visible (variations with no price, or out of stock, can be hidden)
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function variation_is_visible() {
|
|
$visible = true;
|
|
|
|
// Published == enabled checkbox
|
|
if ( get_post_status( $this->variation_id ) != 'publish' ) {
|
|
$visible = false;
|
|
}
|
|
|
|
// Out of stock visibility
|
|
elseif ( get_option('woocommerce_hide_out_of_stock_items') == 'yes' && ! $this->is_in_stock() ) {
|
|
$visible = false;
|
|
}
|
|
|
|
// Price not set
|
|
elseif ( $this->get_price() === "" ) {
|
|
$visible = false;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_variation_is_visible', $visible, $this->variation_id, $this->id );
|
|
}
|
|
|
|
/**
|
|
* Returns false if the product cannot be bought.
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
public function is_purchasable() {
|
|
// Published == enabled checkbox
|
|
if ( get_post_status( $this->variation_id ) != 'publish' ) {
|
|
$purchasable = false;
|
|
} else {
|
|
$purchasable = parent::is_purchasable();
|
|
}
|
|
return apply_filters( 'woocommerce_variation_is_purchasable', $purchasable, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the variations parent is visible.
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
public function parent_is_visible() {
|
|
return $this->is_visible();
|
|
}
|
|
|
|
/**
|
|
* Get variation ID
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_variation_id() {
|
|
return absint( $this->variation_id );
|
|
}
|
|
|
|
/**
|
|
* Get variation attribute values
|
|
*
|
|
* @return array of attributes and their values for this variation
|
|
*/
|
|
public function get_variation_attributes() {
|
|
return $this->variation_data;
|
|
}
|
|
|
|
/**
|
|
* Get variation price HTML. Prices are not inherited from parents.
|
|
*
|
|
* @return string containing the formatted price
|
|
*/
|
|
public function get_price_html( $price = '' ) {
|
|
$tax_display_mode = get_option( 'woocommerce_tax_display_shop' );
|
|
$display_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax() : $this->get_price_excluding_tax();
|
|
$display_regular_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax( 1, $this->get_regular_price() ) : $this->get_price_excluding_tax( 1, $this->get_regular_price() );
|
|
$display_sale_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax( 1, $this->get_sale_price() ) : $this->get_price_excluding_tax( 1, $this->get_sale_price() );
|
|
|
|
if ( $this->get_price() !== '' ) {
|
|
if ( $this->is_on_sale() ) {
|
|
$price = apply_filters( 'woocommerce_variation_sale_price_html', '<del>' . wc_price( $display_regular_price ) . '</del> <ins>' . wc_price( $display_sale_price ) . '</ins>' . $this->get_price_suffix(), $this );
|
|
} elseif ( $this->get_price() > 0 ) {
|
|
$price = apply_filters( 'woocommerce_variation_price_html', wc_price( $display_price ) . $this->get_price_suffix(), $this );
|
|
} else {
|
|
$price = apply_filters( 'woocommerce_variation_free_price_html', __( 'Free!', 'woocommerce' ), $this );
|
|
}
|
|
} else {
|
|
$price = apply_filters( 'woocommerce_variation_empty_price_html', '', $this );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_get_variation_price_html', $price, $this );
|
|
}
|
|
|
|
/**
|
|
* Gets the main product image ID.
|
|
* @return int
|
|
*/
|
|
public function get_image_id() {
|
|
if ( $this->variation_id && has_post_thumbnail( $this->variation_id ) ) {
|
|
$image_id = get_post_thumbnail_id( $this->variation_id );
|
|
} elseif ( has_post_thumbnail( $this->id ) ) {
|
|
$image_id = get_post_thumbnail_id( $this->id );
|
|
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
|
|
$image_id = get_post_thumbnail_id( $parent_id );
|
|
} else {
|
|
$image_id = 0;
|
|
}
|
|
return $image_id;
|
|
}
|
|
|
|
/**
|
|
* Gets the main product image.
|
|
*
|
|
* @access public
|
|
* @param string $size (default: 'shop_thumbnail')
|
|
* @return string
|
|
*/
|
|
public function get_image( $size = 'shop_thumbnail', $attr = array() ) {
|
|
if ( $this->variation_id && has_post_thumbnail( $this->variation_id ) ) {
|
|
$image = get_the_post_thumbnail( $this->variation_id, $size, $attr );
|
|
} elseif ( has_post_thumbnail( $this->id ) ) {
|
|
$image = get_the_post_thumbnail( $this->id, $size, $attr );
|
|
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
|
|
$image = get_the_post_thumbnail( $parent_id, $size , $attr);
|
|
} else {
|
|
$image = wc_placeholder_img( $size );
|
|
}
|
|
return $image;
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product (or variation) is stock managed.
|
|
*
|
|
* @access public
|
|
* @return bool|string Bool if managed at variation level, 'parent' if managed by the parent.
|
|
*/
|
|
public function managing_stock() {
|
|
if ( 'yes' === get_option( 'woocommerce_manage_stock', 'yes' ) ) {
|
|
if ( 'no' === $this->manage_stock ) {
|
|
if ( $this->parent->managing_stock() ) {
|
|
return 'parent';
|
|
}
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns number of items available for sale from the variation, or parent.
|
|
*
|
|
* @access public
|
|
* @return int
|
|
*/
|
|
public function get_stock_quantity() {
|
|
return true === $this->managing_stock() ? wc_stock_amount( $this->stock ) : $this->parent->get_stock_quantity();
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product is in stock.
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
public function is_in_stock() {
|
|
// If we're managing stock at variation level, check stock levels
|
|
if ( true === $this->managing_stock() ) {
|
|
if ( $this->backorders_allowed() ) {
|
|
return true;
|
|
} elseif ( $this->get_total_stock() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
|
|
return false;
|
|
} else {
|
|
return $this->stock_status === 'instock';
|
|
}
|
|
}
|
|
else {
|
|
return $this->stock_status === 'instock';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set stock level of the product variation.
|
|
*
|
|
* Uses queries rather than update_post_meta so we can do this in one query (to avoid stock issues).
|
|
* We cannot rely on the original loaded value in case another order was made since then.
|
|
*
|
|
* @param int $amount
|
|
* @param string $mode can be set, add, or subtract
|
|
* @return int new stock level
|
|
*/
|
|
public function set_stock( $amount = null, $mode = 'set' ) {
|
|
global $wpdb;
|
|
|
|
if ( ! is_null( $amount ) && true === $this->managing_stock() ) {
|
|
|
|
// Ensure key exists
|
|
add_post_meta( $this->variation_id, '_stock', 0, true );
|
|
|
|
// Update stock in DB directly
|
|
switch ( $mode ) {
|
|
case 'add' :
|
|
$wpdb->query( "UPDATE {$wpdb->postmeta} SET meta_value = meta_value + {$amount} WHERE post_id = {$this->variation_id} AND meta_key='_stock'" );
|
|
break;
|
|
case 'subtract' :
|
|
$wpdb->query( "UPDATE {$wpdb->postmeta} SET meta_value = meta_value - {$amount} WHERE post_id = {$this->variation_id} AND meta_key='_stock'" );
|
|
break;
|
|
default :
|
|
$wpdb->query( "UPDATE {$wpdb->postmeta} SET meta_value = {$amount} WHERE post_id = {$this->variation_id} AND meta_key='_stock'" );
|
|
break;
|
|
}
|
|
|
|
// Clear caches
|
|
wp_cache_delete( $this->variation_id, 'post_meta' );
|
|
|
|
// Clear total stock transient
|
|
delete_transient( 'wc_product_total_stock_' . $this->id );
|
|
|
|
// Stock status
|
|
$this->check_stock_status();
|
|
|
|
// Sync the parent
|
|
WC_Product_Variable::sync( $this->id );
|
|
|
|
// Trigger action
|
|
do_action( 'woocommerce_variation_set_stock', $this );
|
|
|
|
} elseif ( ! is_null( $amount ) ) {
|
|
return $this->parent->set_stock( $amount, $mode );
|
|
}
|
|
|
|
return $this->get_stock_quantity();
|
|
}
|
|
|
|
/**
|
|
* set_stock_status function.
|
|
*
|
|
* @access public
|
|
*/
|
|
public function set_stock_status( $status ) {
|
|
$status = 'outofstock' === $status ? 'outofstock' : 'instock';
|
|
|
|
// Sanity check
|
|
if ( true === $this->managing_stock() ) {
|
|
if ( ! $this->backorders_allowed() && $this->get_stock_quantity() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
|
|
$status = 'outofstock';
|
|
}
|
|
} elseif ( 'parent' === $this->managing_stock() ) {
|
|
if ( ! $this->parent->backorders_allowed() && $this->parent->get_stock_quantity() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
|
|
$status = 'outofstock';
|
|
}
|
|
}
|
|
|
|
if ( update_post_meta( $this->variation_id, '_stock_status', $status ) ) {
|
|
do_action( 'woocommerce_variation_set_stock_status', $this->variation_id, $status );
|
|
|
|
if ( true === $this->managing_stock() ) {
|
|
WC_Product_Variable::sync_stock_status( $this->id );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Reduce stock level of the product.
|
|
*
|
|
* @param int $amount (default: 1) Amount to reduce by
|
|
* @return int stock level
|
|
*/
|
|
public function reduce_stock( $amount = 1 ) {
|
|
if ( true === $this->managing_stock() ) {
|
|
return $this->set_stock( $amount, 'subtract' );
|
|
} else {
|
|
return $this->parent->reduce_stock( $amount );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Increase stock level of the product.
|
|
*
|
|
* @param int $amount (default: 1) Amount to increase by
|
|
* @return int stock level
|
|
*/
|
|
public function increase_stock( $amount = 1 ) {
|
|
if ( true === $this->managing_stock() ) {
|
|
return $this->set_stock( $amount, 'add' );
|
|
} else {
|
|
return $this->parent->increase_stock( $amount );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the availability of the product.
|
|
*
|
|
* @access public
|
|
* @return string
|
|
*/
|
|
public function get_availability() {
|
|
if ( true === $this->managing_stock() ) {
|
|
return parent::get_availability();
|
|
} else {
|
|
return $this->parent->get_availability();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product needs to notify the customer on backorder.
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
public function backorders_require_notification() {
|
|
if ( true === $this->managing_stock() ) {
|
|
return parent::backorders_require_notification();
|
|
} else {
|
|
return $this->parent->backorders_require_notification();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* is_on_backorder function.
|
|
*
|
|
* @access public
|
|
* @param int $qty_in_cart (default: 0)
|
|
* @return bool
|
|
*/
|
|
public function is_on_backorder( $qty_in_cart = 0 ) {
|
|
if ( true === $this->managing_stock() ) {
|
|
return parent::is_on_backorder( $qty_in_cart );
|
|
} else {
|
|
return $this->parent->is_on_backorder( $qty_in_cart );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product has enough stock for the order.
|
|
*
|
|
* @access public
|
|
* @param mixed $quantity
|
|
* @return bool
|
|
*/
|
|
public function has_enough_stock( $quantity ) {
|
|
if ( true === $this->managing_stock() ) {
|
|
return parent::has_enough_stock( $quantity );
|
|
} else {
|
|
return $this->parent->has_enough_stock( $quantity );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the shipping class, and if not set, get the shipping class of the parent.
|
|
*
|
|
* @access public
|
|
* @return string
|
|
*/
|
|
public function get_shipping_class() {
|
|
if ( ! $this->variation_shipping_class ) {
|
|
$classes = get_the_terms( $this->variation_id, 'product_shipping_class' );
|
|
|
|
if ( $classes && ! is_wp_error( $classes ) ) {
|
|
$this->variation_shipping_class = current( $classes )->slug;
|
|
} else {
|
|
$this->variation_shipping_class = parent::get_shipping_class();
|
|
}
|
|
}
|
|
return $this->variation_shipping_class;
|
|
}
|
|
|
|
/**
|
|
* Returns the product shipping class ID.
|
|
*
|
|
* @access public
|
|
* @return int
|
|
*/
|
|
public function get_shipping_class_id() {
|
|
if ( ! $this->variation_shipping_class_id ) {
|
|
$classes = get_the_terms( $this->variation_id, 'product_shipping_class' );
|
|
|
|
if ( $classes && ! is_wp_error( $classes ) ) {
|
|
$this->variation_shipping_class_id = current( $classes )->term_id;
|
|
} else {
|
|
$this->variation_shipping_class_id = parent::get_shipping_class_id();
|
|
}
|
|
}
|
|
return absint( $this->variation_shipping_class_id );
|
|
}
|
|
|
|
/**
|
|
* Get product name with extra details such as SKU, price and attributes. Used within admin.
|
|
*
|
|
* @access public
|
|
* @param mixed $product
|
|
* @return string Formatted product name, including attributes and price
|
|
*/
|
|
public function get_formatted_name() {
|
|
if ( $this->get_sku() ) {
|
|
$identifier = $this->get_sku();
|
|
} else {
|
|
$identifier = '#' . $this->variation_id;
|
|
}
|
|
|
|
$attributes = $this->get_variation_attributes();
|
|
$extra_data = ' – ' . implode( ', ', $attributes ) . ' – ' . wc_price( $this->get_price() );
|
|
|
|
return sprintf( __( '%s – %s%s', 'woocommerce' ), $identifier, $this->get_title(), $extra_data );
|
|
}
|
|
}
|