WC_Cart::calculate_totals() - Code Metrics - Inspection of "2.7 - Discount calculation classes" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#11889)

by Mike
created 2016-09-13 12:38 UTC
WC_Cart::calculate_totals() A

↳ Parent: WC_Cart
Complexity

Conditions	1
Paths	1
Size

Total Lines	20
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	10
nc	1
nop	0
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0
<?php
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * @todo
 *
 * - Handle checkout
 * - Item types
 * - Coupon totals
 * - Orers same system
 * - Apply backend coupons
 * - Unit tests
 */
include_once( WC_ABSPATH . 'includes/class-wc-cart-coupons.php' );
include_once( WC_ABSPATH . 'includes/class-wc-cart-fees.php' );
include_once( WC_ABSPATH . 'includes/class-wc-cart-item.php' );
include_once( WC_ABSPATH . 'includes/class-wc-cart-items.php' );
include_once( WC_ABSPATH . 'includes/class-wc-cart-session.php' );
include_once( WC_ABSPATH . 'includes/class-wc-cart-totals.php' );

/**
 * Main cart class.
 *
 * @version		2.7.0
 * @package		WooCommerce/Classes
 * @category	Class
 * @author 		WooThemes
 */
class WC_Cart extends WC_Cart_Session {

	/**
	 * Cart totals class.
	 * @var WC_Cart_Totals
	 */
	protected $totals;

	/**
	 * This stores the chosen shipping methods for the cart item packages.
	 * @var array
	 */
	protected $shipping_methods;

	/**
	 * Constructor for the cart class.
	 */
	public function __construct() {
		parent::__construct();

		$this->totals = new WC_Cart_Totals;

		add_action( 'woocommerce_add_to_cart', array( $this, 'calculate_totals' ), 20, 0 );
		add_action( 'woocommerce_applied_coupon', array( $this, 'calculate_totals' ), 20, 0 );
		add_action( 'woocommerce_cart_item_removed', array( $this, 'calculate_totals' ), 20, 0 );
		add_action( 'woocommerce_cart_item_restored', array( $this, 'calculate_totals' ), 20, 0 );
	}

	/**
	 * Add an item to the cart.
	 */
	public function add_item( $args ) {
		$item_key   = $this->items->generate_key( $args );
		$cart_items = $this->items->get_items();

		if ( $item = $this->items->get_item_by_key( $item_key ) ) {
			$item->set_quantity( $item->get_quantity() + $args['quantity']  );
		} else {
			$item                    = new WC_Item_Product( $args );
			$cart_items[ $item_key ] = apply_filters( 'woocommerce_add_cart_item', $item, $item_key );
		}

		$this->items->set_items( $cart_items );

		return $item_key;
	}

	/**
	 * Add additional fee to the cart.
	 *
	 * @param string $name Unique name for the fee. Multiple fees of the same name cannot be added.
	 * @param float $amount Fee amount.
	 * @param bool $taxable (default: false) Is the fee taxable?
	 * @param string $tax_class (default: '') The tax class for the fee if taxable. A blank string is standard tax class.
	 */
	public function add_fee( $name, $amount, $taxable = false, $tax_class = '' ) {
		$fee_key = $this->fees->generate_key( $name );
		$fees    = $this->fees->get_fees();

		// Only add each fee once
		if ( isset( $fees[ $fee_key ] ) ) {
			return;
		}

		$fees[ $fee_key ] = (object) array(
			'id'        => $fee_key,
			'name'      => wc_clean( $name ),
			'amount'    => (float) $amount,
			'tax_class' => $tax_class,
			'taxable'   => (bool) $taxable,
		);

		$this->fees->set_fees( $fees );

		return $fee_key;
	}

