woocommerce/classes/product.class.php

1050 lines
30 KiB
PHP
Raw Normal View History

2011-08-09 15:16:18 +00:00
<?php
/**
* Product Class
*
2011-08-10 17:11:11 +00:00
* The WooCommerce product class handles individual product data.
2011-08-09 15:16:18 +00:00
*
2011-08-10 17:11:11 +00:00
* @class woocommerce_product
* @package WooCommerce
* @category Class
* @author WooThemes
2011-08-09 15:16:18 +00:00
*/
2011-08-10 17:11:11 +00:00
class woocommerce_product {
2011-08-09 15:16:18 +00:00
var $id;
var $product_custom_fields;
2011-08-09 15:16:18 +00:00
var $exists;
var $attributes;
2011-08-18 23:14:35 +00:00
var $children;
2011-08-09 15:16:18 +00:00
var $post;
var $downloadable;
var $virtual;
2011-08-17 23:42:07 +00:00
var $sku;
var $price;
var $visibility;
2011-08-09 15:16:18 +00:00
var $stock;
2011-08-17 23:42:07 +00:00
var $stock_status;
var $backorders;
2011-08-18 23:14:35 +00:00
var $manage_stock;
var $sale_price;
var $regular_price;
var $weight;
2011-10-08 11:57:04 +00:00
var $length;
var $width;
var $height;
2011-08-18 23:14:35 +00:00
var $tax_status;
var $tax_class;
var $upsell_ids;
var $crosssell_ids;
2011-08-09 15:16:18 +00:00
var $product_type;
var $total_stock;
2011-09-03 22:37:16 +00:00
var $sale_price_dates_from;
var $sale_price_dates_to;
var $min_variation_price;
var $max_variation_price;
2011-11-13 12:07:29 +00:00
var $featured;
2011-12-02 20:48:07 +00:00
var $shipping_class;
var $dimensions;
2011-08-09 15:16:18 +00:00
/**
* Loads all product data from custom fields
*
* @param int $id ID of the product to load
*/
2011-08-10 17:11:11 +00:00
function woocommerce_product( $id ) {
2011-08-09 15:16:18 +00:00
2011-09-03 22:37:16 +00:00
$this->id = (int) $id;
2011-08-09 15:16:18 +00:00
$this->product_custom_fields = get_post_custom( $this->id );
2011-08-09 15:16:18 +00:00
$this->exists = (sizeof($this->product_custom_fields)>0) ? true : false;
2011-08-17 23:42:07 +00:00
// Define the data we're going to load: Key => Default value
$load_data = array(
'sku' => $this->id,
'downloadable' => 'no',
'virtual' => 'no',
'price' => '',
2011-08-17 23:42:07 +00:00
'visibility' => 'hidden',
'stock' => 0,
'stock_status' => 'instock',
'backorders' => 'no',
'manage_stock' => 'no',
'sale_price' => '',
'regular_price' => '',
'weight' => '',
2011-10-08 11:57:04 +00:00
'length' => '',
'width' => '',
'height' => '',
2011-08-17 23:42:07 +00:00
'tax_status' => 'taxable',
'tax_class' => '',
'upsell_ids' => array(),
'crosssell_ids' => array(),
'sale_price_dates_from' => '',
'sale_price_dates_to' => '',
'min_variation_price' => '',
2011-11-13 12:07:29 +00:00
'max_variation_price' => '',
'featured' => 'no'
2011-08-17 23:42:07 +00:00
);
// Load the data from the custom fields
foreach ($load_data as $key => $default) $this->$key = (isset($this->product_custom_fields['_' . $key][0]) && $this->product_custom_fields['_' . $key][0]!=='') ? $this->product_custom_fields['_' . $key][0] : $default;
2011-11-13 02:15:00 +00:00
2011-08-17 23:42:07 +00:00
// Get product type
2011-11-13 02:15:00 +00:00
$transient_name = 'woocommerce_product_type_' . $this->id;
2011-11-13 02:15:00 +00:00
if ( false === ( $this->product_type = get_transient( $transient_name ) ) ) :
$terms = wp_get_object_terms( $id, 'product_type', array('fields' => 'names') );
$this->product_type = (isset($terms[0])) ? sanitize_title($terms[0]) : 'simple';
set_transient( $transient_name, $this->product_type );
endif;
// Check sale dates
$this->check_sale_price();
2011-08-09 15:16:18 +00:00
}
2011-08-22 14:10:22 +00:00
/**
* Get SKU (Stock-keeping unit) - product uniqe ID
*
* @return mixed
*/
function get_sku() {
return $this->sku;
}
2011-11-13 02:15:00 +00:00
/**
* Get total stock
*
* This is the stock of parent and children combined
*/
function get_total_stock() {
if (is_null($this->total_stock)) :
2011-11-13 12:07:29 +00:00
$transient_name = 'woocommerce_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);
2011-11-13 12:07:29 +00:00
if ( $stock!='' ) :
$this->total_stock += $stock;
2011-11-13 02:15:00 +00:00
endif;
2011-11-13 12:07:29 +00:00
endforeach;
set_transient( $transient_name, $this->total_stock );
endif;
2011-11-13 02:15:00 +00:00
endif;
return (int) $this->total_stock;
}
2011-08-22 14:10:22 +00:00
2011-08-09 15:16:18 +00:00
/** Returns the product's children */
function get_children() {
if (!is_array($this->children)) :
$this->children = array();
if ($this->is_type('variable') || $this->is_type('grouped')) :
$child_post_type = ($this->is_type('variable')) ? 'product_variation' : 'product';
2011-11-13 12:07:29 +00:00
$transient_name = 'woocommerce_product_children_ids_' . $this->id;
if ( false === ( $this->children = get_transient( $transient_name ) ) ) :
2011-11-18 01:03:39 +00:00
$this->children = get_posts( 'post_parent=' . $this->id . '&post_type=' . $child_post_type . '&orderby=menu_order&order=ASC&fields=ids&post_status=any&numberposts=-1' );
2011-11-13 12:07:29 +00:00
set_transient( $transient_name, $this->children );
endif;
2011-08-09 15:16:18 +00:00
endif;
endif;
2011-08-22 14:10:22 +00:00
return (array) $this->children;
2011-08-09 15:16:18 +00:00
}
2011-11-13 12:07:29 +00:00
function get_child( $child_id ) {
if ($this->is_type('variable')) :
2012-01-10 15:11:06 +00:00
$child = new woocommerce_product_variation( $child_id, $this->id, $this->product_custom_fields );
2011-11-13 12:07:29 +00:00
else :
2012-01-10 15:11:06 +00:00
$child = new woocommerce_product( $child_id );
2011-11-13 12:07:29 +00:00
endif;
return $child;
}
2011-08-09 15:16:18 +00:00
/**
* Reduce stock level of the product
*
* @param int $by Amount to reduce by
*/
function reduce_stock( $by = 1 ) {
global $woocommerce;
2011-08-09 15:16:18 +00:00
if ($this->managing_stock()) :
2011-08-21 16:47:49 +00:00
$this->stock = $this->stock - $by;
2011-11-13 02:15:00 +00:00
$this->total_stock = $this->get_total_stock() - $by;
update_post_meta($this->id, '_stock', $this->stock);
2011-08-18 23:14:35 +00:00
// Out of stock attribute
2012-01-06 17:28:33 +00:00
if ($this->managing_stock() && !$this->backorders_allowed() && $this->get_total_stock()<=0) :
update_post_meta($this->id, '_stock_status', 'outofstock');
2012-01-06 17:28:33 +00:00
$woocommerce->clear_product_transients( $this->id ); // Clear transient
2011-11-13 02:15:00 +00:00
endif;
2011-08-18 23:14:35 +00:00
2011-08-21 16:47:49 +00:00
return $this->stock;
2011-08-09 15:16:18 +00:00
endif;
}
/**
* Increase stock level of the product
*
* @param int $by Amount to increase by
*/
function increase_stock( $by = 1 ) {
if ($this->managing_stock()) :
2011-08-21 16:47:49 +00:00
$this->stock = $this->stock + $by;
2011-11-13 02:15:00 +00:00
$this->total_stock = $this->get_total_stock() + $by;
update_post_meta($this->id, '_stock', $this->stock);
2011-08-18 23:14:35 +00:00
// Out of stock attribute
2012-01-06 17:28:33 +00:00
if ($this->managing_stock() && ($this->backorders_allowed() || $this->get_total_stock()>0)) :
update_post_meta($this->id, '_stock_status', 'instock');
$woocommerce->clear_product_transients( $this->id ); // Clear transient
endif;
2011-08-18 23:14:35 +00:00
2011-08-21 16:47:49 +00:00
return $this->stock;
2011-08-09 15:16:18 +00:00
endif;
}
/**
* Checks the product type
*
* Backwards compat with downloadable/virtual
2011-08-09 15:16:18 +00:00
*/
function is_type( $type ) {
if (is_array($type) && in_array($this->product_type, $type)) return true;
if ($this->product_type==$type) return true;
2011-08-09 15:16:18 +00:00
return false;
}
/**
* Checks if a product is downloadable
*/
function is_downloadable() {
if ( $this->downloadable=='yes' ) return true; else return false;
}
/**
* Checks if a product is virtual (has no shipping)
*/
function is_virtual() {
if ( $this->virtual=='yes' ) return true; else return false;
}
/**
* Checks if a product needs shipping
*/
function needs_shipping() {
if ($this->is_virtual()) return false; else return true;
}
2011-08-09 15:16:18 +00:00
/** Returns whether or not the product has any child product */
2011-09-21 15:13:53 +00:00
function has_child() {
return sizeof($this->get_children()) ? true : false;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product post exists */
function exists() {
if ($this->exists) return true;
return false;
}
/** Returns whether or not the product is taxable */
function is_taxable() {
2011-12-23 18:07:44 +00:00
if ($this->tax_status=='taxable' && get_option('woocommerce_calc_taxes')=='yes') return true;
2011-08-09 15:16:18 +00:00
return false;
}
/** Returns whether or not the product shipping is taxable */
function is_shipping_taxable() {
2011-08-17 23:42:07 +00:00
if ($this->tax_status=='taxable' || $this->tax_status=='shipping') return true;
2011-08-09 15:16:18 +00:00
return false;
}
/** Get the product's post data */
function get_post_data() {
if (empty($this->post)) :
$this->post = get_post( $this->id );
endif;
return $this->post;
}
/** Get the title of the post */
2011-08-30 11:24:28 +00:00
function get_title() {
2011-08-09 15:16:18 +00:00
$this->get_post_data();
2011-11-13 19:01:10 +00:00
return apply_filters('woocommerce_product_title', apply_filters('the_title', $this->post->post_title), $this);
2011-08-09 15:16:18 +00:00
}
/** Get the add to url */
function add_to_cart_url() {
global $woocommerce;
2011-08-09 15:16:18 +00:00
if ($this->is_type('variable')) :
$url = add_query_arg('add-to-cart', 'variation');
$url = add_query_arg('product', $this->id, $url);
elseif ( $this->has_child() ) :
$url = add_query_arg('add-to-cart', 'group');
$url = add_query_arg('product', $this->id, $url);
else :
$url = add_query_arg('add-to-cart', $this->id);
endif;
$url = $woocommerce->nonce_url( 'add_to_cart', $url );
2011-08-09 15:16:18 +00:00
return $url;
}
/** Returns whether or not the product is stock managed */
function managing_stock() {
2011-12-09 21:47:12 +00:00
if (!isset($this->manage_stock) || $this->manage_stock=='no') return false;
if (get_option('woocommerce_manage_stock')=='yes') return true;
2011-08-09 15:16:18 +00:00
return false;
}
/** Returns whether or not the product is in stock */
function is_in_stock() {
if ($this->managing_stock()) :
if (!$this->backorders_allowed()) :
2011-11-13 02:15:00 +00:00
if ($this->get_total_stock()==0 || $this->get_total_stock()<0) :
2011-08-09 15:16:18 +00:00
return false;
else :
2011-08-17 23:42:07 +00:00
if ($this->stock_status=='instock') return true;
2011-08-09 15:16:18 +00:00
return false;
endif;
else :
2011-08-17 23:42:07 +00:00
if ($this->stock_status=='instock') return true;
2011-08-09 15:16:18 +00:00
return false;
endif;
endif;
2011-08-18 23:14:35 +00:00
if ($this->stock_status=='instock') return true;
return false;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product can be backordered */
function backorders_allowed() {
2011-08-17 23:42:07 +00:00
if ($this->backorders=='yes' || $this->backorders=='notify') return true;
2011-08-09 15:16:18 +00:00
return false;
}
/** Returns whether or not the product needs to notify the customer on backorder */
function backorders_require_notification() {
2011-08-17 23:42:07 +00:00
if ($this->backorders=='notify') return true;
2011-08-09 15:16:18 +00:00
return false;
}
2011-08-22 14:10:22 +00:00
/**
* Returns number of items available for sale.
*
* @return int
*/
function get_stock_quantity() {
2011-11-13 19:01:10 +00:00
return (int) $this->stock;
2011-08-22 14:10:22 +00:00
}
2011-08-09 15:16:18 +00:00
/** Returns whether or not the product has enough stock for the order */
function has_enough_stock( $quantity ) {
2011-08-30 11:24:28 +00:00
if (!$this->managing_stock()) return true;
2011-08-09 15:16:18 +00:00
if ($this->backorders_allowed()) return true;
if ($this->stock >= $quantity) :
return true;
endif;
return false;
}
/** Returns the availability of the product */
function get_availability() {
$availability = "";
$class = "";
if (!$this->managing_stock()) :
if ($this->is_in_stock()) :
2012-01-05 11:31:22 +00:00
//$availability = __('In stock', 'woocommerce'); /* Lets not bother showing stock if its not managed and is available */
2011-08-09 15:16:18 +00:00
else :
2012-01-05 11:31:22 +00:00
$availability = __('Out of stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock';
endif;
else :
if ($this->is_in_stock()) :
2011-11-13 02:15:00 +00:00
if ($this->get_total_stock() > 0) :
2012-01-05 11:31:22 +00:00
$availability = __('In stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
if ($this->backorders_allowed()) :
if ($this->backorders_require_notification()) :
$availability .= ' &ndash; '.$this->stock.' ';
2012-01-05 11:31:22 +00:00
$availability .= __('available', 'woocommerce');
$availability .= __(' (backorders allowed)', 'woocommerce');
2011-08-09 15:16:18 +00:00
endif;
else :
$availability .= ' &ndash; '.$this->stock.' ';
2012-01-05 11:31:22 +00:00
$availability .= __('available', 'woocommerce');
2011-08-09 15:16:18 +00:00
endif;
else :
if ($this->backorders_allowed()) :
if ($this->backorders_require_notification()) :
2012-01-05 11:31:22 +00:00
$availability = __('Available on backorder', 'woocommerce');
2011-08-09 15:16:18 +00:00
else :
2012-01-05 11:31:22 +00:00
$availability = __('In stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
endif;
else :
2012-01-05 11:31:22 +00:00
$availability = __('Out of stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock';
endif;
endif;
else :
if ($this->backorders_allowed()) :
2012-01-05 11:31:22 +00:00
$availability = __('Available on backorder', 'woocommerce');
2011-08-09 15:16:18 +00:00
else :
2012-01-05 11:31:22 +00:00
$availability = __('Out of stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock';
endif;
endif;
endif;
return array( 'availability' => $availability, 'class' => $class);
}
/** Returns whether or not the product is featured */
function is_featured() {
2011-11-13 12:07:29 +00:00
if ($this->featured=='yes') return true; else return false;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product is visible */
2012-01-12 00:54:45 +00:00
function is_visible() {
2011-08-18 23:14:35 +00:00
2012-01-03 15:55:05 +00:00
$visible = true;
2011-08-18 23:14:35 +00:00
// Out of stock visibility
2012-01-03 15:55:05 +00:00
if (get_option('woocommerce_hide_out_of_stock_items')=='yes' && !$this->is_in_stock()) $visible = false;
2011-08-18 23:14:35 +00:00
// visibility setting
2012-01-03 15:55:05 +00:00
elseif ($this->visibility=='hidden') $visible = false;
elseif ($this->visibility=='visible') $visible = true;
2011-11-24 15:32:57 +00:00
// Visibility in loop
2012-01-03 15:55:05 +00:00
elseif ($this->visibility=='search' && is_search()) $visible = true;
elseif ($this->visibility=='search' && !is_search()) $visible = false;
elseif ($this->visibility=='catalog' && is_search()) $visible = false;
elseif ($this->visibility=='catalog' && !is_search()) $visible = true;
return apply_filters('woocommerce_product_is_visible', $visible, $this->id);
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product is on sale */
function is_on_sale() {
2011-12-09 21:47:12 +00:00
if ($this->has_child()) :
2011-08-09 15:16:18 +00:00
2011-11-13 12:07:29 +00:00
foreach ($this->get_children() as $child_id) :
$sale_price = get_post_meta( $child_id, '_sale_price', true );
2012-01-05 16:00:23 +00:00
if ( $sale_price!=="" && $sale_price >= 0 ) return true;
2011-08-09 15:16:18 +00:00
endforeach;
else :
if ( $this->sale_price && $this->sale_price==$this->price ) return true;
2011-08-09 15:16:18 +00:00
endif;
return false;
}
/** Returns the product's weight */
function get_weight() {
2011-08-17 23:42:07 +00:00
if ($this->weight) return $this->weight;
2011-08-09 15:16:18 +00:00
}
/** Adjust a products price dynamically */
function adjust_price( $price ) {
if ($price>0) :
$this->price += $price;
endif;
}
2011-08-09 15:16:18 +00:00
/** Returns the product's price */
function get_price() {
return $this->price;
}
2012-01-04 23:11:07 +00:00
/** Returns the price (including tax) - ignores tax_class filters */
function get_price_including_tax( $round = true ) {
$price = $this->price;
if ( $this->is_taxable() && get_option('woocommerce_prices_include_tax')=='no' ) :
2012-01-10 15:11:06 +00:00
$_tax = new woocommerce_tax();
2012-01-04 23:11:07 +00:00
$tax_rates = $_tax->get_shop_base_rate( $this->tax_class );
$taxes = $_tax->calc_tax( $price, $tax_rates, false );
$tax_amount = $_tax->get_tax_total( $taxes );
$price = round( $price + $tax_amount, 2);
endif;
return $price;
}
2011-08-09 15:16:18 +00:00
/** Returns the price (excluding tax) - ignores tax_class filters since the price may *include* tax and thus needs subtracting */
function get_price_excluding_tax( $round = true ) {
2011-08-09 15:16:18 +00:00
$price = $this->price;
2011-12-30 19:36:44 +00:00
if ( $this->is_taxable() && get_option('woocommerce_prices_include_tax')=='yes' ) :
2011-12-29 01:18:59 +00:00
2012-01-10 15:11:06 +00:00
$_tax = new woocommerce_tax();
2011-12-29 01:18:59 +00:00
$tax_rates = $_tax->get_shop_base_rate( $this->tax_class );
2011-12-29 01:18:59 +00:00
if ($round) :
2012-01-13 21:25:39 +00:00
$taxes = $_tax->calc_tax( $price, $tax_rates, true );
$tax_amount = $_tax->get_tax_total( $taxes );
2011-12-29 01:18:59 +00:00
$price = round( $price - $tax_amount, 2);
else :
2012-01-14 01:23:16 +00:00
$taxes = $_tax->calc_tax( $price, $tax_rates, true );
$tax_amount = array_sum( $taxes );
2011-12-29 01:18:59 +00:00
$price = $price - $tax_amount;
2011-08-09 15:16:18 +00:00
endif;
endif;
return $price;
}
2011-10-07 22:24:11 +00:00
/** Returns the tax class */
function get_tax_class() {
return apply_filters('woocommerce_product_tax_class', $this->tax_class, $this);
}
2011-12-31 19:03:41 +00:00
/** Returns the tax status */
function get_tax_status() {
return $this->tax_status;
}
2011-08-09 15:16:18 +00:00
/** Returns the price in html format */
function get_price_html() {
$price = '';
if ($this->is_type('grouped')) :
2011-08-09 15:16:18 +00:00
$min_price = '';
$max_price = '';
2011-11-13 12:07:29 +00:00
foreach ($this->get_children() as $child_id) :
$child_price = get_post_meta( $child_id, '_price', true);
2011-08-09 15:16:18 +00:00
if ($child_price<$min_price || $min_price == '') $min_price = $child_price;
if ($child_price>$max_price || $max_price == '') $max_price = $child_price;
endforeach;
2012-01-05 11:31:22 +00:00
$price .= '<span class="from">' . _x('From:', 'min_price', 'woocommerce') . ' </span>' . woocommerce_price($min_price);
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_grouped_price_html', $price, $this);
2011-08-09 15:16:18 +00:00
elseif ($this->is_type('variable')) :
2012-01-05 11:31:22 +00:00
if ( !$this->min_variation_price || $this->min_variation_price !== $this->max_variation_price ) $price .= '<span class="from">' . _x('From:', 'min_price', 'woocommerce') . ' </span>';
$price .= woocommerce_price($this->get_price());
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_variable_price_html', $price, $this);
2011-08-09 15:16:18 +00:00
else :
2011-11-22 23:31:44 +00:00
if ($this->price > 0) :
2011-08-17 23:42:07 +00:00
if ($this->is_on_sale() && isset($this->regular_price)) :
2011-08-17 23:42:07 +00:00
$price .= '<del>'.woocommerce_price( $this->regular_price ).'</del> <ins>'.woocommerce_price($this->get_price()).'</ins>';
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_sale_price_html', $price, $this);
2011-08-09 15:16:18 +00:00
else :
2011-08-10 17:11:11 +00:00
$price .= woocommerce_price($this->get_price());
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_price_html', $price, $this);
2011-08-09 15:16:18 +00:00
endif;
elseif ($this->price === '' ) :
2011-11-05 19:12:51 +00:00
$price = apply_filters('woocommerce_empty_price_html', '', $this);
2011-11-22 23:31:44 +00:00
elseif ($this->price == 0 ) :
2011-11-22 23:31:44 +00:00
if ($this->is_on_sale() && isset($this->regular_price)) :
2012-01-05 11:31:22 +00:00
$price .= '<del>'.woocommerce_price( $this->regular_price ).'</del> <ins>'.__('Free!', 'woocommerce').'</ins>';
2011-11-22 23:31:44 +00:00
$price = apply_filters('woocommerce_free_sale_price_html', $price, $this);
else :
2012-01-05 11:31:22 +00:00
$price = __('Free!', 'woocommerce');
2011-11-22 23:31:44 +00:00
$price = apply_filters('woocommerce_free_price_html', $price, $this);
endif;
2011-08-09 15:16:18 +00:00
endif;
endif;
2011-08-09 15:16:18 +00:00
return $price;
}
/** Returns the product rating in html format - ratings are stored in transient cache */
function get_rating_html( $location = '' ) {
2011-08-28 12:04:05 +00:00
if ($location) $location = '_'.$location;
$star_size = apply_filters('woocommerce_star_rating_size'.$location, 16);
if ( false === ( $average_rating = get_transient( $this->id . '_woocommerce_average_rating' ) ) ) :
2011-08-28 12:04:05 +00:00
global $wpdb;
$count = $wpdb->get_var("
SELECT COUNT(meta_value) FROM $wpdb->commentmeta
LEFT JOIN $wpdb->comments ON $wpdb->commentmeta.comment_id = $wpdb->comments.comment_ID
WHERE meta_key = 'rating'
AND comment_post_ID = $this->id
AND comment_approved = '1'
AND meta_value > 0
");
$ratings = $wpdb->get_var("
SELECT SUM(meta_value) FROM $wpdb->commentmeta
LEFT JOIN $wpdb->comments ON $wpdb->commentmeta.comment_id = $wpdb->comments.comment_ID
WHERE meta_key = 'rating'
AND comment_post_ID = $this->id
AND comment_approved = '1'
");
if ( $count>0 ) :
$average_rating = number_format($ratings / $count, 2);
else :
$average_rating = '';
endif;
2011-08-28 12:04:05 +00:00
set_transient( $this->id . '_woocommerce_average_rating', $average_rating );
endif;
if ( $average_rating>0 ) :
2012-01-05 11:31:22 +00:00
return '<div class="star-rating" title="'.sprintf(__('Rated %s out of 5', 'woocommerce'), $average_rating).'"><span style="width:'.($average_rating*$star_size).'px"><span class="rating">'.$average_rating.'</span> '.__('out of 5', 'woocommerce').'</span></div>';
2011-08-28 12:04:05 +00:00
else :
return '';
endif;
}
2011-08-09 15:16:18 +00:00
/** Returns the upsell product ids */
function get_upsells() {
2011-08-19 20:11:04 +00:00
return (array) maybe_unserialize( $this->upsell_ids );
2011-08-09 15:16:18 +00:00
}
/** Returns the crosssell product ids */
function get_cross_sells() {
2011-08-19 20:11:04 +00:00
return (array) maybe_unserialize( $this->crosssell_ids );
2011-08-09 15:16:18 +00:00
}
/** Returns the product categories */
function get_categories( $sep = ', ', $before = '', $after = '' ) {
return get_the_term_list($this->id, 'product_cat', $before, $sep, $after);
}
/** Returns the product tags */
function get_tags( $sep = ', ', $before = '', $after = '' ) {
return get_the_term_list($this->id, 'product_tag', $before, $sep, $after);
}
2011-12-02 20:48:07 +00:00
/** Returns the product shipping class */
function get_shipping_class() {
if (!$this->shipping_class) :
$classes = get_the_terms( $this->id, 'product_shipping_class' );
$this->shipping_class = (isset($classes[0])) ? $classes[0]->slug : '';
endif;
return $this->shipping_class;
}
2011-08-09 15:16:18 +00:00
/** Get and return related products */
function get_related( $limit = 5 ) {
2011-11-13 12:17:52 +00:00
global $woocommerce;
2011-08-09 15:16:18 +00:00
// Related products are found from category and tag
$tags_array = array(0);
$cats_array = array(0);
// Get tags
$terms = wp_get_post_terms($this->id, 'product_tag');
2011-11-13 12:17:52 +00:00
foreach ($terms as $term) $tags_array[] = $term->term_id;
2011-08-09 15:16:18 +00:00
// Get categories
2011-08-09 15:16:18 +00:00
$terms = wp_get_post_terms($this->id, 'product_cat');
2011-11-13 12:17:52 +00:00
foreach ($terms as $term) $cats_array[] = $term->term_id;
// Don't bother if none are set
if ( sizeof($cats_array)==1 && sizeof($tags_array)==1 ) return array();
2011-11-13 12:17:52 +00:00
// Meta query
$meta_query = array();
$meta_query[] = $woocommerce->query->visibility_meta_query();
$meta_query[] = $woocommerce->query->stock_status_meta_query();
// Get the posts
2012-01-05 16:02:37 +00:00
$related_posts = get_posts(apply_filters('woocommerce_product_related_posts', array(
2011-11-13 12:17:52 +00:00
'orderby' => 'rand',
'posts_per_page'=> $limit,
'post_type' => 'product',
'fields' => 'ids',
'meta_query' => $meta_query,
'tax_query' => array(
'relation' => 'OR',
array(
'taxonomy' => 'product_cat',
'field' => 'id',
'terms' => $cats_array
),
array(
'taxonomy' => 'product_tag',
'field' => 'id',
'terms' => $tags_array
2011-08-09 15:16:18 +00:00
)
2011-11-13 12:17:52 +00:00
)
2012-01-05 16:02:37 +00:00
)));
2011-11-13 12:17:52 +00:00
2011-11-17 19:07:25 +00:00
$related_posts = array_diff( $related_posts, array($this->id) );
2011-08-09 15:16:18 +00:00
2011-11-13 12:17:52 +00:00
return $related_posts;
2011-08-09 15:16:18 +00:00
}
2011-11-26 20:23:57 +00:00
/** Returns a single product attribute */
function get_attribute( $attr ) {
$attributes = $this->get_attributes();
2012-01-10 17:14:40 +00:00
$attr = sanitize_title( $attr );
if (isset($attributes[$attr]) || isset($attributes['pa_' . $attr])) :
$attribute = isset($attributes[$attr]) ? $attributes[$attr] : $attributes['pa_' . $attr];
if ($attribute['is_taxonomy']) :
// Get string with terms
return get_the_term_list( $this->id, $attribute['name'], ''. '', ', ' );
else :
return $attribute['value'];
endif;
endif;
return false;
2011-11-26 20:23:57 +00:00
}
2011-08-09 15:16:18 +00:00
/** Returns product attributes */
function get_attributes() {
2011-11-13 02:15:00 +00:00
if (!is_array($this->attributes)) :
if (isset($this->product_custom_fields['_product_attributes'][0]))
$this->attributes = maybe_unserialize( maybe_unserialize( $this->product_custom_fields['_product_attributes'][0] ));
2011-11-13 02:15:00 +00:00
else
$this->attributes = array();
endif;
return (array) $this->attributes;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product has any attributes set */
function has_attributes() {
2011-11-13 02:15:00 +00:00
if (sizeof($this->get_attributes())>0) :
foreach ($this->get_attributes() as $attribute) :
2011-11-14 13:57:12 +00:00
if (isset($attribute['is_visible']) && $attribute['is_visible']) return true;
2011-08-09 15:16:18 +00:00
endforeach;
endif;
return false;
}
/** Returns whether or not we are showing dimensions on the product page */
function enable_dimensions_display() {
if (get_option('woocommerce_enable_dimension_product_attributes')=='yes') return true;
return false;
}
/** Returns whether or not the product has dimensions set */
function has_dimensions() {
if ($this->get_dimensions()) return true;
return false;
}
/** Returns whether or not the product has weight set */
function has_weight() {
if ($this->get_weight()) return true;
return false;
}
/** Returns dimensions */
function get_dimensions() {
if (!$this->dimensions) :
$this->dimensions = '';
$length = $this->length;
$width = $this->width;
$height = $this->height;
if (($length && $width && $height)) $dimensions = $length . get_option('woocommerce_dimension_unit') . ' x ' . $width . get_option('woocommerce_dimension_unit') . ' x ' . $height . get_option('woocommerce_dimension_unit');
endif;
return $this->dimensions;
}
/** Lists a table of attributes for the product page */
function list_attributes() {
global $woocommerce;
$attributes = $this->get_attributes();
if (sizeof($attributes)>0 || ($this->enable_dimensions_display() && ($this->has_dimensions() || $this->has_weight()))) :
2011-08-09 15:16:18 +00:00
echo '<table class="shop_attributes">';
2011-08-09 15:16:18 +00:00
$alt = 1;
if ($this->enable_dimensions_display()) :
if ($this->has_weight()) :
$alt = $alt*-1;
echo '<tr class="';
if ($alt==1) echo 'alt';
echo '"><th>'.__('Weight', 'woocommerce').'</th><td>'. $this->get_weight() . get_option('woocommerce_weight_unit') .'</td></tr>';
endif;
if ($this->has_dimensions()) :
$alt = $alt*-1;
echo '<tr class="';
if ($alt==1) echo 'alt';
echo '"><th>'.__('Dimensions', 'woocommerce').'</th><td>'.$this->get_dimensions().'</td></tr>';
endif;
endif;
2011-08-09 15:16:18 +00:00
foreach ($attributes as $attribute) :
2011-11-14 13:57:12 +00:00
if (!isset($attribute['is_visible']) || !$attribute['is_visible']) continue;
2011-08-09 15:16:18 +00:00
$alt = $alt*-1;
echo '<tr class="';
if ($alt==1) echo 'alt';
echo '"><th>'.$woocommerce->attribute_label( $attribute['name'] ).'</th><td>';
2011-08-09 15:16:18 +00:00
if ($attribute['is_taxonomy']) :
$post_terms = wp_get_post_terms( $this->id, $attribute['name'] );
$values = array();
foreach ($post_terms as $term) :
$values[] = $term->name;
endforeach;
echo implode(', ', $values);
else :
2011-10-31 00:08:41 +00:00
// Convert pipes to commas
$value = explode('|', $attribute['value']);
$value = implode(', ', $value);
echo wpautop(wptexturize($value));
endif;
2011-08-09 15:16:18 +00:00
echo '</td></tr>';
endforeach;
echo '</table>';
endif;
}
2011-08-22 14:10:22 +00:00
/**
* Return an array of attributes used for variations, as well as their possible values
*
* @return two dimensional array of attributes and their available values
*/
function get_available_attribute_variations() {
2011-08-22 14:10:22 +00:00
if (!$this->is_type('variable') || !$this->has_child()) return array();
$attributes = $this->get_attributes();
if(!is_array($attributes)) return array();
$available_attributes = array();
foreach ($attributes as $attribute) {
if (!$attribute['is_variation']) continue;
2011-08-22 14:10:22 +00:00
$values = array();
$attribute_field_name = 'attribute_'.sanitize_title($attribute['name']);
2011-08-22 14:10:22 +00:00
2011-11-13 12:07:29 +00:00
foreach ($this->get_children() as $child_id) {
if (get_post_status( $child_id ) != 'publish') continue; // Disabled
$child = $this->get_child( $child_id );
$vattributes = $child->get_variation_attributes();
2011-08-22 14:10:22 +00:00
2011-11-13 12:07:29 +00:00
if (is_array($vattributes)) {
foreach ($vattributes as $name => $value) {
if ($name == $attribute_field_name) {
$values[] = $value;
2011-08-22 14:10:22 +00:00
}
}
}
}
2011-11-22 16:13:32 +00:00
2011-08-22 14:10:22 +00:00
// empty value indicates that all options for given attribute are available
if(in_array('', $values)) {
// Get all options
if ($attribute['is_taxonomy']) :
$options = array();
$post_terms = wp_get_post_terms( $this->id, $attribute['name'] );
foreach ($post_terms as $term) :
$options[] = $term->slug;
endforeach;
else :
$options = explode('|', $attribute['value']);
endif;
$options = array_map('trim', $options);
2011-08-22 14:10:22 +00:00
$values = array_unique($options);
2011-11-22 16:13:32 +00:00
} else {
// Order custom attributes (non taxonomy) as defined
if (!$attribute['is_taxonomy']) :
$options = explode('|', $attribute['value']);
$options = array_map('trim', $options);
$values = array_intersect( $options, $values );
endif;
$values = array_unique($values);
2011-08-22 14:10:22 +00:00
}
2011-08-22 14:10:22 +00:00
$available_attributes[$attribute['name']] = array_unique($values);
}
2011-08-22 14:10:22 +00:00
return $available_attributes;
}
2011-09-03 22:37:16 +00:00
/**
* Gets the main product image
*/
function get_image( $size = 'shop_thumbnail' ) {
global $woocommerce;
if (has_post_thumbnail($this->id)) :
echo get_the_post_thumbnail($this->id, $size);
2011-11-18 12:32:59 +00:00
elseif (($parent_id = wp_get_post_parent_id( $this->id )) && has_post_thumbnail($parent_id)) :
echo get_the_post_thumbnail($parent_id, $size);
else :
echo '<img src="'.$woocommerce->plugin_url(). '/assets/images/placeholder.png" alt="Placeholder" width="'.$woocommerce->get_image_size('shop_thumbnail_image_width').'" height="'.$woocommerce->get_image_size('shop_thumbnail_image_height').'" />';
endif;
}
2011-09-03 22:37:16 +00:00
/**
* Checks sale data to see if the product is due to go on sale/sale has expired, and updates the main price
*/
function check_sale_price() {
global $woocommerce;
if ($this->sale_price_dates_from && $this->sale_price_dates_from < current_time('timestamp')) :
2011-09-03 22:37:16 +00:00
if ($this->sale_price && $this->price!==$this->sale_price) :
$this->price = $this->sale_price;
update_post_meta($this->id, '_price', $this->price);
2011-09-03 22:37:16 +00:00
// Grouped product prices and sale status are affected by children
$this->grouped_product_sync();
2011-09-03 22:37:16 +00:00
// Clear transient
2011-11-13 12:07:29 +00:00
$woocommerce->clear_product_transients( $this->id );
2011-09-03 22:37:16 +00:00
endif;
endif;
if ($this->sale_price_dates_to && $this->sale_price_dates_to < current_time('timestamp')) :
2011-09-03 22:37:16 +00:00
if ($this->regular_price && $this->price!==$this->regular_price) :
$this->price = $this->regular_price;
update_post_meta($this->id, '_price', $this->price);
2011-09-03 22:37:16 +00:00
// Sale has expired - clear the schedule boxes
update_post_meta($this->id, '_sale_price', '');
update_post_meta($this->id, '_sale_price_dates_from', '');
update_post_meta($this->id, '_sale_price_dates_to', '');
2011-09-03 22:37:16 +00:00
// Grouped product prices and sale status are affected by children
$this->grouped_product_sync();
// Clear transient
2011-11-13 12:07:29 +00:00
$woocommerce->clear_product_transients( $this->id );
2011-09-03 22:37:16 +00:00
endif;
endif;
}
/**
* Sync grouped products with the childs lowest price (so they can be sorted by price accurately)
**/
function grouped_product_sync() {
2011-09-03 22:37:16 +00:00
global $wpdb;
$post_parent = $wpdb->get_var("SELECT post_parent FROM $wpdb->posts WHERE ID = $this->id;");
if (!$post_parent) return;
$children_by_price = get_posts( array(
'post_parent' => $post_parent,
'orderby' => 'meta_value_num',
'order' => 'asc',
2011-12-24 17:09:43 +00:00
'meta_key' => '_price',
2011-09-03 22:37:16 +00:00
'posts_per_page' => 1,
'post_type' => 'product',
'fields' => 'ids'
2011-09-03 22:37:16 +00:00
));
if ($children_by_price) :
foreach ($children_by_price as $child) :
$child_price = get_post_meta($child, '_price', true);
update_post_meta( $post_parent, '_price', $child_price );
endforeach;
2011-09-03 22:37:16 +00:00
endif;
}
2011-08-09 15:16:18 +00:00
}