/**
* Gets the volume of the product, if one is defined, in woocommerce product units
*
* @since 3.0
* @param WC_Product $product the product
* @return WC_Price_Calculator_Measurement total volume measurement for the product, or null
*/
public static function get_volume_measurement($product)
{
$measurement = null;
// if a length and width are defined, use that. We allow large and small dimensions
// (mm, km, mi) which don't make much sense to use as volumes, but
// we have no choice but to support them to some extent, so convert
// them to something more reasonable
if ($product->length && $product->width && $product->height) {
$volume = $product->length * $product->width * $product->height;
switch (get_option('woocommerce_dimension_unit')) {
case 'mm':
$volume *= 0.001;
// convert to ml
$unit = 'ml';
break;
case 'km':
$volume *= 1000000000;
// convert to cu m
$unit = 'cu m';
break;
case 'mi':
$volume *= 5451776000;
// convert to cu yd
$unit = 'cu. yd.';
break;
}
$unit = WC_Price_Calculator_Measurement::to_volume_unit(get_option('woocommerce_dimension_unit'));
$measurement = new WC_Price_Calculator_Measurement($unit, $volume, 'volume', __('Volume', WC_Measurement_Price_Calculator::TEXT_DOMAIN));
// convert to the product volume units
$measurement->set_unit(get_option('woocommerce_volume_unit'));
}
// if there's an area and height, next use that
$area = WC_Price_Calculator_Product::get_product_meta($product, 'area');
if ($area && $product->height) {
$area_unit = get_option('woocommerce_area_unit');
$area_measurement = new WC_Price_Calculator_Measurement($area_unit, $area);
$dimension_unit = get_option('woocommerce_dimension_unit');
$dimension_measurement = new WC_Price_Calculator_Measurement($dimension_unit, $product->height);
// determine the volume, in common units
$dimension_measurement->set_common_unit($area_measurement->get_unit_common());
$volume = $area_measurement->get_value_common() * $dimension_measurement->get_value_common();
$volume_unit = WC_Price_Calculator_Measurement::to_volume_unit($area_measurement->get_unit_common());
$measurement = new WC_Price_Calculator_Measurement($volume_unit, $volume, 'volume', __('Volume', WC_Measurement_Price_Calculator::TEXT_DOMAIN));
// and convert to final volume units
$measurement->set_unit(get_option('woocommerce_volume_unit'));
}
// finally if they overrode the length/width/height with a volume value, use that
$volume = WC_Price_Calculator_Product::get_product_meta($product, 'volume');
if ($volume) {
$measurement = new WC_Price_Calculator_Measurement(get_option('woocommerce_volume_unit'), $volume, 'volume', __('Volume', WC_Measurement_Price_Calculator::TEXT_DOMAIN));
}
// if no measurement, just create a default empty one
if (!$measurement) {
$measurement = new WC_Price_Calculator_Measurement(get_option('woocommerce_volume_unit'), 0, 'volume', __('Volume', WC_Measurement_Price_Calculator::TEXT_DOMAIN));
}
return $measurement;
}
/**
* Render the price calculator on the product page
*
* @since 3.0
*/
public function render_price_calculator()
{
global $product, $wc_measurement_price_calculator;
// is the calculator enabled for this product?
if (!$product || !WC_Price_Calculator_Product::calculator_enabled($product)) {
return;
}
$settings = new WC_Price_Calculator_Settings($product);
if (WC_Price_Calculator_Product::pricing_calculator_enabled($product)) {
// Pricing calculator with custom dimensions and a price "per unit"
// get the product total measurement (ie Area or Volume, etc)
$product_measurement = WC_Price_Calculator_Product::get_product_measurement($product, $settings);
$product_measurement->set_unit($settings->get_pricing_unit());
// get the product measurements, get a measurement, and set the product total measurement common unit based on the measurements common unit
$measurements = $settings->get_calculator_measurements();
list($measurement) = $measurements;
$product_measurement->set_common_unit($measurement->get_unit_common());
// pricing calculator enabled, get the template
wc_get_template('single-product/price-calculator.php', array('product_measurement' => $product_measurement, 'settings' => $settings, 'measurements' => $measurements), '', $wc_measurement_price_calculator->get_plugin_path() . '/templates/');
// need an element to contain the price for simple pricing rule products
if ($product->is_type('simple') && $settings->pricing_rules_enabled()) {
echo '<div class="single_variation"></div>';
}
} else {
// quantity calculator. where the quantity of product needed is based on the configured product dimensions. This is a actually bit more complex
// get the starting quantity, max quantity, and total product measurement in product units
$quantity_range = WC_Price_Calculator_Product::get_quantity_range($product);
// set the product measurement based on the minimum quantity value, and set the unit to the frontend calculator unit
$measurements = $settings->get_calculator_measurements();
// The product measurement will be used to create the 'amount actual' field.
$product_measurement = WC_Price_Calculator_Product::get_product_measurement($product, $settings);
// see whether all calculator measurements are defined in the same units (ie 'in', 'sq. in.' are considered the same)
$measurements_unit = null;
foreach ($measurements as $measurement) {
if (!$measurements_unit) {
$measurements_unit = $measurement->get_unit();
} else {
if (!WC_Price_Calculator_Measurement::compare_units($measurements_unit, $measurement->get_unit())) {
$measurements_unit = false;
break;
}
}
}
// All calculator measurements use the same base units, so lets use those for the 'amount actual' field
// area/volume product measurement can have a calculator measurement defined in units of length, so it
// will need to be converted to units of area or volume respectively
if ($measurements_unit) {
switch ($product_measurement->get_type()) {
case 'area':
$measurements_unit = WC_Price_Calculator_Measurement::to_area_unit($measurements_unit);
break;
case 'volume':
$measurements_unit = WC_Price_Calculator_Measurement::to_volume_unit($measurements_unit);
break;
}
}
// if the price per unit is displayed for this product, default to the pricing units for the 'amount actual' field
if (WC_Price_Calculator_Product::pricing_per_unit_enabled($product)) {
$measurements_unit = $settings->get_pricing_unit();
}
// if a measurement unit other than the default was determined, set it
if ($measurements_unit) {
$product_measurement->set_unit($measurements_unit);
}
$total_price = '';
if ($product->is_type('simple')) {
// If the product type is simple we can set an initial 'Amount Actual' and 'total price'
// we can't do this for variable products because we don't know which will be configured
// initially (actually I guess a default product can be configured, so maybe we can do something here)
// not enough product physical attributes defined to get our measurement, so bail
if (!$product_measurement->get_value()) {
return;
}
// figure out the starting measurement amount
// multiply the starting quantity by the measurement value
$product_measurement->set_value(round($quantity_range['min_value'] * $product_measurement->get_value(), 2));
$total_price = wc_price($quantity_range['min_value'] * $product->get_price(), 2);
} elseif ($product->is_type('variable')) {
// clear the product measurement value for variable products, since we can't really know what it is ahead of time (except for when a default is set)
$product_measurement->set_value('');
}
// pricing calculator enabled, get the template
wc_get_template('single-product/quantity-calculator.php', array('calculator_type' => $settings->get_calculator_type(), 'product_measurement' => $product_measurement, 'measurements' => $measurements, 'total_price' => $total_price), '', $wc_measurement_price_calculator->get_plugin_path() . '/templates/');
}
}