	/**
	 * Applies a coupon code.
	 * @since 2.7.0
	 * @param string $coupon_code - The code to apply
	 * @return bool	True if the coupon is applied, false if it does not exist or cannot be applied
	 */
	public function add_coupon( $coupon_code ) {
		if ( ! wc_coupons_enabled() ) {
			return false;
		}
		try {
			$coupon  = new WC_Coupon( $coupon_code );
			$coupons = array_keys( $this->get_coupons() );

			if ( ! $coupon->is_valid() ) {
				throw new Exception( $coupon->get_error_message() );
			}

			if ( $this->has_coupon( $coupon_code ) ) {
				throw new Exception( '', WC_Coupon::E_WC_COUPON_ALREADY_APPLIED );
			}

			if ( $coupon->get_individual_use() ) {
				$coupons = apply_filters( 'woocommerce_apply_individual_use_coupon', array(), $coupon, $coupons );
			}

			$coupons[] = $coupon_code;

			$this->coupons->set_coupons( $coupons );

			do_action( 'woocommerce_applied_coupon', $coupon_code, $coupon );
		} catch ( Exception $e ) {
			wc_add_notice( $e->getCode() ? WC_Coupon::get_coupon_error( $e->getCode() ) : $e->getMessage(), 'error' );
			return false;
		}
		return true;
	}

	/**
	 * Returns the contents of the cart in an array.
	 * @return array contents of the cart
	 */
	public function get_cart() {
		if ( ! did_action( 'wp_loaded' ) ) {
			_doing_it_wrong( __FUNCTION__, __( 'Get cart should not be called before the wp_loaded action.', 'woocommerce' ), '2.3' );
		}
		if ( ! did_action( 'woocommerce_cart_loaded_from_session' ) ) {
			$this->get_cart_from_session();
		}
		return $this->items->get_items();
	}

	/**
	 * Get array of fees.
	 * @return array of fees
	 */
	public function get_fees() {
		return $this->fees->get_fees();
	}

	/**
	 * Get array of applied coupon objects and codes.
	 * @return array of applied coupons
	 */
	public function get_coupons() {
		return $this->coupons->get_coupons();
	}

	/**
	* Checks if the cart is empty.
	* @return bool
	*/
	public function is_empty() {
		return ! sizeof( $this->get_cart() );
	}

	/**
	 * Empties the cart and optionally the persistent cart too.
	 */
	public function empty_cart() {
		$this->items->set_items( false );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$this->fees->set_fees( false );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$this->coupons->set_coupons( false );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$this->shipping_methods = null;

		$this->totals = new WC_Cart_Totals;
		do_action( 'woocommerce_cart_emptied' );
	}

	/**
	 * Set the quantity for an item in the cart.
	 * @param string	$cart_item_key	contains the id of the cart item
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param int		$quantity		contains the quantity of the item
	 */
	public function set_quantity( $item_key, $quantity = 1, $deprecated = true ) {

		if ( $quantity <= 0 ) {
			$this->items->remove_item( $item_key );
		} elseif ( $item = $this->items->get_item_by_key( $item_key ) ) {
			$old_quantity = $item->get_quantity();
			$item->set_quantity( $quantity );
			do_action( 'woocommerce_after_cart_item_quantity_update', $item_key, $quantity, $old_quantity );
		}
	}

	/**
	 * Remove item from cart.
	 * @param string $item_key Cart item key.
	 */
	public function remove_cart_item( $item_key ) {
		$this->items->remove_item( $item_key );
	}

	/**
	 * Remove a single coupon by code.
	 * @param  string $coupon_code Code of the coupon to remove
	 * @return bool
	 */
	public function remove_coupon( $coupon_code ) {
		return $this->coupons->remove_coupon( $coupon_code );
	}

