woocommerce/classes/class-wc-product-variation.php

455 lines
14 KiB
PHP
Raw Normal View History

2011-08-09 15:16:18 +00:00
<?php
/**
* Product Variation Class
2012-08-10 13:21:10 +00:00
*
2011-08-10 17:11:11 +00:00
* The WooCommerce product variation class handles product variation data.
2011-08-09 15:16:18 +00:00
*
2012-01-27 16:38:39 +00:00
* @class WC_Product_Variation
2012-12-03 19:19:58 +00:00
* @version 2.0.0
2012-08-14 22:43:48 +00:00
* @package WooCommerce/Classes
2012-08-14 19:42:38 +00:00
* @author WooThemes
2011-08-09 15:16:18 +00:00
*/
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
2012-01-27 16:38:39 +00:00
class WC_Product_Variation extends WC_Product {
2012-08-10 13:21:10 +00:00
/** @public int ID of the variable product. */
2012-12-20 11:54:38 +00:00
public $variation_id;
/** @public object Parent Variable product object. */
2012-12-20 11:54:38 +00:00
public $parent;
/** @public array Stores variation data (attributes) for the current variation. */
public $variation_data = array();
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a length. */
public $variation_has_length = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a width. */
public $variation_has_width = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a height. */
public $variation_has_height = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a weight. */
public $variation_has_weight = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a price. */
public $variation_has_price = false;
2012-11-27 16:22:47 +00:00
/** @public bool True if the variation has a regular price. */
public $variation_has_regular_price = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a sale price. */
public $variation_has_sale_price = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has stock and is managing stock. */
public $variation_has_stock = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a sku. */
public $variation_has_sku = false;
2012-08-15 17:08:42 +00:00
/** @public string Stores the shipping class of the variation. */
public $variation_shipping_class = false;
2012-08-15 17:08:42 +00:00
/** @public int Stores the shipping class ID of the variation. */
public $variation_shipping_class_id = false;
2012-08-15 17:08:42 +00:00
/** @public bool True if the variation has a tax class. */
public $variation_has_tax_class = false;
2011-08-09 15:16:18 +00:00
/**
* Loads all product data from custom fields
*
2012-08-14 19:42:38 +00:00
* @access public
2012-10-18 10:33:47 +00:00
* @param int $variation_id ID of the variation to load
* @param array $args Array of the arguments containing parent product data
2012-08-14 19:42:38 +00:00
* @return void
2011-08-09 15:16:18 +00:00
*/
public function __construct( $variation, $args = array() ) {
2012-08-10 13:21:10 +00:00
2012-12-20 11:54:38 +00:00
$this->product_type = 'variable';
if ( is_object( $variation ) ) {
$this->variation_id = absint( $variation->ID );
} else {
$this->variation_id = absint( $variation );
}
2012-08-10 13:21:10 +00:00
/* 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 false;
// Get post data
$this->parent = ! empty( $args['parent'] ) ? $args['parent'] : get_product( $this->id );
$this->post = $this->parent->post;
$this->product_custom_fields = get_post_meta( $this->variation_id );
2012-08-10 13:21:10 +00:00
// Get the variation attributes from meta
foreach ( $this->product_custom_fields as $name => $value ) {
if ( ! strstr( $name, 'attribute_' ) )
continue;
2012-08-10 13:21:10 +00:00
2012-10-18 10:33:47 +00:00
$this->variation_data[ $name ] = $value[0];
2012-08-14 19:42:38 +00:00
}
2011-08-09 15:16:18 +00:00
// Now get variation meta to override the parent variable product
if ( ! empty( $this->product_custom_fields['_sku'][0] ) ) {
2011-08-09 15:16:18 +00:00
$this->variation_has_sku = true;
$this->sku = $this->product_custom_fields['_sku'][0];
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_stock'][0] ) && $this->product_custom_fields['_stock'][0] !== '' ) {
2011-08-09 15:16:18 +00:00
$this->variation_has_stock = true;
$this->manage_stock = 'yes';
$this->stock = $this->product_custom_fields['_stock'][0];
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_weight'][0] ) && $this->product_custom_fields['_weight'][0] !== '' ) {
2011-08-09 15:16:18 +00:00
$this->variation_has_weight = true;
$this->weight = $this->product_custom_fields['_weight'][0];
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_length'][0] ) && $this->product_custom_fields['_length'][0] !== '' ) {
$this->variation_has_length = true;
$this->length = $this->product_custom_fields['_length'][0];
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_width'][0] ) && $this->product_custom_fields['_width'][0] !== '' ) {
$this->variation_has_width = true;
$this->width = $this->product_custom_fields['_width'][0];
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_height'][0] ) && $this->product_custom_fields['_height'][0] !== '' ) {
$this->variation_has_height = true;
$this->height = $this->product_custom_fields['_height'][0];
}
2012-11-27 16:22:47 +00:00
if ( isset( $this->product_custom_fields['_downloadable'][0] ) && $this->product_custom_fields['_downloadable'][0] == 'yes' ) {
$this->downloadable = 'yes';
} else {
$this->downloadable = 'no';
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_virtual'][0] ) && $this->product_custom_fields['_virtual'][0] == 'yes' ) {
$this->virtual = 'yes';
} else {
$this->virtual = 'no';
}
2012-08-10 13:21:10 +00:00
if ( isset( $this->product_custom_fields['_tax_class'][0] ) ) {
$this->variation_has_tax_class = true;
$this->tax_class = $this->product_custom_fields['_tax_class'][0];
}
2012-11-27 16:22:47 +00:00
if ( isset( $this->product_custom_fields['_price'][0] ) && $this->product_custom_fields['_price'][0] !== '' ) {
2012-10-08 11:51:00 +00:00
$this->variation_has_price = true;
$this->price = $this->product_custom_fields['_price'][0];
2012-10-08 11:51:00 +00:00
}
2012-11-27 16:22:47 +00:00
if ( isset( $this->product_custom_fields['_regular_price'][0] ) && $this->product_custom_fields['_regular_price'][0] !== '' ) {
2012-10-08 11:51:00 +00:00
$this->variation_has_regular_price = true;
$this->regular_price = $this->product_custom_fields['_regular_price'][0];
2012-10-08 11:51:00 +00:00
}
2012-11-27 16:22:47 +00:00
if ( isset( $this->product_custom_fields['_sale_price'][0] ) && $this->product_custom_fields['_sale_price'][0] !== '' ) {
2012-10-08 11:51:00 +00:00
$this->variation_has_sale_price = true;
$this->sale_price = $this->product_custom_fields['_sale_price'][0];
2012-10-08 11:51:00 +00:00
}
2012-11-27 16:22:47 +00:00
2012-10-08 11:51:00 +00:00
// Backwards compat for prices
if ( $this->variation_has_price && ! $this->variation_has_regular_price ) {
update_post_meta( $this->variation_id, '_regular_price', $this->price );
$this->variation_has_regular_price = true;
$this->regular_price = $this->price;
2012-11-27 16:22:47 +00:00
2012-10-08 11:51:00 +00:00
if ( $this->variation_has_sale_price && $this->sale_price < $this->regular_price ) {
update_post_meta( $this->variation_id, '_price', $this->sale_price );
$this->price = $this->sale_price;
}
}
2012-11-27 16:22:47 +00:00
if ( isset( $this->product_custom_fields['_sale_price_dates_from'][0] ) )
$this->sale_price_dates_from = $this->product_custom_fields['_sale_price_dates_from'][0];
2012-11-27 16:22:47 +00:00
if ( isset( $this->product_custom_fields['_sale_price_dates_to'][0] ) )
$this->sale_price_dates_from = $this->product_custom_fields['_sale_price_dates_to'][0];
2012-11-27 16:22:47 +00:00
$this->total_stock = $this->stock;
2011-08-09 15:16:18 +00:00
}
2012-08-14 19:42:38 +00:00
/**
* Returns whether or not the variation is visible.
*
* @access public
* @return bool
*/
public function is_visible() {
2012-08-10 13:21:10 +00:00
$visible = true;
2012-08-10 13:21:10 +00:00
// Out of stock visibility
2012-08-10 13:21:10 +00:00
if ( get_option('woocommerce_hide_out_of_stock_items') == 'yes' && ! $this->is_in_stock() )
$visible = false;
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
return apply_filters( 'woocommerce_product_is_visible', $visible, $this->id );
}
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
/**
* Returns whether or not the variations parent is visible.
*
* @access public
* @return bool
*/
public function parent_is_visible() {
2012-08-10 13:21:10 +00:00
return parent::is_visible();
}
2012-08-10 13:21:10 +00:00
2011-08-22 11:57:50 +00:00
/**
* Get variation ID
2012-08-10 13:21:10 +00:00
*
2011-08-22 11:57:50 +00:00
* @return int
*/
public function get_variation_id() {
return absint( $this->variation_id );
2011-08-22 11:57:50 +00:00
}
2012-08-10 13:21:10 +00:00
2011-08-22 11:57:50 +00:00
/**
* Get variation attribute values
2012-08-10 13:21:10 +00:00
*
2011-08-22 11:57:50 +00:00
* @return array of attributes and their values for this variation
*/
public function get_variation_attributes() {
2011-08-22 11:57:50 +00:00
return $this->variation_data;
}
2012-08-10 13:21:10 +00:00
2011-08-22 11:57:50 +00:00
/**
* Get variation attribute values
2012-08-10 13:21:10 +00:00
*
2011-08-22 11:57:50 +00:00
* @return string containing the formatted price
*/
public function get_price_html() {
2012-10-08 11:51:00 +00:00
if ( $this->variation_has_price ) {
2011-08-09 15:16:18 +00:00
$price = '';
2012-08-10 13:21:10 +00:00
2012-10-08 11:51:00 +00:00
if ( $this->price !== '' ) {
if ( $this->price == $this->sale_price && $this->sale_price < $this->regular_price ) {
2012-10-08 11:51:00 +00:00
$price .= '<del>' . woocommerce_price( $this->regular_price ) . '</del> <ins>' . woocommerce_price( $this->sale_price ) . '</ins>';
$price = apply_filters( 'woocommerce_variation_sale_price_html', $price, $this );
} else {
2011-08-10 17:11:11 +00:00
$price .= woocommerce_price( $this->price );
2012-10-08 11:51:00 +00:00
$price = apply_filters( 'woocommerce_variation_price_html', $price, $this );
}
}
2012-08-10 13:21:10 +00:00
2011-08-09 15:16:18 +00:00
return $price;
2012-10-08 11:51:00 +00:00
} else {
return woocommerce_price( parent::get_price() );
}
2011-08-09 15:16:18 +00:00
}
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
/**
* Gets the main product image.
*
* @access public
* @param string $size (default: 'shop_thumbnail')
* @return string
2012-08-10 13:21:10 +00:00
*/
public function get_image( $size = 'shop_thumbnail', $attr = array() ) {
global $woocommerce;
2012-08-10 13:21:10 +00:00
$image = '';
if ( $this->variation_id && has_post_thumbnail( $this->variation_id ) ) {
2012-11-28 18:02:12 +00:00
$image = get_the_post_thumbnail( $this->variation_id, $size, $attr );
} elseif ( has_post_thumbnail( $this->id ) ) {
2012-11-28 18:02:12 +00:00
$image = get_the_post_thumbnail( $this->id, $size, $attr );
} elseif ( $parent_id = wp_get_post_parent_id( $this->id ) && has_post_thumbnail( $parent_id ) ) {
2012-11-28 18:02:12 +00:00
$image = get_the_post_thumbnail( $parent_id, $size , $attr);
} else {
$image = woocommerce_placeholder_img( $size );
}
return $image;
}
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
/**
* Set stock level of the product.
*
* @access public
* @param mixed $amount (default: null)
* @return int Stock
*/
function set_stock( $amount = null ) {
global $woocommerce;
if ( $this->variation_has_stock ) {
if ( $this->managing_stock() && ! is_null( $amount ) ) {
$this->stock = intval( $amount );
$this->total_stock = intval( $amount );
update_post_meta( $this->variation_id, '_stock', $this->stock );
$woocommerce->clear_product_transients( $this->id ); // Clear transient
// Check parents out of stock attribute
if ( ! $this->is_in_stock() ) {
// Check parent
$parent_product = get_product( $this->id );
// Only continue if the parent has backorders off
if ( ! $parent_product->backorders_allowed() && $parent_product->get_total_stock() <= 0 )
$this->set_stock_status( 'outofstock' );
} elseif ( $this->is_in_stock() ) {
$this->set_stock_status( 'instock' );
}
return apply_filters( 'woocommerce_stock_amount', $this->stock );
}
} else {
return parent::set_stock( $amount );
}
}
2011-08-09 15:16:18 +00:00
/**
2012-08-14 19:42:38 +00:00
* Reduce stock level of the product.
2011-08-09 15:16:18 +00:00
*
2012-08-14 19:42:38 +00:00
* @access public
* @param int $by (default: 1) Amount to reduce by
* @return int stock level
2011-08-09 15:16:18 +00:00
*/
public function reduce_stock( $by = 1 ) {
2012-03-07 13:38:51 +00:00
global $woocommerce;
2012-08-10 13:21:10 +00:00
if ( $this->variation_has_stock ) {
if ( $this->managing_stock() ) {
2012-08-10 13:21:10 +00:00
2012-06-29 19:40:18 +00:00
$this->stock = $this->stock - $by;
$this->total_stock = $this->total_stock - $by;
update_post_meta( $this->variation_id, '_stock', $this->stock );
2012-06-29 19:40:18 +00:00
$woocommerce->clear_product_transients( $this->id ); // Clear transient
2012-08-10 13:21:10 +00:00
2012-06-29 19:40:18 +00:00
// Check parents out of stock attribute
if ( ! $this->is_in_stock() ) {
2012-08-10 13:21:10 +00:00
2011-08-21 16:47:49 +00:00
// Check parent
$parent_product = get_product( $this->id );
2012-08-10 13:21:10 +00:00
2012-06-29 19:40:18 +00:00
// Only continue if the parent has backorders off
2012-11-28 15:40:08 +00:00
if ( ! $parent_product->backorders_allowed() && $parent_product->get_total_stock() <= 0 )
$this->set_stock_status( 'outofstock' );
2011-08-21 16:47:49 +00:00
}
2012-08-10 13:21:10 +00:00
return apply_filters( 'woocommerce_stock_amount', $this->stock );
}
} else {
2011-08-09 15:16:18 +00:00
return parent::reduce_stock( $by );
}
2011-08-09 15:16:18 +00:00
}
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
2011-08-09 15:16:18 +00:00
/**
2012-08-14 19:42:38 +00:00
* Increase stock level of the product.
2011-08-09 15:16:18 +00:00
*
2012-08-14 19:42:38 +00:00
* @access public
* @param int $by (default: 1) Amount to increase by
* @return int stock level
2011-08-09 15:16:18 +00:00
*/
public function increase_stock( $by = 1 ) {
2012-06-29 19:40:18 +00:00
global $woocommerce;
2012-08-10 13:21:10 +00:00
2011-08-09 15:16:18 +00:00
if ($this->variation_has_stock) :
if ($this->managing_stock()) :
2011-08-21 16:47:49 +00:00
2012-06-29 19:40:18 +00:00
$this->stock = $this->stock + $by;
$this->total_stock = $this->total_stock + $by;
update_post_meta( $this->variation_id, '_stock', $this->stock );
$woocommerce->clear_product_transients( $this->id ); // Clear transient
2012-08-10 13:21:10 +00:00
2011-08-21 16:47:49 +00:00
// Parents out of stock attribute
2012-08-10 13:21:10 +00:00
if ( $this->is_in_stock() )
2012-11-28 15:40:08 +00:00
$this->set_stock_status( 'instock' );
2012-08-10 13:21:10 +00:00
return apply_filters( 'woocommerce_stock_amount', $this->stock );
2011-08-09 15:16:18 +00:00
endif;
else :
return parent::increase_stock( $by );
endif;
}
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
/**
2012-08-14 19:42:38 +00:00
* Get the shipping class, and if not set, get the shipping class of the parent.
*
* @access public
* @return string
*/
public function get_shipping_class() {
2012-10-18 10:33:47 +00:00
if ( ! $this->variation_shipping_class ) {
$classes = get_the_terms( $this->variation_id, 'product_shipping_class' );
2012-11-27 16:22:47 +00:00
2012-10-18 10:33:47 +00:00
if ( $classes && ! is_wp_error( $classes ) ) {
$this->variation_shipping_class = esc_attr( current( $classes )->slug );
} else {
$this->variation_shipping_class = parent::get_shipping_class();
}
}
return $this->variation_shipping_class;
}
2012-08-10 13:21:10 +00:00
2012-08-14 19:42:38 +00:00
/**
* Returns the product shipping class ID.
*
* @access public
* @return int
*/
public function get_shipping_class_id() {
2012-06-26 12:17:08 +00:00
if ( ! $this->variation_shipping_class_id ) {
2012-08-10 13:21:10 +00:00
2012-06-26 12:17:08 +00:00
$classes = get_the_terms( $this->variation_id, 'product_shipping_class' );
2012-08-10 13:21:10 +00:00
if ( $classes && ! is_wp_error( $classes ) )
$this->variation_shipping_class_id = current( $classes )->term_id;
else
2012-06-26 12:17:08 +00:00
$this->variation_shipping_class_id = parent::get_shipping_class_id();
2012-08-10 13:21:10 +00:00
2012-06-26 12:17:08 +00:00
}
return absint( $this->variation_shipping_class_id );
2012-06-26 12:17:08 +00:00
}
2012-08-10 13:21:10 +00:00
/**
* Get file download path identified by $download_id
2012-11-27 16:22:47 +00:00
*
* @access public
* @param string $download_id file identifier
* @return array
*/
public function get_file_download_path( $download_id ) {
2012-11-27 16:22:47 +00:00
$file_path = '';
$file_paths = apply_filters( 'woocommerce_file_download_paths', get_post_meta( $this->variation_id, '_file_paths', true ), $this->variation_id, null, null );
if ( ! $download_id && count( $file_paths ) == 1 ) {
// backwards compatibility for old-style download URLs and template files
$file_path = array_shift( $file_paths );
} elseif ( isset( $file_paths[ $download_id ] ) ) {
$file_path = $file_paths[ $download_id ];
}
// allow overriding based on the particular file being requested
return apply_filters( 'woocommerce_file_download_path', $file_path, $this->variation_id, $download_id );
}
2011-08-09 15:16:18 +00:00
}