WC_Order_Item_Coupon

Complexity

Total Complexity

19

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetGet()	0	8	3
A	offsetExists()	0	6	2
A	read()	0	7	2
A	save()	0	9	2
A	get_internal_meta_keys()	0	3	1
A	set_name()	0	3	1
A	set_code()	0	3	1
A	set_discount()	0	3	1
A	set_discount_tax()	0	3	1
A	get_type()	0	3	1
A	get_name()	0	3	1
A	get_code()	0	3	1
A	get_discount()	0	3	1
A	get_discount_tax()	0	3	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 14 and the first side effect is on line 3.

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Order Line Item (coupon).
 *
 * @version     2.6.0
 * @since       2.6.0
 * @package     WooCommerce/Classes
 * @author      WooThemes
 */
class WC_Order_Item_Coupon extends WC_Order_Item {

	/**
	 * Data properties of this order item object.
	 * @since 2.6.0
	 * @var array
	 */
	protected $_data = array(
		'order_id'      => 0,
		'order_item_id' => 0,
		'code'          => '',
		'discount'      => 0,
		'discount_tax'  => 0,
	);

	/**
	 * offsetGet for ArrayAccess/Backwards compatibility.
	 * @deprecated Add deprecation notices in future release.
	 * @param string $offset
	 * @return mixed
	 */
	public function offsetGet( $offset ) {
		if ( 'discount_amount' === $offset ) {
			$offset = 'discount';
		} elseif ( 'discount_amount_tax' === $offset ) {
			$offset = 'discount_tax';
		}
		return parent::offsetGet( $offset );
	}

	/**
	 * offsetExists for ArrayAccess
	 * @param string $offset
	 * @return bool
	 */
	public function offsetExists( $offset ) {
		if ( in_array( $offset, array( 'discount_amount', 'discount_amount_tax' ) ) ) {
			return true;
		}
		return parent::offsetExists( $offset );
	}

	/**
	 * Read/populate data properties specific to this order item.
	 */
	public function read( $id ) {
		parent::read( $id );
		if ( $this->get_id() ) {
			$this->set_discount( get_metadata( 'order_item', $this->get_id(), 'discount_amount', true ) );
			$this->set_discount_tax( get_metadata( 'order_item', $this->get_id(), 'discount_amount_tax', true ) );
		}
	}

	/**
	 * Save properties specific to this order item.
	 * @return int Item ID
	 */
	public function save() {
		parent::save();
		if ( $this->get_id() ) {
			wc_update_order_item_meta( $this->get_id(), 'discount_amount', $this->get_discount() );
			wc_update_order_item_meta( $this->get_id(), 'discount_amount_tax', $this->get_discount_tax() );
		}

		return $this->get_id();
	}

	/**
	 * Internal meta keys we don't want exposed as part of meta_data.
	 * @return array()

The doc-type array() could not be parsed: Expected "|" or "end of type", but got "(" at position 5. (view supported doc-types)

	 */
	protected function get_internal_meta_keys() {
		return array( 'discount_amount', 'discount_amount_tax' );
	}

	/*
	|--------------------------------------------------------------------------
	| Setters
	|--------------------------------------------------------------------------
	*/

	/**
	 * Set order item name.
	 * @param string $value
	 */
	public function set_name( $value ) {
		$this->set_code( $value );
	}

	/**
	 * Set code.
	 * @param string $value
	 */
	public function set_code( $value ) {
		$this->_data['code'] = wc_clean( $value );
	}

	/**
	 * Set discount amount.
	 * @param string $value
	 */
	public function set_discount( $value ) {
		$this->_data['discount'] =  wc_format_decimal( $value );
	}

	/**
	 * Set discounted tax amount.
	 * @param string $value
	 */
	public function set_discount_tax( $value ) {
		$this->_data['discount_tax'] = wc_format_decimal( $value );
	}

	/*
	|--------------------------------------------------------------------------
	| Getters
	|--------------------------------------------------------------------------
	*/

	/**
	 * Get order item type.
	 * @return string
	 */
	public function get_type() {
		return 'coupon';
	}

	/**
	 * Get order item name.
	 * @return string
	 */
	public function get_name() {
		return $this->get_code();
	}

	/**
	 * Get coupon code.
	 * @return string
	 */
	public function get_code() {
		return $this->_data['code'];
	}

	/**
	 * Get discount amount.
	 * @return string
	 */
	public function get_discount() {
		return wc_format_decimal( $this->_data['discount'] );
	}

	/**
	 * Get discounted tax amount.
	 * @return string
	 */
	public function get_discount_tax() {
		return wc_format_decimal( $this->_data['discount_tax'] );
	}
}