woocommerce/includes/class-wc-product-variable.php

<?php

if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly

/**
 * Variable Product Class
 *
 * The WooCommerce product class handles individual product data.
 *
 * @class 		WC_Product_Variable
 * @version		2.0.0
 * @package		WooCommerce/Classes/Products
 * @category	Class
 * @author 		WooThemes
 */
class WC_Product_Variable extends WC_Product {

	/** @public array Array of child products/posts/variations. */
	public $children;

	/** @public string The product's total stock, including that of its children. */
	public $total_stock;

	/**
	 * __construct function.
	 *
	 * @access public
	 * @param mixed $product
	 */
	public function __construct( $product ) {
		$this->product_type = 'variable';
		parent::__construct( $product );
	}

	/**
	 * Get the add to cart button text
	 *
	 * @access public
	 * @return string
	 */
	public function add_to_cart_text() {
		return apply_filters( 'woocommerce_product_add_to_cart_text', __( 'Select options', 'woocommerce' ), $this );
	}

    /**
     * Get total stock.
     *
     * This is the stock of parent and children combined.
     *
     * @access public
     * @return int
     */
    public function get_total_stock() {

        if ( empty( $this->total_stock ) ) {

        	$transient_name = 'wc_product_total_stock_' . $this->id;

        	if ( false === ( $this->total_stock = get_transient( $transient_name ) ) ) {
		        $this->total_stock = $this->stock;

				if ( sizeof( $this->get_children() ) > 0 ) {
					foreach ($this->get_children() as $child_id) {
						$stock = get_post_meta( $child_id, '_stock', true );

						if ( $stock != '' ) {
							$this->total_stock += intval( $stock );
						}
					}
				}

				set_transient( $transient_name, $this->total_stock );
			}
		}
		return apply_filters( 'woocommerce_stock_amount', $this->total_stock );
    }

	/**
	 * Set stock level of the product.
	 *
	 * @param mixed $amount (default: null)
	 * @return int Stock
	 */
	function set_stock( $amount = null ) {
		// Empty total stock so its refreshed
		$this->total_stock = '';

		// Call parent set_stock
		return parent::set_stock( $amount );
	}

	/**
	 * Return the products children posts.
	 *
	 * @access public
	 * @return array
	 */
	public function get_children() {

		if ( ! is_array( $this->children ) ) {

			$this->children = array();

			$transient_name = 'wc_product_children_ids_' . $this->id;

        	if ( false === ( $this->children = get_transient( $transient_name ) ) ) {

		        $this->children = get_posts( 'post_parent=' . $this->id . '&post_type=product_variation&orderby=menu_order&order=ASC&fields=ids&post_status=any&numberposts=-1' );

				set_transient( $transient_name, $this->children );

			}

		}

		return (array) $this->children;
	}


	/**
	 * get_child function.
	 *
	 * @access public
	 * @param mixed $child_id
	 * @return object WC_Product or WC_Product_variation
	 */
	public function get_child( $child_id ) {
		return get_product( $child_id, array(
			'parent_id' => $this->id,
			'parent' 	=> $this
			) );
	}


	/**
	 * Returns whether or not the product has any child product.
	 *
	 * @access public
	 * @return bool
	 */
	public function has_child() {
		return sizeof( $this->get_children() ) ? true : false;
	}


	/**
	 * Returns whether or not the product is on sale.
	 *
	 * @access public
	 * @return bool
	 */
	public function is_on_sale() {

		if ( $this->has_child() ) {

			foreach ( $this->get_children() as $child_id ) {
				$price      = get_post_meta( $child_id, '_price', true );
				$sale_price = get_post_meta( $child_id, '_sale_price', true );
				if ( $sale_price !== "" && $sale_price >= 0 && $sale_price == $price )
					return true;
			}

		}
		return false;
	}

	/**
	 * Get the min or max variation regular price.
	 * @param  string $min_or_max - min or max
	 * @return string
	 */
	public function get_variation_regular_price( $min_or_max = 'min' ) {
		$get = $min_or_max . '_variation_regular_price';
		return apply_filters( 'woocommerce_get_variation_regular_price', $this->$get, $this );
	}

