class-wc-order-refund.php — WooCommerce 6.5.0

woocommerce / includes / class-wc-order-refund.php

woocommerce / includes Last commit date

class-wc-order-refund.php

229 lines

1	<?php
2	/**
3	* Order refund. Refunds are based on orders (essentially negative orders) and
4	* contain much of the same data.
5	*
6	* @version 3.0.0
7	* @package WooCommerce\Classes
8	*/
9
10	defined( 'ABSPATH' ) \|\| exit;
11
12	/**
13	* Order refund class.
14	*/
15	class WC_Order_Refund extends WC_Abstract_Order {
16
17	/**
18	* Which data store to load.
19	*
20	* @var string
21	*/
22	protected $data_store_name = 'order-refund';
23
24	/**
25	* This is the name of this object type.
26	*
27	* @var string
28	*/
29	protected $object_type = 'order_refund';
30
31	/**
32	* Stores product data.
33	*
34	* @var array
35	*/
36	protected $extra_data = array(
37	'amount' => '',
38	'reason' => '',
39	'refunded_by' => 0,
40	'refunded_payment' => false,
41	);
42
43	/**
44	* Get internal type (post type.)
45	*
46	* @return string
47	*/
48	public function get_type() {
49	return 'shop_order_refund';
50	}
51
52	/**
53	* Get status - always completed for refunds.
54	*
55	* @param string $context What the value is for. Valid values are view and edit.
56	* @return string
57	*/
58	public function get_status( $context = 'view' ) {
59	return 'completed';
60	}
61
62	/**
63	* Get a title for the new post type.
64	*/
65	public function get_post_title() {
66	// @codingStandardsIgnoreStart
67	return sprintf( __( 'Refund – %s', 'woocommerce' ), strftime( _x( '%b %d, %Y @ %I:%M %p', 'Order date parsed by strftime', 'woocommerce' ) ) );
68	// @codingStandardsIgnoreEnd
69	}
70
71	/**
72	* Get refunded amount.
73	*
74	* @param string $context What the value is for. Valid values are view and edit.
75	* @return int\|float
76	*/
77	public function get_amount( $context = 'view' ) {
78	return $this->get_prop( 'amount', $context );
79	}
80
81	/**
82	* Get refund reason.
83	*
84	* @since 2.2
85	* @param string $context What the value is for. Valid values are view and edit.
86	* @return string
87	*/
88	public function get_reason( $context = 'view' ) {
89	return $this->get_prop( 'reason', $context );
90	}
91
92	/**
93	* Get ID of user who did the refund.
94	*
95	* @since 3.0
96	* @param string $context What the value is for. Valid values are view and edit.
97	* @return int
98	*/
99	public function get_refunded_by( $context = 'view' ) {
100	return $this->get_prop( 'refunded_by', $context );
101	}
102
103	/**
104	* Return if the payment was refunded via API.
105	*
106	* @since 3.3
107	* @param string $context What the value is for. Valid values are view and edit.
108	* @return bool
109	*/
110	public function get_refunded_payment( $context = 'view' ) {
111	return $this->get_prop( 'refunded_payment', $context );
112	}
113
114	/**
115	* Get formatted refunded amount.
116	*
117	* @since 2.4
118	* @return string
119	*/
120	public function get_formatted_refund_amount() {
121	return apply_filters( 'woocommerce_formatted_refund_amount', wc_price( $this->get_amount(), array( 'currency' => $this->get_currency() ) ), $this );
122	}
123
124	/**
125	* Set refunded amount.
126	*
127	* @param string $value Value to set.
128	* @throws WC_Data_Exception Exception if the amount is invalid.
129	*/
130	public function set_amount( $value ) {
131	$this->set_prop( 'amount', wc_format_decimal( $value ) );
132	}
133
134	/**
135	* Set refund reason.
136	*
137	* @param string $value Value to set.
138	* @throws WC_Data_Exception Exception if the amount is invalid.
139	*/
140	public function set_reason( $value ) {
141	$this->set_prop( 'reason', $value );
142	}
143
144	/**
145	* Set refunded by.
146	*
147	* @param int $value Value to set.
148	* @throws WC_Data_Exception Exception if the amount is invalid.
149	*/
150	public function set_refunded_by( $value ) {
151	$this->set_prop( 'refunded_by', absint( $value ) );
152	}
153
154	/**
155	* Set if the payment was refunded via API.
156	*
157	* @since 3.3
158	* @param bool $value Value to set.
159	*/
160	public function set_refunded_payment( $value ) {
161	$this->set_prop( 'refunded_payment', (bool) $value );
162	}
163
164	/**
165	* Magic __get method for backwards compatibility.
166	*
167	* @param string $key Value to get.
168	* @return mixed
169	*/
170	public function __get( $key ) {
171	wc_doing_it_wrong( $key, 'Refund properties should not be accessed directly.', '3.0' );
172	/**
173	* Maps legacy vars to new getters.
174	*/
175	if ( 'reason' === $key ) {
176	return $this->get_reason();
177	} elseif ( 'refund_amount' === $key ) {
178	return $this->get_amount();
179	}
180	return parent::__get( $key );
181	}
182
183	/**
184	* Gets an refund from the database.
185	*
186	* @deprecated 3.0
187	* @param int $id (default: 0).
188	* @return bool
189	*/
190	public function get_refund( $id = 0 ) {
191	wc_deprecated_function( 'get_refund', '3.0', 'read' );
192
193	if ( ! $id ) {
194	return false;
195	}
196
197	$result = get_post( $id );
198
199	if ( $result ) {
200	$this->populate( $result );
201	return true;
202	}
203
204	return false;
205	}
206
207	/**
208	* Get refund amount.
209	*
210	* @deprecated 3.0
211	* @return int\|float
212	*/
213	public function get_refund_amount() {
214	wc_deprecated_function( 'get_refund_amount', '3.0', 'get_amount' );
215	return $this->get_amount();
216	}
217
218	/**
219	* Get refund reason.
220	*
221	* @deprecated 3.0
222	* @return string
223	*/
224	public function get_refund_reason() {
225	wc_deprecated_function( 'get_refund_reason', '3.0', 'get_reason' );
226	return $this->get_reason();
227	}
228	}
229