class-wc-shipping-rate.php — WooCommerce 6.2.0

woocommerce / includes / class-wc-shipping-rate.php

woocommerce / includes Last commit date

class-wc-shipping-rate.php

256 lines

1	<?php
2	/**
3	* WooCommerce Shipping Rate
4	*
5	* Simple Class for storing rates.
6	*
7	* @package WooCommerce\Classes\Shipping
8	* @since 2.6.0
9	*/
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	/**
14	* Shipping rate class.
15	*/
16	class WC_Shipping_Rate {
17
18	/**
19	* Stores data for this rate.
20	*
21	* @since 3.2.0
22	* @var array
23	*/
24	protected $data = array(
25	'id' => '',
26	'method_id' => '',
27	'instance_id' => 0,
28	'label' => '',
29	'cost' => 0,
30	'taxes' => array(),
31	);
32
33	/**
34	* Stores meta data for this rate.
35	*
36	* @since 2.6.0
37	* @var array
38	*/
39	protected $meta_data = array();
40
41	/**
42	* Constructor.
43	*
44	* @param string $id Shipping rate ID.
45	* @param string $label Shipping rate label.
46	* @param integer $cost Cost.
47	* @param array $taxes Taxes applied to shipping rate.
48	* @param string $method_id Shipping method ID.
49	* @param int $instance_id Shipping instance ID.
50	*/
51	public function __construct( $id = '', $label = '', $cost = 0, $taxes = array(), $method_id = '', $instance_id = 0 ) {
52	$this->set_id( $id );
53	$this->set_label( $label );
54	$this->set_cost( $cost );
55	$this->set_taxes( $taxes );
56	$this->set_method_id( $method_id );
57	$this->set_instance_id( $instance_id );
58	}
59
60	/**
61	* Magic methods to support direct access to props.
62	*
63	* @since 3.2.0
64	* @param string $key Key.
65	* @return bool
66	*/
67	public function __isset( $key ) {
68	if ( 'meta_data' === $key ) {
69	wc_doing_it_wrong( __FUNCTION__, __( 'Use `array_key_exists` to check for meta_data on WC_Shipping_Rate to get the correct result.', 'woocommerce' ), '6.0' );
70	}
71	return isset( $this->data[ $key ] );
72	}
73
74	/**
75	* Magic methods to support direct access to props.
76	*
77	* @since 3.2.0
78	* @param string $key Key.
79	* @return mixed
80	*/
81	public function __get( $key ) {
82	if ( is_callable( array( $this, "get_{$key}" ) ) ) {
83	return $this->{"get_{$key}"}();
84	} elseif ( isset( $this->data[ $key ] ) ) {
85	return $this->data[ $key ];
86	} else {
87	return '';
88	}
89	}
90
91	/**
92	* Magic methods to support direct access to props.
93	*
94	* @since 3.2.0
95	* @param string $key Key.
96	* @param mixed $value Value.
97	*/
98	public function __set( $key, $value ) {
99	if ( is_callable( array( $this, "set_{$key}" ) ) ) {
100	$this->{"set_{$key}"}( $value );
101	} else {
102	$this->data[ $key ] = $value;
103	}
104	}
105
106	/**
107	* Set ID for the rate. This is usually a combination of the method and instance IDs.
108	*
109	* @since 3.2.0
110	* @param string $id Shipping rate ID.
111	*/
112	public function set_id( $id ) {
113	$this->data['id'] = (string) $id;
114	}
115
116	/**
117	* Set shipping method ID the rate belongs to.
118	*
119	* @since 3.2.0
120	* @param string $method_id Shipping method ID.
121	*/
122	public function set_method_id( $method_id ) {
123	$this->data['method_id'] = (string) $method_id;
124	}
125
126	/**
127	* Set instance ID the rate belongs to.
128	*
129	* @since 3.2.0
130	* @param int $instance_id Instance ID.
131	*/
132	public function set_instance_id( $instance_id ) {
133	$this->data['instance_id'] = absint( $instance_id );
134	}
135
136	/**
137	* Set rate label.
138	*
139	* @since 3.2.0
140	* @param string $label Shipping rate label.
141	*/
142	public function set_label( $label ) {
143	$this->data['label'] = (string) $label;
144	}
145
146	/**
147	* Set rate cost.
148	*
149	* @todo 4.0 Prevent negative value being set. #19293
150	* @since 3.2.0
151	* @param string $cost Shipping rate cost.
152	*/
153	public function set_cost( $cost ) {
154	$this->data['cost'] = $cost;
155	}
156
157	/**
158	* Set rate taxes.
159	*
160	* @since 3.2.0
161	* @param array $taxes List of taxes applied to shipping rate.
162	*/
163	public function set_taxes( $taxes ) {
164	$this->data['taxes'] = ! empty( $taxes ) && is_array( $taxes ) ? $taxes : array();
165	}
166
167	/**
168	* Get ID for the rate. This is usually a combination of the method and instance IDs.
169	*
170	* @since 3.2.0
171	* @return string
172	*/
173	public function get_id() {
174	return apply_filters( 'woocommerce_shipping_rate_id', $this->data['id'], $this );
175	}
176
177	/**
178	* Get shipping method ID the rate belongs to.
179	*
180	* @since 3.2.0
181	* @return string
182	*/
183	public function get_method_id() {
184	return apply_filters( 'woocommerce_shipping_rate_method_id', $this->data['method_id'], $this );
185	}
186
187	/**
188	* Get instance ID the rate belongs to.
189	*
190	* @since 3.2.0
191	* @return int
192	*/
193	public function get_instance_id() {
194	return apply_filters( 'woocommerce_shipping_rate_instance_id', $this->data['instance_id'], $this );
195	}
196
197	/**
198	* Get rate label.
199	*
200	* @return string
201	*/
202	public function get_label() {
203	return apply_filters( 'woocommerce_shipping_rate_label', $this->data['label'], $this );
204	}
205
206	/**
207	* Get rate cost.
208	*
209	* @since 3.2.0
210	* @return string
211	*/
212	public function get_cost() {
213	return apply_filters( 'woocommerce_shipping_rate_cost', $this->data['cost'], $this );
214	}
215
216	/**
217	* Get rate taxes.
218	*
219	* @since 3.2.0
220	* @return array
221	*/
222	public function get_taxes() {
223	return apply_filters( 'woocommerce_shipping_rate_taxes', $this->data['taxes'], $this );
224	}
225
226	/**
227	* Get shipping tax.
228	*
229	* @return array
230	*/
231	public function get_shipping_tax() {
232	return apply_filters( 'woocommerce_get_shipping_tax', count( $this->taxes ) > 0 && ! WC()->customer->get_is_vat_exempt() ? array_sum( $this->taxes ) : 0, $this );
233	}
234
235	/**
236	* Add some meta data for this rate.
237	*
238	* @since 2.6.0
239	* @param string $key Key.
240	* @param string $value Value.
241	*/
242	public function add_meta_data( $key, $value ) {
243	$this->meta_data[ wc_clean( $key ) ] = wc_clean( $value );
244	}
245
246	/**
247	* Get all meta data for this rate.
248	*
249	* @since 2.6.0
250	* @return array
251	*/
252	public function get_meta_data() {
253	return $this->meta_data;
254	}
255	}
256