	/**
	 * Get the min or max variation sale price.
	 * @param  string $min_or_max - min or max
	 * @return string
	 */
	public function get_variation_sale_price( $min_or_max = 'min' ) {
		$get = $min_or_max . '_variation_sale_price';
		return apply_filters( 'woocommerce_get_variation_sale_price', $this->$get, $this );
	}

	/**
	 * Get the min or max variation (active) price.
	 * @param  string $min_or_max - min or max
	 * @return string
	 */
	public function get_variation_price( $min_or_max = 'min' ) {
		$get = $min_or_max . '_variation_price';
		return apply_filters( 'woocommerce_get_variation_price', $this->$get, $this );
	}

	/**
	 * Returns the price in html format.
	 *
	 * @access public
	 * @param string $price (default: '')
	 * @return string
	 */
	public function get_price_html( $price = '' ) {

		// Ensure variation prices are synced with variations
		if ( $this->get_variation_price( 'max' ) === '' || $this->get_price() === '' )
			$this->variable_product_sync( $this->id );

		$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_min_variation_regular_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax( 1, $this->get_variation_regular_price( 'min' ) ) : $this->get_price_excluding_tax( 1, $this->get_variation_regular_price( 'min' ) );

		// Get the price
		if ( $this->get_price() > 0 ) {

			// Only show 'from' if the min price varies from the max price
			if ( $this->get_variation_price( 'min' ) !== $this->get_variation_price( 'max' ) )
				$price .= $this->get_price_html_from_text();

			if ( $this->is_on_sale() && $this->get_variation_regular_price( 'min' ) !== $this->get_price() ) {

				$price .= $this->get_price_html_from_to( $display_min_variation_regular_price, $display_price ) . $this->get_price_suffix();

				$price = apply_filters( 'woocommerce_variable_sale_price_html', $price, $this );

			} else {

				$price .= woocommerce_price( $display_price ) . $this->get_price_suffix();

				$price = apply_filters('woocommerce_variable_price_html', $price, $this);

			}

		} elseif ( $this->get_price() === '' ) {

			$price = apply_filters( 'woocommerce_variable_empty_price_html', '', $this );

		} elseif ( $this->get_price() == 0 ) {

			// Only show 'from' if the min price varies from the max price
			if ( $this->get_variation_price( 'min' ) !== $this->get_variation_price( 'max' ) )
				$price .= $this->get_price_html_from_text();

			if ( $this->is_on_sale() && $this->get_variation_regular_price( 'min' ) > 0 ) {

				$price .= $this->get_price_html_from_to( $display_min_variation_regular_price, __( 'Free!', 'woocommerce' ) );

				$price = apply_filters( 'woocommerce_variable_free_sale_price_html', $price, $this );

			} else {

				$price .= __( 'Free!', 'woocommerce' );

				$price = apply_filters( 'woocommerce_variable_free_price_html', $price, $this );

			}

		}

		return apply_filters( 'woocommerce_get_price_html', $price, $this );
	}


    /**
     * Return an array of attributes used for variations, as well as their possible values.
     *
     * @access public
     * @return array of attributes and their available values
     */
    public function get_variation_attributes() {

	    $variation_attributes = array();

        if ( ! $this->has_child() )
        	return $variation_attributes;

        $attributes = $this->get_attributes();

        foreach ( $attributes as $attribute ) {
            if ( ! $attribute['is_variation'] )
            	continue;

            $values = array();
            $attribute_field_name = 'attribute_' . sanitize_title( $attribute['name'] );

            foreach ( $this->get_children() as $child_id ) {

            	$variation = $this->get_child( $child_id );

				if ( ! empty( $variation->variation_id ) ) {

					if ( ! $variation->variation_is_visible() )
						continue; // Disabled or hidden

					$child_variation_attributes = $variation->get_variation_attributes();

	                foreach ( $child_variation_attributes as $name => $value )
	                    if ( $name == $attribute_field_name )
	                    	$values[] = sanitize_title( $value );
                }
            }

            // empty value indicates that all options for given attribute are available
            if ( in_array( '', $values ) ) {

            	$values = array();

            	// Get all options
            	if ( $attribute['is_taxonomy'] ) {
	            	$post_terms = wp_get_post_terms( $this->id, $attribute['name'] );
					foreach ( $post_terms as $term )
						$values[] = $term->slug;
				} else {
					$values = array_map( 'trim', explode( WOOCOMMERCE_DELIMITER, $attribute['value'] ) );
				}

				$values = array_unique( $values );

			// Order custom attributes (non taxonomy) as defined
            } elseif ( ! $attribute['is_taxonomy'] ) {

            	$option_names = array_map( 'trim', explode( WOOCOMMERCE_DELIMITER, $attribute['value'] ) );
            	$option_slugs = $values;
            	$values       = array();

            	foreach ( $option_names as $option_name ) {
	            	if ( in_array( sanitize_title( $option_name ), $option_slugs ) )
	            		$values[] = $option_name;
            	}
            }

            $variation_attributes[ $attribute['name'] ] = array_unique( $values );
        }

        return $variation_attributes;
    }

