woocommerce/includes/class-wc-order-item-fee.php

238 lines
5.1 KiB
PHP
Raw Normal View History

2016-06-21 19:10:09 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Order Line Item (fee).
*
* @version 2.7.0
* @since 2.7.0
* @package WooCommerce/Classes
* @author WooThemes
*/
class WC_Order_Item_Fee extends WC_Order_Item {
/**
* Order Data array. This is the core order data exposed in APIs since 2.7.0.
2016-06-21 19:10:09 +00:00
* @since 2.7.0
* @var array
*/
2016-11-17 21:30:34 +00:00
protected $extra_data = array(
2016-08-16 11:36:38 +00:00
'tax_class' => '',
'tax_status' => 'taxable',
'total' => '',
'total_tax' => '',
'taxes' => array(
'total' => array(),
),
2016-06-21 19:10:09 +00:00
);
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
*/
/**
* Set tax class.
2016-11-17 21:30:34 +00:00
*
2016-06-21 19:10:09 +00:00
* @param string $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
public function set_tax_class( $value ) {
2016-08-17 15:53:01 +00:00
if ( $value && ! in_array( $value, WC_Tax::get_tax_classes() ) ) {
$this->error( 'order_item_fee_invalid_tax_class', __( 'Invalid tax class', 'woocommerce' ) );
2016-08-17 15:53:01 +00:00
}
2016-11-17 21:30:34 +00:00
$this->set_prop( 'tax_class', $value );
2016-06-21 19:10:09 +00:00
}
/**
* Set tax_status.
2016-11-17 21:30:34 +00:00
*
2016-06-21 19:10:09 +00:00
* @param string $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
public function set_tax_status( $value ) {
if ( in_array( $value, array( 'taxable', 'none' ) ) ) {
2016-11-17 21:30:34 +00:00
$this->set_prop( 'tax_status', $value );
2016-06-21 19:10:09 +00:00
} else {
2016-11-17 21:30:34 +00:00
$this->set_prop( 'tax_status', 'taxable' );
2016-06-21 19:10:09 +00:00
}
}
/**
* Set total.
2016-11-17 21:30:34 +00:00
*
2016-06-21 19:10:09 +00:00
* @param string $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
public function set_total( $value ) {
2016-11-17 21:30:34 +00:00
$this->set_prop( 'total', wc_format_decimal( $value ) );
2016-06-21 19:10:09 +00:00
}
/**
* Set total tax.
2016-11-17 21:30:34 +00:00
*
2016-06-21 19:10:09 +00:00
* @param string $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
protected function set_total_tax( $value ) {
2016-11-17 21:30:34 +00:00
$this->set_prop( 'total_tax', wc_format_decimal( $value ) );
2016-06-21 19:10:09 +00:00
}
/**
* Set taxes.
*
* This is an array of tax ID keys with total amount values.
* @param array $raw_tax_data
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
public function set_taxes( $raw_tax_data ) {
$raw_tax_data = maybe_unserialize( $raw_tax_data );
$tax_data = array(
'total' => array(),
);
if ( ! empty( $raw_tax_data['total'] ) ) {
$tax_data['total'] = array_map( 'wc_format_decimal', $raw_tax_data['total'] );
}
2016-11-17 21:30:34 +00:00
$this->set_prop( 'taxes', $tax_data );
$this->set_total_tax( array_sum( $tax_data['total'] ) );
2016-06-21 19:10:09 +00:00
}
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
*/
/**
* Get order item name.
2016-11-17 21:30:34 +00:00
*
* @param string $context
2016-06-21 19:10:09 +00:00
* @return string
*/
2016-11-17 21:30:34 +00:00
public function get_name( $context = 'view' ) {
$name = $this->get_prop( 'name', $context );
if ( 'view' === $context ) {
return $name ? $name : __( 'Fee', 'woocommerce' );
} else {
return $name;
}
2016-06-21 19:10:09 +00:00
}
/**
* Get order item type.
2016-11-17 21:30:34 +00:00
*
2016-06-21 19:10:09 +00:00
* @return string
*/
public function get_type() {
2016-06-21 19:10:09 +00:00
return 'fee';
}
/**
* Get tax class.
2016-11-17 21:30:34 +00:00
*
* @param string $context
2016-06-21 19:10:09 +00:00
* @return string
*/
2016-11-17 21:30:34 +00:00
public function get_tax_class( $context = 'view' ) {
return $this->get_prop( 'tax_class', $context );
2016-06-21 19:10:09 +00:00
}
/**
* Get tax status.
2016-11-17 21:30:34 +00:00
*
* @param string $context
2016-06-21 19:10:09 +00:00
* @return string
*/
2016-11-17 21:30:34 +00:00
public function get_tax_status( $context = 'view' ) {
return $this->get_prop( 'tax_status', $context );
2016-06-21 19:10:09 +00:00
}
/**
* Get total fee.
2016-11-17 21:30:34 +00:00
*
* @param string $context
2016-06-21 19:10:09 +00:00
* @return string
*/
2016-11-17 21:30:34 +00:00
public function get_total( $context = 'view' ) {
return $this->get_prop( 'total', $context );
2016-06-21 19:10:09 +00:00
}
/**
* Get total tax.
2016-11-17 21:30:34 +00:00
*
* @param string $context
2016-06-21 19:10:09 +00:00
* @return string
*/
2016-11-17 21:30:34 +00:00
public function get_total_tax( $context = 'view' ) {
return $this->get_prop( 'total_tax', $context );
2016-06-21 19:10:09 +00:00
}
/**
* Get fee taxes.
2016-11-17 21:30:34 +00:00
*
* @param string $context
2016-06-21 19:10:09 +00:00
* @return array
*/
2016-11-17 21:30:34 +00:00
public function get_taxes( $context = 'view' ) {
return $this->get_prop( 'taxes', $context );
}
/*
|--------------------------------------------------------------------------
| Array Access Methods
|--------------------------------------------------------------------------
|
| For backwards compat with legacy arrays.
|
*/
/**
* offsetGet for ArrayAccess/Backwards compatibility.
* @deprecated Add deprecation notices in future release.
* @param string $offset
* @return mixed
*/
public function offsetGet( $offset ) {
if ( 'line_total' === $offset ) {
$offset = 'total';
} elseif ( 'line_tax' === $offset ) {
$offset = 'total_tax';
} elseif ( 'line_tax_data' === $offset ) {
$offset = 'taxes';
}
return parent::offsetGet( $offset );
}
/**
* offsetSet for ArrayAccess/Backwards compatibility.
* @deprecated Add deprecation notices in future release.
* @param string $offset
* @param mixed $value
*/
public function offsetSet( $offset, $value ) {
if ( 'line_total' === $offset ) {
$offset = 'total';
} elseif ( 'line_tax' === $offset ) {
$offset = 'total_tax';
} elseif ( 'line_tax_data' === $offset ) {
$offset = 'taxes';
}
parent::offsetSet( $offset, $value );
}
/**
* offsetExists for ArrayAccess
* @param string $offset
* @return bool
*/
public function offsetExists( $offset ) {
if ( in_array( $offset, array( 'line_total', 'line_tax', 'line_tax_data' ) ) ) {
return true;
}
return parent::offsetExists( $offset );
}
2016-06-21 19:10:09 +00:00
}