woocommerce/includes/class-wc-order-item-shippin...

255 lines
5.4 KiB
PHP
Raw Normal View History

2016-06-21 19:10:09 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Order Line Item (shipping).
*
* @version 2.7.0
* @since 2.7.0
* @package WooCommerce/Classes
* @author WooThemes
*/
class WC_Order_Item_Shipping 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
'method_title' => '',
'method_id' => '',
'total' => 0,
'total_tax' => 0,
'taxes' => array(
'total' => array(),
2016-06-21 19:10:09 +00:00
),
);
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
*/
/**
* Set order item name.
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_name( $value ) {
2016-08-26 09:54:18 +00:00
$this->set_method_title( $value );
2016-06-21 19:10:09 +00:00
}
/**
2016-11-17 21:30:34 +00:00
* Set method title.
*
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_method_title( $value ) {
2016-11-17 21:30:34 +00:00
$this->set_prop( 'method_title', wc_clean( $value ) );
2016-06-21 19:10:09 +00:00
}
/**
* Set shipping method id.
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_method_id( $value ) {
2016-11-17 21:30:34 +00:00
$this->set_prop( 'method_id', wc_clean( $value ) );
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(),
2016-06-21 19:10:09 +00:00
);
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 );
2016-06-21 19:10:09 +00:00
$this->set_total_tax( array_sum( $tax_data['total'] ) );
}
2016-08-22 15:48:19 +00:00
/**
* Set properties based on passed in shipping rate object.
2016-11-17 21:30:34 +00:00
*
2016-08-22 15:48:19 +00:00
* @param WC_Shipping_Rate $tax_rate_id
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-08-22 15:48:19 +00:00
*/
public function set_shipping_rate( $shipping_rate ) {
$this->set_method_title( $shipping_rate->label );
$this->set_method_id( $shipping_rate->id );
$this->set_total( $shipping_rate->cost );
$this->set_taxes( $shipping_rate->taxes );
$this->set_meta_data( $shipping_rate->get_meta_data() );
}
2016-06-21 19:10:09 +00:00
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
*/
/**
* 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 'shipping';
}
/**
* 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' ) {
return $this->get_method_title( $context );
2016-06-21 19:10:09 +00:00
}
/**
* Get title.
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_method_title( $context = 'view' ) {
$method_title = $this->get_prop( 'method_title', $context );
if ( 'view' === $context ) {
return $method_title ? $method_title : __( 'Shipping', 'woocommerce' );
} else {
return $method_title;
}
2016-06-21 19:10:09 +00:00
}
/**
* Get method ID.
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_method_id( $context = 'view' ) {
return $this->get_prop( 'method_id', $context );
2016-06-21 19:10:09 +00:00
}
/**
* Get total cost.
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 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 ( 'cost' === $offset ) {
$offset = 'total';
}
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 ( 'cost' === $offset ) {
$offset = 'total';
}
parent::offsetSet( $offset, $value );
}
/**
* offsetExists for ArrayAccess
* @param string $offset
* @return bool
*/
public function offsetExists( $offset ) {
if ( in_array( $offset, array( 'cost' ) ) ) {
return true;
}
return parent::offsetExists( $offset );
}
/**
* Internal meta keys we don't want exposed as part of meta_data.
* @return array()
*/
protected function get_internal_meta_keys() {
return array( 'method_id', 'cost', 'total_tax', 'taxes' );
2016-06-21 19:10:09 +00:00
}
}