    /**
     * If set, get the default attributes for a variable product.
     *
     * @access public
     * @return array
     */
    public function get_variation_default_attributes() {

    	$default = isset( $this->default_attributes ) ? $this->default_attributes : '';

	    return apply_filters( 'woocommerce_product_default_attributes', (array) maybe_unserialize( $default ), $this );
    }

    /**
     * Get an array of available variations for the current product.
     *
     * @access public
     * @return array
     */
    public function get_available_variations() {

	    $available_variations = array();

		foreach ( $this->get_children() as $child_id ) {

			$variation = $this->get_child( $child_id );

			if ( ! empty( $variation->variation_id ) ) {
				$variation_attributes 	= $variation->get_variation_attributes();
				$availability 			= $variation->get_availability();
				$availability_html 		= empty( $availability['availability'] ) ? '' : apply_filters( 'woocommerce_stock_html', '<p class="stock ' . esc_attr( $availability['class'] ) . '">'. wp_kses_post( $availability['availability'] ).'</p>', wp_kses_post( $availability['availability'] ) );

				if ( has_post_thumbnail( $variation->get_variation_id() ) ) {
					$attachment_id = get_post_thumbnail_id( $variation->get_variation_id() );

					$attachment    = wp_get_attachment_image_src( $attachment_id, apply_filters( 'single_product_large_thumbnail_size', 'shop_single' )  );
					$image         = $attachment ? current( $attachment ) : '';

					$attachment    = wp_get_attachment_image_src( $attachment_id, 'full'  );
					$image_link    = $attachment ? current( $attachment ) : '';

					$image_title   = get_the_title( $attachment_id );
					$image_alt     = get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
				} else {
					$image = $image_link = $image_title = $image_alt = '';
				}

				$available_variations[] = apply_filters( 'woocommerce_available_variation', array(
					'variation_id'         => $child_id,
					'variation_is_visible' => $variation->variation_is_visible(),
					'attributes'           => $variation_attributes,
					'image_src'            => $image,
					'image_link'           => $image_link,
					'image_title'          => $image_title,
					'image_alt'            => $image_alt,
					'price_html'           => $this->min_variation_price != $this->max_variation_price ? '<span class="price">' . $variation->get_price_html() . '</span>' : '',
					'availability_html'    => $availability_html,
					'sku'                  => $variation->get_sku(),
					'weight'               => $variation->get_weight() . ' ' . esc_attr( get_option('woocommerce_weight_unit' ) ),
					'dimensions'           => $variation->get_dimensions(),
					'min_qty'              => 1,
					'max_qty'              => $this->backorders_allowed() ? '' : $variation->stock,
					'backorders_allowed'   => $this->backorders_allowed(),
					'is_in_stock'          => $variation->is_in_stock(),
					'is_downloadable'      => $variation->is_downloadable() ,
					'is_virtual'           => $variation->is_virtual(),
					'is_sold_individually' => $variation->is_sold_individually() ? 'yes' : 'no',
				), $this, $variation );
			}
		}

		return $available_variations;
    }