	/**
	 * Remove all coupons.
	 */
	public function remove_coupons() {
		return $this->coupons->set_coupons( false );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * Returns a specific item in the cart.
	 *
	 * @param string $item_key Cart item key.
	 * @return array Item data
	 */
	public function get_cart_item( $item_key ) {
		 return $this->items->get_item_by_key( $item_key );
	}

	/**
	 * Restore item from cart.
	 * @param string $item_key Cart item key.
	 */
	public function restore_cart_item( $item_key ) {
		$this->items->restore_item( $item_key );
	}

	/**
	 * Get all tax classes for items in the cart.
	 * @return array
	 */
	public function get_cart_item_tax_classes() {
		return $this->items->get_tax_classes();
	}

	/**
	 * Get weight of items in the cart.
	 * @return int
	 */
	public function get_cart_contents_weight() {
		return $this->items->get_weight();
	}

	/**
	 * Get number of items in the cart.
	 * @return int
	 */
	public function get_cart_contents_count() {
		return $this->items->get_quantity();
	}

	/**
	 * Returns whether or not a coupon has been applied.
	 * @param string $coupon_code
	 * @return bool
	 */
	public function has_coupon( $coupon_code = '' ) {
		$coupons = array_keys( $this->get_coupons() );
		return $coupon_code ? in_array( wc_format_coupon_code( $coupon_code ), $coupons ) : sizeof( $coupons );
	}

	/*
	|--------------------------------------------------------------------------
	| Cart shipping calculation.
	|--------------------------------------------------------------------------
	*/

	/**
	 * Looks through the cart to see if shipping is actually required.
	 * @return bool whether or not the cart needs shipping
	 */
	public function needs_shipping() {
		if ( ! wc_shipping_enabled() || 0 === wc_get_shipping_method_count( true ) ) {
			return false;
		}
		$needs_shipping = false;

		foreach ( $this->get_cart() as $cart_item_key => $item ) {
			$product = $item->get_product();
			if ( $product && $product->needs_shipping() ) {
				$needs_shipping = true;
				break;
			}
		}
		return apply_filters( 'woocommerce_cart_needs_shipping', $needs_shipping );
	}

	/**
	 * Should the shipping address form be shown.
	 * @return bool
	 */
	public function needs_shipping_address() {
		return apply_filters( 'woocommerce_cart_needs_shipping_address', $this->needs_shipping() && ! wc_ship_to_billing_address_only() );
	}

	/**
	 * Get packages to calculate shipping for.
	 *
	 * This lets us calculate costs for carts that are shipped to multiple locations.
	 *
	 * Shipping methods are responsible for looping through these packages.
	 *
	 * By default we pass the cart itself as a package - plugins can change this.
	 * through the filter and break it up.
	 *
	 * @since 1.5.4
	 * @return array of cart items
	 */
	public function get_shipping_packages() {
		return apply_filters( 'woocommerce_cart_shipping_packages',
			array(
				array(
					'contents'        => $this->items->get_items_needing_shipping(),
					'contents_cost'   => array_sum( wc_list_pluck( $this->items->get_items_needing_shipping(), 'get_price' ) ),
					'applied_coupons' => array_keys( $this->get_coupons() ),
					'user'            => array(
						'ID' => get_current_user_id(),
					),
					'destination' => WC()->customer->get_shipping(),
				)
			)
		);
	}

	/**
	 * Uses the shipping class to calculate shipping then gets the totals when its finished.
	 */
	public function calculate_shipping() {
		return $this->shipping_methods = $this->needs_shipping() ? $this->get_chosen_shipping_methods( WC()->shipping->calculate_shipping( $this->get_shipping_packages() ) ) : array();
	}

	/**
	 * Given a set of packages with rates, get the chosen ones only.
	 * @since 2.7.0
	 * @param array $calculated_shipping_packages
	 * @return array
	 */
	protected function get_chosen_shipping_methods( $calculated_shipping_packages ) {
		$chosen_methods = array();

		// Get chosen methods for each package to get our totals.
		foreach ( $calculated_shipping_packages as $key => $package ) {
			$chosen_method          = wc_get_chosen_shipping_method_for_package( $key, $package );
			if ( $chosen_method ) {
				$chosen_methods[ $key ] = $package['rates'][ $chosen_method ];
			}
		}

		return $chosen_methods;
	}

	/*
	|--------------------------------------------------------------------------
	| Cart Totals.
	|--------------------------------------------------------------------------
	*/

	/**
	 * Calculate totals for the items in the cart.
	 */
	public function calculate_totals() {
		do_action( 'woocommerce_before_calculate_totals', $this );

		// Calculate line item totals
		$this->totals->set_coupons( $this->get_coupons() );
		$this->totals->set_items( $this->get_cart() );
		$this->totals->set_calculate_tax( ! WC()->customer->get_is_vat_exempt() );
		$this->totals->calculate_item_totals();

		// Calculate fees
		$this->totals->set_fees( $this->fees->calculate_fees() );

		// Calculate shipping costs
		$this->totals->set_shipping( $this->calculate_shipping() );

		// Calc grand totals
		$this->totals->calculate_totals();

		do_action( 'woocommerce_after_calculate_totals', $this );
	}

	/**
	 * Looks at the totals to see if payment is actually required.
	 *
	 * @return bool
	 */
	public function needs_payment() {
		return apply_filters( 'woocommerce_cart_needs_payment', $this->totals->get_total() > 0, $this );
	}

	/**
	 * Get item totals from totals class.
	 * @return array
	 */
	public function get_item_totals() {
		return $this->totals->get_item_totals();
	}

	/**
	 * Gets the order subtotal with or without tax.
	 * @param bool $including_tax
	 * @return string formatted price
	 */
	public function get_subtotal( $including_tax = false ) {
		return apply_filters( 'woocommerce_cart_subtotal', $this->totals->get_items_subtotal( $including_tax ), $including_tax );
	}

	/**
	 * Gets the order total (after calculation).
	 * @return string formatted price
	 */
	public function get_total() {
		return apply_filters( 'woocommerce_cart_total', $this->totals->get_total() );
	}

	/**
	 * Gets all taxes.
	 * @return array of taxes
	 */
	public function get_taxes() {
		return apply_filters( 'woocommerce_cart_get_taxes', $this->totals->get_taxes() );
	}

	/**
	 * Gets all taxes which will be output.
	 * @return array
	 */
	public function get_tax_totals() {

		$taxes = $this->get_taxes();

		if ( apply_filters( 'woocommerce_cart_hide_zero_taxes', true ) ) {
			$zero_amounts = array_filter( wp_list_pluck( $taxes, 'amount' ) );
			$taxes        = array_intersect_key( $taxes, $zero_amounts );
		}

		return apply_filters( 'woocommerce_cart_formatted_tax_totals', $taxes );
	}

	/**
	 * Get tax row amounts with or without compound taxes includes.
	 *
	 * @param  bool $compound True if getting compound taxes
	 * @param  bool $round  True if getting total to display
	 * @return float price
	 */
	public function get_taxes_total( $compound = true, $round = true ) {
		$total = 0;
		foreach ( $this->get_taxes() as $key => $tax ) {
			if ( ! $compound && $tax->get_compound() ) {
				continue;
			}
			$total += $tax;
		}
		return apply_filters( 'woocommerce_cart_taxes_total', $round ? wc_round_tax_total( $total ) : $total, $compound, $display, $this );
	}

	/**
	 * Get the total tax on the cart.
	 * @return float
	 */
	public function get_tax_total() {
		return $this->totals->get_tax_total();
	}

	/**
	 * Get the total tax on shipping.
	 * @return float
	 */
	public function get_shipping_tax_total() {
		return $this->totals->get_shipping_tax_total();
	}

	/**
	 * Get the total cost of shipping, with or without taxes included.
	 * @param  bool $including_tax
	 * @return float
	 */
	public function get_shipping_total( $including_tax = false ) {
		return $this->totals->get_shipping_total( $including_tax );
	}

	/**
	 * Return the total amount of discount granted by coupons.
	 * @return float
	 */
	public function get_cart_discount_total() {
		return $this->totals->get_discount_total();
	}

	/**
	 * Return the tax on the total amount of discount granted by coupons.
	 * @return float
	 */
	public function get_cart_discount_tax_total() {
		return $this->totals->get_discount_total_tax();
	}

	/**
	 * Get the total discount amount for a specific coupon code.
	 * @param string $code
	 * @param bool $ex_tax
	 * @return float
	 */
	public function get_coupon_discount_amount( $code, $ex_tax = true ) {
		$coupon_totals = $this->totals->get_coupons();
		$coupon_total  = isset( $coupon_totals[ $code ] ) ? $coupon_totals[ $code ] : array( 'total' => 0, 'total_tax' => 0 );
		$amount        = $coupon_total['total'];

		if ( ! $ex_tax ) {
			$amount += $coupon_total['total_tax'];
		}

		return wc_cart_round_discount( $amount, wc_get_price_decimals() );
	}

	/**
	 * Get the total discount tax amount for a specific coupon code.
	 * @param string $code
	 * @return float
	 */
	public function get_coupon_discount_tax_amount( $code ) {
		$coupon_totals = $this->totals->get_coupons();
		$coupon_total  = isset( $coupon_totals[ $code ] ) ? $coupon_totals[ $code ] : array( 'total' => 0, 'total_tax' => 0 );
		$amount        = $coupon_total['total_tax'];

		return wc_cart_round_discount( $amount, wc_get_price_decimals() );
	}
}

woothemes / woocommerce

Pull Request — master (#11889)

WC_Cart::calculate_totals() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