	/**
	 * Sync variable product prices with the children lowest/highest prices.
	 */
	public function variable_product_sync( $product_id = '' ) {
		if ( empty( $product_id ) )
			$product_id = $this->id;

		// Sync prices with children
		self::sync( $product_id );

		// Re-load prices
		$this->price                       = get_post_meta( $product_id, '_price', true );
		$this->min_variation_price         = get_post_meta( $product_id, '_min_variation_price', true );
		$this->max_variation_price         = get_post_meta( $product_id, '_max_variation_price', true );
		$this->min_variation_regular_price = get_post_meta( $product_id, '_min_variation_regular_price', true );
		$this->max_variation_regular_price = get_post_meta( $product_id, '_max_variation_regular_price', true );
		$this->min_variation_sale_price    = get_post_meta( $product_id, '_min_variation_sale_price', true );
		$this->max_variation_sale_price    = get_post_meta( $product_id, '_max_variation_sale_price', true );
	}


	/**
	 * Sync variable product prices with the children lowest/highest prices.
	 */
	public static function sync( $product_id ) {
		$children = get_posts( array(
			'post_parent' 	=> $product_id,
			'posts_per_page'=> -1,
			'post_type' 	=> 'product_variation',
			'fields' 		=> 'ids',
			'post_status'	=> 'publish'
		));

		$min_variation_price = $min_variation_regular_price = $min_variation_sale_price = $max_variation_price = $max_variation_regular_price = $max_variation_sale_price = '';

		if ( $children ) {
			foreach ( $children as $child ) {

				$child_price 			= get_post_meta( $child, '_price', true );
				$child_regular_price 	= get_post_meta( $child, '_regular_price', true );
				$child_sale_price 		= get_post_meta( $child, '_sale_price', true );

				if ( $child_price === '' && $child_regular_price === '' )
					continue;

				// Regular prices
				if ( $child_regular_price !== '' ) {
					if ( ! is_numeric( $min_variation_regular_price ) || $child_regular_price < $min_variation_regular_price )
						$min_variation_regular_price = $child_regular_price;

					if ( ! is_numeric( $max_variation_regular_price ) || $child_regular_price > $max_variation_regular_price )
						$max_variation_regular_price = $child_regular_price;
				}

				// Sale prices
				if ( $child_sale_price !== '' ) {
					if ( $child_price == $child_sale_price ) {
						if ( ! is_numeric( $min_variation_sale_price ) || $child_sale_price < $min_variation_sale_price )
							$min_variation_sale_price = $child_sale_price;

						if ( ! is_numeric( $max_variation_sale_price ) || $child_sale_price > $max_variation_sale_price )
							$max_variation_sale_price = $child_sale_price;
					}
				}

				// Actual prices
				if ( $child_price !== '' ) {
					if ( $child_price > $max_variation_price )
						$max_variation_price = $child_price;

					if ( $min_variation_price === '' || $child_price < $min_variation_price )
						$min_variation_price = $child_price;
				}
			}

			update_post_meta( $product_id, '_price', $min_variation_price );
			update_post_meta( $product_id, '_min_variation_price', $min_variation_price );
			update_post_meta( $product_id, '_max_variation_price', $max_variation_price );
			update_post_meta( $product_id, '_min_variation_regular_price', $min_variation_regular_price );
			update_post_meta( $product_id, '_max_variation_regular_price', $max_variation_regular_price );
			update_post_meta( $product_id, '_min_variation_sale_price', $min_variation_sale_price );
			update_post_meta( $product_id, '_max_variation_sale_price', $max_variation_sale_price );

			do_action( 'woocommerce_variable_product_sync', $product_id );

			wc_delete_product_transients( $product_id );
		} elseif ( get_post_status( $product_id ) == 'publish' ) {
			// No published variations - update parent post status. Use $wpdb to prevent endless loop on save_post hooks.
			global $wpdb;

			$wpdb->update( $wpdb->posts, array( 'post_status' => 'draft' ), array( 'ID' => $product_id ) );

			if ( is_admin() )
				WC_Admin_Meta_Boxes::add_error( __( 'This variable product has no active variations and will not be published.', 'woocommerce' ) );
		}
	}
}