@@ -13,467 +13,467 @@ discard block |
||
13 | 13 | */ |
14 | 14 | abstract class GetPaid_Payment_Gateway { |
15 | 15 | |
16 | - /** |
|
17 | - * Set if the place checkout button should be renamed on selection. |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
21 | - public $checkout_button_text; |
|
22 | - |
|
23 | - /** |
|
24 | - * Boolean whether the method is enabled. |
|
25 | - * |
|
26 | - * @var bool |
|
27 | - */ |
|
28 | - public $enabled = true; |
|
29 | - |
|
30 | - /** |
|
31 | - * Payment method id. |
|
32 | - * |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - public $id; |
|
36 | - |
|
37 | - /** |
|
38 | - * Payment method order. |
|
39 | - * |
|
40 | - * @var int |
|
41 | - */ |
|
42 | - public $order = 10; |
|
43 | - |
|
44 | - /** |
|
45 | - * Payment method title for the frontend. |
|
46 | - * |
|
47 | - * @var string |
|
48 | - */ |
|
49 | - public $title; |
|
50 | - |
|
51 | - /** |
|
52 | - * Payment method description for the frontend. |
|
53 | - * |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - public $description; |
|
57 | - |
|
58 | - /** |
|
59 | - * Gateway title. |
|
60 | - * |
|
61 | - * @var string |
|
62 | - */ |
|
63 | - public $method_title = ''; |
|
64 | - |
|
65 | - /** |
|
66 | - * Gateway description. |
|
67 | - * |
|
68 | - * @var string |
|
69 | - */ |
|
70 | - public $method_description = ''; |
|
71 | - |
|
72 | - /** |
|
73 | - * Countries this gateway is allowed for. |
|
74 | - * |
|
75 | - * @var array |
|
76 | - */ |
|
77 | - public $countries; |
|
78 | - |
|
79 | - /** |
|
80 | - * Currencies this gateway is allowed for. |
|
81 | - * |
|
82 | - * @var array |
|
83 | - */ |
|
84 | - public $currencies; |
|
85 | - |
|
86 | - /** |
|
87 | - * Currencies this gateway is not allowed for. |
|
88 | - * |
|
89 | - * @var array |
|
90 | - */ |
|
91 | - public $exclude_currencies; |
|
92 | - |
|
93 | - /** |
|
94 | - * Maximum transaction amount, zero does not define a maximum. |
|
95 | - * |
|
96 | - * @var int |
|
97 | - */ |
|
98 | - public $max_amount = 0; |
|
99 | - |
|
100 | - /** |
|
101 | - * Optional URL to view a transaction. |
|
102 | - * |
|
103 | - * @var string |
|
104 | - */ |
|
105 | - public $view_transaction_url = ''; |
|
106 | - |
|
107 | - /** |
|
108 | - * Optional URL to view a subscription. |
|
109 | - * |
|
110 | - * @var string |
|
111 | - */ |
|
112 | - public $view_subscription_url = ''; |
|
113 | - |
|
114 | - /** |
|
115 | - * Optional label to show for "new payment method" in the payment |
|
116 | - * method/token selection radio selection. |
|
117 | - * |
|
118 | - * @var string |
|
119 | - */ |
|
120 | - public $new_method_label = ''; |
|
121 | - |
|
122 | - /** |
|
123 | - * Contains a user's saved tokens for this gateway. |
|
124 | - * |
|
125 | - * @var array |
|
126 | - */ |
|
127 | - protected $tokens = array(); |
|
128 | - |
|
129 | - /** |
|
130 | - * An array of features that this gateway supports. |
|
131 | - * |
|
132 | - * @var array |
|
133 | - */ |
|
134 | - protected $supports = array(); |
|
135 | - |
|
136 | - /** |
|
137 | - * Class constructor. |
|
138 | - */ |
|
139 | - public function __construct() { |
|
140 | - |
|
141 | - // Register gateway. |
|
142 | - add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) ); |
|
143 | - |
|
144 | - $this->enabled = wpinv_is_gateway_active( $this->id ); |
|
145 | - |
|
146 | - // Enable Subscriptions. |
|
147 | - if ( $this->supports( 'subscription' ) ) { |
|
148 | - add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' ); |
|
149 | - } |
|
150 | - |
|
151 | - // Enable sandbox. |
|
152 | - if ( $this->supports( 'sandbox' ) ) { |
|
153 | - add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' ); |
|
154 | - } |
|
155 | - |
|
156 | - // Invoice addons. |
|
157 | - if ( $this->supports( 'addons' ) ) { |
|
158 | - add_filter( "getpaid_{$this->id}_supports_addons", '__return_true' ); |
|
159 | - add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 ); |
|
160 | - } |
|
161 | - |
|
162 | - // Gateway settings. |
|
163 | - add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) ); |
|
16 | + /** |
|
17 | + * Set if the place checkout button should be renamed on selection. |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | + public $checkout_button_text; |
|
22 | + |
|
23 | + /** |
|
24 | + * Boolean whether the method is enabled. |
|
25 | + * |
|
26 | + * @var bool |
|
27 | + */ |
|
28 | + public $enabled = true; |
|
29 | + |
|
30 | + /** |
|
31 | + * Payment method id. |
|
32 | + * |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + public $id; |
|
36 | + |
|
37 | + /** |
|
38 | + * Payment method order. |
|
39 | + * |
|
40 | + * @var int |
|
41 | + */ |
|
42 | + public $order = 10; |
|
43 | + |
|
44 | + /** |
|
45 | + * Payment method title for the frontend. |
|
46 | + * |
|
47 | + * @var string |
|
48 | + */ |
|
49 | + public $title; |
|
50 | + |
|
51 | + /** |
|
52 | + * Payment method description for the frontend. |
|
53 | + * |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + public $description; |
|
57 | + |
|
58 | + /** |
|
59 | + * Gateway title. |
|
60 | + * |
|
61 | + * @var string |
|
62 | + */ |
|
63 | + public $method_title = ''; |
|
64 | + |
|
65 | + /** |
|
66 | + * Gateway description. |
|
67 | + * |
|
68 | + * @var string |
|
69 | + */ |
|
70 | + public $method_description = ''; |
|
71 | + |
|
72 | + /** |
|
73 | + * Countries this gateway is allowed for. |
|
74 | + * |
|
75 | + * @var array |
|
76 | + */ |
|
77 | + public $countries; |
|
78 | + |
|
79 | + /** |
|
80 | + * Currencies this gateway is allowed for. |
|
81 | + * |
|
82 | + * @var array |
|
83 | + */ |
|
84 | + public $currencies; |
|
85 | + |
|
86 | + /** |
|
87 | + * Currencies this gateway is not allowed for. |
|
88 | + * |
|
89 | + * @var array |
|
90 | + */ |
|
91 | + public $exclude_currencies; |
|
92 | + |
|
93 | + /** |
|
94 | + * Maximum transaction amount, zero does not define a maximum. |
|
95 | + * |
|
96 | + * @var int |
|
97 | + */ |
|
98 | + public $max_amount = 0; |
|
99 | + |
|
100 | + /** |
|
101 | + * Optional URL to view a transaction. |
|
102 | + * |
|
103 | + * @var string |
|
104 | + */ |
|
105 | + public $view_transaction_url = ''; |
|
106 | + |
|
107 | + /** |
|
108 | + * Optional URL to view a subscription. |
|
109 | + * |
|
110 | + * @var string |
|
111 | + */ |
|
112 | + public $view_subscription_url = ''; |
|
113 | + |
|
114 | + /** |
|
115 | + * Optional label to show for "new payment method" in the payment |
|
116 | + * method/token selection radio selection. |
|
117 | + * |
|
118 | + * @var string |
|
119 | + */ |
|
120 | + public $new_method_label = ''; |
|
121 | + |
|
122 | + /** |
|
123 | + * Contains a user's saved tokens for this gateway. |
|
124 | + * |
|
125 | + * @var array |
|
126 | + */ |
|
127 | + protected $tokens = array(); |
|
128 | + |
|
129 | + /** |
|
130 | + * An array of features that this gateway supports. |
|
131 | + * |
|
132 | + * @var array |
|
133 | + */ |
|
134 | + protected $supports = array(); |
|
135 | + |
|
136 | + /** |
|
137 | + * Class constructor. |
|
138 | + */ |
|
139 | + public function __construct() { |
|
140 | + |
|
141 | + // Register gateway. |
|
142 | + add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) ); |
|
143 | + |
|
144 | + $this->enabled = wpinv_is_gateway_active( $this->id ); |
|
145 | + |
|
146 | + // Enable Subscriptions. |
|
147 | + if ( $this->supports( 'subscription' ) ) { |
|
148 | + add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' ); |
|
149 | + } |
|
150 | + |
|
151 | + // Enable sandbox. |
|
152 | + if ( $this->supports( 'sandbox' ) ) { |
|
153 | + add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' ); |
|
154 | + } |
|
155 | + |
|
156 | + // Invoice addons. |
|
157 | + if ( $this->supports( 'addons' ) ) { |
|
158 | + add_filter( "getpaid_{$this->id}_supports_addons", '__return_true' ); |
|
159 | + add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 ); |
|
160 | + } |
|
161 | + |
|
162 | + // Gateway settings. |
|
163 | + add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) ); |
|
164 | 164 | |
165 | 165 | |
166 | - // Gateway checkout fiellds. |
|
167 | - add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 ); |
|
168 | - |
|
169 | - // Process payment. |
|
170 | - add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 ); |
|
166 | + // Gateway checkout fiellds. |
|
167 | + add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 ); |
|
168 | + |
|
169 | + // Process payment. |
|
170 | + add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 ); |
|
171 | + |
|
172 | + // Change the checkout button text. |
|
173 | + if ( ! empty( $this->checkout_button_text ) ) { |
|
174 | + add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) ); |
|
175 | + } |
|
176 | + |
|
177 | + // Check if a gateway is valid for a given currency. |
|
178 | + add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 ); |
|
179 | + |
|
180 | + // Generate the transaction url. |
|
181 | + add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 ); |
|
182 | + |
|
183 | + // Generate the subscription url. |
|
184 | + add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 ); |
|
185 | + |
|
186 | + // Confirm payments. |
|
187 | + add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 ); |
|
188 | + |
|
189 | + // Verify IPNs. |
|
190 | + add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) ); |
|
191 | + |
|
192 | + } |
|
193 | + |
|
194 | + /** |
|
195 | + * Checks if this gateway is a given gateway. |
|
196 | + * |
|
197 | + * @since 1.0.19 |
|
198 | + * @return bool |
|
199 | + */ |
|
200 | + public function is( $gateway ) { |
|
201 | + return $gateway == $this->id; |
|
202 | + } |
|
203 | + |
|
204 | + /** |
|
205 | + * Returns a users saved tokens for this gateway. |
|
206 | + * |
|
207 | + * @since 1.0.19 |
|
208 | + * @return array |
|
209 | + */ |
|
210 | + public function get_tokens( $sandbox = null ) { |
|
211 | + |
|
212 | + if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) { |
|
213 | + $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true ); |
|
214 | + |
|
215 | + if ( is_array( $tokens ) ) { |
|
216 | + $this->tokens = $tokens; |
|
217 | + } |
|
218 | + |
|
219 | + } |
|
220 | + |
|
221 | + if ( ! is_bool( $sandbox ) ) { |
|
222 | + return $this->tokens; |
|
223 | + } |
|
224 | + |
|
225 | + $args = array( 'type' => $sandbox ? 'sandbox' : 'live' ); |
|
226 | + return wp_list_filter( $this->tokens, $args ); |
|
227 | + |
|
228 | + } |
|
229 | + |
|
230 | + /** |
|
231 | + * Saves a token for this gateway. |
|
232 | + * |
|
233 | + * @since 1.0.19 |
|
234 | + */ |
|
235 | + public function save_token( $token ) { |
|
236 | + |
|
237 | + $tokens = $this->get_tokens(); |
|
238 | + $tokens[] = $token; |
|
239 | + |
|
240 | + update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens ); |
|
241 | + |
|
242 | + $this->tokens = $tokens; |
|
243 | + |
|
244 | + } |
|
245 | + |
|
246 | + /** |
|
247 | + * Return the title for admin screens. |
|
248 | + * |
|
249 | + * @return string |
|
250 | + */ |
|
251 | + public function get_method_title() { |
|
252 | + return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this ); |
|
253 | + } |
|
254 | + |
|
255 | + /** |
|
256 | + * Return the description for admin screens. |
|
257 | + * |
|
258 | + * @return string |
|
259 | + */ |
|
260 | + public function get_method_description() { |
|
261 | + return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this ); |
|
262 | + } |
|
263 | + |
|
264 | + /** |
|
265 | + * Get the success url. |
|
266 | + * |
|
267 | + * @param WPInv_Invoice $invoice Invoice object. |
|
268 | + * @return string |
|
269 | + */ |
|
270 | + public function get_return_url( $invoice ) { |
|
271 | + |
|
272 | + // Payment success url |
|
273 | + $return_url = add_query_arg( |
|
274 | + array( |
|
275 | + 'payment-confirm' => $this->id, |
|
276 | + 'invoice_key' => $invoice->get_key(), |
|
277 | + 'utm_nooverride' => 1 |
|
278 | + ), |
|
279 | + wpinv_get_success_page_uri() |
|
280 | + ); |
|
281 | + |
|
282 | + return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this ); |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Confirms payments when rendering the success page. |
|
287 | + * |
|
288 | + * @param string $content Success page content. |
|
289 | + * @return string |
|
290 | + */ |
|
291 | + public function confirm_payment( $content ) { |
|
292 | + |
|
293 | + // Retrieve the invoice. |
|
294 | + $invoice_id = getpaid_get_current_invoice_id(); |
|
295 | + $invoice = wpinv_get_invoice( $invoice_id ); |
|
296 | + |
|
297 | + // Ensure that it exists and that it is pending payment. |
|
298 | + if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) { |
|
299 | + return $content; |
|
300 | + } |
|
301 | + |
|
302 | + // Can the user view this invoice?? |
|
303 | + if ( ! wpinv_user_can_view_invoice( $invoice ) ) { |
|
304 | + return $content; |
|
305 | + } |
|
306 | + |
|
307 | + // Show payment processing indicator. |
|
308 | + return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) ); |
|
309 | + } |
|
310 | + |
|
311 | + /** |
|
312 | + * Processes ipns and marks payments as complete. |
|
313 | + * |
|
314 | + * @return void |
|
315 | + */ |
|
316 | + public function verify_ipn() {} |
|
317 | + |
|
318 | + /** |
|
319 | + * Processes invoice addons. |
|
320 | + * |
|
321 | + * @param WPInv_Invoice $invoice |
|
322 | + * @param GetPaid_Form_Item[] $items |
|
323 | + * @return WPInv_Invoice |
|
324 | + */ |
|
325 | + public function process_addons( $invoice, $items ) { |
|
326 | + |
|
327 | + } |
|
328 | + |
|
329 | + /** |
|
330 | + * Get a link to the transaction on the 3rd party gateway site (if applicable). |
|
331 | + * |
|
332 | + * @param string $transaction_url transaction url. |
|
333 | + * @param WPInv_Invoice $invoice Invoice object. |
|
334 | + * @return string transaction URL, or empty string. |
|
335 | + */ |
|
336 | + public function filter_transaction_url( $transaction_url, $invoice ) { |
|
337 | + |
|
338 | + $transaction_id = $invoice->get_transaction_id(); |
|
339 | + |
|
340 | + if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) { |
|
341 | + $transaction_url = sprintf( $this->view_transaction_url, $transaction_id ); |
|
342 | + $replace = $this->is_sandbox( $invoice ) ? 'sandbox' : ''; |
|
343 | + $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url ); |
|
344 | + } |
|
171 | 345 | |
172 | - // Change the checkout button text. |
|
173 | - if ( ! empty( $this->checkout_button_text ) ) { |
|
174 | - add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) ); |
|
175 | - } |
|
176 | - |
|
177 | - // Check if a gateway is valid for a given currency. |
|
178 | - add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 ); |
|
179 | - |
|
180 | - // Generate the transaction url. |
|
181 | - add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 ); |
|
182 | - |
|
183 | - // Generate the subscription url. |
|
184 | - add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 ); |
|
185 | - |
|
186 | - // Confirm payments. |
|
187 | - add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 ); |
|
188 | - |
|
189 | - // Verify IPNs. |
|
190 | - add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) ); |
|
191 | - |
|
192 | - } |
|
193 | - |
|
194 | - /** |
|
195 | - * Checks if this gateway is a given gateway. |
|
196 | - * |
|
197 | - * @since 1.0.19 |
|
198 | - * @return bool |
|
199 | - */ |
|
200 | - public function is( $gateway ) { |
|
201 | - return $gateway == $this->id; |
|
202 | - } |
|
203 | - |
|
204 | - /** |
|
205 | - * Returns a users saved tokens for this gateway. |
|
206 | - * |
|
207 | - * @since 1.0.19 |
|
208 | - * @return array |
|
209 | - */ |
|
210 | - public function get_tokens( $sandbox = null ) { |
|
211 | - |
|
212 | - if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) { |
|
213 | - $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true ); |
|
214 | - |
|
215 | - if ( is_array( $tokens ) ) { |
|
216 | - $this->tokens = $tokens; |
|
217 | - } |
|
218 | - |
|
219 | - } |
|
220 | - |
|
221 | - if ( ! is_bool( $sandbox ) ) { |
|
222 | - return $this->tokens; |
|
223 | - } |
|
224 | - |
|
225 | - $args = array( 'type' => $sandbox ? 'sandbox' : 'live' ); |
|
226 | - return wp_list_filter( $this->tokens, $args ); |
|
227 | - |
|
228 | - } |
|
229 | - |
|
230 | - /** |
|
231 | - * Saves a token for this gateway. |
|
232 | - * |
|
233 | - * @since 1.0.19 |
|
234 | - */ |
|
235 | - public function save_token( $token ) { |
|
236 | - |
|
237 | - $tokens = $this->get_tokens(); |
|
238 | - $tokens[] = $token; |
|
239 | - |
|
240 | - update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens ); |
|
241 | - |
|
242 | - $this->tokens = $tokens; |
|
243 | - |
|
244 | - } |
|
245 | - |
|
246 | - /** |
|
247 | - * Return the title for admin screens. |
|
248 | - * |
|
249 | - * @return string |
|
250 | - */ |
|
251 | - public function get_method_title() { |
|
252 | - return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this ); |
|
253 | - } |
|
254 | - |
|
255 | - /** |
|
256 | - * Return the description for admin screens. |
|
257 | - * |
|
258 | - * @return string |
|
259 | - */ |
|
260 | - public function get_method_description() { |
|
261 | - return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this ); |
|
262 | - } |
|
263 | - |
|
264 | - /** |
|
265 | - * Get the success url. |
|
266 | - * |
|
267 | - * @param WPInv_Invoice $invoice Invoice object. |
|
268 | - * @return string |
|
269 | - */ |
|
270 | - public function get_return_url( $invoice ) { |
|
271 | - |
|
272 | - // Payment success url |
|
273 | - $return_url = add_query_arg( |
|
274 | - array( |
|
275 | - 'payment-confirm' => $this->id, |
|
276 | - 'invoice_key' => $invoice->get_key(), |
|
277 | - 'utm_nooverride' => 1 |
|
278 | - ), |
|
279 | - wpinv_get_success_page_uri() |
|
280 | - ); |
|
281 | - |
|
282 | - return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this ); |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Confirms payments when rendering the success page. |
|
287 | - * |
|
288 | - * @param string $content Success page content. |
|
289 | - * @return string |
|
290 | - */ |
|
291 | - public function confirm_payment( $content ) { |
|
292 | - |
|
293 | - // Retrieve the invoice. |
|
294 | - $invoice_id = getpaid_get_current_invoice_id(); |
|
295 | - $invoice = wpinv_get_invoice( $invoice_id ); |
|
296 | - |
|
297 | - // Ensure that it exists and that it is pending payment. |
|
298 | - if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) { |
|
299 | - return $content; |
|
300 | - } |
|
301 | - |
|
302 | - // Can the user view this invoice?? |
|
303 | - if ( ! wpinv_user_can_view_invoice( $invoice ) ) { |
|
304 | - return $content; |
|
305 | - } |
|
306 | - |
|
307 | - // Show payment processing indicator. |
|
308 | - return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) ); |
|
309 | - } |
|
310 | - |
|
311 | - /** |
|
312 | - * Processes ipns and marks payments as complete. |
|
313 | - * |
|
314 | - * @return void |
|
315 | - */ |
|
316 | - public function verify_ipn() {} |
|
317 | - |
|
318 | - /** |
|
319 | - * Processes invoice addons. |
|
320 | - * |
|
321 | - * @param WPInv_Invoice $invoice |
|
322 | - * @param GetPaid_Form_Item[] $items |
|
323 | - * @return WPInv_Invoice |
|
324 | - */ |
|
325 | - public function process_addons( $invoice, $items ) { |
|
326 | - |
|
327 | - } |
|
328 | - |
|
329 | - /** |
|
330 | - * Get a link to the transaction on the 3rd party gateway site (if applicable). |
|
331 | - * |
|
332 | - * @param string $transaction_url transaction url. |
|
333 | - * @param WPInv_Invoice $invoice Invoice object. |
|
334 | - * @return string transaction URL, or empty string. |
|
335 | - */ |
|
336 | - public function filter_transaction_url( $transaction_url, $invoice ) { |
|
337 | - |
|
338 | - $transaction_id = $invoice->get_transaction_id(); |
|
339 | - |
|
340 | - if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) { |
|
341 | - $transaction_url = sprintf( $this->view_transaction_url, $transaction_id ); |
|
342 | - $replace = $this->is_sandbox( $invoice ) ? 'sandbox' : ''; |
|
343 | - $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url ); |
|
344 | - } |
|
345 | - |
|
346 | - return $transaction_url; |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Get a link to the subscription on the 3rd party gateway site (if applicable). |
|
351 | - * |
|
352 | - * @param string $subscription_url transaction url. |
|
353 | - * @param WPInv_Invoice $invoice Invoice object. |
|
354 | - * @return string subscription URL, or empty string. |
|
355 | - */ |
|
356 | - public function filter_subscription_url( $subscription_url, $invoice ) { |
|
357 | - |
|
358 | - $profile_id = $invoice->get_subscription_id(); |
|
359 | - |
|
360 | - if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) { |
|
361 | - |
|
362 | - $subscription_url = sprintf( $this->view_subscription_url, $profile_id ); |
|
363 | - $replace = $this->is_sandbox( $invoice ) ? 'sandbox' : ''; |
|
364 | - $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url ); |
|
365 | - |
|
366 | - } |
|
367 | - |
|
368 | - return $subscription_url; |
|
369 | - } |
|
370 | - |
|
371 | - /** |
|
372 | - * Check if the gateway is available for use. |
|
373 | - * |
|
374 | - * @return bool |
|
375 | - */ |
|
376 | - public function is_available() { |
|
377 | - return ! empty( $this->enabled ); |
|
378 | - } |
|
379 | - |
|
380 | - /** |
|
381 | - * Return the gateway's title. |
|
382 | - * |
|
383 | - * @return string |
|
384 | - */ |
|
385 | - public function get_title() { |
|
386 | - return apply_filters( 'getpaid_gateway_title', $this->title, $this ); |
|
387 | - } |
|
388 | - |
|
389 | - /** |
|
390 | - * Return the gateway's description. |
|
391 | - * |
|
392 | - * @return string |
|
393 | - */ |
|
394 | - public function get_description() { |
|
395 | - return apply_filters( 'getpaid_gateway_description', $this->description, $this ); |
|
396 | - } |
|
397 | - |
|
398 | - /** |
|
399 | - * Process Payment. |
|
400 | - * |
|
401 | - * |
|
402 | - * @param WPInv_Invoice $invoice Invoice. |
|
403 | - * @param array $submission_data Posted checkout fields. |
|
404 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
405 | - * @return void |
|
406 | - */ |
|
407 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
408 | - // Process the payment then either redirect to the success page or the gateway. |
|
409 | - do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission ); |
|
410 | - } |
|
411 | - |
|
412 | - /** |
|
413 | - * Process refund. |
|
414 | - * |
|
415 | - * If the gateway declares 'refunds' support, this will allow it to refund. |
|
416 | - * a passed in amount. |
|
417 | - * |
|
418 | - * @param WPInv_Invoice $invoice Invoice. |
|
419 | - * @param float $amount Refund amount. |
|
420 | - * @param string $reason Refund reason. |
|
421 | - * @return WP_Error|bool True or false based on success, or a WP_Error object. |
|
422 | - */ |
|
423 | - public function process_refund( $invoice, $amount = null, $reason = '' ) { |
|
424 | - return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason ); |
|
425 | - } |
|
426 | - |
|
427 | - /** |
|
428 | - * Displays the payment fields, credit cards etc. |
|
429 | - * |
|
430 | - * @param int $invoice_id 0 or invoice id. |
|
431 | - * @param GetPaid_Payment_Form $form Current payment form. |
|
432 | - */ |
|
433 | - public function payment_fields( $invoice_id, $form ) { |
|
434 | - do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form ); |
|
435 | - } |
|
436 | - |
|
437 | - /** |
|
438 | - * Filters the gateway settings. |
|
439 | - * |
|
440 | - * @param array $admin_settings |
|
441 | - */ |
|
442 | - public function admin_settings( $admin_settings ) { |
|
443 | - return $admin_settings; |
|
444 | - } |
|
445 | - |
|
446 | - /** |
|
447 | - * Retrieves the value of a gateway setting. |
|
448 | - * |
|
449 | - * @param string $option |
|
450 | - */ |
|
451 | - public function get_option( $option, $default = false ) { |
|
452 | - return wpinv_get_option( $this->id . '_' . $option, $default ); |
|
453 | - } |
|
454 | - |
|
455 | - /** |
|
456 | - * Check if a gateway supports a given feature. |
|
457 | - * |
|
458 | - * Gateways should override this to declare support (or lack of support) for a feature. |
|
459 | - * For backward compatibility, gateways support 'products' by default, but nothing else. |
|
460 | - * |
|
461 | - * @param string $feature string The name of a feature to test support for. |
|
462 | - * @return bool True if the gateway supports the feature, false otherwise. |
|
463 | - * @since 1.0.19 |
|
464 | - */ |
|
465 | - public function supports( $feature ) { |
|
466 | - return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this ); |
|
467 | - } |
|
468 | - |
|
469 | - /** |
|
470 | - * Returns the credit card form html. |
|
471 | - * |
|
472 | - * @param bool $save whether or not to display the save button. |
|
473 | - */ |
|
346 | + return $transaction_url; |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Get a link to the subscription on the 3rd party gateway site (if applicable). |
|
351 | + * |
|
352 | + * @param string $subscription_url transaction url. |
|
353 | + * @param WPInv_Invoice $invoice Invoice object. |
|
354 | + * @return string subscription URL, or empty string. |
|
355 | + */ |
|
356 | + public function filter_subscription_url( $subscription_url, $invoice ) { |
|
357 | + |
|
358 | + $profile_id = $invoice->get_subscription_id(); |
|
359 | + |
|
360 | + if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) { |
|
361 | + |
|
362 | + $subscription_url = sprintf( $this->view_subscription_url, $profile_id ); |
|
363 | + $replace = $this->is_sandbox( $invoice ) ? 'sandbox' : ''; |
|
364 | + $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url ); |
|
365 | + |
|
366 | + } |
|
367 | + |
|
368 | + return $subscription_url; |
|
369 | + } |
|
370 | + |
|
371 | + /** |
|
372 | + * Check if the gateway is available for use. |
|
373 | + * |
|
374 | + * @return bool |
|
375 | + */ |
|
376 | + public function is_available() { |
|
377 | + return ! empty( $this->enabled ); |
|
378 | + } |
|
379 | + |
|
380 | + /** |
|
381 | + * Return the gateway's title. |
|
382 | + * |
|
383 | + * @return string |
|
384 | + */ |
|
385 | + public function get_title() { |
|
386 | + return apply_filters( 'getpaid_gateway_title', $this->title, $this ); |
|
387 | + } |
|
388 | + |
|
389 | + /** |
|
390 | + * Return the gateway's description. |
|
391 | + * |
|
392 | + * @return string |
|
393 | + */ |
|
394 | + public function get_description() { |
|
395 | + return apply_filters( 'getpaid_gateway_description', $this->description, $this ); |
|
396 | + } |
|
397 | + |
|
398 | + /** |
|
399 | + * Process Payment. |
|
400 | + * |
|
401 | + * |
|
402 | + * @param WPInv_Invoice $invoice Invoice. |
|
403 | + * @param array $submission_data Posted checkout fields. |
|
404 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
405 | + * @return void |
|
406 | + */ |
|
407 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
408 | + // Process the payment then either redirect to the success page or the gateway. |
|
409 | + do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission ); |
|
410 | + } |
|
411 | + |
|
412 | + /** |
|
413 | + * Process refund. |
|
414 | + * |
|
415 | + * If the gateway declares 'refunds' support, this will allow it to refund. |
|
416 | + * a passed in amount. |
|
417 | + * |
|
418 | + * @param WPInv_Invoice $invoice Invoice. |
|
419 | + * @param float $amount Refund amount. |
|
420 | + * @param string $reason Refund reason. |
|
421 | + * @return WP_Error|bool True or false based on success, or a WP_Error object. |
|
422 | + */ |
|
423 | + public function process_refund( $invoice, $amount = null, $reason = '' ) { |
|
424 | + return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason ); |
|
425 | + } |
|
426 | + |
|
427 | + /** |
|
428 | + * Displays the payment fields, credit cards etc. |
|
429 | + * |
|
430 | + * @param int $invoice_id 0 or invoice id. |
|
431 | + * @param GetPaid_Payment_Form $form Current payment form. |
|
432 | + */ |
|
433 | + public function payment_fields( $invoice_id, $form ) { |
|
434 | + do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form ); |
|
435 | + } |
|
436 | + |
|
437 | + /** |
|
438 | + * Filters the gateway settings. |
|
439 | + * |
|
440 | + * @param array $admin_settings |
|
441 | + */ |
|
442 | + public function admin_settings( $admin_settings ) { |
|
443 | + return $admin_settings; |
|
444 | + } |
|
445 | + |
|
446 | + /** |
|
447 | + * Retrieves the value of a gateway setting. |
|
448 | + * |
|
449 | + * @param string $option |
|
450 | + */ |
|
451 | + public function get_option( $option, $default = false ) { |
|
452 | + return wpinv_get_option( $this->id . '_' . $option, $default ); |
|
453 | + } |
|
454 | + |
|
455 | + /** |
|
456 | + * Check if a gateway supports a given feature. |
|
457 | + * |
|
458 | + * Gateways should override this to declare support (or lack of support) for a feature. |
|
459 | + * For backward compatibility, gateways support 'products' by default, but nothing else. |
|
460 | + * |
|
461 | + * @param string $feature string The name of a feature to test support for. |
|
462 | + * @return bool True if the gateway supports the feature, false otherwise. |
|
463 | + * @since 1.0.19 |
|
464 | + */ |
|
465 | + public function supports( $feature ) { |
|
466 | + return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this ); |
|
467 | + } |
|
468 | + |
|
469 | + /** |
|
470 | + * Returns the credit card form html. |
|
471 | + * |
|
472 | + * @param bool $save whether or not to display the save button. |
|
473 | + */ |
|
474 | 474 | public function get_cc_form( $save = false ) { |
475 | 475 | |
476 | - ob_start(); |
|
476 | + ob_start(); |
|
477 | 477 | |
478 | 478 | $id_prefix = esc_attr( uniqid( $this->id ) ); |
479 | 479 | |
@@ -568,8 +568,8 @@ discard block |
||
568 | 568 | 'name' => $this->id . '[cc_cvv2]', |
569 | 569 | 'id' => "$id_prefix-cc-cvv2", |
570 | 570 | 'label' => __( 'CCV', 'invoicing' ), |
571 | - 'label_type' => 'vertical', |
|
572 | - 'class' => 'form-control-sm', |
|
571 | + 'label_type' => 'vertical', |
|
572 | + 'class' => 'form-control-sm', |
|
573 | 573 | ) |
574 | 574 | ); |
575 | 575 | ?> |
@@ -579,189 +579,189 @@ discard block |
||
579 | 579 | |
580 | 580 | <?php |
581 | 581 | |
582 | - if ( $save ) { |
|
583 | - echo $this->save_payment_method_checkbox(); |
|
584 | - } |
|
582 | + if ( $save ) { |
|
583 | + echo $this->save_payment_method_checkbox(); |
|
584 | + } |
|
585 | 585 | |
586 | - ?> |
|
586 | + ?> |
|
587 | 587 | </div> |
588 | 588 | |
589 | 589 | </div> |
590 | 590 | <?php |
591 | 591 | |
592 | - return ob_get_clean(); |
|
592 | + return ob_get_clean(); |
|
593 | + |
|
594 | + } |
|
593 | 595 | |
596 | + /** |
|
597 | + * Displays a new payment method entry form. |
|
598 | + * |
|
599 | + * @since 1.0.19 |
|
600 | + */ |
|
601 | + public function new_payment_method_entry( $form ) { |
|
602 | + echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>"; |
|
594 | 603 | } |
595 | 604 | |
596 | - /** |
|
597 | - * Displays a new payment method entry form. |
|
598 | - * |
|
599 | - * @since 1.0.19 |
|
600 | - */ |
|
601 | - public function new_payment_method_entry( $form ) { |
|
602 | - echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>"; |
|
603 | - } |
|
604 | - |
|
605 | - /** |
|
606 | - * Grab and display our saved payment methods. |
|
607 | - * |
|
608 | - * @since 1.0.19 |
|
609 | - */ |
|
610 | - public function saved_payment_methods() { |
|
611 | - $html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">'; |
|
612 | - |
|
613 | - foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) { |
|
614 | - $html .= $this->get_saved_payment_method_option_html( $token ); |
|
615 | - } |
|
616 | - |
|
617 | - $html .= $this->get_new_payment_method_option_html(); |
|
618 | - $html .= '</ul>'; |
|
619 | - |
|
620 | - echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this ); |
|
621 | - } |
|
622 | - |
|
623 | - /** |
|
624 | - * Gets saved payment method HTML from a token. |
|
625 | - * |
|
626 | - * @since 1.0.19 |
|
627 | - * @param array $token Payment Token. |
|
628 | - * @return string Generated payment method HTML |
|
629 | - */ |
|
630 | - public function get_saved_payment_method_option_html( $token ) { |
|
631 | - |
|
632 | - return sprintf( |
|
633 | - '<li class="getpaid-payment-method form-group"> |
|
605 | + /** |
|
606 | + * Grab and display our saved payment methods. |
|
607 | + * |
|
608 | + * @since 1.0.19 |
|
609 | + */ |
|
610 | + public function saved_payment_methods() { |
|
611 | + $html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">'; |
|
612 | + |
|
613 | + foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) { |
|
614 | + $html .= $this->get_saved_payment_method_option_html( $token ); |
|
615 | + } |
|
616 | + |
|
617 | + $html .= $this->get_new_payment_method_option_html(); |
|
618 | + $html .= '</ul>'; |
|
619 | + |
|
620 | + echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this ); |
|
621 | + } |
|
622 | + |
|
623 | + /** |
|
624 | + * Gets saved payment method HTML from a token. |
|
625 | + * |
|
626 | + * @since 1.0.19 |
|
627 | + * @param array $token Payment Token. |
|
628 | + * @return string Generated payment method HTML |
|
629 | + */ |
|
630 | + public function get_saved_payment_method_option_html( $token ) { |
|
631 | + |
|
632 | + return sprintf( |
|
633 | + '<li class="getpaid-payment-method form-group"> |
|
634 | 634 | <label> |
635 | 635 | <input name="getpaid-%1$s-payment-method" type="radio" value="%2$s" style="width:auto;" class="getpaid-saved-payment-method-token-input" %4$s /> |
636 | 636 | <span>%3$s</span> |
637 | 637 | </label> |
638 | 638 | </li>', |
639 | - esc_attr( $this->id ), |
|
640 | - esc_attr( $token['id'] ), |
|
641 | - esc_html( $token['name'] ), |
|
642 | - checked( empty( $token['default'] ), false, false ) |
|
643 | - ); |
|
639 | + esc_attr( $this->id ), |
|
640 | + esc_attr( $token['id'] ), |
|
641 | + esc_html( $token['name'] ), |
|
642 | + checked( empty( $token['default'] ), false, false ) |
|
643 | + ); |
|
644 | 644 | |
645 | - } |
|
645 | + } |
|
646 | 646 | |
647 | - /** |
|
648 | - * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method. |
|
649 | - * |
|
650 | - * @since 1.0.19 |
|
651 | - */ |
|
652 | - public function get_new_payment_method_option_html() { |
|
647 | + /** |
|
648 | + * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method. |
|
649 | + * |
|
650 | + * @since 1.0.19 |
|
651 | + */ |
|
652 | + public function get_new_payment_method_option_html() { |
|
653 | 653 | |
654 | - $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this ); |
|
654 | + $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this ); |
|
655 | 655 | |
656 | - return sprintf( |
|
657 | - '<li class="getpaid-new-payment-method"> |
|
656 | + return sprintf( |
|
657 | + '<li class="getpaid-new-payment-method"> |
|
658 | 658 | <label> |
659 | 659 | <input name="getpaid-%1$s-payment-method" type="radio" value="new" style="width:auto;" /> |
660 | 660 | <span>%2$s</span> |
661 | 661 | </label> |
662 | 662 | </li>', |
663 | - esc_attr( $this->id ), |
|
664 | - esc_html( $label ) |
|
665 | - ); |
|
663 | + esc_attr( $this->id ), |
|
664 | + esc_html( $label ) |
|
665 | + ); |
|
666 | 666 | |
667 | - } |
|
667 | + } |
|
668 | 668 | |
669 | - /** |
|
670 | - * Outputs a checkbox for saving a new payment method to the database. |
|
671 | - * |
|
672 | - * @since 1.0.19 |
|
673 | - */ |
|
674 | - public function save_payment_method_checkbox() { |
|
669 | + /** |
|
670 | + * Outputs a checkbox for saving a new payment method to the database. |
|
671 | + * |
|
672 | + * @since 1.0.19 |
|
673 | + */ |
|
674 | + public function save_payment_method_checkbox() { |
|
675 | 675 | |
676 | - return sprintf( |
|
677 | - '<p class="form-group getpaid-save-payment-method"> |
|
676 | + return sprintf( |
|
677 | + '<p class="form-group getpaid-save-payment-method"> |
|
678 | 678 | <label> |
679 | 679 | <input name="getpaid-%1$s-new-payment-method" type="checkbox" value="true" style="width:auto;" /> |
680 | 680 | <span>%2$s</span> |
681 | 681 | </label> |
682 | 682 | </p>', |
683 | - esc_attr( $this->id ), |
|
684 | - esc_html__( 'Save payment method', 'invoicing' ) |
|
685 | - ); |
|
683 | + esc_attr( $this->id ), |
|
684 | + esc_html__( 'Save payment method', 'invoicing' ) |
|
685 | + ); |
|
686 | 686 | |
687 | - } |
|
687 | + } |
|
688 | 688 | |
689 | - /** |
|
690 | - * Registers the gateway. |
|
691 | - * |
|
692 | - * @return array |
|
693 | - */ |
|
694 | - public function register_gateway( $gateways ) { |
|
689 | + /** |
|
690 | + * Registers the gateway. |
|
691 | + * |
|
692 | + * @return array |
|
693 | + */ |
|
694 | + public function register_gateway( $gateways ) { |
|
695 | 695 | |
696 | - $gateways[ $this->id ] = array( |
|
696 | + $gateways[ $this->id ] = array( |
|
697 | 697 | |
698 | - 'admin_label' => $this->method_title, |
|
698 | + 'admin_label' => $this->method_title, |
|
699 | 699 | 'checkout_label' => $this->title, |
700 | - 'ordering' => $this->order, |
|
700 | + 'ordering' => $this->order, |
|
701 | 701 | |
702 | - ); |
|
702 | + ); |
|
703 | 703 | |
704 | - return $gateways; |
|
704 | + return $gateways; |
|
705 | 705 | |
706 | - } |
|
706 | + } |
|
707 | 707 | |
708 | - /** |
|
709 | - * Checks whether or not this is a sandbox request. |
|
710 | - * |
|
711 | - * @param WPInv_Invoice|null $invoice Invoice object or null. |
|
712 | - * @return bool |
|
713 | - */ |
|
714 | - public function is_sandbox( $invoice = null ) { |
|
708 | + /** |
|
709 | + * Checks whether or not this is a sandbox request. |
|
710 | + * |
|
711 | + * @param WPInv_Invoice|null $invoice Invoice object or null. |
|
712 | + * @return bool |
|
713 | + */ |
|
714 | + public function is_sandbox( $invoice = null ) { |
|
715 | 715 | |
716 | - if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) { |
|
717 | - return $invoice->get_mode() == 'test'; |
|
718 | - } |
|
716 | + if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) { |
|
717 | + return $invoice->get_mode() == 'test'; |
|
718 | + } |
|
719 | 719 | |
720 | - return wpinv_is_test_mode( $this->id ); |
|
720 | + return wpinv_is_test_mode( $this->id ); |
|
721 | 721 | |
722 | - } |
|
722 | + } |
|
723 | 723 | |
724 | - /** |
|
725 | - * Renames the checkout button |
|
726 | - * |
|
727 | - * @return string |
|
728 | - */ |
|
729 | - public function rename_checkout_button() { |
|
730 | - return $this->checkout_button_text; |
|
731 | - } |
|
724 | + /** |
|
725 | + * Renames the checkout button |
|
726 | + * |
|
727 | + * @return string |
|
728 | + */ |
|
729 | + public function rename_checkout_button() { |
|
730 | + return $this->checkout_button_text; |
|
731 | + } |
|
732 | 732 | |
733 | - /** |
|
734 | - * Validate gateway currency |
|
735 | - * |
|
736 | - * @return bool |
|
737 | - */ |
|
738 | - public function validate_currency( $validation, $currency ) { |
|
733 | + /** |
|
734 | + * Validate gateway currency |
|
735 | + * |
|
736 | + * @return bool |
|
737 | + */ |
|
738 | + public function validate_currency( $validation, $currency ) { |
|
739 | 739 | |
740 | - // Required currencies. |
|
741 | - if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) { |
|
742 | - return false; |
|
743 | - } |
|
740 | + // Required currencies. |
|
741 | + if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) { |
|
742 | + return false; |
|
743 | + } |
|
744 | 744 | |
745 | - // Excluded currencies. |
|
746 | - if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) { |
|
747 | - return false; |
|
748 | - } |
|
745 | + // Excluded currencies. |
|
746 | + if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) { |
|
747 | + return false; |
|
748 | + } |
|
749 | 749 | |
750 | - return $validation; |
|
751 | - } |
|
750 | + return $validation; |
|
751 | + } |
|
752 | 752 | |
753 | - /** |
|
754 | - * Displays an error |
|
755 | - * |
|
756 | - */ |
|
757 | - public function show_error( $code, $message, $type ) { |
|
753 | + /** |
|
754 | + * Displays an error |
|
755 | + * |
|
756 | + */ |
|
757 | + public function show_error( $code, $message, $type ) { |
|
758 | 758 | |
759 | - if ( is_admin() ) { |
|
760 | - getpaid_admin()->{"show_$type"}( $message ); |
|
761 | - } |
|
759 | + if ( is_admin() ) { |
|
760 | + getpaid_admin()->{"show_$type"}( $message ); |
|
761 | + } |
|
762 | 762 | |
763 | - wpinv_set_error( $code, $message, $type ); |
|
763 | + wpinv_set_error( $code, $message, $type ); |
|
764 | 764 | |
765 | - } |
|
765 | + } |
|
766 | 766 | |
767 | 767 | } |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | * Checks if the current user cna view an invoice receipt. |
68 | 68 | */ |
69 | 69 | function wpinv_can_view_receipt( $invoice ) { |
70 | - return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
70 | + return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | /** |
@@ -1256,21 +1256,21 @@ discard block |
||
1256 | 1256 | */ |
1257 | 1257 | function getpaid_get_invoice_status_classes() { |
1258 | 1258 | |
1259 | - return apply_filters( |
|
1260 | - 'getpaid_get_invoice_status_classes', |
|
1261 | - array( |
|
1259 | + return apply_filters( |
|
1260 | + 'getpaid_get_invoice_status_classes', |
|
1261 | + array( |
|
1262 | 1262 | 'wpi-quote-declined' => 'badge-danger', |
1263 | 1263 | 'wpi-failed' => 'badge-danger', |
1264 | - 'wpi-processing' => 'badge-info', |
|
1265 | - 'wpi-onhold' => 'badge-warning', |
|
1266 | - 'wpi-quote-accepted' => 'badge-success', |
|
1267 | - 'publish' => 'badge-success', |
|
1268 | - 'wpi-renewal' => 'badge-primary', |
|
1264 | + 'wpi-processing' => 'badge-info', |
|
1265 | + 'wpi-onhold' => 'badge-warning', |
|
1266 | + 'wpi-quote-accepted' => 'badge-success', |
|
1267 | + 'publish' => 'badge-success', |
|
1268 | + 'wpi-renewal' => 'badge-primary', |
|
1269 | 1269 | 'wpi-cancelled' => 'badge-secondary', |
1270 | 1270 | 'wpi-pending' => 'badge-dark', |
1271 | 1271 | 'wpi-quote-pending' => 'badge-dark', |
1272 | 1272 | 'wpi-refunded' => 'badge-secondary', |
1273 | - ) |
|
1274 | - ); |
|
1273 | + ) |
|
1274 | + ); |
|
1275 | 1275 | |
1276 | 1276 | } |
@@ -14,30 +14,30 @@ discard block |
||
14 | 14 | class WPInv_Invoice extends GetPaid_Data { |
15 | 15 | |
16 | 16 | /** |
17 | - * Which data store to load. |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
17 | + * Which data store to load. |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | 21 | protected $data_store_name = 'invoice'; |
22 | 22 | |
23 | 23 | /** |
24 | - * This is the name of this object type. |
|
25 | - * |
|
26 | - * @var string |
|
27 | - */ |
|
24 | + * This is the name of this object type. |
|
25 | + * |
|
26 | + * @var string |
|
27 | + */ |
|
28 | 28 | protected $object_type = 'invoice'; |
29 | 29 | |
30 | 30 | /** |
31 | - * Item Data array. This is the core item data exposed in APIs. |
|
32 | - * |
|
33 | - * @since 1.0.19 |
|
34 | - * @var array |
|
35 | - */ |
|
36 | - protected $data = array( |
|
37 | - 'parent_id' => 0, |
|
38 | - 'status' => 'wpi-pending', |
|
39 | - 'version' => '', |
|
40 | - 'date_created' => null, |
|
31 | + * Item Data array. This is the core item data exposed in APIs. |
|
32 | + * |
|
33 | + * @since 1.0.19 |
|
34 | + * @var array |
|
35 | + */ |
|
36 | + protected $data = array( |
|
37 | + 'parent_id' => 0, |
|
38 | + 'status' => 'wpi-pending', |
|
39 | + 'version' => '', |
|
40 | + 'date_created' => null, |
|
41 | 41 | 'date_modified' => null, |
42 | 42 | 'due_date' => null, |
43 | 43 | 'completed_date' => null, |
@@ -79,22 +79,22 @@ discard block |
||
79 | 79 | 'transaction_id' => '', |
80 | 80 | 'currency' => '', |
81 | 81 | 'disable_taxes' => false, |
82 | - 'subscription_id' => null, |
|
83 | - 'remote_subscription_id' => null, |
|
84 | - 'is_viewed' => false, |
|
85 | - 'email_cc' => '', |
|
86 | - 'template' => 'quantity', // hours, amount only |
|
87 | - 'created_via' => null, |
|
82 | + 'subscription_id' => null, |
|
83 | + 'remote_subscription_id' => null, |
|
84 | + 'is_viewed' => false, |
|
85 | + 'email_cc' => '', |
|
86 | + 'template' => 'quantity', // hours, amount only |
|
87 | + 'created_via' => null, |
|
88 | 88 | ); |
89 | 89 | |
90 | 90 | /** |
91 | - * Stores meta in cache for future reads. |
|
92 | - * |
|
93 | - * A group must be set to to enable caching. |
|
94 | - * |
|
95 | - * @var string |
|
96 | - */ |
|
97 | - protected $cache_group = 'getpaid_invoices'; |
|
91 | + * Stores meta in cache for future reads. |
|
92 | + * |
|
93 | + * A group must be set to to enable caching. |
|
94 | + * |
|
95 | + * @var string |
|
96 | + */ |
|
97 | + protected $cache_group = 'getpaid_invoices'; |
|
98 | 98 | |
99 | 99 | /** |
100 | 100 | * Stores a reference to the original WP_Post object |
@@ -108,104 +108,104 @@ discard block |
||
108 | 108 | * |
109 | 109 | * @var int |
110 | 110 | */ |
111 | - protected $recurring_item = null; |
|
111 | + protected $recurring_item = null; |
|
112 | 112 | |
113 | - /** |
|
113 | + /** |
|
114 | 114 | * Stores an array of item totals. |
115 | - * |
|
116 | - * e.g $totals['discount'] = array( |
|
117 | - * 'initial' => 10, |
|
118 | - * 'recurring' => 10, |
|
119 | - * ) |
|
115 | + * |
|
116 | + * e.g $totals['discount'] = array( |
|
117 | + * 'initial' => 10, |
|
118 | + * 'recurring' => 10, |
|
119 | + * ) |
|
120 | 120 | * |
121 | 121 | * @var array |
122 | 122 | */ |
123 | - protected $totals = array(); |
|
123 | + protected $totals = array(); |
|
124 | 124 | |
125 | - /** |
|
126 | - * Stores the status transition information. |
|
127 | - * |
|
128 | - * @since 1.0.19 |
|
129 | - * @var bool|array |
|
130 | - */ |
|
131 | - protected $status_transition = false; |
|
125 | + /** |
|
126 | + * Stores the status transition information. |
|
127 | + * |
|
128 | + * @since 1.0.19 |
|
129 | + * @var bool|array |
|
130 | + */ |
|
131 | + protected $status_transition = false; |
|
132 | 132 | |
133 | 133 | /** |
134 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
135 | - * |
|
136 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
137 | - */ |
|
134 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
135 | + * |
|
136 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
137 | + */ |
|
138 | 138 | public function __construct( $invoice = 0 ) { |
139 | 139 | |
140 | 140 | parent::__construct( $invoice ); |
141 | 141 | |
142 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
143 | - $this->set_id( (int) $invoice ); |
|
144 | - } elseif ( $invoice instanceof self ) { |
|
145 | - $this->set_id( $invoice->get_id() ); |
|
146 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
147 | - $this->set_id( $invoice->ID ); |
|
148 | - } elseif ( is_array( $invoice ) ) { |
|
149 | - $this->set_props( $invoice ); |
|
150 | - |
|
151 | - if ( isset( $invoice['ID'] ) ) { |
|
152 | - $this->set_id( $invoice['ID'] ); |
|
153 | - } |
|
154 | - |
|
155 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
156 | - $this->set_id( $invoice_id ); |
|
157 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
158 | - $this->set_id( $invoice_id ); |
|
159 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
160 | - $this->set_id( $invoice_id ); |
|
161 | - }else { |
|
162 | - $this->set_object_read( true ); |
|
163 | - } |
|
142 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
143 | + $this->set_id( (int) $invoice ); |
|
144 | + } elseif ( $invoice instanceof self ) { |
|
145 | + $this->set_id( $invoice->get_id() ); |
|
146 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
147 | + $this->set_id( $invoice->ID ); |
|
148 | + } elseif ( is_array( $invoice ) ) { |
|
149 | + $this->set_props( $invoice ); |
|
150 | + |
|
151 | + if ( isset( $invoice['ID'] ) ) { |
|
152 | + $this->set_id( $invoice['ID'] ); |
|
153 | + } |
|
154 | + |
|
155 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
156 | + $this->set_id( $invoice_id ); |
|
157 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
158 | + $this->set_id( $invoice_id ); |
|
159 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
160 | + $this->set_id( $invoice_id ); |
|
161 | + }else { |
|
162 | + $this->set_object_read( true ); |
|
163 | + } |
|
164 | 164 | |
165 | 165 | // Load the datastore. |
166 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
166 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
167 | 167 | |
168 | - if ( $this->get_id() > 0 ) { |
|
168 | + if ( $this->get_id() > 0 ) { |
|
169 | 169 | $this->post = get_post( $this->get_id() ); |
170 | 170 | $this->ID = $this->get_id(); |
171 | - $this->data_store->read( $this ); |
|
171 | + $this->data_store->read( $this ); |
|
172 | 172 | } |
173 | 173 | |
174 | 174 | } |
175 | 175 | |
176 | 176 | /** |
177 | - * Given an invoice key/number, it returns its id. |
|
178 | - * |
|
179 | - * |
|
180 | - * @static |
|
181 | - * @param string $value The invoice key or number |
|
182 | - * @param string $field Either key, transaction_id or number. |
|
183 | - * @since 1.0.15 |
|
184 | - * @return int |
|
185 | - */ |
|
186 | - public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
177 | + * Given an invoice key/number, it returns its id. |
|
178 | + * |
|
179 | + * |
|
180 | + * @static |
|
181 | + * @param string $value The invoice key or number |
|
182 | + * @param string $field Either key, transaction_id or number. |
|
183 | + * @since 1.0.15 |
|
184 | + * @return int |
|
185 | + */ |
|
186 | + public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
187 | 187 | global $wpdb; |
188 | 188 | |
189 | - // Trim the value. |
|
190 | - $value = trim( $value ); |
|
189 | + // Trim the value. |
|
190 | + $value = trim( $value ); |
|
191 | 191 | |
192 | - if ( empty( $value ) ) { |
|
193 | - return 0; |
|
194 | - } |
|
192 | + if ( empty( $value ) ) { |
|
193 | + return 0; |
|
194 | + } |
|
195 | 195 | |
196 | 196 | // Valid fields. |
197 | 197 | $fields = array( 'key', 'number', 'transaction_id' ); |
198 | 198 | |
199 | - // Ensure a field has been passed. |
|
200 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
201 | - return 0; |
|
202 | - } |
|
199 | + // Ensure a field has been passed. |
|
200 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
201 | + return 0; |
|
202 | + } |
|
203 | 203 | |
204 | - // Maybe retrieve from the cache. |
|
205 | - $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
206 | - if ( false !== $invoice_id ) { |
|
207 | - return $invoice_id; |
|
208 | - } |
|
204 | + // Maybe retrieve from the cache. |
|
205 | + $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
206 | + if ( false !== $invoice_id ) { |
|
207 | + return $invoice_id; |
|
208 | + } |
|
209 | 209 | |
210 | 210 | // Fetch from the db. |
211 | 211 | $table = $wpdb->prefix . 'getpaid_invoices'; |
@@ -213,10 +213,10 @@ discard block |
||
213 | 213 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
214 | 214 | ); |
215 | 215 | |
216 | - // Update the cache with our data |
|
217 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
216 | + // Update the cache with our data |
|
217 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
218 | 218 | |
219 | - return $invoice_id; |
|
219 | + return $invoice_id; |
|
220 | 220 | } |
221 | 221 | |
222 | 222 | /** |
@@ -242,83 +242,83 @@ discard block |
||
242 | 242 | */ |
243 | 243 | |
244 | 244 | /** |
245 | - * Get parent invoice ID. |
|
246 | - * |
|
247 | - * @since 1.0.19 |
|
248 | - * @param string $context View or edit context. |
|
249 | - * @return int |
|
250 | - */ |
|
251 | - public function get_parent_id( $context = 'view' ) { |
|
252 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
245 | + * Get parent invoice ID. |
|
246 | + * |
|
247 | + * @since 1.0.19 |
|
248 | + * @param string $context View or edit context. |
|
249 | + * @return int |
|
250 | + */ |
|
251 | + public function get_parent_id( $context = 'view' ) { |
|
252 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
253 | 253 | } |
254 | 254 | |
255 | 255 | /** |
256 | - * Get parent invoice. |
|
257 | - * |
|
258 | - * @since 1.0.19 |
|
259 | - * @return WPInv_Invoice |
|
260 | - */ |
|
256 | + * Get parent invoice. |
|
257 | + * |
|
258 | + * @since 1.0.19 |
|
259 | + * @return WPInv_Invoice |
|
260 | + */ |
|
261 | 261 | public function get_parent_payment() { |
262 | 262 | return new WPInv_Invoice( $this->get_parent_id() ); |
263 | 263 | } |
264 | 264 | |
265 | 265 | /** |
266 | - * Alias for self::get_parent_payment(). |
|
267 | - * |
|
268 | - * @since 1.0.19 |
|
269 | - * @return WPInv_Invoice |
|
270 | - */ |
|
266 | + * Alias for self::get_parent_payment(). |
|
267 | + * |
|
268 | + * @since 1.0.19 |
|
269 | + * @return WPInv_Invoice |
|
270 | + */ |
|
271 | 271 | public function get_parent() { |
272 | 272 | return $this->get_parent_payment(); |
273 | 273 | } |
274 | 274 | |
275 | 275 | /** |
276 | - * Get invoice status. |
|
277 | - * |
|
278 | - * @since 1.0.19 |
|
279 | - * @param string $context View or edit context. |
|
280 | - * @return string |
|
281 | - */ |
|
282 | - public function get_status( $context = 'view' ) { |
|
283 | - return $this->get_prop( 'status', $context ); |
|
284 | - } |
|
276 | + * Get invoice status. |
|
277 | + * |
|
278 | + * @since 1.0.19 |
|
279 | + * @param string $context View or edit context. |
|
280 | + * @return string |
|
281 | + */ |
|
282 | + public function get_status( $context = 'view' ) { |
|
283 | + return $this->get_prop( 'status', $context ); |
|
284 | + } |
|
285 | 285 | |
286 | - /** |
|
287 | - * Retrieves an array of possible invoice statuses. |
|
288 | - * |
|
289 | - * @since 1.0.19 |
|
290 | - * @return array |
|
291 | - */ |
|
292 | - public function get_all_statuses() { |
|
293 | - return wpinv_get_invoice_statuses( true, true, $this ); |
|
294 | - } |
|
295 | - |
|
296 | - /** |
|
297 | - * Get invoice status nice name. |
|
298 | - * |
|
299 | - * @since 1.0.19 |
|
300 | - * @return string |
|
301 | - */ |
|
286 | + /** |
|
287 | + * Retrieves an array of possible invoice statuses. |
|
288 | + * |
|
289 | + * @since 1.0.19 |
|
290 | + * @return array |
|
291 | + */ |
|
292 | + public function get_all_statuses() { |
|
293 | + return wpinv_get_invoice_statuses( true, true, $this ); |
|
294 | + } |
|
295 | + |
|
296 | + /** |
|
297 | + * Get invoice status nice name. |
|
298 | + * |
|
299 | + * @since 1.0.19 |
|
300 | + * @return string |
|
301 | + */ |
|
302 | 302 | public function get_status_nicename() { |
303 | - $statuses = $this->get_all_statuses(); |
|
303 | + $statuses = $this->get_all_statuses(); |
|
304 | 304 | |
305 | 305 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
306 | 306 | |
307 | 307 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
308 | 308 | } |
309 | 309 | |
310 | - /** |
|
311 | - * Retrieves the invoice status class |
|
312 | - * |
|
313 | - * @since 1.0.19 |
|
314 | - * @return string |
|
315 | - */ |
|
316 | - public function get_status_class() { |
|
317 | - $statuses = getpaid_get_invoice_status_classes(); |
|
318 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
319 | - } |
|
310 | + /** |
|
311 | + * Retrieves the invoice status class |
|
312 | + * |
|
313 | + * @since 1.0.19 |
|
314 | + * @return string |
|
315 | + */ |
|
316 | + public function get_status_class() { |
|
317 | + $statuses = getpaid_get_invoice_status_classes(); |
|
318 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
319 | + } |
|
320 | 320 | |
321 | - /** |
|
321 | + /** |
|
322 | 322 | * Retrieves the invoice status label html |
323 | 323 | * |
324 | 324 | * @since 1.0.0 |
@@ -326,263 +326,263 @@ discard block |
||
326 | 326 | */ |
327 | 327 | public function get_status_label_html() { |
328 | 328 | |
329 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
330 | - $status = sanitize_html_class( $this->get_status() ); |
|
331 | - $class = esc_attr( $this->get_status_class() ); |
|
329 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
330 | + $status = sanitize_html_class( $this->get_status() ); |
|
331 | + $class = esc_attr( $this->get_status_class() ); |
|
332 | 332 | |
333 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
334 | - } |
|
333 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
334 | + } |
|
335 | 335 | |
336 | 336 | /** |
337 | - * Get plugin version when the invoice was created. |
|
338 | - * |
|
339 | - * @since 1.0.19 |
|
340 | - * @param string $context View or edit context. |
|
341 | - * @return string |
|
342 | - */ |
|
343 | - public function get_version( $context = 'view' ) { |
|
344 | - return $this->get_prop( 'version', $context ); |
|
345 | - } |
|
337 | + * Get plugin version when the invoice was created. |
|
338 | + * |
|
339 | + * @since 1.0.19 |
|
340 | + * @param string $context View or edit context. |
|
341 | + * @return string |
|
342 | + */ |
|
343 | + public function get_version( $context = 'view' ) { |
|
344 | + return $this->get_prop( 'version', $context ); |
|
345 | + } |
|
346 | 346 | |
347 | - /** |
|
348 | - * @deprecated |
|
349 | - */ |
|
350 | - public function get_invoice_date( $format = true ) { |
|
351 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
352 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
353 | - $formatted = getpaid_format_date( $date ); |
|
347 | + /** |
|
348 | + * @deprecated |
|
349 | + */ |
|
350 | + public function get_invoice_date( $format = true ) { |
|
351 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
352 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
353 | + $formatted = getpaid_format_date( $date ); |
|
354 | 354 | |
355 | - if ( $format ) { |
|
356 | - return $formatted; |
|
357 | - } |
|
355 | + if ( $format ) { |
|
356 | + return $formatted; |
|
357 | + } |
|
358 | 358 | |
359 | - return empty( $formatted ) ? '' : $date; |
|
359 | + return empty( $formatted ) ? '' : $date; |
|
360 | 360 | |
361 | 361 | } |
362 | 362 | |
363 | 363 | /** |
364 | - * Get date when the invoice was created. |
|
365 | - * |
|
366 | - * @since 1.0.19 |
|
367 | - * @param string $context View or edit context. |
|
368 | - * @return string |
|
369 | - */ |
|
370 | - public function get_date_created( $context = 'view' ) { |
|
371 | - return $this->get_prop( 'date_created', $context ); |
|
372 | - } |
|
364 | + * Get date when the invoice was created. |
|
365 | + * |
|
366 | + * @since 1.0.19 |
|
367 | + * @param string $context View or edit context. |
|
368 | + * @return string |
|
369 | + */ |
|
370 | + public function get_date_created( $context = 'view' ) { |
|
371 | + return $this->get_prop( 'date_created', $context ); |
|
372 | + } |
|
373 | 373 | |
374 | - /** |
|
375 | - * Alias for self::get_date_created(). |
|
376 | - * |
|
377 | - * @since 1.0.19 |
|
378 | - * @param string $context View or edit context. |
|
379 | - * @return string |
|
380 | - */ |
|
381 | - public function get_created_date( $context = 'view' ) { |
|
382 | - return $this->get_date_created( $context ); |
|
383 | - } |
|
384 | - |
|
385 | - /** |
|
386 | - * Get GMT date when the invoice was created. |
|
387 | - * |
|
388 | - * @since 1.0.19 |
|
389 | - * @param string $context View or edit context. |
|
390 | - * @return string |
|
391 | - */ |
|
392 | - public function get_date_created_gmt( $context = 'view' ) { |
|
374 | + /** |
|
375 | + * Alias for self::get_date_created(). |
|
376 | + * |
|
377 | + * @since 1.0.19 |
|
378 | + * @param string $context View or edit context. |
|
379 | + * @return string |
|
380 | + */ |
|
381 | + public function get_created_date( $context = 'view' ) { |
|
382 | + return $this->get_date_created( $context ); |
|
383 | + } |
|
384 | + |
|
385 | + /** |
|
386 | + * Get GMT date when the invoice was created. |
|
387 | + * |
|
388 | + * @since 1.0.19 |
|
389 | + * @param string $context View or edit context. |
|
390 | + * @return string |
|
391 | + */ |
|
392 | + public function get_date_created_gmt( $context = 'view' ) { |
|
393 | 393 | $date = $this->get_date_created( $context ); |
394 | 394 | |
395 | 395 | if ( $date ) { |
396 | 396 | $date = get_gmt_from_date( $date ); |
397 | 397 | } |
398 | - return $date; |
|
398 | + return $date; |
|
399 | 399 | } |
400 | 400 | |
401 | 401 | /** |
402 | - * Get date when the invoice was last modified. |
|
403 | - * |
|
404 | - * @since 1.0.19 |
|
405 | - * @param string $context View or edit context. |
|
406 | - * @return string |
|
407 | - */ |
|
408 | - public function get_date_modified( $context = 'view' ) { |
|
409 | - return $this->get_prop( 'date_modified', $context ); |
|
410 | - } |
|
402 | + * Get date when the invoice was last modified. |
|
403 | + * |
|
404 | + * @since 1.0.19 |
|
405 | + * @param string $context View or edit context. |
|
406 | + * @return string |
|
407 | + */ |
|
408 | + public function get_date_modified( $context = 'view' ) { |
|
409 | + return $this->get_prop( 'date_modified', $context ); |
|
410 | + } |
|
411 | 411 | |
412 | - /** |
|
413 | - * Alias for self::get_date_modified(). |
|
414 | - * |
|
415 | - * @since 1.0.19 |
|
416 | - * @param string $context View or edit context. |
|
417 | - * @return string |
|
418 | - */ |
|
419 | - public function get_modified_date( $context = 'view' ) { |
|
420 | - return $this->get_date_modified( $context ); |
|
412 | + /** |
|
413 | + * Alias for self::get_date_modified(). |
|
414 | + * |
|
415 | + * @since 1.0.19 |
|
416 | + * @param string $context View or edit context. |
|
417 | + * @return string |
|
418 | + */ |
|
419 | + public function get_modified_date( $context = 'view' ) { |
|
420 | + return $this->get_date_modified( $context ); |
|
421 | 421 | } |
422 | 422 | |
423 | 423 | /** |
424 | - * Get GMT date when the invoice was last modified. |
|
425 | - * |
|
426 | - * @since 1.0.19 |
|
427 | - * @param string $context View or edit context. |
|
428 | - * @return string |
|
429 | - */ |
|
430 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
424 | + * Get GMT date when the invoice was last modified. |
|
425 | + * |
|
426 | + * @since 1.0.19 |
|
427 | + * @param string $context View or edit context. |
|
428 | + * @return string |
|
429 | + */ |
|
430 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
431 | 431 | $date = $this->get_date_modified( $context ); |
432 | 432 | |
433 | 433 | if ( $date ) { |
434 | 434 | $date = get_gmt_from_date( $date ); |
435 | 435 | } |
436 | - return $date; |
|
436 | + return $date; |
|
437 | 437 | } |
438 | 438 | |
439 | 439 | /** |
440 | - * Get the invoice due date. |
|
441 | - * |
|
442 | - * @since 1.0.19 |
|
443 | - * @param string $context View or edit context. |
|
444 | - * @return string |
|
445 | - */ |
|
446 | - public function get_due_date( $context = 'view' ) { |
|
447 | - return $this->get_prop( 'due_date', $context ); |
|
440 | + * Get the invoice due date. |
|
441 | + * |
|
442 | + * @since 1.0.19 |
|
443 | + * @param string $context View or edit context. |
|
444 | + * @return string |
|
445 | + */ |
|
446 | + public function get_due_date( $context = 'view' ) { |
|
447 | + return $this->get_prop( 'due_date', $context ); |
|
448 | 448 | } |
449 | 449 | |
450 | 450 | /** |
451 | - * Alias for self::get_due_date(). |
|
452 | - * |
|
453 | - * @since 1.0.19 |
|
454 | - * @param string $context View or edit context. |
|
455 | - * @return string |
|
456 | - */ |
|
457 | - public function get_date_due( $context = 'view' ) { |
|
458 | - return $this->get_due_date( $context ); |
|
451 | + * Alias for self::get_due_date(). |
|
452 | + * |
|
453 | + * @since 1.0.19 |
|
454 | + * @param string $context View or edit context. |
|
455 | + * @return string |
|
456 | + */ |
|
457 | + public function get_date_due( $context = 'view' ) { |
|
458 | + return $this->get_due_date( $context ); |
|
459 | 459 | } |
460 | 460 | |
461 | 461 | /** |
462 | - * Get the invoice GMT due date. |
|
463 | - * |
|
464 | - * @since 1.0.19 |
|
465 | - * @param string $context View or edit context. |
|
466 | - * @return string |
|
467 | - */ |
|
468 | - public function get_due_date_gmt( $context = 'view' ) { |
|
462 | + * Get the invoice GMT due date. |
|
463 | + * |
|
464 | + * @since 1.0.19 |
|
465 | + * @param string $context View or edit context. |
|
466 | + * @return string |
|
467 | + */ |
|
468 | + public function get_due_date_gmt( $context = 'view' ) { |
|
469 | 469 | $date = $this->get_due_date( $context ); |
470 | 470 | |
471 | 471 | if ( $date ) { |
472 | 472 | $date = get_gmt_from_date( $date ); |
473 | 473 | } |
474 | - return $date; |
|
474 | + return $date; |
|
475 | 475 | } |
476 | 476 | |
477 | 477 | /** |
478 | - * Alias for self::get_due_date_gmt(). |
|
479 | - * |
|
480 | - * @since 1.0.19 |
|
481 | - * @param string $context View or edit context. |
|
482 | - * @return string |
|
483 | - */ |
|
484 | - public function get_gmt_date_due( $context = 'view' ) { |
|
485 | - return $this->get_due_date_gmt( $context ); |
|
478 | + * Alias for self::get_due_date_gmt(). |
|
479 | + * |
|
480 | + * @since 1.0.19 |
|
481 | + * @param string $context View or edit context. |
|
482 | + * @return string |
|
483 | + */ |
|
484 | + public function get_gmt_date_due( $context = 'view' ) { |
|
485 | + return $this->get_due_date_gmt( $context ); |
|
486 | 486 | } |
487 | 487 | |
488 | 488 | /** |
489 | - * Get date when the invoice was completed. |
|
490 | - * |
|
491 | - * @since 1.0.19 |
|
492 | - * @param string $context View or edit context. |
|
493 | - * @return string |
|
494 | - */ |
|
495 | - public function get_completed_date( $context = 'view' ) { |
|
496 | - return $this->get_prop( 'completed_date', $context ); |
|
489 | + * Get date when the invoice was completed. |
|
490 | + * |
|
491 | + * @since 1.0.19 |
|
492 | + * @param string $context View or edit context. |
|
493 | + * @return string |
|
494 | + */ |
|
495 | + public function get_completed_date( $context = 'view' ) { |
|
496 | + return $this->get_prop( 'completed_date', $context ); |
|
497 | 497 | } |
498 | 498 | |
499 | 499 | /** |
500 | - * Alias for self::get_completed_date(). |
|
501 | - * |
|
502 | - * @since 1.0.19 |
|
503 | - * @param string $context View or edit context. |
|
504 | - * @return string |
|
505 | - */ |
|
506 | - public function get_date_completed( $context = 'view' ) { |
|
507 | - return $this->get_completed_date( $context ); |
|
500 | + * Alias for self::get_completed_date(). |
|
501 | + * |
|
502 | + * @since 1.0.19 |
|
503 | + * @param string $context View or edit context. |
|
504 | + * @return string |
|
505 | + */ |
|
506 | + public function get_date_completed( $context = 'view' ) { |
|
507 | + return $this->get_completed_date( $context ); |
|
508 | 508 | } |
509 | 509 | |
510 | 510 | /** |
511 | - * Get GMT date when the invoice was was completed. |
|
512 | - * |
|
513 | - * @since 1.0.19 |
|
514 | - * @param string $context View or edit context. |
|
515 | - * @return string |
|
516 | - */ |
|
517 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
511 | + * Get GMT date when the invoice was was completed. |
|
512 | + * |
|
513 | + * @since 1.0.19 |
|
514 | + * @param string $context View or edit context. |
|
515 | + * @return string |
|
516 | + */ |
|
517 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
518 | 518 | $date = $this->get_completed_date( $context ); |
519 | 519 | |
520 | 520 | if ( $date ) { |
521 | 521 | $date = get_gmt_from_date( $date ); |
522 | 522 | } |
523 | - return $date; |
|
523 | + return $date; |
|
524 | 524 | } |
525 | 525 | |
526 | 526 | /** |
527 | - * Alias for self::get_completed_date_gmt(). |
|
528 | - * |
|
529 | - * @since 1.0.19 |
|
530 | - * @param string $context View or edit context. |
|
531 | - * @return string |
|
532 | - */ |
|
533 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
534 | - return $this->get_completed_date_gmt( $context ); |
|
527 | + * Alias for self::get_completed_date_gmt(). |
|
528 | + * |
|
529 | + * @since 1.0.19 |
|
530 | + * @param string $context View or edit context. |
|
531 | + * @return string |
|
532 | + */ |
|
533 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
534 | + return $this->get_completed_date_gmt( $context ); |
|
535 | 535 | } |
536 | 536 | |
537 | 537 | /** |
538 | - * Get the invoice number. |
|
539 | - * |
|
540 | - * @since 1.0.19 |
|
541 | - * @param string $context View or edit context. |
|
542 | - * @return string |
|
543 | - */ |
|
544 | - public function get_number( $context = 'view' ) { |
|
545 | - $number = $this->get_prop( 'number', $context ); |
|
538 | + * Get the invoice number. |
|
539 | + * |
|
540 | + * @since 1.0.19 |
|
541 | + * @param string $context View or edit context. |
|
542 | + * @return string |
|
543 | + */ |
|
544 | + public function get_number( $context = 'view' ) { |
|
545 | + $number = $this->get_prop( 'number', $context ); |
|
546 | 546 | |
547 | - if ( empty( $number ) ) { |
|
548 | - $number = $this->generate_number(); |
|
549 | - $this->set_number( $this->generate_number() ); |
|
550 | - } |
|
547 | + if ( empty( $number ) ) { |
|
548 | + $number = $this->generate_number(); |
|
549 | + $this->set_number( $this->generate_number() ); |
|
550 | + } |
|
551 | 551 | |
552 | - return $number; |
|
552 | + return $number; |
|
553 | 553 | } |
554 | 554 | |
555 | - /** |
|
556 | - * Set the invoice number. |
|
557 | - * |
|
558 | - * @since 1.0.19 |
|
559 | - */ |
|
560 | - public function maybe_set_number() { |
|
555 | + /** |
|
556 | + * Set the invoice number. |
|
557 | + * |
|
558 | + * @since 1.0.19 |
|
559 | + */ |
|
560 | + public function maybe_set_number() { |
|
561 | 561 | $number = $this->get_number(); |
562 | 562 | |
563 | 563 | if ( empty( $number ) || $this->get_id() == $number ) { |
564 | - $this->set_number( $this->generate_number() ); |
|
564 | + $this->set_number( $this->generate_number() ); |
|
565 | 565 | } |
566 | 566 | |
567 | - } |
|
567 | + } |
|
568 | 568 | |
569 | 569 | /** |
570 | - * Get the invoice key. |
|
571 | - * |
|
572 | - * @since 1.0.19 |
|
573 | - * @param string $context View or edit context. |
|
574 | - * @return string |
|
575 | - */ |
|
576 | - public function get_key( $context = 'view' ) { |
|
570 | + * Get the invoice key. |
|
571 | + * |
|
572 | + * @since 1.0.19 |
|
573 | + * @param string $context View or edit context. |
|
574 | + * @return string |
|
575 | + */ |
|
576 | + public function get_key( $context = 'view' ) { |
|
577 | 577 | return $this->get_prop( 'key', $context ); |
578 | - } |
|
579 | - |
|
580 | - /** |
|
581 | - * Set the invoice key. |
|
582 | - * |
|
583 | - * @since 1.0.19 |
|
584 | - */ |
|
585 | - public function maybe_set_key() { |
|
578 | + } |
|
579 | + |
|
580 | + /** |
|
581 | + * Set the invoice key. |
|
582 | + * |
|
583 | + * @since 1.0.19 |
|
584 | + */ |
|
585 | + public function maybe_set_key() { |
|
586 | 586 | $key = $this->get_key(); |
587 | 587 | |
588 | 588 | if ( empty( $key ) ) { |
@@ -593,140 +593,140 @@ discard block |
||
593 | 593 | } |
594 | 594 | |
595 | 595 | /** |
596 | - * Get the invoice type. |
|
597 | - * |
|
598 | - * @since 1.0.19 |
|
599 | - * @param string $context View or edit context. |
|
600 | - * @return string |
|
601 | - */ |
|
602 | - public function get_type( $context = 'view' ) { |
|
596 | + * Get the invoice type. |
|
597 | + * |
|
598 | + * @since 1.0.19 |
|
599 | + * @param string $context View or edit context. |
|
600 | + * @return string |
|
601 | + */ |
|
602 | + public function get_type( $context = 'view' ) { |
|
603 | 603 | return $this->get_prop( 'type', $context ); |
604 | - } |
|
605 | - |
|
606 | - /** |
|
607 | - * Returns the post type name. |
|
608 | - * |
|
609 | - * @since 1.0.19 |
|
610 | - * @return string |
|
611 | - */ |
|
612 | - public function get_invoice_quote_type() { |
|
604 | + } |
|
605 | + |
|
606 | + /** |
|
607 | + * Returns the post type name. |
|
608 | + * |
|
609 | + * @since 1.0.19 |
|
610 | + * @return string |
|
611 | + */ |
|
612 | + public function get_invoice_quote_type() { |
|
613 | 613 | return getpaid_get_post_type_label( $this->get_post_type(), false ); |
614 | 614 | } |
615 | 615 | |
616 | 616 | /** |
617 | - * Get the invoice post type label. |
|
618 | - * |
|
619 | - * @since 1.0.19 |
|
620 | - * @param string $context View or edit context. |
|
621 | - * @return string |
|
622 | - */ |
|
623 | - public function get_label( $context = 'view' ) { |
|
617 | + * Get the invoice post type label. |
|
618 | + * |
|
619 | + * @since 1.0.19 |
|
620 | + * @param string $context View or edit context. |
|
621 | + * @return string |
|
622 | + */ |
|
623 | + public function get_label( $context = 'view' ) { |
|
624 | 624 | return getpaid_get_post_type_label( $this->get_post_type( $context ), false ); |
625 | - } |
|
626 | - |
|
627 | - /** |
|
628 | - * Get the invoice post type. |
|
629 | - * |
|
630 | - * @since 1.0.19 |
|
631 | - * @param string $context View or edit context. |
|
632 | - * @return string |
|
633 | - */ |
|
634 | - public function get_post_type( $context = 'view' ) { |
|
625 | + } |
|
626 | + |
|
627 | + /** |
|
628 | + * Get the invoice post type. |
|
629 | + * |
|
630 | + * @since 1.0.19 |
|
631 | + * @param string $context View or edit context. |
|
632 | + * @return string |
|
633 | + */ |
|
634 | + public function get_post_type( $context = 'view' ) { |
|
635 | 635 | return $this->get_prop( 'post_type', $context ); |
636 | 636 | } |
637 | 637 | |
638 | 638 | /** |
639 | - * Get the invoice mode. |
|
640 | - * |
|
641 | - * @since 1.0.19 |
|
642 | - * @param string $context View or edit context. |
|
643 | - * @return string |
|
644 | - */ |
|
645 | - public function get_mode( $context = 'view' ) { |
|
639 | + * Get the invoice mode. |
|
640 | + * |
|
641 | + * @since 1.0.19 |
|
642 | + * @param string $context View or edit context. |
|
643 | + * @return string |
|
644 | + */ |
|
645 | + public function get_mode( $context = 'view' ) { |
|
646 | 646 | return $this->get_prop( 'mode', $context ); |
647 | 647 | } |
648 | 648 | |
649 | 649 | /** |
650 | - * Get the invoice path. |
|
651 | - * |
|
652 | - * @since 1.0.19 |
|
653 | - * @param string $context View or edit context. |
|
654 | - * @return string |
|
655 | - */ |
|
656 | - public function get_path( $context = 'view' ) { |
|
650 | + * Get the invoice path. |
|
651 | + * |
|
652 | + * @since 1.0.19 |
|
653 | + * @param string $context View or edit context. |
|
654 | + * @return string |
|
655 | + */ |
|
656 | + public function get_path( $context = 'view' ) { |
|
657 | 657 | $path = $this->get_prop( 'path', $context ); |
658 | - $prefix = $this->get_type(); |
|
658 | + $prefix = $this->get_type(); |
|
659 | 659 | |
660 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
661 | - $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
662 | - $this->set_path( $path ); |
|
663 | - } |
|
660 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
661 | + $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
662 | + $this->set_path( $path ); |
|
663 | + } |
|
664 | 664 | |
665 | - return $path; |
|
665 | + return $path; |
|
666 | 666 | } |
667 | 667 | |
668 | 668 | /** |
669 | - * Get the invoice name/title. |
|
670 | - * |
|
671 | - * @since 1.0.19 |
|
672 | - * @param string $context View or edit context. |
|
673 | - * @return string |
|
674 | - */ |
|
675 | - public function get_name( $context = 'view' ) { |
|
669 | + * Get the invoice name/title. |
|
670 | + * |
|
671 | + * @since 1.0.19 |
|
672 | + * @param string $context View or edit context. |
|
673 | + * @return string |
|
674 | + */ |
|
675 | + public function get_name( $context = 'view' ) { |
|
676 | 676 | return $this->get_prop( 'title', $context ); |
677 | 677 | } |
678 | 678 | |
679 | 679 | /** |
680 | - * Alias of self::get_name(). |
|
681 | - * |
|
682 | - * @since 1.0.19 |
|
683 | - * @param string $context View or edit context. |
|
684 | - * @return string |
|
685 | - */ |
|
686 | - public function get_title( $context = 'view' ) { |
|
687 | - return $this->get_name( $context ); |
|
680 | + * Alias of self::get_name(). |
|
681 | + * |
|
682 | + * @since 1.0.19 |
|
683 | + * @param string $context View or edit context. |
|
684 | + * @return string |
|
685 | + */ |
|
686 | + public function get_title( $context = 'view' ) { |
|
687 | + return $this->get_name( $context ); |
|
688 | 688 | } |
689 | 689 | |
690 | 690 | /** |
691 | - * Get the invoice description. |
|
692 | - * |
|
693 | - * @since 1.0.19 |
|
694 | - * @param string $context View or edit context. |
|
695 | - * @return string |
|
696 | - */ |
|
697 | - public function get_description( $context = 'view' ) { |
|
698 | - return $this->get_prop( 'description', $context ); |
|
691 | + * Get the invoice description. |
|
692 | + * |
|
693 | + * @since 1.0.19 |
|
694 | + * @param string $context View or edit context. |
|
695 | + * @return string |
|
696 | + */ |
|
697 | + public function get_description( $context = 'view' ) { |
|
698 | + return $this->get_prop( 'description', $context ); |
|
699 | 699 | } |
700 | 700 | |
701 | 701 | /** |
702 | - * Alias of self::get_description(). |
|
703 | - * |
|
704 | - * @since 1.0.19 |
|
705 | - * @param string $context View or edit context. |
|
706 | - * @return string |
|
707 | - */ |
|
708 | - public function get_excerpt( $context = 'view' ) { |
|
709 | - return $this->get_description( $context ); |
|
702 | + * Alias of self::get_description(). |
|
703 | + * |
|
704 | + * @since 1.0.19 |
|
705 | + * @param string $context View or edit context. |
|
706 | + * @return string |
|
707 | + */ |
|
708 | + public function get_excerpt( $context = 'view' ) { |
|
709 | + return $this->get_description( $context ); |
|
710 | 710 | } |
711 | 711 | |
712 | 712 | /** |
713 | - * Alias of self::get_description(). |
|
714 | - * |
|
715 | - * @since 1.0.19 |
|
716 | - * @param string $context View or edit context. |
|
717 | - * @return string |
|
718 | - */ |
|
719 | - public function get_summary( $context = 'view' ) { |
|
720 | - return $this->get_description( $context ); |
|
713 | + * Alias of self::get_description(). |
|
714 | + * |
|
715 | + * @since 1.0.19 |
|
716 | + * @param string $context View or edit context. |
|
717 | + * @return string |
|
718 | + */ |
|
719 | + public function get_summary( $context = 'view' ) { |
|
720 | + return $this->get_description( $context ); |
|
721 | 721 | } |
722 | 722 | |
723 | 723 | /** |
724 | - * Returns the user info. |
|
725 | - * |
|
726 | - * @since 1.0.19 |
|
724 | + * Returns the user info. |
|
725 | + * |
|
726 | + * @since 1.0.19 |
|
727 | 727 | * @param string $context View or edit context. |
728 | - * @return array |
|
729 | - */ |
|
728 | + * @return array |
|
729 | + */ |
|
730 | 730 | public function get_user_info( $context = 'view' ) { |
731 | 731 | |
732 | 732 | $user_info = array( |
@@ -743,616 +743,616 @@ discard block |
||
743 | 743 | 'company' => $this->get_company( $context ), |
744 | 744 | 'vat_number' => $this->get_vat_number( $context ), |
745 | 745 | 'discount' => $this->get_discount_code( $context ), |
746 | - ); |
|
746 | + ); |
|
747 | + |
|
748 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
749 | + |
|
750 | + } |
|
751 | + |
|
752 | + /** |
|
753 | + * Get the customer id. |
|
754 | + * |
|
755 | + * @since 1.0.19 |
|
756 | + * @param string $context View or edit context. |
|
757 | + * @return int |
|
758 | + */ |
|
759 | + public function get_author( $context = 'view' ) { |
|
760 | + return (int) $this->get_prop( 'author', $context ); |
|
761 | + } |
|
762 | + |
|
763 | + /** |
|
764 | + * Alias of self::get_author(). |
|
765 | + * |
|
766 | + * @since 1.0.19 |
|
767 | + * @param string $context View or edit context. |
|
768 | + * @return int |
|
769 | + */ |
|
770 | + public function get_user_id( $context = 'view' ) { |
|
771 | + return $this->get_author( $context ); |
|
772 | + } |
|
773 | + |
|
774 | + /** |
|
775 | + * Alias of self::get_author(). |
|
776 | + * |
|
777 | + * @since 1.0.19 |
|
778 | + * @param string $context View or edit context. |
|
779 | + * @return int |
|
780 | + */ |
|
781 | + public function get_customer_id( $context = 'view' ) { |
|
782 | + return $this->get_author( $context ); |
|
783 | + } |
|
784 | + |
|
785 | + /** |
|
786 | + * Get the customer's ip. |
|
787 | + * |
|
788 | + * @since 1.0.19 |
|
789 | + * @param string $context View or edit context. |
|
790 | + * @return string |
|
791 | + */ |
|
792 | + public function get_ip( $context = 'view' ) { |
|
793 | + return $this->get_prop( 'user_ip', $context ); |
|
794 | + } |
|
795 | + |
|
796 | + /** |
|
797 | + * Alias of self::get_ip(). |
|
798 | + * |
|
799 | + * @since 1.0.19 |
|
800 | + * @param string $context View or edit context. |
|
801 | + * @return string |
|
802 | + */ |
|
803 | + public function get_user_ip( $context = 'view' ) { |
|
804 | + return $this->get_ip( $context ); |
|
805 | + } |
|
747 | 806 | |
748 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
807 | + /** |
|
808 | + * Alias of self::get_ip(). |
|
809 | + * |
|
810 | + * @since 1.0.19 |
|
811 | + * @param string $context View or edit context. |
|
812 | + * @return string |
|
813 | + */ |
|
814 | + public function get_customer_ip( $context = 'view' ) { |
|
815 | + return $this->get_ip( $context ); |
|
816 | + } |
|
749 | 817 | |
818 | + /** |
|
819 | + * Get the customer's first name. |
|
820 | + * |
|
821 | + * @since 1.0.19 |
|
822 | + * @param string $context View or edit context. |
|
823 | + * @return string |
|
824 | + */ |
|
825 | + public function get_first_name( $context = 'view' ) { |
|
826 | + return $this->get_prop( 'first_name', $context ); |
|
750 | 827 | } |
751 | 828 | |
752 | 829 | /** |
753 | - * Get the customer id. |
|
754 | - * |
|
755 | - * @since 1.0.19 |
|
756 | - * @param string $context View or edit context. |
|
757 | - * @return int |
|
758 | - */ |
|
759 | - public function get_author( $context = 'view' ) { |
|
760 | - return (int) $this->get_prop( 'author', $context ); |
|
830 | + * Alias of self::get_first_name(). |
|
831 | + * |
|
832 | + * @since 1.0.19 |
|
833 | + * @param string $context View or edit context. |
|
834 | + * @return string |
|
835 | + */ |
|
836 | + public function get_user_first_name( $context = 'view' ) { |
|
837 | + return $this->get_first_name( $context ); |
|
838 | + } |
|
839 | + |
|
840 | + /** |
|
841 | + * Alias of self::get_first_name(). |
|
842 | + * |
|
843 | + * @since 1.0.19 |
|
844 | + * @param string $context View or edit context. |
|
845 | + * @return string |
|
846 | + */ |
|
847 | + public function get_customer_first_name( $context = 'view' ) { |
|
848 | + return $this->get_first_name( $context ); |
|
761 | 849 | } |
762 | 850 | |
763 | 851 | /** |
764 | - * Alias of self::get_author(). |
|
765 | - * |
|
766 | - * @since 1.0.19 |
|
767 | - * @param string $context View or edit context. |
|
768 | - * @return int |
|
769 | - */ |
|
770 | - public function get_user_id( $context = 'view' ) { |
|
771 | - return $this->get_author( $context ); |
|
852 | + * Get the customer's last name. |
|
853 | + * |
|
854 | + * @since 1.0.19 |
|
855 | + * @param string $context View or edit context. |
|
856 | + * @return string |
|
857 | + */ |
|
858 | + public function get_last_name( $context = 'view' ) { |
|
859 | + return $this->get_prop( 'last_name', $context ); |
|
772 | 860 | } |
773 | 861 | |
774 | - /** |
|
775 | - * Alias of self::get_author(). |
|
776 | - * |
|
777 | - * @since 1.0.19 |
|
778 | - * @param string $context View or edit context. |
|
779 | - * @return int |
|
780 | - */ |
|
781 | - public function get_customer_id( $context = 'view' ) { |
|
782 | - return $this->get_author( $context ); |
|
862 | + /** |
|
863 | + * Alias of self::get_last_name(). |
|
864 | + * |
|
865 | + * @since 1.0.19 |
|
866 | + * @param string $context View or edit context. |
|
867 | + * @return string |
|
868 | + */ |
|
869 | + public function get_user_last_name( $context = 'view' ) { |
|
870 | + return $this->get_last_name( $context ); |
|
783 | 871 | } |
784 | 872 | |
785 | 873 | /** |
786 | - * Get the customer's ip. |
|
787 | - * |
|
788 | - * @since 1.0.19 |
|
789 | - * @param string $context View or edit context. |
|
790 | - * @return string |
|
791 | - */ |
|
792 | - public function get_ip( $context = 'view' ) { |
|
793 | - return $this->get_prop( 'user_ip', $context ); |
|
874 | + * Alias of self::get_last_name(). |
|
875 | + * |
|
876 | + * @since 1.0.19 |
|
877 | + * @param string $context View or edit context. |
|
878 | + * @return string |
|
879 | + */ |
|
880 | + public function get_customer_last_name( $context = 'view' ) { |
|
881 | + return $this->get_last_name( $context ); |
|
794 | 882 | } |
795 | 883 | |
796 | 884 | /** |
797 | - * Alias of self::get_ip(). |
|
798 | - * |
|
799 | - * @since 1.0.19 |
|
800 | - * @param string $context View or edit context. |
|
801 | - * @return string |
|
802 | - */ |
|
803 | - public function get_user_ip( $context = 'view' ) { |
|
804 | - return $this->get_ip( $context ); |
|
885 | + * Get the customer's full name. |
|
886 | + * |
|
887 | + * @since 1.0.19 |
|
888 | + * @param string $context View or edit context. |
|
889 | + * @return string |
|
890 | + */ |
|
891 | + public function get_full_name( $context = 'view' ) { |
|
892 | + return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
805 | 893 | } |
806 | 894 | |
807 | - /** |
|
808 | - * Alias of self::get_ip(). |
|
809 | - * |
|
810 | - * @since 1.0.19 |
|
811 | - * @param string $context View or edit context. |
|
812 | - * @return string |
|
813 | - */ |
|
814 | - public function get_customer_ip( $context = 'view' ) { |
|
815 | - return $this->get_ip( $context ); |
|
895 | + /** |
|
896 | + * Alias of self::get_full_name(). |
|
897 | + * |
|
898 | + * @since 1.0.19 |
|
899 | + * @param string $context View or edit context. |
|
900 | + * @return string |
|
901 | + */ |
|
902 | + public function get_user_full_name( $context = 'view' ) { |
|
903 | + return $this->get_full_name( $context ); |
|
816 | 904 | } |
817 | 905 | |
818 | 906 | /** |
819 | - * Get the customer's first name. |
|
820 | - * |
|
821 | - * @since 1.0.19 |
|
822 | - * @param string $context View or edit context. |
|
823 | - * @return string |
|
824 | - */ |
|
825 | - public function get_first_name( $context = 'view' ) { |
|
826 | - return $this->get_prop( 'first_name', $context ); |
|
907 | + * Alias of self::get_full_name(). |
|
908 | + * |
|
909 | + * @since 1.0.19 |
|
910 | + * @param string $context View or edit context. |
|
911 | + * @return string |
|
912 | + */ |
|
913 | + public function get_customer_full_name( $context = 'view' ) { |
|
914 | + return $this->get_full_name( $context ); |
|
827 | 915 | } |
828 | 916 | |
829 | 917 | /** |
830 | - * Alias of self::get_first_name(). |
|
831 | - * |
|
832 | - * @since 1.0.19 |
|
833 | - * @param string $context View or edit context. |
|
834 | - * @return string |
|
835 | - */ |
|
836 | - public function get_user_first_name( $context = 'view' ) { |
|
837 | - return $this->get_first_name( $context ); |
|
918 | + * Get the customer's phone number. |
|
919 | + * |
|
920 | + * @since 1.0.19 |
|
921 | + * @param string $context View or edit context. |
|
922 | + * @return string |
|
923 | + */ |
|
924 | + public function get_phone( $context = 'view' ) { |
|
925 | + return $this->get_prop( 'phone', $context ); |
|
838 | 926 | } |
839 | 927 | |
840 | - /** |
|
841 | - * Alias of self::get_first_name(). |
|
842 | - * |
|
843 | - * @since 1.0.19 |
|
844 | - * @param string $context View or edit context. |
|
845 | - * @return string |
|
846 | - */ |
|
847 | - public function get_customer_first_name( $context = 'view' ) { |
|
848 | - return $this->get_first_name( $context ); |
|
928 | + /** |
|
929 | + * Alias of self::get_phone(). |
|
930 | + * |
|
931 | + * @since 1.0.19 |
|
932 | + * @param string $context View or edit context. |
|
933 | + * @return string |
|
934 | + */ |
|
935 | + public function get_phone_number( $context = 'view' ) { |
|
936 | + return $this->get_phone( $context ); |
|
849 | 937 | } |
850 | 938 | |
851 | 939 | /** |
852 | - * Get the customer's last name. |
|
853 | - * |
|
854 | - * @since 1.0.19 |
|
855 | - * @param string $context View or edit context. |
|
856 | - * @return string |
|
857 | - */ |
|
858 | - public function get_last_name( $context = 'view' ) { |
|
859 | - return $this->get_prop( 'last_name', $context ); |
|
940 | + * Alias of self::get_phone(). |
|
941 | + * |
|
942 | + * @since 1.0.19 |
|
943 | + * @param string $context View or edit context. |
|
944 | + * @return string |
|
945 | + */ |
|
946 | + public function get_user_phone( $context = 'view' ) { |
|
947 | + return $this->get_phone( $context ); |
|
860 | 948 | } |
861 | 949 | |
862 | 950 | /** |
863 | - * Alias of self::get_last_name(). |
|
864 | - * |
|
865 | - * @since 1.0.19 |
|
866 | - * @param string $context View or edit context. |
|
867 | - * @return string |
|
868 | - */ |
|
869 | - public function get_user_last_name( $context = 'view' ) { |
|
870 | - return $this->get_last_name( $context ); |
|
951 | + * Alias of self::get_phone(). |
|
952 | + * |
|
953 | + * @since 1.0.19 |
|
954 | + * @param string $context View or edit context. |
|
955 | + * @return string |
|
956 | + */ |
|
957 | + public function get_customer_phone( $context = 'view' ) { |
|
958 | + return $this->get_phone( $context ); |
|
871 | 959 | } |
872 | 960 | |
873 | 961 | /** |
874 | - * Alias of self::get_last_name(). |
|
875 | - * |
|
876 | - * @since 1.0.19 |
|
877 | - * @param string $context View or edit context. |
|
878 | - * @return string |
|
879 | - */ |
|
880 | - public function get_customer_last_name( $context = 'view' ) { |
|
881 | - return $this->get_last_name( $context ); |
|
962 | + * Get the customer's email address. |
|
963 | + * |
|
964 | + * @since 1.0.19 |
|
965 | + * @param string $context View or edit context. |
|
966 | + * @return string |
|
967 | + */ |
|
968 | + public function get_email( $context = 'view' ) { |
|
969 | + return $this->get_prop( 'email', $context ); |
|
882 | 970 | } |
883 | 971 | |
884 | 972 | /** |
885 | - * Get the customer's full name. |
|
886 | - * |
|
887 | - * @since 1.0.19 |
|
888 | - * @param string $context View or edit context. |
|
889 | - * @return string |
|
890 | - */ |
|
891 | - public function get_full_name( $context = 'view' ) { |
|
892 | - return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
973 | + * Alias of self::get_email(). |
|
974 | + * |
|
975 | + * @since 1.0.19 |
|
976 | + * @param string $context View or edit context. |
|
977 | + * @return string |
|
978 | + */ |
|
979 | + public function get_email_address( $context = 'view' ) { |
|
980 | + return $this->get_email( $context ); |
|
893 | 981 | } |
894 | 982 | |
895 | 983 | /** |
896 | - * Alias of self::get_full_name(). |
|
897 | - * |
|
898 | - * @since 1.0.19 |
|
899 | - * @param string $context View or edit context. |
|
900 | - * @return string |
|
901 | - */ |
|
902 | - public function get_user_full_name( $context = 'view' ) { |
|
903 | - return $this->get_full_name( $context ); |
|
984 | + * Alias of self::get_email(). |
|
985 | + * |
|
986 | + * @since 1.0.19 |
|
987 | + * @param string $context View or edit context. |
|
988 | + * @return string |
|
989 | + */ |
|
990 | + public function get_user_email( $context = 'view' ) { |
|
991 | + return $this->get_email( $context ); |
|
904 | 992 | } |
905 | 993 | |
906 | 994 | /** |
907 | - * Alias of self::get_full_name(). |
|
908 | - * |
|
909 | - * @since 1.0.19 |
|
910 | - * @param string $context View or edit context. |
|
911 | - * @return string |
|
912 | - */ |
|
913 | - public function get_customer_full_name( $context = 'view' ) { |
|
914 | - return $this->get_full_name( $context ); |
|
995 | + * Alias of self::get_email(). |
|
996 | + * |
|
997 | + * @since 1.0.19 |
|
998 | + * @param string $context View or edit context. |
|
999 | + * @return string |
|
1000 | + */ |
|
1001 | + public function get_customer_email( $context = 'view' ) { |
|
1002 | + return $this->get_email( $context ); |
|
915 | 1003 | } |
916 | 1004 | |
917 | 1005 | /** |
918 | - * Get the customer's phone number. |
|
919 | - * |
|
920 | - * @since 1.0.19 |
|
921 | - * @param string $context View or edit context. |
|
922 | - * @return string |
|
923 | - */ |
|
924 | - public function get_phone( $context = 'view' ) { |
|
925 | - return $this->get_prop( 'phone', $context ); |
|
1006 | + * Get the customer's country. |
|
1007 | + * |
|
1008 | + * @since 1.0.19 |
|
1009 | + * @param string $context View or edit context. |
|
1010 | + * @return string |
|
1011 | + */ |
|
1012 | + public function get_country( $context = 'view' ) { |
|
1013 | + $country = $this->get_prop( 'country', $context ); |
|
1014 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
926 | 1015 | } |
927 | 1016 | |
928 | 1017 | /** |
929 | - * Alias of self::get_phone(). |
|
930 | - * |
|
931 | - * @since 1.0.19 |
|
932 | - * @param string $context View or edit context. |
|
933 | - * @return string |
|
934 | - */ |
|
935 | - public function get_phone_number( $context = 'view' ) { |
|
936 | - return $this->get_phone( $context ); |
|
1018 | + * Alias of self::get_country(). |
|
1019 | + * |
|
1020 | + * @since 1.0.19 |
|
1021 | + * @param string $context View or edit context. |
|
1022 | + * @return string |
|
1023 | + */ |
|
1024 | + public function get_user_country( $context = 'view' ) { |
|
1025 | + return $this->get_country( $context ); |
|
937 | 1026 | } |
938 | 1027 | |
939 | 1028 | /** |
940 | - * Alias of self::get_phone(). |
|
941 | - * |
|
942 | - * @since 1.0.19 |
|
943 | - * @param string $context View or edit context. |
|
944 | - * @return string |
|
945 | - */ |
|
946 | - public function get_user_phone( $context = 'view' ) { |
|
947 | - return $this->get_phone( $context ); |
|
1029 | + * Alias of self::get_country(). |
|
1030 | + * |
|
1031 | + * @since 1.0.19 |
|
1032 | + * @param string $context View or edit context. |
|
1033 | + * @return string |
|
1034 | + */ |
|
1035 | + public function get_customer_country( $context = 'view' ) { |
|
1036 | + return $this->get_country( $context ); |
|
948 | 1037 | } |
949 | 1038 | |
950 | 1039 | /** |
951 | - * Alias of self::get_phone(). |
|
952 | - * |
|
953 | - * @since 1.0.19 |
|
954 | - * @param string $context View or edit context. |
|
955 | - * @return string |
|
956 | - */ |
|
957 | - public function get_customer_phone( $context = 'view' ) { |
|
958 | - return $this->get_phone( $context ); |
|
1040 | + * Get the customer's state. |
|
1041 | + * |
|
1042 | + * @since 1.0.19 |
|
1043 | + * @param string $context View or edit context. |
|
1044 | + * @return string |
|
1045 | + */ |
|
1046 | + public function get_state( $context = 'view' ) { |
|
1047 | + $state = $this->get_prop( 'state', $context ); |
|
1048 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
959 | 1049 | } |
960 | 1050 | |
961 | 1051 | /** |
962 | - * Get the customer's email address. |
|
963 | - * |
|
964 | - * @since 1.0.19 |
|
965 | - * @param string $context View or edit context. |
|
966 | - * @return string |
|
967 | - */ |
|
968 | - public function get_email( $context = 'view' ) { |
|
969 | - return $this->get_prop( 'email', $context ); |
|
1052 | + * Alias of self::get_state(). |
|
1053 | + * |
|
1054 | + * @since 1.0.19 |
|
1055 | + * @param string $context View or edit context. |
|
1056 | + * @return string |
|
1057 | + */ |
|
1058 | + public function get_user_state( $context = 'view' ) { |
|
1059 | + return $this->get_state( $context ); |
|
970 | 1060 | } |
971 | 1061 | |
972 | 1062 | /** |
973 | - * Alias of self::get_email(). |
|
974 | - * |
|
975 | - * @since 1.0.19 |
|
976 | - * @param string $context View or edit context. |
|
977 | - * @return string |
|
978 | - */ |
|
979 | - public function get_email_address( $context = 'view' ) { |
|
980 | - return $this->get_email( $context ); |
|
1063 | + * Alias of self::get_state(). |
|
1064 | + * |
|
1065 | + * @since 1.0.19 |
|
1066 | + * @param string $context View or edit context. |
|
1067 | + * @return string |
|
1068 | + */ |
|
1069 | + public function get_customer_state( $context = 'view' ) { |
|
1070 | + return $this->get_state( $context ); |
|
981 | 1071 | } |
982 | 1072 | |
983 | 1073 | /** |
984 | - * Alias of self::get_email(). |
|
985 | - * |
|
986 | - * @since 1.0.19 |
|
987 | - * @param string $context View or edit context. |
|
988 | - * @return string |
|
989 | - */ |
|
990 | - public function get_user_email( $context = 'view' ) { |
|
991 | - return $this->get_email( $context ); |
|
1074 | + * Get the customer's city. |
|
1075 | + * |
|
1076 | + * @since 1.0.19 |
|
1077 | + * @param string $context View or edit context. |
|
1078 | + * @return string |
|
1079 | + */ |
|
1080 | + public function get_city( $context = 'view' ) { |
|
1081 | + return $this->get_prop( 'city', $context ); |
|
992 | 1082 | } |
993 | 1083 | |
994 | 1084 | /** |
995 | - * Alias of self::get_email(). |
|
996 | - * |
|
997 | - * @since 1.0.19 |
|
998 | - * @param string $context View or edit context. |
|
999 | - * @return string |
|
1000 | - */ |
|
1001 | - public function get_customer_email( $context = 'view' ) { |
|
1002 | - return $this->get_email( $context ); |
|
1085 | + * Alias of self::get_city(). |
|
1086 | + * |
|
1087 | + * @since 1.0.19 |
|
1088 | + * @param string $context View or edit context. |
|
1089 | + * @return string |
|
1090 | + */ |
|
1091 | + public function get_user_city( $context = 'view' ) { |
|
1092 | + return $this->get_city( $context ); |
|
1003 | 1093 | } |
1004 | 1094 | |
1005 | 1095 | /** |
1006 | - * Get the customer's country. |
|
1007 | - * |
|
1008 | - * @since 1.0.19 |
|
1009 | - * @param string $context View or edit context. |
|
1010 | - * @return string |
|
1011 | - */ |
|
1012 | - public function get_country( $context = 'view' ) { |
|
1013 | - $country = $this->get_prop( 'country', $context ); |
|
1014 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
1096 | + * Alias of self::get_city(). |
|
1097 | + * |
|
1098 | + * @since 1.0.19 |
|
1099 | + * @param string $context View or edit context. |
|
1100 | + * @return string |
|
1101 | + */ |
|
1102 | + public function get_customer_city( $context = 'view' ) { |
|
1103 | + return $this->get_city( $context ); |
|
1015 | 1104 | } |
1016 | 1105 | |
1017 | 1106 | /** |
1018 | - * Alias of self::get_country(). |
|
1019 | - * |
|
1020 | - * @since 1.0.19 |
|
1021 | - * @param string $context View or edit context. |
|
1022 | - * @return string |
|
1023 | - */ |
|
1024 | - public function get_user_country( $context = 'view' ) { |
|
1025 | - return $this->get_country( $context ); |
|
1107 | + * Get the customer's zip. |
|
1108 | + * |
|
1109 | + * @since 1.0.19 |
|
1110 | + * @param string $context View or edit context. |
|
1111 | + * @return string |
|
1112 | + */ |
|
1113 | + public function get_zip( $context = 'view' ) { |
|
1114 | + return $this->get_prop( 'zip', $context ); |
|
1026 | 1115 | } |
1027 | 1116 | |
1028 | 1117 | /** |
1029 | - * Alias of self::get_country(). |
|
1030 | - * |
|
1031 | - * @since 1.0.19 |
|
1032 | - * @param string $context View or edit context. |
|
1033 | - * @return string |
|
1034 | - */ |
|
1035 | - public function get_customer_country( $context = 'view' ) { |
|
1036 | - return $this->get_country( $context ); |
|
1118 | + * Alias of self::get_zip(). |
|
1119 | + * |
|
1120 | + * @since 1.0.19 |
|
1121 | + * @param string $context View or edit context. |
|
1122 | + * @return string |
|
1123 | + */ |
|
1124 | + public function get_user_zip( $context = 'view' ) { |
|
1125 | + return $this->get_zip( $context ); |
|
1037 | 1126 | } |
1038 | 1127 | |
1039 | 1128 | /** |
1040 | - * Get the customer's state. |
|
1041 | - * |
|
1042 | - * @since 1.0.19 |
|
1043 | - * @param string $context View or edit context. |
|
1044 | - * @return string |
|
1045 | - */ |
|
1046 | - public function get_state( $context = 'view' ) { |
|
1047 | - $state = $this->get_prop( 'state', $context ); |
|
1048 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1129 | + * Alias of self::get_zip(). |
|
1130 | + * |
|
1131 | + * @since 1.0.19 |
|
1132 | + * @param string $context View or edit context. |
|
1133 | + * @return string |
|
1134 | + */ |
|
1135 | + public function get_customer_zip( $context = 'view' ) { |
|
1136 | + return $this->get_zip( $context ); |
|
1049 | 1137 | } |
1050 | 1138 | |
1051 | 1139 | /** |
1052 | - * Alias of self::get_state(). |
|
1053 | - * |
|
1054 | - * @since 1.0.19 |
|
1055 | - * @param string $context View or edit context. |
|
1056 | - * @return string |
|
1057 | - */ |
|
1058 | - public function get_user_state( $context = 'view' ) { |
|
1059 | - return $this->get_state( $context ); |
|
1140 | + * Get the customer's company. |
|
1141 | + * |
|
1142 | + * @since 1.0.19 |
|
1143 | + * @param string $context View or edit context. |
|
1144 | + * @return string |
|
1145 | + */ |
|
1146 | + public function get_company( $context = 'view' ) { |
|
1147 | + return $this->get_prop( 'company', $context ); |
|
1060 | 1148 | } |
1061 | 1149 | |
1062 | 1150 | /** |
1063 | - * Alias of self::get_state(). |
|
1064 | - * |
|
1065 | - * @since 1.0.19 |
|
1066 | - * @param string $context View or edit context. |
|
1067 | - * @return string |
|
1068 | - */ |
|
1069 | - public function get_customer_state( $context = 'view' ) { |
|
1070 | - return $this->get_state( $context ); |
|
1151 | + * Alias of self::get_company(). |
|
1152 | + * |
|
1153 | + * @since 1.0.19 |
|
1154 | + * @param string $context View or edit context. |
|
1155 | + * @return string |
|
1156 | + */ |
|
1157 | + public function get_user_company( $context = 'view' ) { |
|
1158 | + return $this->get_company( $context ); |
|
1071 | 1159 | } |
1072 | 1160 | |
1073 | 1161 | /** |
1074 | - * Get the customer's city. |
|
1075 | - * |
|
1076 | - * @since 1.0.19 |
|
1077 | - * @param string $context View or edit context. |
|
1078 | - * @return string |
|
1079 | - */ |
|
1080 | - public function get_city( $context = 'view' ) { |
|
1081 | - return $this->get_prop( 'city', $context ); |
|
1162 | + * Alias of self::get_company(). |
|
1163 | + * |
|
1164 | + * @since 1.0.19 |
|
1165 | + * @param string $context View or edit context. |
|
1166 | + * @return string |
|
1167 | + */ |
|
1168 | + public function get_customer_company( $context = 'view' ) { |
|
1169 | + return $this->get_company( $context ); |
|
1082 | 1170 | } |
1083 | 1171 | |
1084 | 1172 | /** |
1085 | - * Alias of self::get_city(). |
|
1086 | - * |
|
1087 | - * @since 1.0.19 |
|
1088 | - * @param string $context View or edit context. |
|
1089 | - * @return string |
|
1090 | - */ |
|
1091 | - public function get_user_city( $context = 'view' ) { |
|
1092 | - return $this->get_city( $context ); |
|
1173 | + * Get the customer's vat number. |
|
1174 | + * |
|
1175 | + * @since 1.0.19 |
|
1176 | + * @param string $context View or edit context. |
|
1177 | + * @return string |
|
1178 | + */ |
|
1179 | + public function get_vat_number( $context = 'view' ) { |
|
1180 | + return $this->get_prop( 'vat_number', $context ); |
|
1093 | 1181 | } |
1094 | 1182 | |
1095 | 1183 | /** |
1096 | - * Alias of self::get_city(). |
|
1097 | - * |
|
1098 | - * @since 1.0.19 |
|
1099 | - * @param string $context View or edit context. |
|
1100 | - * @return string |
|
1101 | - */ |
|
1102 | - public function get_customer_city( $context = 'view' ) { |
|
1103 | - return $this->get_city( $context ); |
|
1184 | + * Alias of self::get_vat_number(). |
|
1185 | + * |
|
1186 | + * @since 1.0.19 |
|
1187 | + * @param string $context View or edit context. |
|
1188 | + * @return string |
|
1189 | + */ |
|
1190 | + public function get_user_vat_number( $context = 'view' ) { |
|
1191 | + return $this->get_vat_number( $context ); |
|
1104 | 1192 | } |
1105 | 1193 | |
1106 | 1194 | /** |
1107 | - * Get the customer's zip. |
|
1108 | - * |
|
1109 | - * @since 1.0.19 |
|
1110 | - * @param string $context View or edit context. |
|
1111 | - * @return string |
|
1112 | - */ |
|
1113 | - public function get_zip( $context = 'view' ) { |
|
1114 | - return $this->get_prop( 'zip', $context ); |
|
1195 | + * Alias of self::get_vat_number(). |
|
1196 | + * |
|
1197 | + * @since 1.0.19 |
|
1198 | + * @param string $context View or edit context. |
|
1199 | + * @return string |
|
1200 | + */ |
|
1201 | + public function get_customer_vat_number( $context = 'view' ) { |
|
1202 | + return $this->get_vat_number( $context ); |
|
1115 | 1203 | } |
1116 | 1204 | |
1117 | 1205 | /** |
1118 | - * Alias of self::get_zip(). |
|
1119 | - * |
|
1120 | - * @since 1.0.19 |
|
1121 | - * @param string $context View or edit context. |
|
1122 | - * @return string |
|
1123 | - */ |
|
1124 | - public function get_user_zip( $context = 'view' ) { |
|
1125 | - return $this->get_zip( $context ); |
|
1206 | + * Get the customer's vat rate. |
|
1207 | + * |
|
1208 | + * @since 1.0.19 |
|
1209 | + * @param string $context View or edit context. |
|
1210 | + * @return string |
|
1211 | + */ |
|
1212 | + public function get_vat_rate( $context = 'view' ) { |
|
1213 | + return $this->get_prop( 'vat_rate', $context ); |
|
1126 | 1214 | } |
1127 | 1215 | |
1128 | 1216 | /** |
1129 | - * Alias of self::get_zip(). |
|
1130 | - * |
|
1131 | - * @since 1.0.19 |
|
1132 | - * @param string $context View or edit context. |
|
1133 | - * @return string |
|
1134 | - */ |
|
1135 | - public function get_customer_zip( $context = 'view' ) { |
|
1136 | - return $this->get_zip( $context ); |
|
1217 | + * Alias of self::get_vat_rate(). |
|
1218 | + * |
|
1219 | + * @since 1.0.19 |
|
1220 | + * @param string $context View or edit context. |
|
1221 | + * @return string |
|
1222 | + */ |
|
1223 | + public function get_user_vat_rate( $context = 'view' ) { |
|
1224 | + return $this->get_vat_rate( $context ); |
|
1137 | 1225 | } |
1138 | 1226 | |
1139 | 1227 | /** |
1140 | - * Get the customer's company. |
|
1141 | - * |
|
1142 | - * @since 1.0.19 |
|
1143 | - * @param string $context View or edit context. |
|
1144 | - * @return string |
|
1145 | - */ |
|
1146 | - public function get_company( $context = 'view' ) { |
|
1147 | - return $this->get_prop( 'company', $context ); |
|
1228 | + * Alias of self::get_vat_rate(). |
|
1229 | + * |
|
1230 | + * @since 1.0.19 |
|
1231 | + * @param string $context View or edit context. |
|
1232 | + * @return string |
|
1233 | + */ |
|
1234 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
1235 | + return $this->get_vat_rate( $context ); |
|
1148 | 1236 | } |
1149 | 1237 | |
1150 | 1238 | /** |
1151 | - * Alias of self::get_company(). |
|
1152 | - * |
|
1153 | - * @since 1.0.19 |
|
1154 | - * @param string $context View or edit context. |
|
1155 | - * @return string |
|
1156 | - */ |
|
1157 | - public function get_user_company( $context = 'view' ) { |
|
1158 | - return $this->get_company( $context ); |
|
1239 | + * Get the customer's address. |
|
1240 | + * |
|
1241 | + * @since 1.0.19 |
|
1242 | + * @param string $context View or edit context. |
|
1243 | + * @return string |
|
1244 | + */ |
|
1245 | + public function get_address( $context = 'view' ) { |
|
1246 | + return $this->get_prop( 'address', $context ); |
|
1159 | 1247 | } |
1160 | 1248 | |
1161 | 1249 | /** |
1162 | - * Alias of self::get_company(). |
|
1163 | - * |
|
1164 | - * @since 1.0.19 |
|
1165 | - * @param string $context View or edit context. |
|
1166 | - * @return string |
|
1167 | - */ |
|
1168 | - public function get_customer_company( $context = 'view' ) { |
|
1169 | - return $this->get_company( $context ); |
|
1250 | + * Alias of self::get_address(). |
|
1251 | + * |
|
1252 | + * @since 1.0.19 |
|
1253 | + * @param string $context View or edit context. |
|
1254 | + * @return string |
|
1255 | + */ |
|
1256 | + public function get_user_address( $context = 'view' ) { |
|
1257 | + return $this->get_address( $context ); |
|
1258 | + } |
|
1259 | + |
|
1260 | + /** |
|
1261 | + * Alias of self::get_address(). |
|
1262 | + * |
|
1263 | + * @since 1.0.19 |
|
1264 | + * @param string $context View or edit context. |
|
1265 | + * @return string |
|
1266 | + */ |
|
1267 | + public function get_customer_address( $context = 'view' ) { |
|
1268 | + return $this->get_address( $context ); |
|
1269 | + } |
|
1270 | + |
|
1271 | + /** |
|
1272 | + * Get whether the customer has viewed the invoice or not. |
|
1273 | + * |
|
1274 | + * @since 1.0.19 |
|
1275 | + * @param string $context View or edit context. |
|
1276 | + * @return bool |
|
1277 | + */ |
|
1278 | + public function get_is_viewed( $context = 'view' ) { |
|
1279 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1170 | 1280 | } |
1171 | 1281 | |
1172 | 1282 | /** |
1173 | - * Get the customer's vat number. |
|
1174 | - * |
|
1175 | - * @since 1.0.19 |
|
1176 | - * @param string $context View or edit context. |
|
1177 | - * @return string |
|
1178 | - */ |
|
1179 | - public function get_vat_number( $context = 'view' ) { |
|
1180 | - return $this->get_prop( 'vat_number', $context ); |
|
1283 | + * Get other recipients for invoice communications. |
|
1284 | + * |
|
1285 | + * @since 1.0.19 |
|
1286 | + * @param string $context View or edit context. |
|
1287 | + * @return bool |
|
1288 | + */ |
|
1289 | + public function get_email_cc( $context = 'view' ) { |
|
1290 | + return $this->get_prop( 'email_cc', $context ); |
|
1181 | 1291 | } |
1182 | 1292 | |
1183 | 1293 | /** |
1184 | - * Alias of self::get_vat_number(). |
|
1185 | - * |
|
1186 | - * @since 1.0.19 |
|
1187 | - * @param string $context View or edit context. |
|
1188 | - * @return string |
|
1189 | - */ |
|
1190 | - public function get_user_vat_number( $context = 'view' ) { |
|
1191 | - return $this->get_vat_number( $context ); |
|
1294 | + * Get invoice template. |
|
1295 | + * |
|
1296 | + * @since 1.0.19 |
|
1297 | + * @param string $context View or edit context. |
|
1298 | + * @return bool |
|
1299 | + */ |
|
1300 | + public function get_template( $context = 'view' ) { |
|
1301 | + return $this->get_prop( 'template', $context ); |
|
1192 | 1302 | } |
1193 | 1303 | |
1194 | 1304 | /** |
1195 | - * Alias of self::get_vat_number(). |
|
1196 | - * |
|
1197 | - * @since 1.0.19 |
|
1198 | - * @param string $context View or edit context. |
|
1199 | - * @return string |
|
1200 | - */ |
|
1201 | - public function get_customer_vat_number( $context = 'view' ) { |
|
1202 | - return $this->get_vat_number( $context ); |
|
1305 | + * Get invoice source. |
|
1306 | + * |
|
1307 | + * @since 1.0.19 |
|
1308 | + * @param string $context View or edit context. |
|
1309 | + * @return bool |
|
1310 | + */ |
|
1311 | + public function get_created_via( $context = 'view' ) { |
|
1312 | + return $this->get_prop( 'created_via', $context ); |
|
1203 | 1313 | } |
1204 | 1314 | |
1205 | 1315 | /** |
1206 | - * Get the customer's vat rate. |
|
1207 | - * |
|
1208 | - * @since 1.0.19 |
|
1209 | - * @param string $context View or edit context. |
|
1210 | - * @return string |
|
1211 | - */ |
|
1212 | - public function get_vat_rate( $context = 'view' ) { |
|
1213 | - return $this->get_prop( 'vat_rate', $context ); |
|
1214 | - } |
|
1215 | - |
|
1216 | - /** |
|
1217 | - * Alias of self::get_vat_rate(). |
|
1218 | - * |
|
1219 | - * @since 1.0.19 |
|
1220 | - * @param string $context View or edit context. |
|
1221 | - * @return string |
|
1222 | - */ |
|
1223 | - public function get_user_vat_rate( $context = 'view' ) { |
|
1224 | - return $this->get_vat_rate( $context ); |
|
1225 | - } |
|
1226 | - |
|
1227 | - /** |
|
1228 | - * Alias of self::get_vat_rate(). |
|
1229 | - * |
|
1230 | - * @since 1.0.19 |
|
1231 | - * @param string $context View or edit context. |
|
1232 | - * @return string |
|
1233 | - */ |
|
1234 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
1235 | - return $this->get_vat_rate( $context ); |
|
1236 | - } |
|
1237 | - |
|
1238 | - /** |
|
1239 | - * Get the customer's address. |
|
1240 | - * |
|
1241 | - * @since 1.0.19 |
|
1242 | - * @param string $context View or edit context. |
|
1243 | - * @return string |
|
1244 | - */ |
|
1245 | - public function get_address( $context = 'view' ) { |
|
1246 | - return $this->get_prop( 'address', $context ); |
|
1247 | - } |
|
1248 | - |
|
1249 | - /** |
|
1250 | - * Alias of self::get_address(). |
|
1251 | - * |
|
1252 | - * @since 1.0.19 |
|
1253 | - * @param string $context View or edit context. |
|
1254 | - * @return string |
|
1255 | - */ |
|
1256 | - public function get_user_address( $context = 'view' ) { |
|
1257 | - return $this->get_address( $context ); |
|
1258 | - } |
|
1259 | - |
|
1260 | - /** |
|
1261 | - * Alias of self::get_address(). |
|
1262 | - * |
|
1263 | - * @since 1.0.19 |
|
1264 | - * @param string $context View or edit context. |
|
1265 | - * @return string |
|
1266 | - */ |
|
1267 | - public function get_customer_address( $context = 'view' ) { |
|
1268 | - return $this->get_address( $context ); |
|
1269 | - } |
|
1270 | - |
|
1271 | - /** |
|
1272 | - * Get whether the customer has viewed the invoice or not. |
|
1273 | - * |
|
1274 | - * @since 1.0.19 |
|
1275 | - * @param string $context View or edit context. |
|
1276 | - * @return bool |
|
1277 | - */ |
|
1278 | - public function get_is_viewed( $context = 'view' ) { |
|
1279 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1280 | - } |
|
1281 | - |
|
1282 | - /** |
|
1283 | - * Get other recipients for invoice communications. |
|
1284 | - * |
|
1285 | - * @since 1.0.19 |
|
1286 | - * @param string $context View or edit context. |
|
1287 | - * @return bool |
|
1288 | - */ |
|
1289 | - public function get_email_cc( $context = 'view' ) { |
|
1290 | - return $this->get_prop( 'email_cc', $context ); |
|
1291 | - } |
|
1292 | - |
|
1293 | - /** |
|
1294 | - * Get invoice template. |
|
1295 | - * |
|
1296 | - * @since 1.0.19 |
|
1297 | - * @param string $context View or edit context. |
|
1298 | - * @return bool |
|
1299 | - */ |
|
1300 | - public function get_template( $context = 'view' ) { |
|
1301 | - return $this->get_prop( 'template', $context ); |
|
1302 | - } |
|
1303 | - |
|
1304 | - /** |
|
1305 | - * Get invoice source. |
|
1306 | - * |
|
1307 | - * @since 1.0.19 |
|
1308 | - * @param string $context View or edit context. |
|
1309 | - * @return bool |
|
1310 | - */ |
|
1311 | - public function get_created_via( $context = 'view' ) { |
|
1312 | - return $this->get_prop( 'created_via', $context ); |
|
1313 | - } |
|
1314 | - |
|
1315 | - /** |
|
1316 | - * Get whether the customer has confirmed their address. |
|
1317 | - * |
|
1318 | - * @since 1.0.19 |
|
1319 | - * @param string $context View or edit context. |
|
1320 | - * @return bool |
|
1321 | - */ |
|
1322 | - public function get_address_confirmed( $context = 'view' ) { |
|
1323 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1324 | - } |
|
1325 | - |
|
1326 | - /** |
|
1327 | - * Alias of self::get_address_confirmed(). |
|
1328 | - * |
|
1329 | - * @since 1.0.19 |
|
1330 | - * @param string $context View or edit context. |
|
1331 | - * @return bool |
|
1332 | - */ |
|
1333 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
1334 | - return $this->get_address_confirmed( $context ); |
|
1335 | - } |
|
1336 | - |
|
1337 | - /** |
|
1338 | - * Alias of self::get_address(). |
|
1339 | - * |
|
1340 | - * @since 1.0.19 |
|
1341 | - * @param string $context View or edit context. |
|
1342 | - * @return bool |
|
1343 | - */ |
|
1344 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
1345 | - return $this->get_address_confirmed( $context ); |
|
1346 | - } |
|
1347 | - |
|
1348 | - /** |
|
1349 | - * Get the invoice subtotal. |
|
1350 | - * |
|
1351 | - * @since 1.0.19 |
|
1352 | - * @param string $context View or edit context. |
|
1353 | - * @return float |
|
1354 | - */ |
|
1355 | - public function get_subtotal( $context = 'view' ) { |
|
1316 | + * Get whether the customer has confirmed their address. |
|
1317 | + * |
|
1318 | + * @since 1.0.19 |
|
1319 | + * @param string $context View or edit context. |
|
1320 | + * @return bool |
|
1321 | + */ |
|
1322 | + public function get_address_confirmed( $context = 'view' ) { |
|
1323 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1324 | + } |
|
1325 | + |
|
1326 | + /** |
|
1327 | + * Alias of self::get_address_confirmed(). |
|
1328 | + * |
|
1329 | + * @since 1.0.19 |
|
1330 | + * @param string $context View or edit context. |
|
1331 | + * @return bool |
|
1332 | + */ |
|
1333 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
1334 | + return $this->get_address_confirmed( $context ); |
|
1335 | + } |
|
1336 | + |
|
1337 | + /** |
|
1338 | + * Alias of self::get_address(). |
|
1339 | + * |
|
1340 | + * @since 1.0.19 |
|
1341 | + * @param string $context View or edit context. |
|
1342 | + * @return bool |
|
1343 | + */ |
|
1344 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
1345 | + return $this->get_address_confirmed( $context ); |
|
1346 | + } |
|
1347 | + |
|
1348 | + /** |
|
1349 | + * Get the invoice subtotal. |
|
1350 | + * |
|
1351 | + * @since 1.0.19 |
|
1352 | + * @param string $context View or edit context. |
|
1353 | + * @return float |
|
1354 | + */ |
|
1355 | + public function get_subtotal( $context = 'view' ) { |
|
1356 | 1356 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
1357 | 1357 | |
1358 | 1358 | // Backwards compatibility. |
@@ -1364,167 +1364,167 @@ discard block |
||
1364 | 1364 | } |
1365 | 1365 | |
1366 | 1366 | /** |
1367 | - * Get the invoice discount total. |
|
1368 | - * |
|
1369 | - * @since 1.0.19 |
|
1370 | - * @param string $context View or edit context. |
|
1371 | - * @return float |
|
1372 | - */ |
|
1373 | - public function get_total_discount( $context = 'view' ) { |
|
1374 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1367 | + * Get the invoice discount total. |
|
1368 | + * |
|
1369 | + * @since 1.0.19 |
|
1370 | + * @param string $context View or edit context. |
|
1371 | + * @return float |
|
1372 | + */ |
|
1373 | + public function get_total_discount( $context = 'view' ) { |
|
1374 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1375 | 1375 | } |
1376 | 1376 | |
1377 | 1377 | /** |
1378 | - * Get the invoice tax total. |
|
1379 | - * |
|
1380 | - * @since 1.0.19 |
|
1381 | - * @param string $context View or edit context. |
|
1382 | - * @return float |
|
1383 | - */ |
|
1384 | - public function get_total_tax( $context = 'view' ) { |
|
1385 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1386 | - } |
|
1378 | + * Get the invoice tax total. |
|
1379 | + * |
|
1380 | + * @since 1.0.19 |
|
1381 | + * @param string $context View or edit context. |
|
1382 | + * @return float |
|
1383 | + */ |
|
1384 | + public function get_total_tax( $context = 'view' ) { |
|
1385 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1386 | + } |
|
1387 | 1387 | |
1388 | - /** |
|
1389 | - * @deprecated |
|
1390 | - */ |
|
1391 | - public function get_final_tax( $currency = false ) { |
|
1392 | - $tax = $this->get_total_tax(); |
|
1388 | + /** |
|
1389 | + * @deprecated |
|
1390 | + */ |
|
1391 | + public function get_final_tax( $currency = false ) { |
|
1392 | + $tax = $this->get_total_tax(); |
|
1393 | 1393 | |
1394 | 1394 | if ( $currency ) { |
1395 | - return wpinv_price( $tax, $this->get_currency() ); |
|
1395 | + return wpinv_price( $tax, $this->get_currency() ); |
|
1396 | 1396 | } |
1397 | 1397 | |
1398 | 1398 | return $tax; |
1399 | 1399 | } |
1400 | 1400 | |
1401 | 1401 | /** |
1402 | - * Get the invoice fees total. |
|
1403 | - * |
|
1404 | - * @since 1.0.19 |
|
1405 | - * @param string $context View or edit context. |
|
1406 | - * @return float |
|
1407 | - */ |
|
1408 | - public function get_total_fees( $context = 'view' ) { |
|
1409 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1402 | + * Get the invoice fees total. |
|
1403 | + * |
|
1404 | + * @since 1.0.19 |
|
1405 | + * @param string $context View or edit context. |
|
1406 | + * @return float |
|
1407 | + */ |
|
1408 | + public function get_total_fees( $context = 'view' ) { |
|
1409 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1410 | 1410 | } |
1411 | 1411 | |
1412 | 1412 | /** |
1413 | - * Alias for self::get_total_fees(). |
|
1414 | - * |
|
1415 | - * @since 1.0.19 |
|
1416 | - * @param string $context View or edit context. |
|
1417 | - * @return float |
|
1418 | - */ |
|
1419 | - public function get_fees_total( $context = 'view' ) { |
|
1420 | - return $this->get_total_fees( $context ); |
|
1413 | + * Alias for self::get_total_fees(). |
|
1414 | + * |
|
1415 | + * @since 1.0.19 |
|
1416 | + * @param string $context View or edit context. |
|
1417 | + * @return float |
|
1418 | + */ |
|
1419 | + public function get_fees_total( $context = 'view' ) { |
|
1420 | + return $this->get_total_fees( $context ); |
|
1421 | 1421 | } |
1422 | 1422 | |
1423 | 1423 | /** |
1424 | - * Get the invoice total. |
|
1425 | - * |
|
1426 | - * @since 1.0.19 |
|
1424 | + * Get the invoice total. |
|
1425 | + * |
|
1426 | + * @since 1.0.19 |
|
1427 | 1427 | * @return float |
1428 | - */ |
|
1429 | - public function get_total() { |
|
1430 | - $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total(); |
|
1431 | - return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this ); |
|
1432 | - } |
|
1428 | + */ |
|
1429 | + public function get_total() { |
|
1430 | + $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total(); |
|
1431 | + return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this ); |
|
1432 | + } |
|
1433 | 1433 | |
1434 | - /** |
|
1435 | - * Get the invoice totals. |
|
1436 | - * |
|
1437 | - * @since 1.0.19 |
|
1434 | + /** |
|
1435 | + * Get the invoice totals. |
|
1436 | + * |
|
1437 | + * @since 1.0.19 |
|
1438 | 1438 | * @return array |
1439 | - */ |
|
1440 | - public function get_totals() { |
|
1441 | - return $this->totals; |
|
1439 | + */ |
|
1440 | + public function get_totals() { |
|
1441 | + return $this->totals; |
|
1442 | 1442 | } |
1443 | 1443 | |
1444 | 1444 | /** |
1445 | - * Get the initial invoice total. |
|
1446 | - * |
|
1447 | - * @since 1.0.19 |
|
1445 | + * Get the initial invoice total. |
|
1446 | + * |
|
1447 | + * @since 1.0.19 |
|
1448 | 1448 | * @param string $context View or edit context. |
1449 | 1449 | * @return float |
1450 | - */ |
|
1450 | + */ |
|
1451 | 1451 | public function get_initial_total() { |
1452 | 1452 | |
1453 | - if ( empty( $this->totals ) ) { |
|
1454 | - $this->recalculate_total(); |
|
1455 | - } |
|
1453 | + if ( empty( $this->totals ) ) { |
|
1454 | + $this->recalculate_total(); |
|
1455 | + } |
|
1456 | 1456 | |
1457 | - $tax = $this->totals['tax']['initial']; |
|
1458 | - $fee = $this->totals['fee']['initial']; |
|
1459 | - $discount = $this->totals['discount']['initial']; |
|
1460 | - $subtotal = $this->totals['subtotal']['initial']; |
|
1461 | - $total = $tax + $fee - $discount + $subtotal; |
|
1457 | + $tax = $this->totals['tax']['initial']; |
|
1458 | + $fee = $this->totals['fee']['initial']; |
|
1459 | + $discount = $this->totals['discount']['initial']; |
|
1460 | + $subtotal = $this->totals['subtotal']['initial']; |
|
1461 | + $total = $tax + $fee - $discount + $subtotal; |
|
1462 | 1462 | |
1463 | - if ( 0 > $total ) { |
|
1464 | - $total = 0; |
|
1465 | - } |
|
1463 | + if ( 0 > $total ) { |
|
1464 | + $total = 0; |
|
1465 | + } |
|
1466 | 1466 | |
1467 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1467 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1468 | 1468 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
1469 | - } |
|
1469 | + } |
|
1470 | 1470 | |
1471 | - /** |
|
1472 | - * Get the recurring invoice total. |
|
1473 | - * |
|
1474 | - * @since 1.0.19 |
|
1471 | + /** |
|
1472 | + * Get the recurring invoice total. |
|
1473 | + * |
|
1474 | + * @since 1.0.19 |
|
1475 | 1475 | * @param string $context View or edit context. |
1476 | 1476 | * @return float |
1477 | - */ |
|
1477 | + */ |
|
1478 | 1478 | public function get_recurring_total() { |
1479 | 1479 | |
1480 | - if ( empty( $this->totals ) ) { |
|
1481 | - $this->recalculate_total(); |
|
1482 | - } |
|
1480 | + if ( empty( $this->totals ) ) { |
|
1481 | + $this->recalculate_total(); |
|
1482 | + } |
|
1483 | 1483 | |
1484 | - $tax = $this->totals['tax']['recurring']; |
|
1485 | - $fee = $this->totals['fee']['recurring']; |
|
1486 | - $discount = $this->totals['discount']['recurring']; |
|
1487 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
1488 | - $total = $tax + $fee - $discount + $subtotal; |
|
1484 | + $tax = $this->totals['tax']['recurring']; |
|
1485 | + $fee = $this->totals['fee']['recurring']; |
|
1486 | + $discount = $this->totals['discount']['recurring']; |
|
1487 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
1488 | + $total = $tax + $fee - $discount + $subtotal; |
|
1489 | 1489 | |
1490 | - if ( 0 > $total ) { |
|
1491 | - $total = 0; |
|
1492 | - } |
|
1490 | + if ( 0 > $total ) { |
|
1491 | + $total = 0; |
|
1492 | + } |
|
1493 | 1493 | |
1494 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1494 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1495 | 1495 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
1496 | - } |
|
1496 | + } |
|
1497 | 1497 | |
1498 | - /** |
|
1499 | - * Returns recurring payment details. |
|
1500 | - * |
|
1501 | - * @since 1.0.19 |
|
1498 | + /** |
|
1499 | + * Returns recurring payment details. |
|
1500 | + * |
|
1501 | + * @since 1.0.19 |
|
1502 | 1502 | * @param string $field Optionally provide a field to return. |
1503 | - * @param string $currency Whether to include the currency. |
|
1503 | + * @param string $currency Whether to include the currency. |
|
1504 | 1504 | * @return float|string |
1505 | - */ |
|
1505 | + */ |
|
1506 | 1506 | public function get_recurring_details( $field = '', $currency = false ) { |
1507 | 1507 | |
1508 | - // Maybe recalculate totals. |
|
1509 | - if ( empty( $this->totals ) ) { |
|
1510 | - $this->recalculate_total(); |
|
1511 | - } |
|
1508 | + // Maybe recalculate totals. |
|
1509 | + if ( empty( $this->totals ) ) { |
|
1510 | + $this->recalculate_total(); |
|
1511 | + } |
|
1512 | 1512 | |
1513 | - // Prepare recurring totals. |
|
1513 | + // Prepare recurring totals. |
|
1514 | 1514 | $data = apply_filters( |
1515 | - 'wpinv_get_invoice_recurring_details', |
|
1516 | - array( |
|
1517 | - 'cart_details' => $this->get_cart_details(), |
|
1518 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1519 | - 'discount' => $this->totals['discount']['recurring'], |
|
1520 | - 'tax' => $this->totals['tax']['recurring'], |
|
1521 | - 'fee' => $this->totals['fee']['recurring'], |
|
1522 | - 'total' => $this->get_recurring_total(), |
|
1523 | - ), |
|
1524 | - $this, |
|
1525 | - $field, |
|
1526 | - $currency |
|
1527 | - ); |
|
1515 | + 'wpinv_get_invoice_recurring_details', |
|
1516 | + array( |
|
1517 | + 'cart_details' => $this->get_cart_details(), |
|
1518 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1519 | + 'discount' => $this->totals['discount']['recurring'], |
|
1520 | + 'tax' => $this->totals['tax']['recurring'], |
|
1521 | + 'fee' => $this->totals['fee']['recurring'], |
|
1522 | + 'total' => $this->get_recurring_total(), |
|
1523 | + ), |
|
1524 | + $this, |
|
1525 | + $field, |
|
1526 | + $currency |
|
1527 | + ); |
|
1528 | 1528 | |
1529 | 1529 | if ( isset( $data[$field] ) ) { |
1530 | 1530 | return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] ); |
@@ -1534,166 +1534,166 @@ discard block |
||
1534 | 1534 | } |
1535 | 1535 | |
1536 | 1536 | /** |
1537 | - * Get the invoice fees. |
|
1538 | - * |
|
1539 | - * @since 1.0.19 |
|
1540 | - * @param string $context View or edit context. |
|
1541 | - * @return array |
|
1542 | - */ |
|
1543 | - public function get_fees( $context = 'view' ) { |
|
1544 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1537 | + * Get the invoice fees. |
|
1538 | + * |
|
1539 | + * @since 1.0.19 |
|
1540 | + * @param string $context View or edit context. |
|
1541 | + * @return array |
|
1542 | + */ |
|
1543 | + public function get_fees( $context = 'view' ) { |
|
1544 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1545 | 1545 | } |
1546 | 1546 | |
1547 | 1547 | /** |
1548 | - * Get the invoice discounts. |
|
1549 | - * |
|
1550 | - * @since 1.0.19 |
|
1551 | - * @param string $context View or edit context. |
|
1552 | - * @return array |
|
1553 | - */ |
|
1554 | - public function get_discounts( $context = 'view' ) { |
|
1555 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1548 | + * Get the invoice discounts. |
|
1549 | + * |
|
1550 | + * @since 1.0.19 |
|
1551 | + * @param string $context View or edit context. |
|
1552 | + * @return array |
|
1553 | + */ |
|
1554 | + public function get_discounts( $context = 'view' ) { |
|
1555 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1556 | 1556 | } |
1557 | 1557 | |
1558 | 1558 | /** |
1559 | - * Get the invoice taxes. |
|
1560 | - * |
|
1561 | - * @since 1.0.19 |
|
1562 | - * @param string $context View or edit context. |
|
1563 | - * @return array |
|
1564 | - */ |
|
1565 | - public function get_taxes( $context = 'view' ) { |
|
1566 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1559 | + * Get the invoice taxes. |
|
1560 | + * |
|
1561 | + * @since 1.0.19 |
|
1562 | + * @param string $context View or edit context. |
|
1563 | + * @return array |
|
1564 | + */ |
|
1565 | + public function get_taxes( $context = 'view' ) { |
|
1566 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1567 | 1567 | } |
1568 | 1568 | |
1569 | 1569 | /** |
1570 | - * Get the invoice items. |
|
1571 | - * |
|
1572 | - * @since 1.0.19 |
|
1573 | - * @param string $context View or edit context. |
|
1574 | - * @return GetPaid_Form_Item[] |
|
1575 | - */ |
|
1576 | - public function get_items( $context = 'view' ) { |
|
1570 | + * Get the invoice items. |
|
1571 | + * |
|
1572 | + * @since 1.0.19 |
|
1573 | + * @param string $context View or edit context. |
|
1574 | + * @return GetPaid_Form_Item[] |
|
1575 | + */ |
|
1576 | + public function get_items( $context = 'view' ) { |
|
1577 | 1577 | return $this->get_prop( 'items', $context ); |
1578 | - } |
|
1578 | + } |
|
1579 | 1579 | |
1580 | - /** |
|
1581 | - * Get the invoice item ids. |
|
1582 | - * |
|
1583 | - * @since 1.0.19 |
|
1584 | - * @return string |
|
1585 | - */ |
|
1586 | - public function get_item_ids() { |
|
1587 | - return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1580 | + /** |
|
1581 | + * Get the invoice item ids. |
|
1582 | + * |
|
1583 | + * @since 1.0.19 |
|
1584 | + * @return string |
|
1585 | + */ |
|
1586 | + public function get_item_ids() { |
|
1587 | + return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1588 | 1588 | } |
1589 | 1589 | |
1590 | 1590 | /** |
1591 | - * Get the invoice's payment form. |
|
1592 | - * |
|
1593 | - * @since 1.0.19 |
|
1594 | - * @param string $context View or edit context. |
|
1595 | - * @return int |
|
1596 | - */ |
|
1597 | - public function get_payment_form( $context = 'view' ) { |
|
1598 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1591 | + * Get the invoice's payment form. |
|
1592 | + * |
|
1593 | + * @since 1.0.19 |
|
1594 | + * @param string $context View or edit context. |
|
1595 | + * @return int |
|
1596 | + */ |
|
1597 | + public function get_payment_form( $context = 'view' ) { |
|
1598 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1599 | 1599 | } |
1600 | 1600 | |
1601 | 1601 | /** |
1602 | - * Get the invoice's submission id. |
|
1603 | - * |
|
1604 | - * @since 1.0.19 |
|
1605 | - * @param string $context View or edit context. |
|
1606 | - * @return string |
|
1607 | - */ |
|
1608 | - public function get_submission_id( $context = 'view' ) { |
|
1609 | - return $this->get_prop( 'submission_id', $context ); |
|
1602 | + * Get the invoice's submission id. |
|
1603 | + * |
|
1604 | + * @since 1.0.19 |
|
1605 | + * @param string $context View or edit context. |
|
1606 | + * @return string |
|
1607 | + */ |
|
1608 | + public function get_submission_id( $context = 'view' ) { |
|
1609 | + return $this->get_prop( 'submission_id', $context ); |
|
1610 | 1610 | } |
1611 | 1611 | |
1612 | 1612 | /** |
1613 | - * Get the invoice's discount code. |
|
1614 | - * |
|
1615 | - * @since 1.0.19 |
|
1616 | - * @param string $context View or edit context. |
|
1617 | - * @return string |
|
1618 | - */ |
|
1619 | - public function get_discount_code( $context = 'view' ) { |
|
1620 | - return $this->get_prop( 'discount_code', $context ); |
|
1613 | + * Get the invoice's discount code. |
|
1614 | + * |
|
1615 | + * @since 1.0.19 |
|
1616 | + * @param string $context View or edit context. |
|
1617 | + * @return string |
|
1618 | + */ |
|
1619 | + public function get_discount_code( $context = 'view' ) { |
|
1620 | + return $this->get_prop( 'discount_code', $context ); |
|
1621 | 1621 | } |
1622 | 1622 | |
1623 | 1623 | /** |
1624 | - * Get the invoice's gateway. |
|
1625 | - * |
|
1626 | - * @since 1.0.19 |
|
1627 | - * @param string $context View or edit context. |
|
1628 | - * @return string |
|
1629 | - */ |
|
1630 | - public function get_gateway( $context = 'view' ) { |
|
1631 | - return $this->get_prop( 'gateway', $context ); |
|
1624 | + * Get the invoice's gateway. |
|
1625 | + * |
|
1626 | + * @since 1.0.19 |
|
1627 | + * @param string $context View or edit context. |
|
1628 | + * @return string |
|
1629 | + */ |
|
1630 | + public function get_gateway( $context = 'view' ) { |
|
1631 | + return $this->get_prop( 'gateway', $context ); |
|
1632 | 1632 | } |
1633 | 1633 | |
1634 | 1634 | /** |
1635 | - * Get the invoice's gateway display title. |
|
1636 | - * |
|
1637 | - * @since 1.0.19 |
|
1638 | - * @return string |
|
1639 | - */ |
|
1635 | + * Get the invoice's gateway display title. |
|
1636 | + * |
|
1637 | + * @since 1.0.19 |
|
1638 | + * @return string |
|
1639 | + */ |
|
1640 | 1640 | public function get_gateway_title() { |
1641 | 1641 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
1642 | 1642 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
1643 | 1643 | } |
1644 | 1644 | |
1645 | 1645 | /** |
1646 | - * Get the invoice's transaction id. |
|
1647 | - * |
|
1648 | - * @since 1.0.19 |
|
1649 | - * @param string $context View or edit context. |
|
1650 | - * @return string |
|
1651 | - */ |
|
1652 | - public function get_transaction_id( $context = 'view' ) { |
|
1653 | - return $this->get_prop( 'transaction_id', $context ); |
|
1646 | + * Get the invoice's transaction id. |
|
1647 | + * |
|
1648 | + * @since 1.0.19 |
|
1649 | + * @param string $context View or edit context. |
|
1650 | + * @return string |
|
1651 | + */ |
|
1652 | + public function get_transaction_id( $context = 'view' ) { |
|
1653 | + return $this->get_prop( 'transaction_id', $context ); |
|
1654 | 1654 | } |
1655 | 1655 | |
1656 | 1656 | /** |
1657 | - * Get the invoice's currency. |
|
1658 | - * |
|
1659 | - * @since 1.0.19 |
|
1660 | - * @param string $context View or edit context. |
|
1661 | - * @return string |
|
1662 | - */ |
|
1663 | - public function get_currency( $context = 'view' ) { |
|
1657 | + * Get the invoice's currency. |
|
1658 | + * |
|
1659 | + * @since 1.0.19 |
|
1660 | + * @param string $context View or edit context. |
|
1661 | + * @return string |
|
1662 | + */ |
|
1663 | + public function get_currency( $context = 'view' ) { |
|
1664 | 1664 | $currency = $this->get_prop( 'currency', $context ); |
1665 | 1665 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
1666 | 1666 | } |
1667 | 1667 | |
1668 | 1668 | /** |
1669 | - * Checks if we are charging taxes for this invoice. |
|
1670 | - * |
|
1671 | - * @since 1.0.19 |
|
1672 | - * @param string $context View or edit context. |
|
1673 | - * @return bool |
|
1674 | - */ |
|
1675 | - public function get_disable_taxes( $context = 'view' ) { |
|
1669 | + * Checks if we are charging taxes for this invoice. |
|
1670 | + * |
|
1671 | + * @since 1.0.19 |
|
1672 | + * @param string $context View or edit context. |
|
1673 | + * @return bool |
|
1674 | + */ |
|
1675 | + public function get_disable_taxes( $context = 'view' ) { |
|
1676 | 1676 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
1677 | 1677 | } |
1678 | 1678 | |
1679 | 1679 | /** |
1680 | - * Retrieves the subscription id for an invoice. |
|
1681 | - * |
|
1682 | - * @since 1.0.19 |
|
1683 | - * @param string $context View or edit context. |
|
1684 | - * @return int |
|
1685 | - */ |
|
1680 | + * Retrieves the subscription id for an invoice. |
|
1681 | + * |
|
1682 | + * @since 1.0.19 |
|
1683 | + * @param string $context View or edit context. |
|
1684 | + * @return int |
|
1685 | + */ |
|
1686 | 1686 | public function get_subscription_id( $context = 'view' ) { |
1687 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1688 | - } |
|
1689 | - |
|
1690 | - /** |
|
1691 | - * Retrieves the remote subscription id for an invoice. |
|
1692 | - * |
|
1693 | - * @since 1.0.19 |
|
1694 | - * @param string $context View or edit context. |
|
1695 | - * @return int |
|
1696 | - */ |
|
1687 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1688 | + } |
|
1689 | + |
|
1690 | + /** |
|
1691 | + * Retrieves the remote subscription id for an invoice. |
|
1692 | + * |
|
1693 | + * @since 1.0.19 |
|
1694 | + * @param string $context View or edit context. |
|
1695 | + * @return int |
|
1696 | + */ |
|
1697 | 1697 | public function get_remote_subscription_id( $context = 'view' ) { |
1698 | 1698 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
1699 | 1699 | |
@@ -1706,12 +1706,12 @@ discard block |
||
1706 | 1706 | } |
1707 | 1707 | |
1708 | 1708 | /** |
1709 | - * Retrieves the payment meta for an invoice. |
|
1710 | - * |
|
1711 | - * @since 1.0.19 |
|
1712 | - * @param string $context View or edit context. |
|
1713 | - * @return array |
|
1714 | - */ |
|
1709 | + * Retrieves the payment meta for an invoice. |
|
1710 | + * |
|
1711 | + * @since 1.0.19 |
|
1712 | + * @param string $context View or edit context. |
|
1713 | + * @return array |
|
1714 | + */ |
|
1715 | 1715 | public function get_payment_meta( $context = 'view' ) { |
1716 | 1716 | |
1717 | 1717 | return array( |
@@ -1731,31 +1731,31 @@ discard block |
||
1731 | 1731 | } |
1732 | 1732 | |
1733 | 1733 | /** |
1734 | - * Retrieves the cart details for an invoice. |
|
1735 | - * |
|
1736 | - * @since 1.0.19 |
|
1737 | - * @return array |
|
1738 | - */ |
|
1734 | + * Retrieves the cart details for an invoice. |
|
1735 | + * |
|
1736 | + * @since 1.0.19 |
|
1737 | + * @return array |
|
1738 | + */ |
|
1739 | 1739 | public function get_cart_details() { |
1740 | 1740 | $items = $this->get_items(); |
1741 | 1741 | $cart_details = array(); |
1742 | 1742 | |
1743 | 1743 | foreach ( $items as $item ) { |
1744 | - $item->invoice_id = $this->get_id(); |
|
1744 | + $item->invoice_id = $this->get_id(); |
|
1745 | 1745 | $cart_details[] = $item->prepare_data_for_saving(); |
1746 | 1746 | } |
1747 | 1747 | |
1748 | 1748 | return $cart_details; |
1749 | - } |
|
1749 | + } |
|
1750 | 1750 | |
1751 | - /** |
|
1752 | - * Retrieves the recurring item. |
|
1753 | - * |
|
1754 | - * @return null|GetPaid_Form_Item|int |
|
1755 | - */ |
|
1756 | - public function get_recurring( $object = false ) { |
|
1751 | + /** |
|
1752 | + * Retrieves the recurring item. |
|
1753 | + * |
|
1754 | + * @return null|GetPaid_Form_Item|int |
|
1755 | + */ |
|
1756 | + public function get_recurring( $object = false ) { |
|
1757 | 1757 | |
1758 | - // Are we returning an object? |
|
1758 | + // Are we returning an object? |
|
1759 | 1759 | if ( $object ) { |
1760 | 1760 | return $this->get_item( $this->recurring_item ); |
1761 | 1761 | } |
@@ -1763,114 +1763,114 @@ discard block |
||
1763 | 1763 | return $this->recurring_item; |
1764 | 1764 | } |
1765 | 1765 | |
1766 | - /** |
|
1767 | - * Retrieves the subscription name. |
|
1768 | - * |
|
1769 | - * @since 1.0.19 |
|
1770 | - * @return string |
|
1771 | - */ |
|
1772 | - public function get_subscription_name() { |
|
1766 | + /** |
|
1767 | + * Retrieves the subscription name. |
|
1768 | + * |
|
1769 | + * @since 1.0.19 |
|
1770 | + * @return string |
|
1771 | + */ |
|
1772 | + public function get_subscription_name() { |
|
1773 | 1773 | |
1774 | - // Retrieve the recurring name |
|
1774 | + // Retrieve the recurring name |
|
1775 | 1775 | $item = $this->get_recurring( true ); |
1776 | 1776 | |
1777 | - // Abort if it does not exist. |
|
1777 | + // Abort if it does not exist. |
|
1778 | 1778 | if ( empty( $item ) ) { |
1779 | 1779 | return ''; |
1780 | 1780 | } |
1781 | 1781 | |
1782 | - // Return the item name. |
|
1782 | + // Return the item name. |
|
1783 | 1783 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
1784 | - } |
|
1785 | - |
|
1786 | - /** |
|
1787 | - * Retrieves the view url. |
|
1788 | - * |
|
1789 | - * @since 1.0.19 |
|
1790 | - * @return string |
|
1791 | - */ |
|
1792 | - public function get_view_url() { |
|
1784 | + } |
|
1785 | + |
|
1786 | + /** |
|
1787 | + * Retrieves the view url. |
|
1788 | + * |
|
1789 | + * @since 1.0.19 |
|
1790 | + * @return string |
|
1791 | + */ |
|
1792 | + public function get_view_url() { |
|
1793 | 1793 | $invoice_url = get_permalink( $this->get_id() ); |
1794 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1794 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1795 | 1795 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
1796 | - } |
|
1796 | + } |
|
1797 | 1797 | |
1798 | - /** |
|
1799 | - * Retrieves the payment url. |
|
1800 | - * |
|
1801 | - * @since 1.0.19 |
|
1802 | - * @return string |
|
1803 | - */ |
|
1804 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1798 | + /** |
|
1799 | + * Retrieves the payment url. |
|
1800 | + * |
|
1801 | + * @since 1.0.19 |
|
1802 | + * @return string |
|
1803 | + */ |
|
1804 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1805 | 1805 | |
1806 | - // Retrieve the checkout url. |
|
1806 | + // Retrieve the checkout url. |
|
1807 | 1807 | $pay_url = wpinv_get_checkout_uri(); |
1808 | 1808 | |
1809 | - // Maybe force ssl. |
|
1809 | + // Maybe force ssl. |
|
1810 | 1810 | if ( is_ssl() ) { |
1811 | 1811 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
1812 | 1812 | } |
1813 | 1813 | |
1814 | - // Add the invoice key. |
|
1815 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1814 | + // Add the invoice key. |
|
1815 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1816 | 1816 | |
1817 | - // (Maybe?) add a secret |
|
1817 | + // (Maybe?) add a secret |
|
1818 | 1818 | if ( $secret ) { |
1819 | 1819 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
1820 | 1820 | } |
1821 | 1821 | |
1822 | 1822 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
1823 | - } |
|
1823 | + } |
|
1824 | 1824 | |
1825 | - /** |
|
1826 | - * Retrieves the receipt url. |
|
1827 | - * |
|
1828 | - * @since 1.0.19 |
|
1829 | - * @return string |
|
1830 | - */ |
|
1831 | - public function get_receipt_url() { |
|
1832 | - |
|
1833 | - // Retrieve the checkout url. |
|
1825 | + /** |
|
1826 | + * Retrieves the receipt url. |
|
1827 | + * |
|
1828 | + * @since 1.0.19 |
|
1829 | + * @return string |
|
1830 | + */ |
|
1831 | + public function get_receipt_url() { |
|
1832 | + |
|
1833 | + // Retrieve the checkout url. |
|
1834 | 1834 | $receipt_url = wpinv_get_success_page_uri(); |
1835 | 1835 | |
1836 | - // Maybe force ssl. |
|
1836 | + // Maybe force ssl. |
|
1837 | 1837 | if ( is_ssl() ) { |
1838 | 1838 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
1839 | 1839 | } |
1840 | 1840 | |
1841 | - // Add the invoice key. |
|
1842 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1841 | + // Add the invoice key. |
|
1842 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1843 | 1843 | |
1844 | 1844 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
1845 | - } |
|
1845 | + } |
|
1846 | 1846 | |
1847 | - /** |
|
1848 | - * Retrieves the default status. |
|
1849 | - * |
|
1850 | - * @since 1.0.19 |
|
1851 | - * @return string |
|
1852 | - */ |
|
1853 | - public function get_default_status() { |
|
1854 | - |
|
1855 | - $type = $this->get_type(); |
|
1856 | - $status = "wpi-$type-pending"; |
|
1857 | - return str_replace( '-invoice', '', $status ); |
|
1858 | - |
|
1859 | - } |
|
1860 | - |
|
1861 | - /** |
|
1862 | - * Magic method for accessing invoice properties. |
|
1863 | - * |
|
1864 | - * @since 1.0.15 |
|
1865 | - * @access public |
|
1866 | - * |
|
1867 | - * @param string $key Discount data to retrieve |
|
1868 | - * @param string $context View or edit context. |
|
1869 | - * @return mixed Value of the given invoice property (if set). |
|
1870 | - */ |
|
1871 | - public function get( $key, $context = 'view' ) { |
|
1847 | + /** |
|
1848 | + * Retrieves the default status. |
|
1849 | + * |
|
1850 | + * @since 1.0.19 |
|
1851 | + * @return string |
|
1852 | + */ |
|
1853 | + public function get_default_status() { |
|
1854 | + |
|
1855 | + $type = $this->get_type(); |
|
1856 | + $status = "wpi-$type-pending"; |
|
1857 | + return str_replace( '-invoice', '', $status ); |
|
1858 | + |
|
1859 | + } |
|
1860 | + |
|
1861 | + /** |
|
1862 | + * Magic method for accessing invoice properties. |
|
1863 | + * |
|
1864 | + * @since 1.0.15 |
|
1865 | + * @access public |
|
1866 | + * |
|
1867 | + * @param string $key Discount data to retrieve |
|
1868 | + * @param string $context View or edit context. |
|
1869 | + * @return mixed Value of the given invoice property (if set). |
|
1870 | + */ |
|
1871 | + public function get( $key, $context = 'view' ) { |
|
1872 | 1872 | return $this->get_prop( $key, $context ); |
1873 | - } |
|
1873 | + } |
|
1874 | 1874 | |
1875 | 1875 | /* |
1876 | 1876 | |-------------------------------------------------------------------------- |
@@ -1883,130 +1883,130 @@ discard block |
||
1883 | 1883 | */ |
1884 | 1884 | |
1885 | 1885 | /** |
1886 | - * Magic method for setting invoice properties. |
|
1887 | - * |
|
1888 | - * @since 1.0.19 |
|
1889 | - * @access public |
|
1890 | - * |
|
1891 | - * @param string $key Discount data to retrieve |
|
1892 | - * @param mixed $value new value. |
|
1893 | - * @return mixed Value of the given invoice property (if set). |
|
1894 | - */ |
|
1895 | - public function set( $key, $value ) { |
|
1886 | + * Magic method for setting invoice properties. |
|
1887 | + * |
|
1888 | + * @since 1.0.19 |
|
1889 | + * @access public |
|
1890 | + * |
|
1891 | + * @param string $key Discount data to retrieve |
|
1892 | + * @param mixed $value new value. |
|
1893 | + * @return mixed Value of the given invoice property (if set). |
|
1894 | + */ |
|
1895 | + public function set( $key, $value ) { |
|
1896 | 1896 | |
1897 | 1897 | $setter = "set_$key"; |
1898 | 1898 | if ( is_callable( array( $this, $setter ) ) ) { |
1899 | 1899 | $this->{$setter}( $value ); |
1900 | 1900 | } |
1901 | 1901 | |
1902 | - } |
|
1902 | + } |
|
1903 | 1903 | |
1904 | - /** |
|
1905 | - * Sets item status. |
|
1906 | - * |
|
1907 | - * @since 1.0.19 |
|
1908 | - * @param string $new_status New status. |
|
1909 | - * @param string $note Optional note to add. |
|
1910 | - * @param bool $manual_update Is this a manual status change?. |
|
1911 | - * @return array details of change. |
|
1912 | - */ |
|
1913 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1914 | - $old_status = $this->get_status(); |
|
1904 | + /** |
|
1905 | + * Sets item status. |
|
1906 | + * |
|
1907 | + * @since 1.0.19 |
|
1908 | + * @param string $new_status New status. |
|
1909 | + * @param string $note Optional note to add. |
|
1910 | + * @param bool $manual_update Is this a manual status change?. |
|
1911 | + * @return array details of change. |
|
1912 | + */ |
|
1913 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1914 | + $old_status = $this->get_status(); |
|
1915 | 1915 | |
1916 | - $statuses = $this->get_all_statuses(); |
|
1916 | + $statuses = $this->get_all_statuses(); |
|
1917 | 1917 | |
1918 | - if ( isset( $statuses[ 'draft' ] ) ) { |
|
1919 | - unset( $statuses[ 'draft' ] ); |
|
1920 | - } |
|
1918 | + if ( isset( $statuses[ 'draft' ] ) ) { |
|
1919 | + unset( $statuses[ 'draft' ] ); |
|
1920 | + } |
|
1921 | 1921 | |
1922 | - $this->set_prop( 'status', $new_status ); |
|
1922 | + $this->set_prop( 'status', $new_status ); |
|
1923 | 1923 | |
1924 | - // If setting the status, ensure it's set to a valid status. |
|
1925 | - if ( true === $this->object_read ) { |
|
1924 | + // If setting the status, ensure it's set to a valid status. |
|
1925 | + if ( true === $this->object_read ) { |
|
1926 | 1926 | |
1927 | - // Only allow valid new status. |
|
1928 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1929 | - $new_status = $this->get_default_status(); |
|
1930 | - } |
|
1927 | + // Only allow valid new status. |
|
1928 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1929 | + $new_status = $this->get_default_status(); |
|
1930 | + } |
|
1931 | 1931 | |
1932 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1933 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1934 | - $old_status = $this->get_default_status(); |
|
1935 | - } |
|
1932 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1933 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1934 | + $old_status = $this->get_default_status(); |
|
1935 | + } |
|
1936 | 1936 | |
1937 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1938 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1939 | - $old_status = 'wpi-pending'; |
|
1940 | - } |
|
1937 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1938 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1939 | + $old_status = 'wpi-pending'; |
|
1940 | + } |
|
1941 | 1941 | |
1942 | - } |
|
1942 | + } |
|
1943 | 1943 | |
1944 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
1945 | - $this->status_transition = array( |
|
1946 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1947 | - 'to' => $new_status, |
|
1948 | - 'note' => $note, |
|
1949 | - 'manual' => (bool) $manual_update, |
|
1950 | - ); |
|
1944 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
1945 | + $this->status_transition = array( |
|
1946 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1947 | + 'to' => $new_status, |
|
1948 | + 'note' => $note, |
|
1949 | + 'manual' => (bool) $manual_update, |
|
1950 | + ); |
|
1951 | 1951 | |
1952 | - if ( $manual_update ) { |
|
1953 | - do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1954 | - } |
|
1952 | + if ( $manual_update ) { |
|
1953 | + do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1954 | + } |
|
1955 | 1955 | |
1956 | - $this->maybe_set_date_paid(); |
|
1956 | + $this->maybe_set_date_paid(); |
|
1957 | 1957 | |
1958 | - } |
|
1958 | + } |
|
1959 | 1959 | |
1960 | - return array( |
|
1961 | - 'from' => $old_status, |
|
1962 | - 'to' => $new_status, |
|
1963 | - ); |
|
1964 | - } |
|
1960 | + return array( |
|
1961 | + 'from' => $old_status, |
|
1962 | + 'to' => $new_status, |
|
1963 | + ); |
|
1964 | + } |
|
1965 | 1965 | |
1966 | - /** |
|
1967 | - * Maybe set date paid. |
|
1968 | - * |
|
1969 | - * Sets the date paid variable when transitioning to the payment complete |
|
1970 | - * order status. |
|
1971 | - * |
|
1972 | - * @since 1.0.19 |
|
1973 | - */ |
|
1974 | - public function maybe_set_date_paid() { |
|
1966 | + /** |
|
1967 | + * Maybe set date paid. |
|
1968 | + * |
|
1969 | + * Sets the date paid variable when transitioning to the payment complete |
|
1970 | + * order status. |
|
1971 | + * |
|
1972 | + * @since 1.0.19 |
|
1973 | + */ |
|
1974 | + public function maybe_set_date_paid() { |
|
1975 | 1975 | |
1976 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
1977 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
1978 | - } |
|
1979 | - } |
|
1976 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
1977 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
1978 | + } |
|
1979 | + } |
|
1980 | 1980 | |
1981 | 1981 | /** |
1982 | - * Set parent invoice ID. |
|
1983 | - * |
|
1984 | - * @since 1.0.19 |
|
1985 | - */ |
|
1986 | - public function set_parent_id( $value ) { |
|
1987 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
1988 | - return; |
|
1989 | - } |
|
1990 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
1982 | + * Set parent invoice ID. |
|
1983 | + * |
|
1984 | + * @since 1.0.19 |
|
1985 | + */ |
|
1986 | + public function set_parent_id( $value ) { |
|
1987 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
1988 | + return; |
|
1989 | + } |
|
1990 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
1991 | 1991 | } |
1992 | 1992 | |
1993 | 1993 | /** |
1994 | - * Set plugin version when the invoice was created. |
|
1995 | - * |
|
1996 | - * @since 1.0.19 |
|
1997 | - */ |
|
1998 | - public function set_version( $value ) { |
|
1999 | - $this->set_prop( 'version', $value ); |
|
1994 | + * Set plugin version when the invoice was created. |
|
1995 | + * |
|
1996 | + * @since 1.0.19 |
|
1997 | + */ |
|
1998 | + public function set_version( $value ) { |
|
1999 | + $this->set_prop( 'version', $value ); |
|
2000 | 2000 | } |
2001 | - |
|
2002 | - /** |
|
2003 | - * Set date when the invoice was created. |
|
2004 | - * |
|
2005 | - * @since 1.0.19 |
|
2006 | - * @param string $value Value to set. |
|
2001 | + |
|
2002 | + /** |
|
2003 | + * Set date when the invoice was created. |
|
2004 | + * |
|
2005 | + * @since 1.0.19 |
|
2006 | + * @param string $value Value to set. |
|
2007 | 2007 | * @return bool Whether or not the date was set. |
2008 | - */ |
|
2009 | - public function set_date_created( $value ) { |
|
2008 | + */ |
|
2009 | + public function set_date_created( $value ) { |
|
2010 | 2010 | $date = strtotime( $value ); |
2011 | 2011 | |
2012 | 2012 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2014,19 +2014,19 @@ discard block |
||
2014 | 2014 | return true; |
2015 | 2015 | } |
2016 | 2016 | |
2017 | - $this->set_prop( 'date_created', '' ); |
|
2018 | - return false; |
|
2017 | + $this->set_prop( 'date_created', '' ); |
|
2018 | + return false; |
|
2019 | 2019 | |
2020 | 2020 | } |
2021 | 2021 | |
2022 | 2022 | /** |
2023 | - * Set date invoice due date. |
|
2024 | - * |
|
2025 | - * @since 1.0.19 |
|
2026 | - * @param string $value Value to set. |
|
2023 | + * Set date invoice due date. |
|
2024 | + * |
|
2025 | + * @since 1.0.19 |
|
2026 | + * @param string $value Value to set. |
|
2027 | 2027 | * @return bool Whether or not the date was set. |
2028 | - */ |
|
2029 | - public function set_due_date( $value ) { |
|
2028 | + */ |
|
2029 | + public function set_due_date( $value ) { |
|
2030 | 2030 | $date = strtotime( $value ); |
2031 | 2031 | |
2032 | 2032 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2034,29 +2034,29 @@ discard block |
||
2034 | 2034 | return true; |
2035 | 2035 | } |
2036 | 2036 | |
2037 | - $this->set_prop( 'due_date', '' ); |
|
2037 | + $this->set_prop( 'due_date', '' ); |
|
2038 | 2038 | return false; |
2039 | 2039 | |
2040 | 2040 | } |
2041 | 2041 | |
2042 | 2042 | /** |
2043 | - * Alias of self::set_due_date(). |
|
2044 | - * |
|
2045 | - * @since 1.0.19 |
|
2046 | - * @param string $value New name. |
|
2047 | - */ |
|
2048 | - public function set_date_due( $value ) { |
|
2049 | - $this->set_due_date( $value ); |
|
2043 | + * Alias of self::set_due_date(). |
|
2044 | + * |
|
2045 | + * @since 1.0.19 |
|
2046 | + * @param string $value New name. |
|
2047 | + */ |
|
2048 | + public function set_date_due( $value ) { |
|
2049 | + $this->set_due_date( $value ); |
|
2050 | 2050 | } |
2051 | 2051 | |
2052 | 2052 | /** |
2053 | - * Set date invoice was completed. |
|
2054 | - * |
|
2055 | - * @since 1.0.19 |
|
2056 | - * @param string $value Value to set. |
|
2053 | + * Set date invoice was completed. |
|
2054 | + * |
|
2055 | + * @since 1.0.19 |
|
2056 | + * @param string $value Value to set. |
|
2057 | 2057 | * @return bool Whether or not the date was set. |
2058 | - */ |
|
2059 | - public function set_completed_date( $value ) { |
|
2058 | + */ |
|
2059 | + public function set_completed_date( $value ) { |
|
2060 | 2060 | $date = strtotime( $value ); |
2061 | 2061 | |
2062 | 2062 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2064,29 +2064,29 @@ discard block |
||
2064 | 2064 | return true; |
2065 | 2065 | } |
2066 | 2066 | |
2067 | - $this->set_prop( 'completed_date', '' ); |
|
2067 | + $this->set_prop( 'completed_date', '' ); |
|
2068 | 2068 | return false; |
2069 | 2069 | |
2070 | 2070 | } |
2071 | 2071 | |
2072 | 2072 | /** |
2073 | - * Alias of self::set_completed_date(). |
|
2074 | - * |
|
2075 | - * @since 1.0.19 |
|
2076 | - * @param string $value New name. |
|
2077 | - */ |
|
2078 | - public function set_date_completed( $value ) { |
|
2079 | - $this->set_completed_date( $value ); |
|
2073 | + * Alias of self::set_completed_date(). |
|
2074 | + * |
|
2075 | + * @since 1.0.19 |
|
2076 | + * @param string $value New name. |
|
2077 | + */ |
|
2078 | + public function set_date_completed( $value ) { |
|
2079 | + $this->set_completed_date( $value ); |
|
2080 | 2080 | } |
2081 | 2081 | |
2082 | 2082 | /** |
2083 | - * Set date when the invoice was last modified. |
|
2084 | - * |
|
2085 | - * @since 1.0.19 |
|
2086 | - * @param string $value Value to set. |
|
2083 | + * Set date when the invoice was last modified. |
|
2084 | + * |
|
2085 | + * @since 1.0.19 |
|
2086 | + * @param string $value Value to set. |
|
2087 | 2087 | * @return bool Whether or not the date was set. |
2088 | - */ |
|
2089 | - public function set_date_modified( $value ) { |
|
2088 | + */ |
|
2089 | + public function set_date_modified( $value ) { |
|
2090 | 2090 | $date = strtotime( $value ); |
2091 | 2091 | |
2092 | 2092 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2094,763 +2094,763 @@ discard block |
||
2094 | 2094 | return true; |
2095 | 2095 | } |
2096 | 2096 | |
2097 | - $this->set_prop( 'date_modified', '' ); |
|
2097 | + $this->set_prop( 'date_modified', '' ); |
|
2098 | 2098 | return false; |
2099 | 2099 | |
2100 | 2100 | } |
2101 | 2101 | |
2102 | 2102 | /** |
2103 | - * Set the invoice number. |
|
2104 | - * |
|
2105 | - * @since 1.0.19 |
|
2106 | - * @param string $value New number. |
|
2107 | - */ |
|
2108 | - public function set_number( $value ) { |
|
2103 | + * Set the invoice number. |
|
2104 | + * |
|
2105 | + * @since 1.0.19 |
|
2106 | + * @param string $value New number. |
|
2107 | + */ |
|
2108 | + public function set_number( $value ) { |
|
2109 | 2109 | $number = sanitize_text_field( $value ); |
2110 | - $this->set_prop( 'number', $number ); |
|
2110 | + $this->set_prop( 'number', $number ); |
|
2111 | 2111 | } |
2112 | 2112 | |
2113 | 2113 | /** |
2114 | - * Set the invoice type. |
|
2115 | - * |
|
2116 | - * @since 1.0.19 |
|
2117 | - * @param string $value Type. |
|
2118 | - */ |
|
2119 | - public function set_type( $value ) { |
|
2114 | + * Set the invoice type. |
|
2115 | + * |
|
2116 | + * @since 1.0.19 |
|
2117 | + * @param string $value Type. |
|
2118 | + */ |
|
2119 | + public function set_type( $value ) { |
|
2120 | 2120 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
2121 | - $this->set_prop( 'type', $type ); |
|
2122 | - } |
|
2121 | + $this->set_prop( 'type', $type ); |
|
2122 | + } |
|
2123 | 2123 | |
2124 | 2124 | /** |
2125 | - * Set the invoice post type. |
|
2126 | - * |
|
2127 | - * @since 1.0.19 |
|
2128 | - * @param string $value Post type. |
|
2129 | - */ |
|
2130 | - public function set_post_type( $value ) { |
|
2125 | + * Set the invoice post type. |
|
2126 | + * |
|
2127 | + * @since 1.0.19 |
|
2128 | + * @param string $value Post type. |
|
2129 | + */ |
|
2130 | + public function set_post_type( $value ) { |
|
2131 | 2131 | if ( getpaid_is_invoice_post_type( $value ) ) { |
2132 | - $this->set_type( $value ); |
|
2132 | + $this->set_type( $value ); |
|
2133 | 2133 | $this->set_prop( 'post_type', $value ); |
2134 | 2134 | } |
2135 | 2135 | } |
2136 | 2136 | |
2137 | 2137 | /** |
2138 | - * Set the invoice key. |
|
2139 | - * |
|
2140 | - * @since 1.0.19 |
|
2141 | - * @param string $value New key. |
|
2142 | - */ |
|
2143 | - public function set_key( $value ) { |
|
2138 | + * Set the invoice key. |
|
2139 | + * |
|
2140 | + * @since 1.0.19 |
|
2141 | + * @param string $value New key. |
|
2142 | + */ |
|
2143 | + public function set_key( $value ) { |
|
2144 | 2144 | $key = sanitize_text_field( $value ); |
2145 | - $this->set_prop( 'key', $key ); |
|
2145 | + $this->set_prop( 'key', $key ); |
|
2146 | 2146 | } |
2147 | 2147 | |
2148 | 2148 | /** |
2149 | - * Set the invoice mode. |
|
2150 | - * |
|
2151 | - * @since 1.0.19 |
|
2152 | - * @param string $value mode. |
|
2153 | - */ |
|
2154 | - public function set_mode( $value ) { |
|
2149 | + * Set the invoice mode. |
|
2150 | + * |
|
2151 | + * @since 1.0.19 |
|
2152 | + * @param string $value mode. |
|
2153 | + */ |
|
2154 | + public function set_mode( $value ) { |
|
2155 | 2155 | if ( in_array( $value, array( 'live', 'test' ) ) ) { |
2156 | 2156 | $this->set_prop( 'mode', $value ); |
2157 | 2157 | } |
2158 | 2158 | } |
2159 | 2159 | |
2160 | 2160 | /** |
2161 | - * Set the invoice path. |
|
2162 | - * |
|
2163 | - * @since 1.0.19 |
|
2164 | - * @param string $value path. |
|
2165 | - */ |
|
2166 | - public function set_path( $value ) { |
|
2161 | + * Set the invoice path. |
|
2162 | + * |
|
2163 | + * @since 1.0.19 |
|
2164 | + * @param string $value path. |
|
2165 | + */ |
|
2166 | + public function set_path( $value ) { |
|
2167 | 2167 | $this->set_prop( 'path', $value ); |
2168 | 2168 | } |
2169 | 2169 | |
2170 | 2170 | /** |
2171 | - * Set the invoice name. |
|
2172 | - * |
|
2173 | - * @since 1.0.19 |
|
2174 | - * @param string $value New name. |
|
2175 | - */ |
|
2176 | - public function set_name( $value ) { |
|
2171 | + * Set the invoice name. |
|
2172 | + * |
|
2173 | + * @since 1.0.19 |
|
2174 | + * @param string $value New name. |
|
2175 | + */ |
|
2176 | + public function set_name( $value ) { |
|
2177 | 2177 | $name = sanitize_text_field( $value ); |
2178 | - $this->set_prop( 'name', $name ); |
|
2178 | + $this->set_prop( 'name', $name ); |
|
2179 | 2179 | } |
2180 | 2180 | |
2181 | 2181 | /** |
2182 | - * Alias of self::set_name(). |
|
2183 | - * |
|
2184 | - * @since 1.0.19 |
|
2185 | - * @param string $value New name. |
|
2186 | - */ |
|
2187 | - public function set_title( $value ) { |
|
2188 | - $this->set_name( $value ); |
|
2182 | + * Alias of self::set_name(). |
|
2183 | + * |
|
2184 | + * @since 1.0.19 |
|
2185 | + * @param string $value New name. |
|
2186 | + */ |
|
2187 | + public function set_title( $value ) { |
|
2188 | + $this->set_name( $value ); |
|
2189 | 2189 | } |
2190 | 2190 | |
2191 | 2191 | /** |
2192 | - * Set the invoice description. |
|
2193 | - * |
|
2194 | - * @since 1.0.19 |
|
2195 | - * @param string $value New description. |
|
2196 | - */ |
|
2197 | - public function set_description( $value ) { |
|
2192 | + * Set the invoice description. |
|
2193 | + * |
|
2194 | + * @since 1.0.19 |
|
2195 | + * @param string $value New description. |
|
2196 | + */ |
|
2197 | + public function set_description( $value ) { |
|
2198 | 2198 | $description = wp_kses_post( $value ); |
2199 | - $this->set_prop( 'description', $description ); |
|
2199 | + $this->set_prop( 'description', $description ); |
|
2200 | + } |
|
2201 | + |
|
2202 | + /** |
|
2203 | + * Alias of self::set_description(). |
|
2204 | + * |
|
2205 | + * @since 1.0.19 |
|
2206 | + * @param string $value New description. |
|
2207 | + */ |
|
2208 | + public function set_excerpt( $value ) { |
|
2209 | + $this->set_description( $value ); |
|
2210 | + } |
|
2211 | + |
|
2212 | + /** |
|
2213 | + * Alias of self::set_description(). |
|
2214 | + * |
|
2215 | + * @since 1.0.19 |
|
2216 | + * @param string $value New description. |
|
2217 | + */ |
|
2218 | + public function set_summary( $value ) { |
|
2219 | + $this->set_description( $value ); |
|
2200 | 2220 | } |
2201 | 2221 | |
2202 | 2222 | /** |
2203 | - * Alias of self::set_description(). |
|
2204 | - * |
|
2205 | - * @since 1.0.19 |
|
2206 | - * @param string $value New description. |
|
2207 | - */ |
|
2208 | - public function set_excerpt( $value ) { |
|
2209 | - $this->set_description( $value ); |
|
2223 | + * Set the receiver of the invoice. |
|
2224 | + * |
|
2225 | + * @since 1.0.19 |
|
2226 | + * @param int $value New author. |
|
2227 | + */ |
|
2228 | + public function set_author( $value ) { |
|
2229 | + $user = get_user_by( 'id', (int) $value ); |
|
2230 | + |
|
2231 | + if ( $user && $user->ID ) { |
|
2232 | + $this->set_prop( 'author', $user->ID ); |
|
2233 | + $this->set_prop( 'email', $user->user_email ); |
|
2234 | + } |
|
2235 | + |
|
2210 | 2236 | } |
2211 | 2237 | |
2212 | 2238 | /** |
2213 | - * Alias of self::set_description(). |
|
2214 | - * |
|
2215 | - * @since 1.0.19 |
|
2216 | - * @param string $value New description. |
|
2217 | - */ |
|
2218 | - public function set_summary( $value ) { |
|
2219 | - $this->set_description( $value ); |
|
2239 | + * Alias of self::set_author(). |
|
2240 | + * |
|
2241 | + * @since 1.0.19 |
|
2242 | + * @param int $value New user id. |
|
2243 | + */ |
|
2244 | + public function set_user_id( $value ) { |
|
2245 | + $this->set_author( $value ); |
|
2220 | 2246 | } |
2221 | 2247 | |
2222 | 2248 | /** |
2223 | - * Set the receiver of the invoice. |
|
2224 | - * |
|
2225 | - * @since 1.0.19 |
|
2226 | - * @param int $value New author. |
|
2227 | - */ |
|
2228 | - public function set_author( $value ) { |
|
2229 | - $user = get_user_by( 'id', (int) $value ); |
|
2249 | + * Alias of self::set_author(). |
|
2250 | + * |
|
2251 | + * @since 1.0.19 |
|
2252 | + * @param int $value New user id. |
|
2253 | + */ |
|
2254 | + public function set_customer_id( $value ) { |
|
2255 | + $this->set_author( $value ); |
|
2256 | + } |
|
2230 | 2257 | |
2231 | - if ( $user && $user->ID ) { |
|
2232 | - $this->set_prop( 'author', $user->ID ); |
|
2233 | - $this->set_prop( 'email', $user->user_email ); |
|
2234 | - } |
|
2258 | + /** |
|
2259 | + * Set the customer's ip. |
|
2260 | + * |
|
2261 | + * @since 1.0.19 |
|
2262 | + * @param string $value ip address. |
|
2263 | + */ |
|
2264 | + public function set_ip( $value ) { |
|
2265 | + $this->set_prop( 'ip', $value ); |
|
2266 | + } |
|
2235 | 2267 | |
2268 | + /** |
|
2269 | + * Alias of self::set_ip(). |
|
2270 | + * |
|
2271 | + * @since 1.0.19 |
|
2272 | + * @param string $value ip address. |
|
2273 | + */ |
|
2274 | + public function set_user_ip( $value ) { |
|
2275 | + $this->set_ip( $value ); |
|
2236 | 2276 | } |
2237 | 2277 | |
2238 | 2278 | /** |
2239 | - * Alias of self::set_author(). |
|
2240 | - * |
|
2241 | - * @since 1.0.19 |
|
2242 | - * @param int $value New user id. |
|
2243 | - */ |
|
2244 | - public function set_user_id( $value ) { |
|
2245 | - $this->set_author( $value ); |
|
2279 | + * Set the customer's first name. |
|
2280 | + * |
|
2281 | + * @since 1.0.19 |
|
2282 | + * @param string $value first name. |
|
2283 | + */ |
|
2284 | + public function set_first_name( $value ) { |
|
2285 | + $this->set_prop( 'first_name', $value ); |
|
2246 | 2286 | } |
2247 | 2287 | |
2248 | 2288 | /** |
2249 | - * Alias of self::set_author(). |
|
2250 | - * |
|
2251 | - * @since 1.0.19 |
|
2252 | - * @param int $value New user id. |
|
2253 | - */ |
|
2254 | - public function set_customer_id( $value ) { |
|
2255 | - $this->set_author( $value ); |
|
2289 | + * Alias of self::set_first_name(). |
|
2290 | + * |
|
2291 | + * @since 1.0.19 |
|
2292 | + * @param string $value first name. |
|
2293 | + */ |
|
2294 | + public function set_user_first_name( $value ) { |
|
2295 | + $this->set_first_name( $value ); |
|
2256 | 2296 | } |
2257 | 2297 | |
2258 | 2298 | /** |
2259 | - * Set the customer's ip. |
|
2260 | - * |
|
2261 | - * @since 1.0.19 |
|
2262 | - * @param string $value ip address. |
|
2263 | - */ |
|
2264 | - public function set_ip( $value ) { |
|
2265 | - $this->set_prop( 'ip', $value ); |
|
2299 | + * Alias of self::set_first_name(). |
|
2300 | + * |
|
2301 | + * @since 1.0.19 |
|
2302 | + * @param string $value first name. |
|
2303 | + */ |
|
2304 | + public function set_customer_first_name( $value ) { |
|
2305 | + $this->set_first_name( $value ); |
|
2266 | 2306 | } |
2267 | 2307 | |
2268 | 2308 | /** |
2269 | - * Alias of self::set_ip(). |
|
2270 | - * |
|
2271 | - * @since 1.0.19 |
|
2272 | - * @param string $value ip address. |
|
2273 | - */ |
|
2274 | - public function set_user_ip( $value ) { |
|
2275 | - $this->set_ip( $value ); |
|
2309 | + * Set the customer's last name. |
|
2310 | + * |
|
2311 | + * @since 1.0.19 |
|
2312 | + * @param string $value last name. |
|
2313 | + */ |
|
2314 | + public function set_last_name( $value ) { |
|
2315 | + $this->set_prop( 'last_name', $value ); |
|
2276 | 2316 | } |
2277 | 2317 | |
2278 | 2318 | /** |
2279 | - * Set the customer's first name. |
|
2280 | - * |
|
2281 | - * @since 1.0.19 |
|
2282 | - * @param string $value first name. |
|
2283 | - */ |
|
2284 | - public function set_first_name( $value ) { |
|
2285 | - $this->set_prop( 'first_name', $value ); |
|
2319 | + * Alias of self::set_last_name(). |
|
2320 | + * |
|
2321 | + * @since 1.0.19 |
|
2322 | + * @param string $value last name. |
|
2323 | + */ |
|
2324 | + public function set_user_last_name( $value ) { |
|
2325 | + $this->set_last_name( $value ); |
|
2286 | 2326 | } |
2287 | 2327 | |
2288 | 2328 | /** |
2289 | - * Alias of self::set_first_name(). |
|
2290 | - * |
|
2291 | - * @since 1.0.19 |
|
2292 | - * @param string $value first name. |
|
2293 | - */ |
|
2294 | - public function set_user_first_name( $value ) { |
|
2295 | - $this->set_first_name( $value ); |
|
2329 | + * Alias of self::set_last_name(). |
|
2330 | + * |
|
2331 | + * @since 1.0.19 |
|
2332 | + * @param string $value last name. |
|
2333 | + */ |
|
2334 | + public function set_customer_last_name( $value ) { |
|
2335 | + $this->set_last_name( $value ); |
|
2296 | 2336 | } |
2297 | 2337 | |
2298 | 2338 | /** |
2299 | - * Alias of self::set_first_name(). |
|
2300 | - * |
|
2301 | - * @since 1.0.19 |
|
2302 | - * @param string $value first name. |
|
2303 | - */ |
|
2304 | - public function set_customer_first_name( $value ) { |
|
2305 | - $this->set_first_name( $value ); |
|
2339 | + * Set the customer's phone number. |
|
2340 | + * |
|
2341 | + * @since 1.0.19 |
|
2342 | + * @param string $value phone. |
|
2343 | + */ |
|
2344 | + public function set_phone( $value ) { |
|
2345 | + $this->set_prop( 'phone', $value ); |
|
2306 | 2346 | } |
2307 | 2347 | |
2308 | 2348 | /** |
2309 | - * Set the customer's last name. |
|
2310 | - * |
|
2311 | - * @since 1.0.19 |
|
2312 | - * @param string $value last name. |
|
2313 | - */ |
|
2314 | - public function set_last_name( $value ) { |
|
2315 | - $this->set_prop( 'last_name', $value ); |
|
2349 | + * Alias of self::set_phone(). |
|
2350 | + * |
|
2351 | + * @since 1.0.19 |
|
2352 | + * @param string $value phone. |
|
2353 | + */ |
|
2354 | + public function set_user_phone( $value ) { |
|
2355 | + $this->set_phone( $value ); |
|
2316 | 2356 | } |
2317 | 2357 | |
2318 | 2358 | /** |
2319 | - * Alias of self::set_last_name(). |
|
2320 | - * |
|
2321 | - * @since 1.0.19 |
|
2322 | - * @param string $value last name. |
|
2323 | - */ |
|
2324 | - public function set_user_last_name( $value ) { |
|
2325 | - $this->set_last_name( $value ); |
|
2359 | + * Alias of self::set_phone(). |
|
2360 | + * |
|
2361 | + * @since 1.0.19 |
|
2362 | + * @param string $value phone. |
|
2363 | + */ |
|
2364 | + public function set_customer_phone( $value ) { |
|
2365 | + $this->set_phone( $value ); |
|
2326 | 2366 | } |
2327 | 2367 | |
2328 | 2368 | /** |
2329 | - * Alias of self::set_last_name(). |
|
2330 | - * |
|
2331 | - * @since 1.0.19 |
|
2332 | - * @param string $value last name. |
|
2333 | - */ |
|
2334 | - public function set_customer_last_name( $value ) { |
|
2335 | - $this->set_last_name( $value ); |
|
2369 | + * Alias of self::set_phone(). |
|
2370 | + * |
|
2371 | + * @since 1.0.19 |
|
2372 | + * @param string $value phone. |
|
2373 | + */ |
|
2374 | + public function set_phone_number( $value ) { |
|
2375 | + $this->set_phone( $value ); |
|
2336 | 2376 | } |
2337 | 2377 | |
2338 | 2378 | /** |
2339 | - * Set the customer's phone number. |
|
2340 | - * |
|
2341 | - * @since 1.0.19 |
|
2342 | - * @param string $value phone. |
|
2343 | - */ |
|
2344 | - public function set_phone( $value ) { |
|
2345 | - $this->set_prop( 'phone', $value ); |
|
2379 | + * Set the customer's email address. |
|
2380 | + * |
|
2381 | + * @since 1.0.19 |
|
2382 | + * @param string $value email address. |
|
2383 | + */ |
|
2384 | + public function set_email( $value ) { |
|
2385 | + $this->set_prop( 'email', $value ); |
|
2346 | 2386 | } |
2347 | 2387 | |
2348 | 2388 | /** |
2349 | - * Alias of self::set_phone(). |
|
2350 | - * |
|
2351 | - * @since 1.0.19 |
|
2352 | - * @param string $value phone. |
|
2353 | - */ |
|
2354 | - public function set_user_phone( $value ) { |
|
2355 | - $this->set_phone( $value ); |
|
2389 | + * Alias of self::set_email(). |
|
2390 | + * |
|
2391 | + * @since 1.0.19 |
|
2392 | + * @param string $value email address. |
|
2393 | + */ |
|
2394 | + public function set_user_email( $value ) { |
|
2395 | + $this->set_email( $value ); |
|
2356 | 2396 | } |
2357 | 2397 | |
2358 | 2398 | /** |
2359 | - * Alias of self::set_phone(). |
|
2360 | - * |
|
2361 | - * @since 1.0.19 |
|
2362 | - * @param string $value phone. |
|
2363 | - */ |
|
2364 | - public function set_customer_phone( $value ) { |
|
2365 | - $this->set_phone( $value ); |
|
2399 | + * Alias of self::set_email(). |
|
2400 | + * |
|
2401 | + * @since 1.0.19 |
|
2402 | + * @param string $value email address. |
|
2403 | + */ |
|
2404 | + public function set_email_address( $value ) { |
|
2405 | + $this->set_email( $value ); |
|
2366 | 2406 | } |
2367 | 2407 | |
2368 | 2408 | /** |
2369 | - * Alias of self::set_phone(). |
|
2370 | - * |
|
2371 | - * @since 1.0.19 |
|
2372 | - * @param string $value phone. |
|
2373 | - */ |
|
2374 | - public function set_phone_number( $value ) { |
|
2375 | - $this->set_phone( $value ); |
|
2409 | + * Alias of self::set_email(). |
|
2410 | + * |
|
2411 | + * @since 1.0.19 |
|
2412 | + * @param string $value email address. |
|
2413 | + */ |
|
2414 | + public function set_customer_email( $value ) { |
|
2415 | + $this->set_email( $value ); |
|
2376 | 2416 | } |
2377 | 2417 | |
2378 | 2418 | /** |
2379 | - * Set the customer's email address. |
|
2380 | - * |
|
2381 | - * @since 1.0.19 |
|
2382 | - * @param string $value email address. |
|
2383 | - */ |
|
2384 | - public function set_email( $value ) { |
|
2385 | - $this->set_prop( 'email', $value ); |
|
2419 | + * Set the customer's country. |
|
2420 | + * |
|
2421 | + * @since 1.0.19 |
|
2422 | + * @param string $value country. |
|
2423 | + */ |
|
2424 | + public function set_country( $value ) { |
|
2425 | + $this->set_prop( 'country', $value ); |
|
2386 | 2426 | } |
2387 | 2427 | |
2388 | 2428 | /** |
2389 | - * Alias of self::set_email(). |
|
2390 | - * |
|
2391 | - * @since 1.0.19 |
|
2392 | - * @param string $value email address. |
|
2393 | - */ |
|
2394 | - public function set_user_email( $value ) { |
|
2395 | - $this->set_email( $value ); |
|
2429 | + * Alias of self::set_country(). |
|
2430 | + * |
|
2431 | + * @since 1.0.19 |
|
2432 | + * @param string $value country. |
|
2433 | + */ |
|
2434 | + public function set_user_country( $value ) { |
|
2435 | + $this->set_country( $value ); |
|
2396 | 2436 | } |
2397 | 2437 | |
2398 | 2438 | /** |
2399 | - * Alias of self::set_email(). |
|
2400 | - * |
|
2401 | - * @since 1.0.19 |
|
2402 | - * @param string $value email address. |
|
2403 | - */ |
|
2404 | - public function set_email_address( $value ) { |
|
2405 | - $this->set_email( $value ); |
|
2439 | + * Alias of self::set_country(). |
|
2440 | + * |
|
2441 | + * @since 1.0.19 |
|
2442 | + * @param string $value country. |
|
2443 | + */ |
|
2444 | + public function set_customer_country( $value ) { |
|
2445 | + $this->set_country( $value ); |
|
2406 | 2446 | } |
2407 | 2447 | |
2408 | 2448 | /** |
2409 | - * Alias of self::set_email(). |
|
2410 | - * |
|
2411 | - * @since 1.0.19 |
|
2412 | - * @param string $value email address. |
|
2413 | - */ |
|
2414 | - public function set_customer_email( $value ) { |
|
2415 | - $this->set_email( $value ); |
|
2449 | + * Set the customer's state. |
|
2450 | + * |
|
2451 | + * @since 1.0.19 |
|
2452 | + * @param string $value state. |
|
2453 | + */ |
|
2454 | + public function set_state( $value ) { |
|
2455 | + $this->set_prop( 'state', $value ); |
|
2416 | 2456 | } |
2417 | 2457 | |
2418 | 2458 | /** |
2419 | - * Set the customer's country. |
|
2420 | - * |
|
2421 | - * @since 1.0.19 |
|
2422 | - * @param string $value country. |
|
2423 | - */ |
|
2424 | - public function set_country( $value ) { |
|
2425 | - $this->set_prop( 'country', $value ); |
|
2459 | + * Alias of self::set_state(). |
|
2460 | + * |
|
2461 | + * @since 1.0.19 |
|
2462 | + * @param string $value state. |
|
2463 | + */ |
|
2464 | + public function set_user_state( $value ) { |
|
2465 | + $this->set_state( $value ); |
|
2426 | 2466 | } |
2427 | 2467 | |
2428 | 2468 | /** |
2429 | - * Alias of self::set_country(). |
|
2430 | - * |
|
2431 | - * @since 1.0.19 |
|
2432 | - * @param string $value country. |
|
2433 | - */ |
|
2434 | - public function set_user_country( $value ) { |
|
2435 | - $this->set_country( $value ); |
|
2469 | + * Alias of self::set_state(). |
|
2470 | + * |
|
2471 | + * @since 1.0.19 |
|
2472 | + * @param string $value state. |
|
2473 | + */ |
|
2474 | + public function set_customer_state( $value ) { |
|
2475 | + $this->set_state( $value ); |
|
2436 | 2476 | } |
2437 | 2477 | |
2438 | 2478 | /** |
2439 | - * Alias of self::set_country(). |
|
2440 | - * |
|
2441 | - * @since 1.0.19 |
|
2442 | - * @param string $value country. |
|
2443 | - */ |
|
2444 | - public function set_customer_country( $value ) { |
|
2445 | - $this->set_country( $value ); |
|
2479 | + * Set the customer's city. |
|
2480 | + * |
|
2481 | + * @since 1.0.19 |
|
2482 | + * @param string $value city. |
|
2483 | + */ |
|
2484 | + public function set_city( $value ) { |
|
2485 | + $this->set_prop( 'city', $value ); |
|
2446 | 2486 | } |
2447 | 2487 | |
2448 | 2488 | /** |
2449 | - * Set the customer's state. |
|
2450 | - * |
|
2451 | - * @since 1.0.19 |
|
2452 | - * @param string $value state. |
|
2453 | - */ |
|
2454 | - public function set_state( $value ) { |
|
2455 | - $this->set_prop( 'state', $value ); |
|
2489 | + * Alias of self::set_city(). |
|
2490 | + * |
|
2491 | + * @since 1.0.19 |
|
2492 | + * @param string $value city. |
|
2493 | + */ |
|
2494 | + public function set_user_city( $value ) { |
|
2495 | + $this->set_city( $value ); |
|
2456 | 2496 | } |
2457 | 2497 | |
2458 | 2498 | /** |
2459 | - * Alias of self::set_state(). |
|
2460 | - * |
|
2461 | - * @since 1.0.19 |
|
2462 | - * @param string $value state. |
|
2463 | - */ |
|
2464 | - public function set_user_state( $value ) { |
|
2465 | - $this->set_state( $value ); |
|
2499 | + * Alias of self::set_city(). |
|
2500 | + * |
|
2501 | + * @since 1.0.19 |
|
2502 | + * @param string $value city. |
|
2503 | + */ |
|
2504 | + public function set_customer_city( $value ) { |
|
2505 | + $this->set_city( $value ); |
|
2466 | 2506 | } |
2467 | 2507 | |
2468 | 2508 | /** |
2469 | - * Alias of self::set_state(). |
|
2470 | - * |
|
2471 | - * @since 1.0.19 |
|
2472 | - * @param string $value state. |
|
2473 | - */ |
|
2474 | - public function set_customer_state( $value ) { |
|
2475 | - $this->set_state( $value ); |
|
2509 | + * Set the customer's zip code. |
|
2510 | + * |
|
2511 | + * @since 1.0.19 |
|
2512 | + * @param string $value zip. |
|
2513 | + */ |
|
2514 | + public function set_zip( $value ) { |
|
2515 | + $this->set_prop( 'zip', $value ); |
|
2476 | 2516 | } |
2477 | 2517 | |
2478 | 2518 | /** |
2479 | - * Set the customer's city. |
|
2480 | - * |
|
2481 | - * @since 1.0.19 |
|
2482 | - * @param string $value city. |
|
2483 | - */ |
|
2484 | - public function set_city( $value ) { |
|
2485 | - $this->set_prop( 'city', $value ); |
|
2519 | + * Alias of self::set_zip(). |
|
2520 | + * |
|
2521 | + * @since 1.0.19 |
|
2522 | + * @param string $value zip. |
|
2523 | + */ |
|
2524 | + public function set_user_zip( $value ) { |
|
2525 | + $this->set_zip( $value ); |
|
2486 | 2526 | } |
2487 | 2527 | |
2488 | 2528 | /** |
2489 | - * Alias of self::set_city(). |
|
2490 | - * |
|
2491 | - * @since 1.0.19 |
|
2492 | - * @param string $value city. |
|
2493 | - */ |
|
2494 | - public function set_user_city( $value ) { |
|
2495 | - $this->set_city( $value ); |
|
2529 | + * Alias of self::set_zip(). |
|
2530 | + * |
|
2531 | + * @since 1.0.19 |
|
2532 | + * @param string $value zip. |
|
2533 | + */ |
|
2534 | + public function set_customer_zip( $value ) { |
|
2535 | + $this->set_zip( $value ); |
|
2496 | 2536 | } |
2497 | 2537 | |
2498 | 2538 | /** |
2499 | - * Alias of self::set_city(). |
|
2500 | - * |
|
2501 | - * @since 1.0.19 |
|
2502 | - * @param string $value city. |
|
2503 | - */ |
|
2504 | - public function set_customer_city( $value ) { |
|
2505 | - $this->set_city( $value ); |
|
2539 | + * Set the customer's company. |
|
2540 | + * |
|
2541 | + * @since 1.0.19 |
|
2542 | + * @param string $value company. |
|
2543 | + */ |
|
2544 | + public function set_company( $value ) { |
|
2545 | + $this->set_prop( 'company', $value ); |
|
2506 | 2546 | } |
2507 | 2547 | |
2508 | 2548 | /** |
2509 | - * Set the customer's zip code. |
|
2510 | - * |
|
2511 | - * @since 1.0.19 |
|
2512 | - * @param string $value zip. |
|
2513 | - */ |
|
2514 | - public function set_zip( $value ) { |
|
2515 | - $this->set_prop( 'zip', $value ); |
|
2549 | + * Alias of self::set_company(). |
|
2550 | + * |
|
2551 | + * @since 1.0.19 |
|
2552 | + * @param string $value company. |
|
2553 | + */ |
|
2554 | + public function set_user_company( $value ) { |
|
2555 | + $this->set_company( $value ); |
|
2516 | 2556 | } |
2517 | 2557 | |
2518 | 2558 | /** |
2519 | - * Alias of self::set_zip(). |
|
2520 | - * |
|
2521 | - * @since 1.0.19 |
|
2522 | - * @param string $value zip. |
|
2523 | - */ |
|
2524 | - public function set_user_zip( $value ) { |
|
2525 | - $this->set_zip( $value ); |
|
2559 | + * Alias of self::set_company(). |
|
2560 | + * |
|
2561 | + * @since 1.0.19 |
|
2562 | + * @param string $value company. |
|
2563 | + */ |
|
2564 | + public function set_customer_company( $value ) { |
|
2565 | + $this->set_company( $value ); |
|
2526 | 2566 | } |
2527 | 2567 | |
2528 | 2568 | /** |
2529 | - * Alias of self::set_zip(). |
|
2530 | - * |
|
2531 | - * @since 1.0.19 |
|
2532 | - * @param string $value zip. |
|
2533 | - */ |
|
2534 | - public function set_customer_zip( $value ) { |
|
2535 | - $this->set_zip( $value ); |
|
2569 | + * Set the customer's var number. |
|
2570 | + * |
|
2571 | + * @since 1.0.19 |
|
2572 | + * @param string $value var number. |
|
2573 | + */ |
|
2574 | + public function set_vat_number( $value ) { |
|
2575 | + $this->set_prop( 'vat_number', $value ); |
|
2536 | 2576 | } |
2537 | 2577 | |
2538 | 2578 | /** |
2539 | - * Set the customer's company. |
|
2540 | - * |
|
2541 | - * @since 1.0.19 |
|
2542 | - * @param string $value company. |
|
2543 | - */ |
|
2544 | - public function set_company( $value ) { |
|
2545 | - $this->set_prop( 'company', $value ); |
|
2579 | + * Alias of self::set_vat_number(). |
|
2580 | + * |
|
2581 | + * @since 1.0.19 |
|
2582 | + * @param string $value var number. |
|
2583 | + */ |
|
2584 | + public function set_user_vat_number( $value ) { |
|
2585 | + $this->set_vat_number( $value ); |
|
2546 | 2586 | } |
2547 | 2587 | |
2548 | 2588 | /** |
2549 | - * Alias of self::set_company(). |
|
2550 | - * |
|
2551 | - * @since 1.0.19 |
|
2552 | - * @param string $value company. |
|
2553 | - */ |
|
2554 | - public function set_user_company( $value ) { |
|
2555 | - $this->set_company( $value ); |
|
2589 | + * Alias of self::set_vat_number(). |
|
2590 | + * |
|
2591 | + * @since 1.0.19 |
|
2592 | + * @param string $value var number. |
|
2593 | + */ |
|
2594 | + public function set_customer_vat_number( $value ) { |
|
2595 | + $this->set_vat_number( $value ); |
|
2556 | 2596 | } |
2557 | 2597 | |
2558 | 2598 | /** |
2559 | - * Alias of self::set_company(). |
|
2560 | - * |
|
2561 | - * @since 1.0.19 |
|
2562 | - * @param string $value company. |
|
2563 | - */ |
|
2564 | - public function set_customer_company( $value ) { |
|
2565 | - $this->set_company( $value ); |
|
2599 | + * Set the customer's vat rate. |
|
2600 | + * |
|
2601 | + * @since 1.0.19 |
|
2602 | + * @param string $value var rate. |
|
2603 | + */ |
|
2604 | + public function set_vat_rate( $value ) { |
|
2605 | + $this->set_prop( 'vat_rate', $value ); |
|
2566 | 2606 | } |
2567 | 2607 | |
2568 | 2608 | /** |
2569 | - * Set the customer's var number. |
|
2570 | - * |
|
2571 | - * @since 1.0.19 |
|
2572 | - * @param string $value var number. |
|
2573 | - */ |
|
2574 | - public function set_vat_number( $value ) { |
|
2575 | - $this->set_prop( 'vat_number', $value ); |
|
2609 | + * Alias of self::set_vat_rate(). |
|
2610 | + * |
|
2611 | + * @since 1.0.19 |
|
2612 | + * @param string $value var number. |
|
2613 | + */ |
|
2614 | + public function set_user_vat_rate( $value ) { |
|
2615 | + $this->set_vat_rate( $value ); |
|
2576 | 2616 | } |
2577 | 2617 | |
2578 | 2618 | /** |
2579 | - * Alias of self::set_vat_number(). |
|
2580 | - * |
|
2581 | - * @since 1.0.19 |
|
2582 | - * @param string $value var number. |
|
2583 | - */ |
|
2584 | - public function set_user_vat_number( $value ) { |
|
2585 | - $this->set_vat_number( $value ); |
|
2619 | + * Alias of self::set_vat_rate(). |
|
2620 | + * |
|
2621 | + * @since 1.0.19 |
|
2622 | + * @param string $value var number. |
|
2623 | + */ |
|
2624 | + public function set_customer_vat_rate( $value ) { |
|
2625 | + $this->set_vat_rate( $value ); |
|
2586 | 2626 | } |
2587 | 2627 | |
2588 | 2628 | /** |
2589 | - * Alias of self::set_vat_number(). |
|
2590 | - * |
|
2591 | - * @since 1.0.19 |
|
2592 | - * @param string $value var number. |
|
2593 | - */ |
|
2594 | - public function set_customer_vat_number( $value ) { |
|
2595 | - $this->set_vat_number( $value ); |
|
2629 | + * Set the customer's address. |
|
2630 | + * |
|
2631 | + * @since 1.0.19 |
|
2632 | + * @param string $value address. |
|
2633 | + */ |
|
2634 | + public function set_address( $value ) { |
|
2635 | + $this->set_prop( 'address', $value ); |
|
2596 | 2636 | } |
2597 | 2637 | |
2598 | 2638 | /** |
2599 | - * Set the customer's vat rate. |
|
2600 | - * |
|
2601 | - * @since 1.0.19 |
|
2602 | - * @param string $value var rate. |
|
2603 | - */ |
|
2604 | - public function set_vat_rate( $value ) { |
|
2605 | - $this->set_prop( 'vat_rate', $value ); |
|
2639 | + * Alias of self::set_address(). |
|
2640 | + * |
|
2641 | + * @since 1.0.19 |
|
2642 | + * @param string $value address. |
|
2643 | + */ |
|
2644 | + public function set_user_address( $value ) { |
|
2645 | + $this->set_address( $value ); |
|
2606 | 2646 | } |
2607 | 2647 | |
2608 | 2648 | /** |
2609 | - * Alias of self::set_vat_rate(). |
|
2610 | - * |
|
2611 | - * @since 1.0.19 |
|
2612 | - * @param string $value var number. |
|
2613 | - */ |
|
2614 | - public function set_user_vat_rate( $value ) { |
|
2615 | - $this->set_vat_rate( $value ); |
|
2649 | + * Alias of self::set_address(). |
|
2650 | + * |
|
2651 | + * @since 1.0.19 |
|
2652 | + * @param string $value address. |
|
2653 | + */ |
|
2654 | + public function set_customer_address( $value ) { |
|
2655 | + $this->set_address( $value ); |
|
2616 | 2656 | } |
2617 | 2657 | |
2618 | 2658 | /** |
2619 | - * Alias of self::set_vat_rate(). |
|
2620 | - * |
|
2621 | - * @since 1.0.19 |
|
2622 | - * @param string $value var number. |
|
2623 | - */ |
|
2624 | - public function set_customer_vat_rate( $value ) { |
|
2625 | - $this->set_vat_rate( $value ); |
|
2659 | + * Set whether the customer has viewed the invoice or not. |
|
2660 | + * |
|
2661 | + * @since 1.0.19 |
|
2662 | + * @param int|bool $value confirmed. |
|
2663 | + */ |
|
2664 | + public function set_is_viewed( $value ) { |
|
2665 | + $this->set_prop( 'is_viewed', $value ); |
|
2626 | 2666 | } |
2627 | 2667 | |
2628 | 2668 | /** |
2629 | - * Set the customer's address. |
|
2630 | - * |
|
2631 | - * @since 1.0.19 |
|
2632 | - * @param string $value address. |
|
2633 | - */ |
|
2634 | - public function set_address( $value ) { |
|
2635 | - $this->set_prop( 'address', $value ); |
|
2669 | + * Set extra email recipients. |
|
2670 | + * |
|
2671 | + * @since 1.0.19 |
|
2672 | + * @param string $value email recipients. |
|
2673 | + */ |
|
2674 | + public function set_email_cc( $value ) { |
|
2675 | + $this->set_prop( 'email_cc', $value ); |
|
2636 | 2676 | } |
2637 | 2677 | |
2638 | 2678 | /** |
2639 | - * Alias of self::set_address(). |
|
2640 | - * |
|
2641 | - * @since 1.0.19 |
|
2642 | - * @param string $value address. |
|
2643 | - */ |
|
2644 | - public function set_user_address( $value ) { |
|
2645 | - $this->set_address( $value ); |
|
2679 | + * Set the invoice template. |
|
2680 | + * |
|
2681 | + * @since 1.0.19 |
|
2682 | + * @param string $value template. |
|
2683 | + */ |
|
2684 | + public function set_template( $value ) { |
|
2685 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2686 | + $this->set_prop( 'template', $value ); |
|
2687 | + } |
|
2646 | 2688 | } |
2647 | 2689 | |
2648 | 2690 | /** |
2649 | - * Alias of self::set_address(). |
|
2650 | - * |
|
2651 | - * @since 1.0.19 |
|
2652 | - * @param string $value address. |
|
2653 | - */ |
|
2654 | - public function set_customer_address( $value ) { |
|
2655 | - $this->set_address( $value ); |
|
2691 | + * Set the invoice source. |
|
2692 | + * |
|
2693 | + * @since 1.0.19 |
|
2694 | + * @param string $value email recipients. |
|
2695 | + */ |
|
2696 | + public function created_via( $value ) { |
|
2697 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2656 | 2698 | } |
2657 | 2699 | |
2658 | 2700 | /** |
2659 | - * Set whether the customer has viewed the invoice or not. |
|
2660 | - * |
|
2661 | - * @since 1.0.19 |
|
2662 | - * @param int|bool $value confirmed. |
|
2663 | - */ |
|
2664 | - public function set_is_viewed( $value ) { |
|
2665 | - $this->set_prop( 'is_viewed', $value ); |
|
2666 | - } |
|
2667 | - |
|
2668 | - /** |
|
2669 | - * Set extra email recipients. |
|
2670 | - * |
|
2671 | - * @since 1.0.19 |
|
2672 | - * @param string $value email recipients. |
|
2673 | - */ |
|
2674 | - public function set_email_cc( $value ) { |
|
2675 | - $this->set_prop( 'email_cc', $value ); |
|
2676 | - } |
|
2677 | - |
|
2678 | - /** |
|
2679 | - * Set the invoice template. |
|
2680 | - * |
|
2681 | - * @since 1.0.19 |
|
2682 | - * @param string $value template. |
|
2683 | - */ |
|
2684 | - public function set_template( $value ) { |
|
2685 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2686 | - $this->set_prop( 'template', $value ); |
|
2687 | - } |
|
2688 | - } |
|
2689 | - |
|
2690 | - /** |
|
2691 | - * Set the invoice source. |
|
2692 | - * |
|
2693 | - * @since 1.0.19 |
|
2694 | - * @param string $value email recipients. |
|
2695 | - */ |
|
2696 | - public function created_via( $value ) { |
|
2697 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2698 | - } |
|
2699 | - |
|
2700 | - /** |
|
2701 | - * Set the customer's address confirmed status. |
|
2702 | - * |
|
2703 | - * @since 1.0.19 |
|
2704 | - * @param int|bool $value confirmed. |
|
2705 | - */ |
|
2706 | - public function set_address_confirmed( $value ) { |
|
2707 | - $this->set_prop( 'address_confirmed', $value ); |
|
2701 | + * Set the customer's address confirmed status. |
|
2702 | + * |
|
2703 | + * @since 1.0.19 |
|
2704 | + * @param int|bool $value confirmed. |
|
2705 | + */ |
|
2706 | + public function set_address_confirmed( $value ) { |
|
2707 | + $this->set_prop( 'address_confirmed', $value ); |
|
2708 | 2708 | } |
2709 | 2709 | |
2710 | 2710 | /** |
2711 | - * Alias of self::set_address_confirmed(). |
|
2712 | - * |
|
2713 | - * @since 1.0.19 |
|
2714 | - * @param int|bool $value confirmed. |
|
2715 | - */ |
|
2716 | - public function set_user_address_confirmed( $value ) { |
|
2717 | - $this->set_address_confirmed( $value ); |
|
2711 | + * Alias of self::set_address_confirmed(). |
|
2712 | + * |
|
2713 | + * @since 1.0.19 |
|
2714 | + * @param int|bool $value confirmed. |
|
2715 | + */ |
|
2716 | + public function set_user_address_confirmed( $value ) { |
|
2717 | + $this->set_address_confirmed( $value ); |
|
2718 | 2718 | } |
2719 | 2719 | |
2720 | 2720 | /** |
2721 | - * Alias of self::set_address_confirmed(). |
|
2722 | - * |
|
2723 | - * @since 1.0.19 |
|
2724 | - * @param int|bool $value confirmed. |
|
2725 | - */ |
|
2726 | - public function set_customer_address_confirmed( $value ) { |
|
2727 | - $this->set_address_confirmed( $value ); |
|
2721 | + * Alias of self::set_address_confirmed(). |
|
2722 | + * |
|
2723 | + * @since 1.0.19 |
|
2724 | + * @param int|bool $value confirmed. |
|
2725 | + */ |
|
2726 | + public function set_customer_address_confirmed( $value ) { |
|
2727 | + $this->set_address_confirmed( $value ); |
|
2728 | 2728 | } |
2729 | 2729 | |
2730 | 2730 | /** |
2731 | - * Set the invoice sub total. |
|
2732 | - * |
|
2733 | - * @since 1.0.19 |
|
2734 | - * @param float $value sub total. |
|
2735 | - */ |
|
2736 | - public function set_subtotal( $value ) { |
|
2737 | - $this->set_prop( 'subtotal', $value ); |
|
2731 | + * Set the invoice sub total. |
|
2732 | + * |
|
2733 | + * @since 1.0.19 |
|
2734 | + * @param float $value sub total. |
|
2735 | + */ |
|
2736 | + public function set_subtotal( $value ) { |
|
2737 | + $this->set_prop( 'subtotal', $value ); |
|
2738 | 2738 | } |
2739 | 2739 | |
2740 | 2740 | /** |
2741 | - * Set the invoice discount amount. |
|
2742 | - * |
|
2743 | - * @since 1.0.19 |
|
2744 | - * @param float $value discount total. |
|
2745 | - */ |
|
2746 | - public function set_total_discount( $value ) { |
|
2747 | - $this->set_prop( 'total_discount', $value ); |
|
2741 | + * Set the invoice discount amount. |
|
2742 | + * |
|
2743 | + * @since 1.0.19 |
|
2744 | + * @param float $value discount total. |
|
2745 | + */ |
|
2746 | + public function set_total_discount( $value ) { |
|
2747 | + $this->set_prop( 'total_discount', $value ); |
|
2748 | 2748 | } |
2749 | 2749 | |
2750 | 2750 | /** |
2751 | - * Alias of self::set_total_discount(). |
|
2752 | - * |
|
2753 | - * @since 1.0.19 |
|
2754 | - * @param float $value discount total. |
|
2755 | - */ |
|
2756 | - public function set_discount( $value ) { |
|
2757 | - $this->set_total_discount( $value ); |
|
2751 | + * Alias of self::set_total_discount(). |
|
2752 | + * |
|
2753 | + * @since 1.0.19 |
|
2754 | + * @param float $value discount total. |
|
2755 | + */ |
|
2756 | + public function set_discount( $value ) { |
|
2757 | + $this->set_total_discount( $value ); |
|
2758 | 2758 | } |
2759 | 2759 | |
2760 | 2760 | /** |
2761 | - * Set the invoice tax amount. |
|
2762 | - * |
|
2763 | - * @since 1.0.19 |
|
2764 | - * @param float $value tax total. |
|
2765 | - */ |
|
2766 | - public function set_total_tax( $value ) { |
|
2767 | - $this->set_prop( 'total_tax', $value ); |
|
2761 | + * Set the invoice tax amount. |
|
2762 | + * |
|
2763 | + * @since 1.0.19 |
|
2764 | + * @param float $value tax total. |
|
2765 | + */ |
|
2766 | + public function set_total_tax( $value ) { |
|
2767 | + $this->set_prop( 'total_tax', $value ); |
|
2768 | 2768 | } |
2769 | 2769 | |
2770 | 2770 | /** |
2771 | - * Alias of self::set_total_tax(). |
|
2772 | - * |
|
2773 | - * @since 1.0.19 |
|
2774 | - * @param float $value tax total. |
|
2775 | - */ |
|
2776 | - public function set_tax_total( $value ) { |
|
2777 | - $this->set_total_tax( $value ); |
|
2771 | + * Alias of self::set_total_tax(). |
|
2772 | + * |
|
2773 | + * @since 1.0.19 |
|
2774 | + * @param float $value tax total. |
|
2775 | + */ |
|
2776 | + public function set_tax_total( $value ) { |
|
2777 | + $this->set_total_tax( $value ); |
|
2778 | 2778 | } |
2779 | 2779 | |
2780 | 2780 | /** |
2781 | - * Set the invoice fees amount. |
|
2782 | - * |
|
2783 | - * @since 1.0.19 |
|
2784 | - * @param float $value fees total. |
|
2785 | - */ |
|
2786 | - public function set_total_fees( $value ) { |
|
2787 | - $this->set_prop( 'total_fees', $value ); |
|
2781 | + * Set the invoice fees amount. |
|
2782 | + * |
|
2783 | + * @since 1.0.19 |
|
2784 | + * @param float $value fees total. |
|
2785 | + */ |
|
2786 | + public function set_total_fees( $value ) { |
|
2787 | + $this->set_prop( 'total_fees', $value ); |
|
2788 | 2788 | } |
2789 | 2789 | |
2790 | 2790 | /** |
2791 | - * Alias of self::set_total_fees(). |
|
2792 | - * |
|
2793 | - * @since 1.0.19 |
|
2794 | - * @param float $value fees total. |
|
2795 | - */ |
|
2796 | - public function set_fees_total( $value ) { |
|
2797 | - $this->set_total_fees( $value ); |
|
2791 | + * Alias of self::set_total_fees(). |
|
2792 | + * |
|
2793 | + * @since 1.0.19 |
|
2794 | + * @param float $value fees total. |
|
2795 | + */ |
|
2796 | + public function set_fees_total( $value ) { |
|
2797 | + $this->set_total_fees( $value ); |
|
2798 | 2798 | } |
2799 | 2799 | |
2800 | 2800 | /** |
2801 | - * Set the invoice fees. |
|
2802 | - * |
|
2803 | - * @since 1.0.19 |
|
2804 | - * @param array $value fees. |
|
2805 | - */ |
|
2806 | - public function set_fees( $value ) { |
|
2801 | + * Set the invoice fees. |
|
2802 | + * |
|
2803 | + * @since 1.0.19 |
|
2804 | + * @param array $value fees. |
|
2805 | + */ |
|
2806 | + public function set_fees( $value ) { |
|
2807 | 2807 | |
2808 | - if ( ! is_array( $value ) ) { |
|
2809 | - $value = array(); |
|
2810 | - } |
|
2808 | + if ( ! is_array( $value ) ) { |
|
2809 | + $value = array(); |
|
2810 | + } |
|
2811 | 2811 | |
2812 | - $this->set_prop( 'fees', $value ); |
|
2812 | + $this->set_prop( 'fees', $value ); |
|
2813 | 2813 | |
2814 | 2814 | } |
2815 | 2815 | |
2816 | 2816 | /** |
2817 | - * Set the invoice taxes. |
|
2818 | - * |
|
2819 | - * @since 1.0.19 |
|
2820 | - * @param array $value taxes. |
|
2821 | - */ |
|
2822 | - public function set_taxes( $value ) { |
|
2817 | + * Set the invoice taxes. |
|
2818 | + * |
|
2819 | + * @since 1.0.19 |
|
2820 | + * @param array $value taxes. |
|
2821 | + */ |
|
2822 | + public function set_taxes( $value ) { |
|
2823 | 2823 | |
2824 | - if ( ! is_array( $value ) ) { |
|
2825 | - $value = array(); |
|
2826 | - } |
|
2824 | + if ( ! is_array( $value ) ) { |
|
2825 | + $value = array(); |
|
2826 | + } |
|
2827 | 2827 | |
2828 | - $this->set_prop( 'taxes', $value ); |
|
2828 | + $this->set_prop( 'taxes', $value ); |
|
2829 | 2829 | |
2830 | 2830 | } |
2831 | 2831 | |
2832 | 2832 | /** |
2833 | - * Set the invoice discounts. |
|
2834 | - * |
|
2835 | - * @since 1.0.19 |
|
2836 | - * @param array $value discounts. |
|
2837 | - */ |
|
2838 | - public function set_discounts( $value ) { |
|
2833 | + * Set the invoice discounts. |
|
2834 | + * |
|
2835 | + * @since 1.0.19 |
|
2836 | + * @param array $value discounts. |
|
2837 | + */ |
|
2838 | + public function set_discounts( $value ) { |
|
2839 | 2839 | |
2840 | - if ( ! is_array( $value ) ) { |
|
2841 | - $value = array(); |
|
2842 | - } |
|
2840 | + if ( ! is_array( $value ) ) { |
|
2841 | + $value = array(); |
|
2842 | + } |
|
2843 | 2843 | |
2844 | - $this->set_prop( 'discounts', $value ); |
|
2844 | + $this->set_prop( 'discounts', $value ); |
|
2845 | 2845 | } |
2846 | 2846 | |
2847 | 2847 | /** |
2848 | - * Set the invoice items. |
|
2849 | - * |
|
2850 | - * @since 1.0.19 |
|
2851 | - * @param GetPaid_Form_Item[] $value items. |
|
2852 | - */ |
|
2853 | - public function set_items( $value ) { |
|
2848 | + * Set the invoice items. |
|
2849 | + * |
|
2850 | + * @since 1.0.19 |
|
2851 | + * @param GetPaid_Form_Item[] $value items. |
|
2852 | + */ |
|
2853 | + public function set_items( $value ) { |
|
2854 | 2854 | |
2855 | 2855 | // Remove existing items. |
2856 | 2856 | $this->set_prop( 'items', array() ); |
@@ -2867,95 +2867,95 @@ discard block |
||
2867 | 2867 | } |
2868 | 2868 | |
2869 | 2869 | /** |
2870 | - * Set the payment form. |
|
2871 | - * |
|
2872 | - * @since 1.0.19 |
|
2873 | - * @param int $value payment form. |
|
2874 | - */ |
|
2875 | - public function set_payment_form( $value ) { |
|
2876 | - $this->set_prop( 'payment_form', $value ); |
|
2870 | + * Set the payment form. |
|
2871 | + * |
|
2872 | + * @since 1.0.19 |
|
2873 | + * @param int $value payment form. |
|
2874 | + */ |
|
2875 | + public function set_payment_form( $value ) { |
|
2876 | + $this->set_prop( 'payment_form', $value ); |
|
2877 | 2877 | } |
2878 | 2878 | |
2879 | 2879 | /** |
2880 | - * Set the submission id. |
|
2881 | - * |
|
2882 | - * @since 1.0.19 |
|
2883 | - * @param string $value submission id. |
|
2884 | - */ |
|
2885 | - public function set_submission_id( $value ) { |
|
2886 | - $this->set_prop( 'submission_id', $value ); |
|
2880 | + * Set the submission id. |
|
2881 | + * |
|
2882 | + * @since 1.0.19 |
|
2883 | + * @param string $value submission id. |
|
2884 | + */ |
|
2885 | + public function set_submission_id( $value ) { |
|
2886 | + $this->set_prop( 'submission_id', $value ); |
|
2887 | 2887 | } |
2888 | 2888 | |
2889 | 2889 | /** |
2890 | - * Set the discount code. |
|
2891 | - * |
|
2892 | - * @since 1.0.19 |
|
2893 | - * @param string $value discount code. |
|
2894 | - */ |
|
2895 | - public function set_discount_code( $value ) { |
|
2896 | - $this->set_prop( 'discount_code', $value ); |
|
2890 | + * Set the discount code. |
|
2891 | + * |
|
2892 | + * @since 1.0.19 |
|
2893 | + * @param string $value discount code. |
|
2894 | + */ |
|
2895 | + public function set_discount_code( $value ) { |
|
2896 | + $this->set_prop( 'discount_code', $value ); |
|
2897 | 2897 | } |
2898 | 2898 | |
2899 | 2899 | /** |
2900 | - * Set the gateway. |
|
2901 | - * |
|
2902 | - * @since 1.0.19 |
|
2903 | - * @param string $value gateway. |
|
2904 | - */ |
|
2905 | - public function set_gateway( $value ) { |
|
2906 | - $this->set_prop( 'gateway', $value ); |
|
2900 | + * Set the gateway. |
|
2901 | + * |
|
2902 | + * @since 1.0.19 |
|
2903 | + * @param string $value gateway. |
|
2904 | + */ |
|
2905 | + public function set_gateway( $value ) { |
|
2906 | + $this->set_prop( 'gateway', $value ); |
|
2907 | 2907 | } |
2908 | 2908 | |
2909 | 2909 | /** |
2910 | - * Set the transaction id. |
|
2911 | - * |
|
2912 | - * @since 1.0.19 |
|
2913 | - * @param string $value transaction id. |
|
2914 | - */ |
|
2915 | - public function set_transaction_id( $value ) { |
|
2916 | - if ( ! empty( $value ) ) { |
|
2917 | - $this->set_prop( 'transaction_id', $value ); |
|
2918 | - } |
|
2910 | + * Set the transaction id. |
|
2911 | + * |
|
2912 | + * @since 1.0.19 |
|
2913 | + * @param string $value transaction id. |
|
2914 | + */ |
|
2915 | + public function set_transaction_id( $value ) { |
|
2916 | + if ( ! empty( $value ) ) { |
|
2917 | + $this->set_prop( 'transaction_id', $value ); |
|
2918 | + } |
|
2919 | 2919 | } |
2920 | 2920 | |
2921 | 2921 | /** |
2922 | - * Set the currency id. |
|
2923 | - * |
|
2924 | - * @since 1.0.19 |
|
2925 | - * @param string $value currency id. |
|
2926 | - */ |
|
2927 | - public function set_currency( $value ) { |
|
2928 | - $this->set_prop( 'currency', $value ); |
|
2922 | + * Set the currency id. |
|
2923 | + * |
|
2924 | + * @since 1.0.19 |
|
2925 | + * @param string $value currency id. |
|
2926 | + */ |
|
2927 | + public function set_currency( $value ) { |
|
2928 | + $this->set_prop( 'currency', $value ); |
|
2929 | 2929 | } |
2930 | 2930 | |
2931 | - /** |
|
2932 | - * Set whether to disable taxes. |
|
2933 | - * |
|
2934 | - * @since 1.0.19 |
|
2935 | - * @param bool $value value. |
|
2936 | - */ |
|
2937 | - public function set_disable_taxes( $value ) { |
|
2938 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
2939 | - } |
|
2931 | + /** |
|
2932 | + * Set whether to disable taxes. |
|
2933 | + * |
|
2934 | + * @since 1.0.19 |
|
2935 | + * @param bool $value value. |
|
2936 | + */ |
|
2937 | + public function set_disable_taxes( $value ) { |
|
2938 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
2939 | + } |
|
2940 | 2940 | |
2941 | 2941 | /** |
2942 | - * Set the subscription id. |
|
2943 | - * |
|
2944 | - * @since 1.0.19 |
|
2945 | - * @param string $value subscription id. |
|
2946 | - */ |
|
2947 | - public function set_subscription_id( $value ) { |
|
2948 | - $this->set_prop( 'subscription_id', $value ); |
|
2949 | - } |
|
2942 | + * Set the subscription id. |
|
2943 | + * |
|
2944 | + * @since 1.0.19 |
|
2945 | + * @param string $value subscription id. |
|
2946 | + */ |
|
2947 | + public function set_subscription_id( $value ) { |
|
2948 | + $this->set_prop( 'subscription_id', $value ); |
|
2949 | + } |
|
2950 | 2950 | |
2951 | - /** |
|
2952 | - * Set the remote subscription id. |
|
2953 | - * |
|
2954 | - * @since 1.0.19 |
|
2955 | - * @param string $value subscription id. |
|
2956 | - */ |
|
2957 | - public function set_remote_subscription_id( $value ) { |
|
2958 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
2951 | + /** |
|
2952 | + * Set the remote subscription id. |
|
2953 | + * |
|
2954 | + * @since 1.0.19 |
|
2955 | + * @param string $value subscription id. |
|
2956 | + */ |
|
2957 | + public function set_remote_subscription_id( $value ) { |
|
2958 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
2959 | 2959 | } |
2960 | 2960 | |
2961 | 2961 | /* |
@@ -2994,24 +2994,24 @@ discard block |
||
2994 | 2994 | */ |
2995 | 2995 | public function is_taxable() { |
2996 | 2996 | return ! $this->get_disable_taxes(); |
2997 | - } |
|
2997 | + } |
|
2998 | 2998 | |
2999 | - /** |
|
3000 | - * @deprecated |
|
3001 | - */ |
|
3002 | - public function has_vat() { |
|
2999 | + /** |
|
3000 | + * @deprecated |
|
3001 | + */ |
|
3002 | + public function has_vat() { |
|
3003 | 3003 | return $this->is_taxable(); |
3004 | - } |
|
3004 | + } |
|
3005 | 3005 | |
3006 | - /** |
|
3007 | - * Checks to see if the invoice requires payment. |
|
3008 | - */ |
|
3009 | - public function is_free() { |
|
3006 | + /** |
|
3007 | + * Checks to see if the invoice requires payment. |
|
3008 | + */ |
|
3009 | + public function is_free() { |
|
3010 | 3010 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
3011 | 3011 | |
3012 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3013 | - $is_free = false; |
|
3014 | - } |
|
3012 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3013 | + $is_free = false; |
|
3014 | + } |
|
3015 | 3015 | |
3016 | 3016 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
3017 | 3017 | } |
@@ -3022,46 +3022,46 @@ discard block |
||
3022 | 3022 | public function is_paid() { |
3023 | 3023 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
3024 | 3024 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
3025 | - } |
|
3025 | + } |
|
3026 | 3026 | |
3027 | - /** |
|
3027 | + /** |
|
3028 | 3028 | * Checks if the invoice needs payment. |
3029 | 3029 | */ |
3030 | - public function needs_payment() { |
|
3031 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3030 | + public function needs_payment() { |
|
3031 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3032 | 3032 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
3033 | 3033 | } |
3034 | 3034 | |
3035 | - /** |
|
3035 | + /** |
|
3036 | 3036 | * Checks if the invoice is refunded. |
3037 | 3037 | */ |
3038 | - public function is_refunded() { |
|
3038 | + public function is_refunded() { |
|
3039 | 3039 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
3040 | 3040 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
3041 | - } |
|
3041 | + } |
|
3042 | 3042 | |
3043 | - /** |
|
3043 | + /** |
|
3044 | 3044 | * Checks if the invoice is held. |
3045 | 3045 | */ |
3046 | - public function is_held() { |
|
3046 | + public function is_held() { |
|
3047 | 3047 | $is_held = $this->has_status( 'wpi-onhold' ); |
3048 | 3048 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
3049 | - } |
|
3049 | + } |
|
3050 | 3050 | |
3051 | - /** |
|
3051 | + /** |
|
3052 | 3052 | * Checks if the invoice is due. |
3053 | 3053 | */ |
3054 | - public function is_due() { |
|
3055 | - $due_date = $this->get_due_date(); |
|
3056 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3057 | - } |
|
3054 | + public function is_due() { |
|
3055 | + $due_date = $this->get_due_date(); |
|
3056 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3057 | + } |
|
3058 | 3058 | |
3059 | - /** |
|
3059 | + /** |
|
3060 | 3060 | * Checks if the invoice is draft. |
3061 | 3061 | */ |
3062 | - public function is_draft() { |
|
3062 | + public function is_draft() { |
|
3063 | 3063 | return $this->has_status( 'draft, auto-draft' ); |
3064 | - } |
|
3064 | + } |
|
3065 | 3065 | |
3066 | 3066 | /** |
3067 | 3067 | * Checks if the invoice has a given status. |
@@ -3069,9 +3069,9 @@ discard block |
||
3069 | 3069 | public function has_status( $status ) { |
3070 | 3070 | $status = wpinv_parse_list( $status ); |
3071 | 3071 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
3072 | - } |
|
3072 | + } |
|
3073 | 3073 | |
3074 | - /** |
|
3074 | + /** |
|
3075 | 3075 | * Checks if the invoice is of a given type. |
3076 | 3076 | */ |
3077 | 3077 | public function is_type( $type ) { |
@@ -3094,25 +3094,25 @@ discard block |
||
3094 | 3094 | */ |
3095 | 3095 | public function has_free_trial() { |
3096 | 3096 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
3097 | - } |
|
3097 | + } |
|
3098 | 3098 | |
3099 | - /** |
|
3099 | + /** |
|
3100 | 3100 | * @deprecated |
3101 | 3101 | */ |
3102 | 3102 | public function is_free_trial() { |
3103 | 3103 | $this->has_free_trial(); |
3104 | 3104 | } |
3105 | 3105 | |
3106 | - /** |
|
3106 | + /** |
|
3107 | 3107 | * Check if the initial payment if 0. |
3108 | 3108 | * |
3109 | 3109 | */ |
3110 | - public function is_initial_free() { |
|
3110 | + public function is_initial_free() { |
|
3111 | 3111 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
3112 | 3112 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
3113 | 3113 | } |
3114 | 3114 | |
3115 | - /** |
|
3115 | + /** |
|
3116 | 3116 | * Check if the recurring item has a free trial. |
3117 | 3117 | * |
3118 | 3118 | */ |
@@ -3125,21 +3125,21 @@ discard block |
||
3125 | 3125 | |
3126 | 3126 | $item = $this->get_recurring( true ); |
3127 | 3127 | return $item->has_free_trial(); |
3128 | - } |
|
3128 | + } |
|
3129 | 3129 | |
3130 | - /** |
|
3130 | + /** |
|
3131 | 3131 | * Check if the free trial is a result of a discount. |
3132 | 3132 | */ |
3133 | 3133 | public function is_free_trial_from_discount() { |
3134 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3135 | - } |
|
3134 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3135 | + } |
|
3136 | 3136 | |
3137 | - /** |
|
3137 | + /** |
|
3138 | 3138 | * @deprecated |
3139 | 3139 | */ |
3140 | 3140 | public function discount_first_payment_only() { |
3141 | 3141 | |
3142 | - $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3142 | + $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3143 | 3143 | if ( ! $discount->exists() || ! $this->is_recurring() ) { |
3144 | 3144 | return true; |
3145 | 3145 | } |
@@ -3164,28 +3164,28 @@ discard block |
||
3164 | 3164 | */ |
3165 | 3165 | public function add_item( $item ) { |
3166 | 3166 | |
3167 | - if ( is_array( $item ) ) { |
|
3168 | - $item = $this->process_array_item( $item ); |
|
3169 | - } |
|
3167 | + if ( is_array( $item ) ) { |
|
3168 | + $item = $this->process_array_item( $item ); |
|
3169 | + } |
|
3170 | 3170 | |
3171 | - if ( is_numeric( $item ) ) { |
|
3172 | - $item = new GetPaid_Form_Item( $item ); |
|
3173 | - } |
|
3171 | + if ( is_numeric( $item ) ) { |
|
3172 | + $item = new GetPaid_Form_Item( $item ); |
|
3173 | + } |
|
3174 | 3174 | |
3175 | 3175 | // Make sure that it is available for purchase. |
3176 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3177 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3176 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3177 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3178 | 3178 | } |
3179 | 3179 | |
3180 | 3180 | // Do we have a recurring item? |
3181 | - if ( $item->is_recurring() ) { |
|
3181 | + if ( $item->is_recurring() ) { |
|
3182 | 3182 | |
3183 | - // An invoice can only contain one recurring item. |
|
3184 | - if ( ! empty( $this->recurring_item && $this->recurring_item != (int) $item->get_id() ) ) { |
|
3185 | - return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
3186 | - } |
|
3183 | + // An invoice can only contain one recurring item. |
|
3184 | + if ( ! empty( $this->recurring_item && $this->recurring_item != (int) $item->get_id() ) ) { |
|
3185 | + return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
3186 | + } |
|
3187 | 3187 | |
3188 | - $this->recurring_item = $item->get_id(); |
|
3188 | + $this->recurring_item = $item->get_id(); |
|
3189 | 3189 | } |
3190 | 3190 | |
3191 | 3191 | // Invoice id. |
@@ -3196,60 +3196,60 @@ discard block |
||
3196 | 3196 | $items[ (int) $item->get_id() ] = $item; |
3197 | 3197 | |
3198 | 3198 | $this->set_prop( 'items', $items ); |
3199 | - return true; |
|
3200 | - } |
|
3199 | + return true; |
|
3200 | + } |
|
3201 | 3201 | |
3202 | - /** |
|
3203 | - * Converts an array to an item. |
|
3204 | - * |
|
3205 | - * @since 1.0.19 |
|
3206 | - * @return GetPaid_Form_Item |
|
3207 | - */ |
|
3208 | - protected function process_array_item( $array ) { |
|
3202 | + /** |
|
3203 | + * Converts an array to an item. |
|
3204 | + * |
|
3205 | + * @since 1.0.19 |
|
3206 | + * @return GetPaid_Form_Item |
|
3207 | + */ |
|
3208 | + protected function process_array_item( $array ) { |
|
3209 | 3209 | |
3210 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3211 | - $item = new GetPaid_Form_Item( $item_id ); |
|
3210 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3211 | + $item = new GetPaid_Form_Item( $item_id ); |
|
3212 | 3212 | |
3213 | - // Set item data. |
|
3214 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3215 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
3216 | - $method = "set_$key"; |
|
3217 | - $item->$method( $array[ "item_$key" ] ); |
|
3218 | - } |
|
3219 | - } |
|
3213 | + // Set item data. |
|
3214 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3215 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
3216 | + $method = "set_$key"; |
|
3217 | + $item->$method( $array[ "item_$key" ] ); |
|
3218 | + } |
|
3219 | + } |
|
3220 | 3220 | |
3221 | - if ( isset( $array['quantity'] ) ) { |
|
3222 | - $item->set_quantity( $array['quantity'] ); |
|
3223 | - } |
|
3221 | + if ( isset( $array['quantity'] ) ) { |
|
3222 | + $item->set_quantity( $array['quantity'] ); |
|
3223 | + } |
|
3224 | 3224 | |
3225 | - // Set item meta. |
|
3226 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3227 | - $item->set_item_meta( $array['meta'] ); |
|
3228 | - } |
|
3225 | + // Set item meta. |
|
3226 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3227 | + $item->set_item_meta( $array['meta'] ); |
|
3228 | + } |
|
3229 | 3229 | |
3230 | - return $item; |
|
3230 | + return $item; |
|
3231 | 3231 | |
3232 | - } |
|
3232 | + } |
|
3233 | 3233 | |
3234 | 3234 | /** |
3235 | - * Retrieves a specific item. |
|
3236 | - * |
|
3237 | - * @since 1.0.19 |
|
3238 | - */ |
|
3239 | - public function get_item( $item_id ) { |
|
3240 | - $items = $this->get_items(); |
|
3241 | - $item_id = (int) $item_id; |
|
3242 | - return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null; |
|
3235 | + * Retrieves a specific item. |
|
3236 | + * |
|
3237 | + * @since 1.0.19 |
|
3238 | + */ |
|
3239 | + public function get_item( $item_id ) { |
|
3240 | + $items = $this->get_items(); |
|
3241 | + $item_id = (int) $item_id; |
|
3242 | + return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null; |
|
3243 | 3243 | } |
3244 | 3244 | |
3245 | 3245 | /** |
3246 | - * Removes a specific item. |
|
3247 | - * |
|
3248 | - * @since 1.0.19 |
|
3249 | - */ |
|
3250 | - public function remove_item( $item_id ) { |
|
3251 | - $items = $this->get_items(); |
|
3252 | - $item_id = (int) $item_id; |
|
3246 | + * Removes a specific item. |
|
3247 | + * |
|
3248 | + * @since 1.0.19 |
|
3249 | + */ |
|
3250 | + public function remove_item( $item_id ) { |
|
3251 | + $items = $this->get_items(); |
|
3252 | + $item_id = (int) $item_id; |
|
3253 | 3253 | |
3254 | 3254 | if ( $item_id == $this->recurring_item ) { |
3255 | 3255 | $this->recurring_item = null; |
@@ -3262,35 +3262,35 @@ discard block |
||
3262 | 3262 | } |
3263 | 3263 | |
3264 | 3264 | /** |
3265 | - * Adds a fee to the invoice. |
|
3266 | - * |
|
3267 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3268 | - * @since 1.0.19 |
|
3269 | - */ |
|
3265 | + * Adds a fee to the invoice. |
|
3266 | + * |
|
3267 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3268 | + * @since 1.0.19 |
|
3269 | + */ |
|
3270 | 3270 | public function add_fee( $fee ) { |
3271 | 3271 | |
3272 | - $fees = $this->get_fees(); |
|
3273 | - $fees[ $fee['name'] ] = $fee; |
|
3274 | - $this->set_prop( 'fees', $fees ); |
|
3272 | + $fees = $this->get_fees(); |
|
3273 | + $fees[ $fee['name'] ] = $fee; |
|
3274 | + $this->set_prop( 'fees', $fees ); |
|
3275 | 3275 | |
3276 | 3276 | } |
3277 | 3277 | |
3278 | 3278 | /** |
3279 | - * Retrieves a specific fee. |
|
3280 | - * |
|
3281 | - * @since 1.0.19 |
|
3282 | - */ |
|
3283 | - public function get_fee( $fee ) { |
|
3279 | + * Retrieves a specific fee. |
|
3280 | + * |
|
3281 | + * @since 1.0.19 |
|
3282 | + */ |
|
3283 | + public function get_fee( $fee ) { |
|
3284 | 3284 | $fees = $this->get_fees(); |
3285 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3285 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3286 | 3286 | } |
3287 | 3287 | |
3288 | 3288 | /** |
3289 | - * Removes a specific fee. |
|
3290 | - * |
|
3291 | - * @since 1.0.19 |
|
3292 | - */ |
|
3293 | - public function remove_fee( $fee ) { |
|
3289 | + * Removes a specific fee. |
|
3290 | + * |
|
3291 | + * @since 1.0.19 |
|
3292 | + */ |
|
3293 | + public function remove_fee( $fee ) { |
|
3294 | 3294 | $fees = $this->get_fees(); |
3295 | 3295 | if ( isset( $fees[ $fee ] ) ) { |
3296 | 3296 | unset( $fees[ $fee ] ); |
@@ -3298,43 +3298,43 @@ discard block |
||
3298 | 3298 | } |
3299 | 3299 | } |
3300 | 3300 | |
3301 | - /** |
|
3302 | - * Adds a discount to the invoice. |
|
3303 | - * |
|
3304 | - * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
3305 | - * @since 1.0.19 |
|
3306 | - */ |
|
3307 | - public function add_discount( $discount ) { |
|
3301 | + /** |
|
3302 | + * Adds a discount to the invoice. |
|
3303 | + * |
|
3304 | + * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
3305 | + * @since 1.0.19 |
|
3306 | + */ |
|
3307 | + public function add_discount( $discount ) { |
|
3308 | 3308 | |
3309 | - $discounts = $this->get_discounts(); |
|
3310 | - $discounts[ $discount['name'] ] = $discount; |
|
3311 | - $this->set_prop( 'discounts', $discounts ); |
|
3309 | + $discounts = $this->get_discounts(); |
|
3310 | + $discounts[ $discount['name'] ] = $discount; |
|
3311 | + $this->set_prop( 'discounts', $discounts ); |
|
3312 | 3312 | |
3313 | - } |
|
3313 | + } |
|
3314 | 3314 | |
3315 | 3315 | /** |
3316 | - * Retrieves a specific discount. |
|
3317 | - * |
|
3318 | - * @since 1.0.19 |
|
3319 | - * @return float |
|
3320 | - */ |
|
3321 | - public function get_discount( $discount = false ) { |
|
3316 | + * Retrieves a specific discount. |
|
3317 | + * |
|
3318 | + * @since 1.0.19 |
|
3319 | + * @return float |
|
3320 | + */ |
|
3321 | + public function get_discount( $discount = false ) { |
|
3322 | 3322 | |
3323 | - // Backwards compatibilty. |
|
3324 | - if ( empty( $discount ) ) { |
|
3325 | - return $this->get_total_discount(); |
|
3326 | - } |
|
3323 | + // Backwards compatibilty. |
|
3324 | + if ( empty( $discount ) ) { |
|
3325 | + return $this->get_total_discount(); |
|
3326 | + } |
|
3327 | 3327 | |
3328 | 3328 | $discounts = $this->get_discounts(); |
3329 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3329 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3330 | 3330 | } |
3331 | 3331 | |
3332 | 3332 | /** |
3333 | - * Removes a specific discount. |
|
3334 | - * |
|
3335 | - * @since 1.0.19 |
|
3336 | - */ |
|
3337 | - public function remove_discount( $discount ) { |
|
3333 | + * Removes a specific discount. |
|
3334 | + * |
|
3335 | + * @since 1.0.19 |
|
3336 | + */ |
|
3337 | + public function remove_discount( $discount ) { |
|
3338 | 3338 | $discounts = $this->get_discounts(); |
3339 | 3339 | if ( isset( $discounts[ $discount ] ) ) { |
3340 | 3340 | unset( $discounts[ $discount ] ); |
@@ -3351,34 +3351,34 @@ discard block |
||
3351 | 3351 | if ( $this->is_taxable() ) { |
3352 | 3352 | |
3353 | 3353 | $taxes = $this->get_taxes(); |
3354 | - $taxes[ $tax['name'] ] = $tax; |
|
3355 | - $this->set_prop( 'taxes', $tax ); |
|
3354 | + $taxes[ $tax['name'] ] = $tax; |
|
3355 | + $this->set_prop( 'taxes', $tax ); |
|
3356 | 3356 | |
3357 | 3357 | } |
3358 | 3358 | } |
3359 | 3359 | |
3360 | 3360 | /** |
3361 | - * Retrieves a specific tax. |
|
3362 | - * |
|
3363 | - * @since 1.0.19 |
|
3364 | - */ |
|
3365 | - public function get_tax( $tax = null ) { |
|
3361 | + * Retrieves a specific tax. |
|
3362 | + * |
|
3363 | + * @since 1.0.19 |
|
3364 | + */ |
|
3365 | + public function get_tax( $tax = null ) { |
|
3366 | 3366 | |
3367 | - // Backwards compatility. |
|
3368 | - if ( empty( $tax ) ) { |
|
3369 | - return $this->get_total_tax(); |
|
3370 | - } |
|
3367 | + // Backwards compatility. |
|
3368 | + if ( empty( $tax ) ) { |
|
3369 | + return $this->get_total_tax(); |
|
3370 | + } |
|
3371 | 3371 | |
3372 | 3372 | $taxes = $this->get_taxes(); |
3373 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3373 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3374 | 3374 | } |
3375 | 3375 | |
3376 | 3376 | /** |
3377 | - * Removes a specific tax. |
|
3378 | - * |
|
3379 | - * @since 1.0.19 |
|
3380 | - */ |
|
3381 | - public function remove_tax( $tax ) { |
|
3377 | + * Removes a specific tax. |
|
3378 | + * |
|
3379 | + * @since 1.0.19 |
|
3380 | + */ |
|
3381 | + public function remove_tax( $tax ) { |
|
3382 | 3382 | $taxes = $this->get_taxes(); |
3383 | 3383 | if ( isset( $taxes[ $tax ] ) ) { |
3384 | 3384 | unset( $taxes[ $tax ] ); |
@@ -3387,134 +3387,134 @@ discard block |
||
3387 | 3387 | } |
3388 | 3388 | |
3389 | 3389 | /** |
3390 | - * Recalculates the invoice subtotal. |
|
3391 | - * |
|
3392 | - * @since 1.0.19 |
|
3393 | - * @return float The recalculated subtotal |
|
3394 | - */ |
|
3395 | - public function recalculate_subtotal() { |
|
3390 | + * Recalculates the invoice subtotal. |
|
3391 | + * |
|
3392 | + * @since 1.0.19 |
|
3393 | + * @return float The recalculated subtotal |
|
3394 | + */ |
|
3395 | + public function recalculate_subtotal() { |
|
3396 | 3396 | $items = $this->get_items(); |
3397 | - $subtotal = 0; |
|
3398 | - $recurring = 0; |
|
3397 | + $subtotal = 0; |
|
3398 | + $recurring = 0; |
|
3399 | 3399 | |
3400 | 3400 | foreach ( $items as $item ) { |
3401 | - $subtotal += $item->get_sub_total(); |
|
3402 | - $recurring += $item->get_recurring_sub_total(); |
|
3401 | + $subtotal += $item->get_sub_total(); |
|
3402 | + $recurring += $item->get_recurring_sub_total(); |
|
3403 | 3403 | } |
3404 | 3404 | |
3405 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3406 | - $this->set_subtotal( $current ); |
|
3405 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3406 | + $this->set_subtotal( $current ); |
|
3407 | 3407 | |
3408 | - $this->totals['subtotal'] = array( |
|
3409 | - 'initial' => $subtotal, |
|
3410 | - 'recurring' => $recurring, |
|
3411 | - ); |
|
3408 | + $this->totals['subtotal'] = array( |
|
3409 | + 'initial' => $subtotal, |
|
3410 | + 'recurring' => $recurring, |
|
3411 | + ); |
|
3412 | 3412 | |
3413 | 3413 | return $current; |
3414 | 3414 | } |
3415 | 3415 | |
3416 | 3416 | /** |
3417 | - * Recalculates the invoice discount total. |
|
3418 | - * |
|
3419 | - * @since 1.0.19 |
|
3420 | - * @return float The recalculated discount |
|
3421 | - */ |
|
3422 | - public function recalculate_total_discount() { |
|
3417 | + * Recalculates the invoice discount total. |
|
3418 | + * |
|
3419 | + * @since 1.0.19 |
|
3420 | + * @return float The recalculated discount |
|
3421 | + */ |
|
3422 | + public function recalculate_total_discount() { |
|
3423 | 3423 | $discounts = $this->get_discounts(); |
3424 | - $discount = 0; |
|
3425 | - $recurring = 0; |
|
3424 | + $discount = 0; |
|
3425 | + $recurring = 0; |
|
3426 | 3426 | |
3427 | 3427 | foreach ( $discounts as $data ) { |
3428 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3429 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3430 | - } |
|
3428 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3429 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3430 | + } |
|
3431 | 3431 | |
3432 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
3432 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
3433 | 3433 | |
3434 | - $this->set_total_discount( $current ); |
|
3434 | + $this->set_total_discount( $current ); |
|
3435 | 3435 | |
3436 | - $this->totals['discount'] = array( |
|
3437 | - 'initial' => $discount, |
|
3438 | - 'recurring' => $recurring, |
|
3439 | - ); |
|
3436 | + $this->totals['discount'] = array( |
|
3437 | + 'initial' => $discount, |
|
3438 | + 'recurring' => $recurring, |
|
3439 | + ); |
|
3440 | 3440 | |
3441 | - return $current; |
|
3441 | + return $current; |
|
3442 | 3442 | |
3443 | 3443 | } |
3444 | 3444 | |
3445 | 3445 | /** |
3446 | - * Recalculates the invoice tax total. |
|
3447 | - * |
|
3448 | - * @since 1.0.19 |
|
3449 | - * @return float The recalculated tax |
|
3450 | - */ |
|
3451 | - public function recalculate_total_tax() { |
|
3446 | + * Recalculates the invoice tax total. |
|
3447 | + * |
|
3448 | + * @since 1.0.19 |
|
3449 | + * @return float The recalculated tax |
|
3450 | + */ |
|
3451 | + public function recalculate_total_tax() { |
|
3452 | 3452 | $taxes = $this->get_taxes(); |
3453 | - $tax = 0; |
|
3454 | - $recurring = 0; |
|
3453 | + $tax = 0; |
|
3454 | + $recurring = 0; |
|
3455 | 3455 | |
3456 | 3456 | foreach ( $taxes as $data ) { |
3457 | - $tax += wpinv_sanitize_amount( $data['initial_tax'] ); |
|
3458 | - $recurring += wpinv_sanitize_amount( $data['recurring_tax'] ); |
|
3459 | - } |
|
3457 | + $tax += wpinv_sanitize_amount( $data['initial_tax'] ); |
|
3458 | + $recurring += wpinv_sanitize_amount( $data['recurring_tax'] ); |
|
3459 | + } |
|
3460 | 3460 | |
3461 | - $current = $this->is_renewal() ? $recurring : $tax; |
|
3462 | - $this->set_total_tax( $current ); |
|
3461 | + $current = $this->is_renewal() ? $recurring : $tax; |
|
3462 | + $this->set_total_tax( $current ); |
|
3463 | 3463 | |
3464 | - $this->totals['tax'] = array( |
|
3465 | - 'initial' => $tax, |
|
3466 | - 'recurring' => $recurring, |
|
3467 | - ); |
|
3464 | + $this->totals['tax'] = array( |
|
3465 | + 'initial' => $tax, |
|
3466 | + 'recurring' => $recurring, |
|
3467 | + ); |
|
3468 | 3468 | |
3469 | - return $current; |
|
3469 | + return $current; |
|
3470 | 3470 | |
3471 | 3471 | } |
3472 | 3472 | |
3473 | 3473 | /** |
3474 | - * Recalculates the invoice fees total. |
|
3475 | - * |
|
3476 | - * @since 1.0.19 |
|
3477 | - * @return float The recalculated fee |
|
3478 | - */ |
|
3479 | - public function recalculate_total_fees() { |
|
3480 | - $fees = $this->get_fees(); |
|
3481 | - $fee = 0; |
|
3482 | - $recurring = 0; |
|
3474 | + * Recalculates the invoice fees total. |
|
3475 | + * |
|
3476 | + * @since 1.0.19 |
|
3477 | + * @return float The recalculated fee |
|
3478 | + */ |
|
3479 | + public function recalculate_total_fees() { |
|
3480 | + $fees = $this->get_fees(); |
|
3481 | + $fee = 0; |
|
3482 | + $recurring = 0; |
|
3483 | 3483 | |
3484 | 3484 | foreach ( $fees as $data ) { |
3485 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3486 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3487 | - } |
|
3485 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3486 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3487 | + } |
|
3488 | 3488 | |
3489 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
3490 | - $this->set_total_fees( $current ); |
|
3489 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
3490 | + $this->set_total_fees( $current ); |
|
3491 | 3491 | |
3492 | - $this->totals['fee'] = array( |
|
3493 | - 'initial' => $fee, |
|
3494 | - 'recurring' => $recurring, |
|
3495 | - ); |
|
3492 | + $this->totals['fee'] = array( |
|
3493 | + 'initial' => $fee, |
|
3494 | + 'recurring' => $recurring, |
|
3495 | + ); |
|
3496 | 3496 | |
3497 | 3497 | $this->set_total_fees( $fee ); |
3498 | 3498 | return $current; |
3499 | 3499 | } |
3500 | 3500 | |
3501 | 3501 | /** |
3502 | - * Recalculates the invoice total. |
|
3503 | - * |
|
3504 | - * @since 1.0.19 |
|
3502 | + * Recalculates the invoice total. |
|
3503 | + * |
|
3504 | + * @since 1.0.19 |
|
3505 | 3505 | * @return float The invoice total |
3506 | - */ |
|
3507 | - public function recalculate_total() { |
|
3506 | + */ |
|
3507 | + public function recalculate_total() { |
|
3508 | 3508 | $this->recalculate_subtotal(); |
3509 | 3509 | $this->recalculate_total_fees(); |
3510 | 3510 | $this->recalculate_total_discount(); |
3511 | 3511 | $this->recalculate_total_tax(); |
3512 | - return $this->get_total(); |
|
3513 | - } |
|
3512 | + return $this->get_total(); |
|
3513 | + } |
|
3514 | 3514 | |
3515 | - /** |
|
3516 | - * @deprecated |
|
3517 | - */ |
|
3515 | + /** |
|
3516 | + * @deprecated |
|
3517 | + */ |
|
3518 | 3518 | public function recalculate_totals() { |
3519 | 3519 | $this->recalculate_total(); |
3520 | 3520 | $this->save( true ); |
@@ -3532,7 +3532,7 @@ discard block |
||
3532 | 3532 | * Adds a note to an invoice. |
3533 | 3533 | * |
3534 | 3534 | * @param string $note The note being added. |
3535 | - * @return int|false The new note's ID on success, false on failure. |
|
3535 | + * @return int|false The new note's ID on success, false on failure. |
|
3536 | 3536 | * |
3537 | 3537 | */ |
3538 | 3538 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3542,21 +3542,21 @@ discard block |
||
3542 | 3542 | return false; |
3543 | 3543 | } |
3544 | 3544 | |
3545 | - $author = 'System'; |
|
3546 | - $author_email = '[email protected]'; |
|
3545 | + $author = 'System'; |
|
3546 | + $author_email = '[email protected]'; |
|
3547 | 3547 | |
3548 | - // If this is an admin comment or it has been added by the user. |
|
3549 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3550 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
3548 | + // If this is an admin comment or it has been added by the user. |
|
3549 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3550 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
3551 | 3551 | $author = $user->display_name; |
3552 | 3552 | $author_email = $user->user_email; |
3553 | - } |
|
3553 | + } |
|
3554 | 3554 | |
3555 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3555 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3556 | 3556 | |
3557 | - } |
|
3557 | + } |
|
3558 | 3558 | |
3559 | - /** |
|
3559 | + /** |
|
3560 | 3560 | * Generates a unique key for the invoice. |
3561 | 3561 | */ |
3562 | 3562 | public function generate_key( $string = '' ) { |
@@ -3576,113 +3576,113 @@ discard block |
||
3576 | 3576 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
3577 | 3577 | } |
3578 | 3578 | |
3579 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3580 | - |
|
3581 | - } |
|
3582 | - |
|
3583 | - /** |
|
3584 | - * Handle the status transition. |
|
3585 | - */ |
|
3586 | - protected function status_transition() { |
|
3587 | - $status_transition = $this->status_transition; |
|
3588 | - |
|
3589 | - // Reset status transition variable. |
|
3590 | - $this->status_transition = false; |
|
3591 | - |
|
3592 | - if ( $status_transition ) { |
|
3593 | - try { |
|
3579 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3594 | 3580 | |
3595 | - // Fire a hook for the status change. |
|
3596 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3597 | - |
|
3598 | - // @deprecated this is deprecated and will be removed in the future. |
|
3599 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3600 | - |
|
3601 | - if ( ! empty( $status_transition['from'] ) ) { |
|
3602 | - |
|
3603 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
3604 | - $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'], $this ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3605 | - |
|
3606 | - // Fire another hook. |
|
3607 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3608 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3609 | - |
|
3610 | - // @deprecated this is deprecated and will be removed in the future. |
|
3611 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3612 | - |
|
3613 | - // Note the transition occurred. |
|
3614 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3615 | - |
|
3616 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3617 | - if ( |
|
3618 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3619 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3620 | - ) { |
|
3621 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3622 | - } |
|
3623 | - |
|
3624 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3625 | - if ( |
|
3626 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3627 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3628 | - ) { |
|
3629 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3630 | - } |
|
3631 | - } else { |
|
3632 | - /* translators: %s: new invoice status */ |
|
3633 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3634 | - |
|
3635 | - // Note the transition occurred. |
|
3636 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3581 | + } |
|
3637 | 3582 | |
3638 | - } |
|
3639 | - } catch ( Exception $e ) { |
|
3640 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3641 | - } |
|
3642 | - } |
|
3643 | - } |
|
3583 | + /** |
|
3584 | + * Handle the status transition. |
|
3585 | + */ |
|
3586 | + protected function status_transition() { |
|
3587 | + $status_transition = $this->status_transition; |
|
3588 | + |
|
3589 | + // Reset status transition variable. |
|
3590 | + $this->status_transition = false; |
|
3591 | + |
|
3592 | + if ( $status_transition ) { |
|
3593 | + try { |
|
3594 | + |
|
3595 | + // Fire a hook for the status change. |
|
3596 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3597 | + |
|
3598 | + // @deprecated this is deprecated and will be removed in the future. |
|
3599 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3600 | + |
|
3601 | + if ( ! empty( $status_transition['from'] ) ) { |
|
3602 | + |
|
3603 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
3604 | + $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'], $this ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3605 | + |
|
3606 | + // Fire another hook. |
|
3607 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3608 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3609 | + |
|
3610 | + // @deprecated this is deprecated and will be removed in the future. |
|
3611 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3612 | + |
|
3613 | + // Note the transition occurred. |
|
3614 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3615 | + |
|
3616 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3617 | + if ( |
|
3618 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3619 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3620 | + ) { |
|
3621 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3622 | + } |
|
3623 | + |
|
3624 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3625 | + if ( |
|
3626 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3627 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3628 | + ) { |
|
3629 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3630 | + } |
|
3631 | + } else { |
|
3632 | + /* translators: %s: new invoice status */ |
|
3633 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3634 | + |
|
3635 | + // Note the transition occurred. |
|
3636 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3637 | + |
|
3638 | + } |
|
3639 | + } catch ( Exception $e ) { |
|
3640 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3641 | + } |
|
3642 | + } |
|
3643 | + } |
|
3644 | 3644 | |
3645 | - /** |
|
3646 | - * Updates an invoice status. |
|
3647 | - */ |
|
3648 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3645 | + /** |
|
3646 | + * Updates an invoice status. |
|
3647 | + */ |
|
3648 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3649 | 3649 | |
3650 | - // Fires before updating a status. |
|
3651 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3650 | + // Fires before updating a status. |
|
3651 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3652 | 3652 | |
3653 | - // Update the status. |
|
3654 | - $this->set_status( $new_status, $note, $manual ); |
|
3653 | + // Update the status. |
|
3654 | + $this->set_status( $new_status, $note, $manual ); |
|
3655 | 3655 | |
3656 | - // Save the order. |
|
3657 | - return $this->save(); |
|
3656 | + // Save the order. |
|
3657 | + return $this->save(); |
|
3658 | 3658 | |
3659 | - } |
|
3659 | + } |
|
3660 | 3660 | |
3661 | - /** |
|
3662 | - * @deprecated |
|
3663 | - */ |
|
3664 | - public function refresh_item_ids() { |
|
3661 | + /** |
|
3662 | + * @deprecated |
|
3663 | + */ |
|
3664 | + public function refresh_item_ids() { |
|
3665 | 3665 | $item_ids = implode( ',', array_unique( array_keys( $this->get_items() ) ) ); |
3666 | 3666 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
3667 | - } |
|
3667 | + } |
|
3668 | 3668 | |
3669 | - /** |
|
3670 | - * @deprecated |
|
3671 | - */ |
|
3672 | - public function update_items( $temp = false ) { |
|
3669 | + /** |
|
3670 | + * @deprecated |
|
3671 | + */ |
|
3672 | + public function update_items( $temp = false ) { |
|
3673 | 3673 | |
3674 | - $this->set_items( $this->get_items() ); |
|
3674 | + $this->set_items( $this->get_items() ); |
|
3675 | 3675 | |
3676 | - if ( ! $temp ) { |
|
3677 | - $this->save(); |
|
3678 | - } |
|
3676 | + if ( ! $temp ) { |
|
3677 | + $this->save(); |
|
3678 | + } |
|
3679 | 3679 | |
3680 | 3680 | return $this; |
3681 | - } |
|
3681 | + } |
|
3682 | 3682 | |
3683 | - /** |
|
3684 | - * @deprecated |
|
3685 | - */ |
|
3683 | + /** |
|
3684 | + * @deprecated |
|
3685 | + */ |
|
3686 | 3686 | public function validate_discount() { |
3687 | 3687 | |
3688 | 3688 | $discount_code = $this->get_discount_code(); |
@@ -3698,97 +3698,97 @@ discard block |
||
3698 | 3698 | |
3699 | 3699 | } |
3700 | 3700 | |
3701 | - /** |
|
3702 | - * Refunds an invoice. |
|
3703 | - */ |
|
3701 | + /** |
|
3702 | + * Refunds an invoice. |
|
3703 | + */ |
|
3704 | 3704 | public function refund() { |
3705 | - $this->set_status( 'wpi-refunded' ); |
|
3705 | + $this->set_status( 'wpi-refunded' ); |
|
3706 | 3706 | $this->save(); |
3707 | - } |
|
3707 | + } |
|
3708 | 3708 | |
3709 | - /** |
|
3710 | - * Marks an invoice as paid. |
|
3711 | - * |
|
3712 | - * @param string $transaction_id |
|
3713 | - */ |
|
3709 | + /** |
|
3710 | + * Marks an invoice as paid. |
|
3711 | + * |
|
3712 | + * @param string $transaction_id |
|
3713 | + */ |
|
3714 | 3714 | public function mark_paid( $transaction_id = null, $note = '' ) { |
3715 | 3715 | |
3716 | - // Set the transaction id. |
|
3717 | - if ( empty( $transaction_id ) ) { |
|
3718 | - $transaction_id = $this->generate_key('trans_'); |
|
3719 | - } |
|
3716 | + // Set the transaction id. |
|
3717 | + if ( empty( $transaction_id ) ) { |
|
3718 | + $transaction_id = $this->generate_key('trans_'); |
|
3719 | + } |
|
3720 | 3720 | |
3721 | - if ( ! $this->get_transaction_id() ) { |
|
3722 | - $this->set_transaction_id( $transaction_id ); |
|
3723 | - } |
|
3721 | + if ( ! $this->get_transaction_id() ) { |
|
3722 | + $this->set_transaction_id( $transaction_id ); |
|
3723 | + } |
|
3724 | 3724 | |
3725 | - if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3726 | - return $this->save(); |
|
3727 | - } |
|
3725 | + if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3726 | + return $this->save(); |
|
3727 | + } |
|
3728 | 3728 | |
3729 | - // Set the completed date. |
|
3730 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
3729 | + // Set the completed date. |
|
3730 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
3731 | 3731 | |
3732 | - // Set the new status. |
|
3733 | - if ( $this->is_renewal() ) { |
|
3732 | + // Set the new status. |
|
3733 | + if ( $this->is_renewal() ) { |
|
3734 | 3734 | |
3735 | - $_note = sprintf( |
|
3736 | - __( 'Renewed via %s', 'invoicing' ), |
|
3737 | - $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
3738 | - ); |
|
3735 | + $_note = sprintf( |
|
3736 | + __( 'Renewed via %s', 'invoicing' ), |
|
3737 | + $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
3738 | + ); |
|
3739 | 3739 | |
3740 | - if ( 'none' == $this->get_gateway() ) { |
|
3741 | - $_note = $note; |
|
3742 | - } |
|
3740 | + if ( 'none' == $this->get_gateway() ) { |
|
3741 | + $_note = $note; |
|
3742 | + } |
|
3743 | 3743 | |
3744 | - $this->set_status( 'wpi-renewal', $_note ); |
|
3744 | + $this->set_status( 'wpi-renewal', $_note ); |
|
3745 | 3745 | |
3746 | - } else { |
|
3746 | + } else { |
|
3747 | 3747 | |
3748 | - $_note = sprintf( |
|
3749 | - __( 'Paid via %s', 'invoicing' ), |
|
3750 | - $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
3751 | - ); |
|
3748 | + $_note = sprintf( |
|
3749 | + __( 'Paid via %s', 'invoicing' ), |
|
3750 | + $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
3751 | + ); |
|
3752 | 3752 | |
3753 | - if ( 'none' == $this->get_gateway() ) { |
|
3754 | - $_note = $note; |
|
3755 | - } |
|
3753 | + if ( 'none' == $this->get_gateway() ) { |
|
3754 | + $_note = $note; |
|
3755 | + } |
|
3756 | 3756 | |
3757 | - $this->set_status( 'publish',$_note ); |
|
3757 | + $this->set_status( 'publish',$_note ); |
|
3758 | 3758 | |
3759 | - } |
|
3759 | + } |
|
3760 | 3760 | |
3761 | - // Set checkout mode. |
|
3762 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3763 | - $this->set_mode( $mode ); |
|
3761 | + // Set checkout mode. |
|
3762 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3763 | + $this->set_mode( $mode ); |
|
3764 | 3764 | |
3765 | - // Save the invoice. |
|
3765 | + // Save the invoice. |
|
3766 | 3766 | $this->save(); |
3767 | - } |
|
3768 | - |
|
3769 | - |
|
3770 | - /** |
|
3771 | - * Save data to the database. |
|
3772 | - * |
|
3773 | - * @since 1.0.19 |
|
3774 | - * @return int invoice ID |
|
3775 | - */ |
|
3776 | - public function save() { |
|
3777 | - $this->maybe_set_date_paid(); |
|
3778 | - $this->maybe_set_key(); |
|
3779 | - parent::save(); |
|
3780 | - $this->clear_cache(); |
|
3781 | - $this->status_transition(); |
|
3782 | - return $this->get_id(); |
|
3783 | - } |
|
3784 | - |
|
3785 | - /** |
|
3767 | + } |
|
3768 | + |
|
3769 | + |
|
3770 | + /** |
|
3771 | + * Save data to the database. |
|
3772 | + * |
|
3773 | + * @since 1.0.19 |
|
3774 | + * @return int invoice ID |
|
3775 | + */ |
|
3776 | + public function save() { |
|
3777 | + $this->maybe_set_date_paid(); |
|
3778 | + $this->maybe_set_key(); |
|
3779 | + parent::save(); |
|
3780 | + $this->clear_cache(); |
|
3781 | + $this->status_transition(); |
|
3782 | + return $this->get_id(); |
|
3783 | + } |
|
3784 | + |
|
3785 | + /** |
|
3786 | 3786 | * Clears the subscription's cache. |
3787 | 3787 | */ |
3788 | 3788 | public function clear_cache() { |
3789 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3790 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3791 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3792 | - } |
|
3789 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3790 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3791 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3792 | + } |
|
3793 | 3793 | |
3794 | 3794 | } |
@@ -17,28 +17,28 @@ discard block |
||
17 | 17 | */ |
18 | 18 | function getpaid_get_subscriptions( $args = array(), $return = 'results' ) { |
19 | 19 | |
20 | - // Do not retrieve all fields if we just want the count. |
|
21 | - if ( 'count' == $return ) { |
|
22 | - $args['fields'] = 'id'; |
|
23 | - $args['number'] = 1; |
|
24 | - } |
|
20 | + // Do not retrieve all fields if we just want the count. |
|
21 | + if ( 'count' == $return ) { |
|
22 | + $args['fields'] = 'id'; |
|
23 | + $args['number'] = 1; |
|
24 | + } |
|
25 | 25 | |
26 | - // Do not count all matches if we just want the results. |
|
27 | - if ( 'results' == $return ) { |
|
28 | - $args['count_total'] = false; |
|
29 | - } |
|
26 | + // Do not count all matches if we just want the results. |
|
27 | + if ( 'results' == $return ) { |
|
28 | + $args['count_total'] = false; |
|
29 | + } |
|
30 | 30 | |
31 | - $query = new GetPaid_Subscriptions_Query( $args ); |
|
31 | + $query = new GetPaid_Subscriptions_Query( $args ); |
|
32 | 32 | |
33 | - if ( 'results' == $return ) { |
|
34 | - return $query->get_results(); |
|
35 | - } |
|
33 | + if ( 'results' == $return ) { |
|
34 | + return $query->get_results(); |
|
35 | + } |
|
36 | 36 | |
37 | - if ( 'count' == $return ) { |
|
38 | - return $query->get_total(); |
|
39 | - } |
|
37 | + if ( 'count' == $return ) { |
|
38 | + return $query->get_total(); |
|
39 | + } |
|
40 | 40 | |
41 | - return $query; |
|
41 | + return $query; |
|
42 | 42 | } |
43 | 43 | |
44 | 44 | /** |
@@ -48,18 +48,18 @@ discard block |
||
48 | 48 | */ |
49 | 49 | function getpaid_get_subscription_statuses() { |
50 | 50 | |
51 | - return apply_filters( |
|
52 | - 'getpaid_get_subscription_statuses', |
|
53 | - array( |
|
54 | - 'pending' => __( 'Pending', 'invoicing' ), |
|
55 | - 'trialling' => __( 'Trialing', 'invoicing' ), |
|
56 | - 'active' => __( 'Active', 'invoicing' ), |
|
57 | - 'failing' => __( 'Failing', 'invoicing' ), |
|
58 | - 'expired' => __( 'Expired', 'invoicing' ), |
|
59 | - 'completed' => __( 'Complete', 'invoicing' ), |
|
60 | - 'cancelled' => __( 'Cancelled', 'invoicing' ), |
|
61 | - ) |
|
62 | - ); |
|
51 | + return apply_filters( |
|
52 | + 'getpaid_get_subscription_statuses', |
|
53 | + array( |
|
54 | + 'pending' => __( 'Pending', 'invoicing' ), |
|
55 | + 'trialling' => __( 'Trialing', 'invoicing' ), |
|
56 | + 'active' => __( 'Active', 'invoicing' ), |
|
57 | + 'failing' => __( 'Failing', 'invoicing' ), |
|
58 | + 'expired' => __( 'Expired', 'invoicing' ), |
|
59 | + 'completed' => __( 'Complete', 'invoicing' ), |
|
60 | + 'cancelled' => __( 'Cancelled', 'invoicing' ), |
|
61 | + ) |
|
62 | + ); |
|
63 | 63 | |
64 | 64 | } |
65 | 65 | |
@@ -69,8 +69,8 @@ discard block |
||
69 | 69 | * @return string |
70 | 70 | */ |
71 | 71 | function getpaid_get_subscription_status_label( $status ) { |
72 | - $statuses = getpaid_get_subscription_statuses(); |
|
73 | - return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
72 | + $statuses = getpaid_get_subscription_statuses(); |
|
73 | + return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
74 | 74 | } |
75 | 75 | |
76 | 76 | /** |
@@ -80,18 +80,18 @@ discard block |
||
80 | 80 | */ |
81 | 81 | function getpaid_get_subscription_status_classes() { |
82 | 82 | |
83 | - return apply_filters( |
|
84 | - 'getpaid_get_subscription_status_classes', |
|
85 | - array( |
|
86 | - 'pending' => 'badge-dark', |
|
87 | - 'trialling' => 'badge-info', |
|
88 | - 'active' => 'badge-success', |
|
89 | - 'failing' => 'badge-warning', |
|
90 | - 'expired' => 'badge-danger', |
|
91 | - 'completed' => 'badge-primary', |
|
92 | - 'cancelled' => 'badge-secondary', |
|
93 | - ) |
|
94 | - ); |
|
83 | + return apply_filters( |
|
84 | + 'getpaid_get_subscription_status_classes', |
|
85 | + array( |
|
86 | + 'pending' => 'badge-dark', |
|
87 | + 'trialling' => 'badge-info', |
|
88 | + 'active' => 'badge-success', |
|
89 | + 'failing' => 'badge-warning', |
|
90 | + 'expired' => 'badge-danger', |
|
91 | + 'completed' => 'badge-primary', |
|
92 | + 'cancelled' => 'badge-secondary', |
|
93 | + ) |
|
94 | + ); |
|
95 | 95 | |
96 | 96 | } |
97 | 97 | |
@@ -102,15 +102,15 @@ discard block |
||
102 | 102 | */ |
103 | 103 | function getpaid_get_subscription_status_counts( $args = array() ) { |
104 | 104 | |
105 | - $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
106 | - $counts = array(); |
|
105 | + $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
106 | + $counts = array(); |
|
107 | 107 | |
108 | - foreach ( $statuses as $status ) { |
|
109 | - $_args = wp_parse_args( "status=$status", $args ); |
|
110 | - $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' ); |
|
111 | - } |
|
108 | + foreach ( $statuses as $status ) { |
|
109 | + $_args = wp_parse_args( "status=$status", $args ); |
|
110 | + $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' ); |
|
111 | + } |
|
112 | 112 | |
113 | - return $counts; |
|
113 | + return $counts; |
|
114 | 114 | |
115 | 115 | } |
116 | 116 | |
@@ -121,32 +121,32 @@ discard block |
||
121 | 121 | */ |
122 | 122 | function getpaid_get_subscription_periods() { |
123 | 123 | |
124 | - return apply_filters( |
|
125 | - 'getpaid_get_subscription_periods', |
|
126 | - array( |
|
124 | + return apply_filters( |
|
125 | + 'getpaid_get_subscription_periods', |
|
126 | + array( |
|
127 | 127 | |
128 | - 'day' => array( |
|
129 | - 'singular' => __( '%s day', 'invoicing' ), |
|
130 | - 'plural' => __( '%d days', 'invoicing' ), |
|
131 | - ), |
|
128 | + 'day' => array( |
|
129 | + 'singular' => __( '%s day', 'invoicing' ), |
|
130 | + 'plural' => __( '%d days', 'invoicing' ), |
|
131 | + ), |
|
132 | 132 | |
133 | - 'week' => array( |
|
134 | - 'singular' => __( '%s week', 'invoicing' ), |
|
135 | - 'plural' => __( '%d weeks', 'invoicing' ), |
|
136 | - ), |
|
133 | + 'week' => array( |
|
134 | + 'singular' => __( '%s week', 'invoicing' ), |
|
135 | + 'plural' => __( '%d weeks', 'invoicing' ), |
|
136 | + ), |
|
137 | 137 | |
138 | - 'month' => array( |
|
139 | - 'singular' => __( '%s month', 'invoicing' ), |
|
140 | - 'plural' => __( '%d months', 'invoicing' ), |
|
141 | - ), |
|
138 | + 'month' => array( |
|
139 | + 'singular' => __( '%s month', 'invoicing' ), |
|
140 | + 'plural' => __( '%d months', 'invoicing' ), |
|
141 | + ), |
|
142 | 142 | |
143 | - 'year' => array( |
|
144 | - 'singular' => __( '%s year', 'invoicing' ), |
|
145 | - 'plural' => __( '%d years', 'invoicing' ), |
|
146 | - ), |
|
143 | + 'year' => array( |
|
144 | + 'singular' => __( '%s year', 'invoicing' ), |
|
145 | + 'plural' => __( '%d years', 'invoicing' ), |
|
146 | + ), |
|
147 | 147 | |
148 | - ) |
|
149 | - ); |
|
148 | + ) |
|
149 | + ); |
|
150 | 150 | |
151 | 151 | } |
152 | 152 | |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | * @return int |
158 | 158 | */ |
159 | 159 | function getpaid_get_subscription_trial_period_interval( $trial_period ) { |
160 | - return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
160 | + return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
161 | 161 | } |
162 | 162 | |
163 | 163 | /** |
@@ -167,7 +167,7 @@ discard block |
||
167 | 167 | * @return string |
168 | 168 | */ |
169 | 169 | function getpaid_get_subscription_trial_period_period( $trial_period ) { |
170 | - return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
170 | + return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
171 | 171 | } |
172 | 172 | |
173 | 173 | /** |
@@ -178,8 +178,8 @@ discard block |
||
178 | 178 | * @return string |
179 | 179 | */ |
180 | 180 | function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) { |
181 | - $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix ); |
|
182 | - return strtolower( sanitize_text_field( $label ) ); |
|
181 | + $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix ); |
|
182 | + return strtolower( sanitize_text_field( $label ) ); |
|
183 | 183 | } |
184 | 184 | |
185 | 185 | /** |
@@ -190,22 +190,22 @@ discard block |
||
190 | 190 | */ |
191 | 191 | function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) { |
192 | 192 | |
193 | - $periods = getpaid_get_subscription_periods(); |
|
194 | - $period = strtolower( $period ); |
|
193 | + $periods = getpaid_get_subscription_periods(); |
|
194 | + $period = strtolower( $period ); |
|
195 | 195 | |
196 | - if ( isset( $periods[ $period ] ) ) { |
|
197 | - return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
198 | - } |
|
196 | + if ( isset( $periods[ $period ] ) ) { |
|
197 | + return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
198 | + } |
|
199 | 199 | |
200 | - // Backwards compatibility. |
|
201 | - foreach ( $periods as $key => $data ) { |
|
202 | - if ( strpos( $key, $period ) === 0 ) { |
|
203 | - return sprintf( $data['singular'], $singular_prefix ); |
|
204 | - } |
|
205 | - } |
|
200 | + // Backwards compatibility. |
|
201 | + foreach ( $periods as $key => $data ) { |
|
202 | + if ( strpos( $key, $period ) === 0 ) { |
|
203 | + return sprintf( $data['singular'], $singular_prefix ); |
|
204 | + } |
|
205 | + } |
|
206 | 206 | |
207 | - // Invalid string. |
|
208 | - return ''; |
|
207 | + // Invalid string. |
|
208 | + return ''; |
|
209 | 209 | } |
210 | 210 | |
211 | 211 | /** |
@@ -217,22 +217,22 @@ discard block |
||
217 | 217 | */ |
218 | 218 | function getpaid_get_plural_subscription_period_label( $period, $interval ) { |
219 | 219 | |
220 | - $periods = getpaid_get_subscription_periods(); |
|
221 | - $period = strtolower( $period ); |
|
220 | + $periods = getpaid_get_subscription_periods(); |
|
221 | + $period = strtolower( $period ); |
|
222 | 222 | |
223 | - if ( isset( $periods[ $period ] ) ) { |
|
224 | - return sprintf( $periods[ $period ]['plural'], $interval ); |
|
225 | - } |
|
223 | + if ( isset( $periods[ $period ] ) ) { |
|
224 | + return sprintf( $periods[ $period ]['plural'], $interval ); |
|
225 | + } |
|
226 | 226 | |
227 | - // Backwards compatibility. |
|
228 | - foreach ( $periods as $key => $data ) { |
|
229 | - if ( strpos( $key, $period ) === 0 ) { |
|
230 | - return sprintf( $data['plural'], $interval ); |
|
231 | - } |
|
232 | - } |
|
227 | + // Backwards compatibility. |
|
228 | + foreach ( $periods as $key => $data ) { |
|
229 | + if ( strpos( $key, $period ) === 0 ) { |
|
230 | + return sprintf( $data['plural'], $interval ); |
|
231 | + } |
|
232 | + } |
|
233 | 233 | |
234 | - // Invalid string. |
|
235 | - return ''; |
|
234 | + // Invalid string. |
|
235 | + return ''; |
|
236 | 236 | } |
237 | 237 | |
238 | 238 | /** |
@@ -243,50 +243,50 @@ discard block |
||
243 | 243 | */ |
244 | 244 | function getpaid_get_formatted_subscription_amount( $subscription ) { |
245 | 245 | |
246 | - $initial = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() ); |
|
247 | - $recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() ); |
|
248 | - $period = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
246 | + $initial = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() ); |
|
247 | + $recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() ); |
|
248 | + $period = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
249 | 249 | |
250 | - // Trial periods. |
|
251 | - if ( $subscription->has_trial_period() ) { |
|
250 | + // Trial periods. |
|
251 | + if ( $subscription->has_trial_period() ) { |
|
252 | 252 | |
253 | - $trial_period = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() ); |
|
254 | - $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() ); |
|
255 | - return sprintf( |
|
253 | + $trial_period = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() ); |
|
254 | + $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() ); |
|
255 | + return sprintf( |
|
256 | 256 | |
257 | - // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period |
|
258 | - _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ), |
|
259 | - $initial, |
|
260 | - getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
261 | - $recurring, |
|
262 | - $period |
|
257 | + // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period |
|
258 | + _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ), |
|
259 | + $initial, |
|
260 | + getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
261 | + $recurring, |
|
262 | + $period |
|
263 | 263 | |
264 | - ); |
|
264 | + ); |
|
265 | 265 | |
266 | - } |
|
266 | + } |
|
267 | 267 | |
268 | - if ( $initial != $recurring ) { |
|
268 | + if ( $initial != $recurring ) { |
|
269 | 269 | |
270 | - return sprintf( |
|
270 | + return sprintf( |
|
271 | 271 | |
272 | - // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period |
|
273 | - _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ), |
|
274 | - $initial, |
|
275 | - $recurring, |
|
276 | - $period |
|
272 | + // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period |
|
273 | + _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ), |
|
274 | + $initial, |
|
275 | + $recurring, |
|
276 | + $period |
|
277 | 277 | |
278 | - ); |
|
278 | + ); |
|
279 | 279 | |
280 | - } |
|
280 | + } |
|
281 | 281 | |
282 | - return sprintf( |
|
282 | + return sprintf( |
|
283 | 283 | |
284 | - // translators: $1: is the recurring amount, $2: is the recurring period |
|
285 | - _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ), |
|
286 | - $initial, |
|
287 | - $period |
|
284 | + // translators: $1: is the recurring amount, $2: is the recurring period |
|
285 | + _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ), |
|
286 | + $initial, |
|
287 | + $period |
|
288 | 288 | |
289 | - ); |
|
289 | + ); |
|
290 | 290 | |
291 | 291 | } |
292 | 292 | |
@@ -297,7 +297,7 @@ discard block |
||
297 | 297 | * @return WPInv_Subscription|bool |
298 | 298 | */ |
299 | 299 | function getpaid_get_invoice_subscription( $invoice ) { |
300 | - return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
300 | + return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
301 | 301 | } |
302 | 302 | |
303 | 303 | /** |
@@ -306,10 +306,10 @@ discard block |
||
306 | 306 | * @param WPInv_Invoice $invoice |
307 | 307 | */ |
308 | 308 | function getpaid_activate_invoice_subscription( $invoice ) { |
309 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
310 | - if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
311 | - $subscription->activate(); |
|
312 | - } |
|
309 | + $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
310 | + if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
311 | + $subscription->activate(); |
|
312 | + } |
|
313 | 313 | } |
314 | 314 | |
315 | 315 | /** |
@@ -318,7 +318,7 @@ discard block |
||
318 | 318 | * @return WPInv_Subscriptions |
319 | 319 | */ |
320 | 320 | function getpaid_subscriptions() { |
321 | - return getpaid()->get( 'subscriptions' ); |
|
321 | + return getpaid()->get( 'subscriptions' ); |
|
322 | 322 | } |
323 | 323 | |
324 | 324 | /** |
@@ -336,14 +336,14 @@ discard block |
||
336 | 336 | return false; |
337 | 337 | } |
338 | 338 | |
339 | - // Fetch the invoiec subscription. |
|
340 | - $subscription = getpaid_get_subscriptions( |
|
341 | - array( |
|
342 | - 'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(), |
|
343 | - 'number' => 1, |
|
344 | - ) |
|
345 | - ); |
|
339 | + // Fetch the invoiec subscription. |
|
340 | + $subscription = getpaid_get_subscriptions( |
|
341 | + array( |
|
342 | + 'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(), |
|
343 | + 'number' => 1, |
|
344 | + ) |
|
345 | + ); |
|
346 | 346 | |
347 | - return empty( $subscription ) ? false : $subscription[0]; |
|
347 | + return empty( $subscription ) ? false : $subscription[0]; |
|
348 | 348 | |
349 | 349 | } |
@@ -15,125 +15,125 @@ discard block |
||
15 | 15 | */ |
16 | 16 | class WPInv_Subscription extends GetPaid_Data { |
17 | 17 | |
18 | - /** |
|
19 | - * Which data store to load. |
|
20 | - * |
|
21 | - * @var string |
|
22 | - */ |
|
23 | - protected $data_store_name = 'subscription'; |
|
24 | - |
|
25 | - /** |
|
26 | - * This is the name of this object type. |
|
27 | - * |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $object_type = 'subscription'; |
|
31 | - |
|
32 | - /** |
|
33 | - * Item Data array. This is the core item data exposed in APIs. |
|
34 | - * |
|
35 | - * @since 1.0.19 |
|
36 | - * @var array |
|
37 | - */ |
|
38 | - protected $data = array( |
|
39 | - 'customer_id' => 0, |
|
40 | - 'frequency' => 1, |
|
41 | - 'period' => 'D', |
|
42 | - 'initial_amount' => null, |
|
43 | - 'recurring_amount' => null, |
|
44 | - 'bill_times' => 0, |
|
45 | - 'transaction_id' => '', |
|
46 | - 'parent_payment_id' => null, |
|
47 | - 'product_id' => 0, |
|
48 | - 'created' => '0000-00-00 00:00:00', |
|
49 | - 'expiration' => '0000-00-00 00:00:00', |
|
50 | - 'trial_period' => '', |
|
51 | - 'status' => 'pending', |
|
52 | - 'profile_id' => '', |
|
53 | - 'gateway' => '', |
|
54 | - 'customer' => '', |
|
55 | - ); |
|
56 | - |
|
57 | - /** |
|
58 | - * Stores the status transition information. |
|
59 | - * |
|
60 | - * @since 1.0.19 |
|
61 | - * @var bool |
|
62 | - */ |
|
63 | - protected $status_transition = false; |
|
64 | - |
|
65 | - /** |
|
66 | - * Get the subscription if ID is passed, otherwise the subscription is new and empty. |
|
67 | - * |
|
68 | - * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
|
69 | - * @param bool $deprecated |
|
70 | - */ |
|
71 | - function __construct( $subscription = 0, $deprecated = false ) { |
|
72 | - |
|
73 | - parent::__construct( $subscription ); |
|
74 | - |
|
75 | - if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
76 | - $this->set_id( $subscription ); |
|
77 | - } elseif ( $subscription instanceof self ) { |
|
78 | - $this->set_id( $subscription->get_id() ); |
|
79 | - } elseif ( ! empty( $subscription->id ) ) { |
|
80 | - $this->set_id( $subscription->id ); |
|
81 | - } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
82 | - $this->set_id( $subscription_id ); |
|
83 | - } else { |
|
84 | - $this->set_object_read( true ); |
|
85 | - } |
|
86 | - |
|
87 | - // Load the datastore. |
|
88 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
89 | - |
|
90 | - if ( $this->get_id() > 0 ) { |
|
91 | - $this->data_store->read( $this ); |
|
92 | - } |
|
93 | - |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * Given an invoice id, profile id, transaction id, it returns the subscription's id. |
|
98 | - * |
|
99 | - * |
|
100 | - * @static |
|
101 | - * @param string $value |
|
102 | - * @param string $field Either invoice_id, transaction_id or profile_id. |
|
103 | - * @since 1.0.19 |
|
104 | - * @return int |
|
105 | - */ |
|
106 | - public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
18 | + /** |
|
19 | + * Which data store to load. |
|
20 | + * |
|
21 | + * @var string |
|
22 | + */ |
|
23 | + protected $data_store_name = 'subscription'; |
|
24 | + |
|
25 | + /** |
|
26 | + * This is the name of this object type. |
|
27 | + * |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $object_type = 'subscription'; |
|
31 | + |
|
32 | + /** |
|
33 | + * Item Data array. This is the core item data exposed in APIs. |
|
34 | + * |
|
35 | + * @since 1.0.19 |
|
36 | + * @var array |
|
37 | + */ |
|
38 | + protected $data = array( |
|
39 | + 'customer_id' => 0, |
|
40 | + 'frequency' => 1, |
|
41 | + 'period' => 'D', |
|
42 | + 'initial_amount' => null, |
|
43 | + 'recurring_amount' => null, |
|
44 | + 'bill_times' => 0, |
|
45 | + 'transaction_id' => '', |
|
46 | + 'parent_payment_id' => null, |
|
47 | + 'product_id' => 0, |
|
48 | + 'created' => '0000-00-00 00:00:00', |
|
49 | + 'expiration' => '0000-00-00 00:00:00', |
|
50 | + 'trial_period' => '', |
|
51 | + 'status' => 'pending', |
|
52 | + 'profile_id' => '', |
|
53 | + 'gateway' => '', |
|
54 | + 'customer' => '', |
|
55 | + ); |
|
56 | + |
|
57 | + /** |
|
58 | + * Stores the status transition information. |
|
59 | + * |
|
60 | + * @since 1.0.19 |
|
61 | + * @var bool |
|
62 | + */ |
|
63 | + protected $status_transition = false; |
|
64 | + |
|
65 | + /** |
|
66 | + * Get the subscription if ID is passed, otherwise the subscription is new and empty. |
|
67 | + * |
|
68 | + * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
|
69 | + * @param bool $deprecated |
|
70 | + */ |
|
71 | + function __construct( $subscription = 0, $deprecated = false ) { |
|
72 | + |
|
73 | + parent::__construct( $subscription ); |
|
74 | + |
|
75 | + if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
76 | + $this->set_id( $subscription ); |
|
77 | + } elseif ( $subscription instanceof self ) { |
|
78 | + $this->set_id( $subscription->get_id() ); |
|
79 | + } elseif ( ! empty( $subscription->id ) ) { |
|
80 | + $this->set_id( $subscription->id ); |
|
81 | + } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
82 | + $this->set_id( $subscription_id ); |
|
83 | + } else { |
|
84 | + $this->set_object_read( true ); |
|
85 | + } |
|
86 | + |
|
87 | + // Load the datastore. |
|
88 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
89 | + |
|
90 | + if ( $this->get_id() > 0 ) { |
|
91 | + $this->data_store->read( $this ); |
|
92 | + } |
|
93 | + |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * Given an invoice id, profile id, transaction id, it returns the subscription's id. |
|
98 | + * |
|
99 | + * |
|
100 | + * @static |
|
101 | + * @param string $value |
|
102 | + * @param string $field Either invoice_id, transaction_id or profile_id. |
|
103 | + * @since 1.0.19 |
|
104 | + * @return int |
|
105 | + */ |
|
106 | + public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
107 | 107 | global $wpdb; |
108 | 108 | |
109 | - // Trim the value. |
|
110 | - $value = trim( $value ); |
|
109 | + // Trim the value. |
|
110 | + $value = trim( $value ); |
|
111 | 111 | |
112 | - if ( empty( $value ) ) { |
|
113 | - return 0; |
|
114 | - } |
|
112 | + if ( empty( $value ) ) { |
|
113 | + return 0; |
|
114 | + } |
|
115 | 115 | |
116 | - if ( 'invoice_id' == $field ) { |
|
117 | - $field = 'parent_payment_id'; |
|
118 | - } |
|
116 | + if ( 'invoice_id' == $field ) { |
|
117 | + $field = 'parent_payment_id'; |
|
118 | + } |
|
119 | 119 | |
120 | 120 | // Valid fields. |
121 | 121 | $fields = array( |
122 | - 'parent_payment_id', |
|
123 | - 'transaction_id', |
|
124 | - 'profile_id' |
|
125 | - ); |
|
126 | - |
|
127 | - // Ensure a field has been passed. |
|
128 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
129 | - return 0; |
|
130 | - } |
|
131 | - |
|
132 | - // Maybe retrieve from the cache. |
|
133 | - $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
134 | - if ( ! empty( $subscription_id ) ) { |
|
135 | - return $subscription_id; |
|
136 | - } |
|
122 | + 'parent_payment_id', |
|
123 | + 'transaction_id', |
|
124 | + 'profile_id' |
|
125 | + ); |
|
126 | + |
|
127 | + // Ensure a field has been passed. |
|
128 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
129 | + return 0; |
|
130 | + } |
|
131 | + |
|
132 | + // Maybe retrieve from the cache. |
|
133 | + $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
134 | + if ( ! empty( $subscription_id ) ) { |
|
135 | + return $subscription_id; |
|
136 | + } |
|
137 | 137 | |
138 | 138 | // Fetch from the db. |
139 | 139 | $table = $wpdb->prefix . 'wpinv_subscriptions'; |
@@ -141,34 +141,34 @@ discard block |
||
141 | 141 | $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
142 | 142 | ); |
143 | 143 | |
144 | - if ( empty( $subscription_id ) ) { |
|
145 | - return 0; |
|
146 | - } |
|
144 | + if ( empty( $subscription_id ) ) { |
|
145 | + return 0; |
|
146 | + } |
|
147 | 147 | |
148 | - // Update the cache with our data. |
|
149 | - wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
148 | + // Update the cache with our data. |
|
149 | + wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
150 | 150 | |
151 | - return $subscription_id; |
|
152 | - } |
|
151 | + return $subscription_id; |
|
152 | + } |
|
153 | 153 | |
154 | - /** |
|
154 | + /** |
|
155 | 155 | * Clears the subscription's cache. |
156 | 156 | */ |
157 | 157 | public function clear_cache() { |
158 | - wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
159 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
160 | - wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
161 | - wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
162 | - } |
|
158 | + wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
159 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
160 | + wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
161 | + wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
162 | + } |
|
163 | 163 | |
164 | - /** |
|
164 | + /** |
|
165 | 165 | * Checks if a subscription key is set. |
166 | 166 | */ |
167 | 167 | public function _isset( $key ) { |
168 | 168 | return isset( $this->data[$key] ) || method_exists( $this, "get_$key" ); |
169 | - } |
|
169 | + } |
|
170 | 170 | |
171 | - /* |
|
171 | + /* |
|
172 | 172 | |-------------------------------------------------------------------------- |
173 | 173 | | CRUD methods |
174 | 174 | |-------------------------------------------------------------------------- |
@@ -177,545 +177,545 @@ discard block |
||
177 | 177 | | |
178 | 178 | */ |
179 | 179 | |
180 | - /* |
|
180 | + /* |
|
181 | 181 | |-------------------------------------------------------------------------- |
182 | 182 | | Getters |
183 | 183 | |-------------------------------------------------------------------------- |
184 | 184 | */ |
185 | 185 | |
186 | - /** |
|
187 | - * Get customer id. |
|
188 | - * |
|
189 | - * @since 1.0.19 |
|
190 | - * @param string $context View or edit context. |
|
191 | - * @return int |
|
192 | - */ |
|
193 | - public function get_customer_id( $context = 'view' ) { |
|
194 | - return (int) $this->get_prop( 'customer_id', $context ); |
|
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * Get customer information. |
|
199 | - * |
|
200 | - * @since 1.0.19 |
|
201 | - * @param string $context View or edit context. |
|
202 | - * @return WP_User|false WP_User object on success, false on failure. |
|
203 | - */ |
|
204 | - public function get_customer( $context = 'view' ) { |
|
205 | - return get_userdata( $this->get_customer_id( $context ) ); |
|
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * Get parent invoice id. |
|
210 | - * |
|
211 | - * @since 1.0.19 |
|
212 | - * @param string $context View or edit context. |
|
213 | - * @return int |
|
214 | - */ |
|
215 | - public function get_parent_invoice_id( $context = 'view' ) { |
|
216 | - return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
217 | - } |
|
218 | - |
|
219 | - /** |
|
220 | - * Alias for self::get_parent_invoice_id(). |
|
221 | - * |
|
222 | - * @since 1.0.19 |
|
223 | - * @param string $context View or edit context. |
|
224 | - * @return int |
|
225 | - */ |
|
186 | + /** |
|
187 | + * Get customer id. |
|
188 | + * |
|
189 | + * @since 1.0.19 |
|
190 | + * @param string $context View or edit context. |
|
191 | + * @return int |
|
192 | + */ |
|
193 | + public function get_customer_id( $context = 'view' ) { |
|
194 | + return (int) $this->get_prop( 'customer_id', $context ); |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * Get customer information. |
|
199 | + * |
|
200 | + * @since 1.0.19 |
|
201 | + * @param string $context View or edit context. |
|
202 | + * @return WP_User|false WP_User object on success, false on failure. |
|
203 | + */ |
|
204 | + public function get_customer( $context = 'view' ) { |
|
205 | + return get_userdata( $this->get_customer_id( $context ) ); |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * Get parent invoice id. |
|
210 | + * |
|
211 | + * @since 1.0.19 |
|
212 | + * @param string $context View or edit context. |
|
213 | + * @return int |
|
214 | + */ |
|
215 | + public function get_parent_invoice_id( $context = 'view' ) { |
|
216 | + return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
217 | + } |
|
218 | + |
|
219 | + /** |
|
220 | + * Alias for self::get_parent_invoice_id(). |
|
221 | + * |
|
222 | + * @since 1.0.19 |
|
223 | + * @param string $context View or edit context. |
|
224 | + * @return int |
|
225 | + */ |
|
226 | 226 | public function get_parent_payment_id( $context = 'view' ) { |
227 | 227 | return $this->get_parent_invoice_id( $context ); |
228 | - } |
|
228 | + } |
|
229 | 229 | |
230 | - /** |
|
230 | + /** |
|
231 | 231 | * Alias for self::get_parent_invoice_id(). |
232 | 232 | * |
233 | - * @since 1.0.0 |
|
234 | - * @return int |
|
233 | + * @since 1.0.0 |
|
234 | + * @return int |
|
235 | + */ |
|
236 | + public function get_original_payment_id( $context = 'view' ) { |
|
237 | + return $this->get_parent_invoice_id( $context ); |
|
238 | + } |
|
239 | + |
|
240 | + /** |
|
241 | + * Get parent invoice. |
|
242 | + * |
|
243 | + * @since 1.0.19 |
|
244 | + * @param string $context View or edit context. |
|
245 | + * @return WPInv_Invoice |
|
246 | + */ |
|
247 | + public function get_parent_invoice( $context = 'view' ) { |
|
248 | + return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
249 | + } |
|
250 | + |
|
251 | + /** |
|
252 | + * Alias for self::get_parent_invoice(). |
|
253 | + * |
|
254 | + * @since 1.0.19 |
|
255 | + * @param string $context View or edit context. |
|
256 | + * @return WPInv_Invoice |
|
257 | + */ |
|
258 | + public function get_parent_payment( $context = 'view' ) { |
|
259 | + return $this->get_parent_invoice( $context ); |
|
260 | + } |
|
261 | + |
|
262 | + /** |
|
263 | + * Get subscription's product id. |
|
264 | + * |
|
265 | + * @since 1.0.19 |
|
266 | + * @param string $context View or edit context. |
|
267 | + * @return int |
|
268 | + */ |
|
269 | + public function get_product_id( $context = 'view' ) { |
|
270 | + return (int) $this->get_prop( 'product_id', $context ); |
|
271 | + } |
|
272 | + |
|
273 | + /** |
|
274 | + * Get the subscription product. |
|
275 | + * |
|
276 | + * @since 1.0.19 |
|
277 | + * @param string $context View or edit context. |
|
278 | + * @return WPInv_Item |
|
279 | + */ |
|
280 | + public function get_product( $context = 'view' ) { |
|
281 | + return new WPInv_Item( $this->get_product_id( $context ) ); |
|
282 | + } |
|
283 | + |
|
284 | + /** |
|
285 | + * Get parent invoice's gateway. |
|
286 | + * |
|
287 | + * Here for backwards compatibility. |
|
288 | + * |
|
289 | + * @since 1.0.19 |
|
290 | + * @param string $context View or edit context. |
|
291 | + * @return string |
|
292 | + */ |
|
293 | + public function get_gateway( $context = 'view' ) { |
|
294 | + return $this->get_parent_invoice( $context )->get_gateway(); |
|
295 | + } |
|
296 | + |
|
297 | + /** |
|
298 | + * Get the period of a renewal. |
|
299 | + * |
|
300 | + * @since 1.0.19 |
|
301 | + * @param string $context View or edit context. |
|
302 | + * @return string |
|
303 | + */ |
|
304 | + public function get_period( $context = 'view' ) { |
|
305 | + return $this->get_prop( 'period', $context ); |
|
306 | + } |
|
307 | + |
|
308 | + /** |
|
309 | + * Get number of periods each renewal is valid for. |
|
310 | + * |
|
311 | + * @since 1.0.19 |
|
312 | + * @param string $context View or edit context. |
|
313 | + * @return int |
|
314 | + */ |
|
315 | + public function get_frequency( $context = 'view' ) { |
|
316 | + return (int) $this->get_prop( 'frequency', $context ); |
|
317 | + } |
|
318 | + |
|
319 | + /** |
|
320 | + * Get the initial amount for the subscription. |
|
321 | + * |
|
322 | + * @since 1.0.19 |
|
323 | + * @param string $context View or edit context. |
|
324 | + * @return float |
|
325 | + */ |
|
326 | + public function get_initial_amount( $context = 'view' ) { |
|
327 | + return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
328 | + } |
|
329 | + |
|
330 | + /** |
|
331 | + * Get the recurring amount for the subscription. |
|
332 | + * |
|
333 | + * @since 1.0.19 |
|
334 | + * @param string $context View or edit context. |
|
335 | + * @return float |
|
336 | + */ |
|
337 | + public function get_recurring_amount( $context = 'view' ) { |
|
338 | + return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
339 | + } |
|
340 | + |
|
341 | + /** |
|
342 | + * Get number of times that this subscription can be renewed. |
|
343 | + * |
|
344 | + * @since 1.0.19 |
|
345 | + * @param string $context View or edit context. |
|
346 | + * @return int |
|
347 | + */ |
|
348 | + public function get_bill_times( $context = 'view' ) { |
|
349 | + return (int) $this->get_prop( 'bill_times', $context ); |
|
350 | + } |
|
351 | + |
|
352 | + /** |
|
353 | + * Get transaction id of this subscription's parent invoice. |
|
354 | + * |
|
355 | + * @since 1.0.19 |
|
356 | + * @param string $context View or edit context. |
|
357 | + * @return string |
|
358 | + */ |
|
359 | + public function get_transaction_id( $context = 'view' ) { |
|
360 | + return $this->get_prop( 'transaction_id', $context ); |
|
361 | + } |
|
362 | + |
|
363 | + /** |
|
364 | + * Get the date that the subscription was created. |
|
365 | + * |
|
366 | + * @since 1.0.19 |
|
367 | + * @param string $context View or edit context. |
|
368 | + * @return string |
|
369 | + */ |
|
370 | + public function get_created( $context = 'view' ) { |
|
371 | + return $this->get_prop( 'created', $context ); |
|
372 | + } |
|
373 | + |
|
374 | + /** |
|
375 | + * Alias for self::get_created(). |
|
376 | + * |
|
377 | + * @since 1.0.19 |
|
378 | + * @param string $context View or edit context. |
|
379 | + * @return string |
|
380 | + */ |
|
381 | + public function get_date_created( $context = 'view' ) { |
|
382 | + return $this->get_created( $context ); |
|
383 | + } |
|
384 | + |
|
385 | + /** |
|
386 | + * Retrieves the creation date in a timestamp |
|
387 | + * |
|
388 | + * @since 1.0.0 |
|
389 | + * @return int |
|
390 | + */ |
|
391 | + public function get_time_created() { |
|
392 | + $created = $this->get_date_created(); |
|
393 | + return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
394 | + } |
|
395 | + |
|
396 | + /** |
|
397 | + * Get GMT date when the subscription was created. |
|
398 | + * |
|
399 | + * @since 1.0.19 |
|
400 | + * @param string $context View or edit context. |
|
401 | + * @return string |
|
402 | + */ |
|
403 | + public function get_date_created_gmt( $context = 'view' ) { |
|
404 | + $date = $this->get_date_created( $context ); |
|
405 | + |
|
406 | + if ( $date ) { |
|
407 | + $date = get_gmt_from_date( $date ); |
|
408 | + } |
|
409 | + return $date; |
|
410 | + } |
|
411 | + |
|
412 | + /** |
|
413 | + * Get the date that the subscription will renew. |
|
414 | + * |
|
415 | + * @since 1.0.19 |
|
416 | + * @param string $context View or edit context. |
|
417 | + * @return string |
|
418 | + */ |
|
419 | + public function get_next_renewal_date( $context = 'view' ) { |
|
420 | + return $this->get_prop( 'expiration', $context ); |
|
421 | + } |
|
422 | + |
|
423 | + /** |
|
424 | + * Alias for self::get_next_renewal_date(). |
|
425 | + * |
|
426 | + * @since 1.0.19 |
|
427 | + * @param string $context View or edit context. |
|
428 | + * @return string |
|
429 | + */ |
|
430 | + public function get_expiration( $context = 'view' ) { |
|
431 | + return $this->get_next_renewal_date( $context ); |
|
432 | + } |
|
433 | + |
|
434 | + /** |
|
435 | + * Retrieves the expiration date in a timestamp |
|
436 | + * |
|
437 | + * @since 1.0.0 |
|
438 | + * @return int |
|
439 | + */ |
|
440 | + public function get_expiration_time() { |
|
441 | + $expiration = $this->get_expiration(); |
|
442 | + |
|
443 | + if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
444 | + return current_time( 'timestamp' ); |
|
445 | + } |
|
446 | + |
|
447 | + $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
448 | + return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
449 | + } |
|
450 | + |
|
451 | + /** |
|
452 | + * Get GMT date when the subscription will renew. |
|
453 | + * |
|
454 | + * @since 1.0.19 |
|
455 | + * @param string $context View or edit context. |
|
456 | + * @return string |
|
457 | + */ |
|
458 | + public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
459 | + $date = $this->get_next_renewal_date( $context ); |
|
460 | + |
|
461 | + if ( $date ) { |
|
462 | + $date = get_gmt_from_date( $date ); |
|
463 | + } |
|
464 | + return $date; |
|
465 | + } |
|
466 | + |
|
467 | + /** |
|
468 | + * Get the subscription's trial period. |
|
469 | + * |
|
470 | + * @since 1.0.19 |
|
471 | + * @param string $context View or edit context. |
|
472 | + * @return string |
|
473 | + */ |
|
474 | + public function get_trial_period( $context = 'view' ) { |
|
475 | + return $this->get_prop( 'trial_period', $context ); |
|
476 | + } |
|
477 | + |
|
478 | + /** |
|
479 | + * Get the subscription's status. |
|
480 | + * |
|
481 | + * @since 1.0.19 |
|
482 | + * @param string $context View or edit context. |
|
483 | + * @return string |
|
484 | + */ |
|
485 | + public function get_status( $context = 'view' ) { |
|
486 | + return $this->get_prop( 'status', $context ); |
|
487 | + } |
|
488 | + |
|
489 | + /** |
|
490 | + * Get the subscription's profile id. |
|
491 | + * |
|
492 | + * @since 1.0.19 |
|
493 | + * @param string $context View or edit context. |
|
494 | + * @return string |
|
495 | + */ |
|
496 | + public function get_profile_id( $context = 'view' ) { |
|
497 | + return $this->get_prop( 'profile_id', $context ); |
|
498 | + } |
|
499 | + |
|
500 | + /* |
|
501 | + |-------------------------------------------------------------------------- |
|
502 | + | Setters |
|
503 | + |-------------------------------------------------------------------------- |
|
504 | + */ |
|
505 | + |
|
506 | + /** |
|
507 | + * Set customer id. |
|
508 | + * |
|
509 | + * @since 1.0.19 |
|
510 | + * @param int $value The customer's id. |
|
511 | + */ |
|
512 | + public function set_customer_id( $value ) { |
|
513 | + $this->set_prop( 'customer_id', (int) $value ); |
|
514 | + } |
|
515 | + |
|
516 | + /** |
|
517 | + * Set parent invoice id. |
|
518 | + * |
|
519 | + * @since 1.0.19 |
|
520 | + * @param int $value The parent invoice id. |
|
521 | + */ |
|
522 | + public function set_parent_invoice_id( $value ) { |
|
523 | + $this->set_prop( 'parent_payment_id', (int) $value ); |
|
524 | + } |
|
525 | + |
|
526 | + /** |
|
527 | + * Alias for self::set_parent_invoice_id(). |
|
528 | + * |
|
529 | + * @since 1.0.19 |
|
530 | + * @param int $value The parent invoice id. |
|
531 | + */ |
|
532 | + public function set_parent_payment_id( $value ) { |
|
533 | + $this->set_parent_invoice_id( $value ); |
|
534 | + } |
|
535 | + |
|
536 | + /** |
|
537 | + * Alias for self::set_parent_invoice_id(). |
|
538 | + * |
|
539 | + * @since 1.0.19 |
|
540 | + * @param int $value The parent invoice id. |
|
541 | + */ |
|
542 | + public function set_original_payment_id( $value ) { |
|
543 | + $this->set_parent_invoice_id( $value ); |
|
544 | + } |
|
545 | + |
|
546 | + /** |
|
547 | + * Set subscription's product id. |
|
548 | + * |
|
549 | + * @since 1.0.19 |
|
550 | + * @param int $value The subscription product id. |
|
551 | + */ |
|
552 | + public function set_product_id( $value ) { |
|
553 | + $this->set_prop( 'product_id', (int) $value ); |
|
554 | + } |
|
555 | + |
|
556 | + /** |
|
557 | + * Set the period of a renewal. |
|
558 | + * |
|
559 | + * @since 1.0.19 |
|
560 | + * @param string $value The renewal period. |
|
561 | + */ |
|
562 | + public function set_period( $value ) { |
|
563 | + $this->set_prop( 'period', $value ); |
|
564 | + } |
|
565 | + |
|
566 | + /** |
|
567 | + * Set number of periods each renewal is valid for. |
|
568 | + * |
|
569 | + * @since 1.0.19 |
|
570 | + * @param int $value The subscription frequency. |
|
571 | + */ |
|
572 | + public function set_frequency( $value ) { |
|
573 | + $value = empty( $value ) ? 1 : (int) $value; |
|
574 | + $this->set_prop( 'frequency', absint( $value ) ); |
|
575 | + } |
|
576 | + |
|
577 | + /** |
|
578 | + * Set the initial amount for the subscription. |
|
579 | + * |
|
580 | + * @since 1.0.19 |
|
581 | + * @param float $value The initial subcription amount. |
|
582 | + */ |
|
583 | + public function set_initial_amount( $value ) { |
|
584 | + $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
585 | + } |
|
586 | + |
|
587 | + /** |
|
588 | + * Set the recurring amount for the subscription. |
|
589 | + * |
|
590 | + * @since 1.0.19 |
|
591 | + * @param float $value The recurring subcription amount. |
|
592 | + */ |
|
593 | + public function set_recurring_amount( $value ) { |
|
594 | + $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
595 | + } |
|
596 | + |
|
597 | + /** |
|
598 | + * Set number of times that this subscription can be renewed. |
|
599 | + * |
|
600 | + * @since 1.0.19 |
|
601 | + * @param int $value Bill times. |
|
602 | + */ |
|
603 | + public function set_bill_times( $value ) { |
|
604 | + $this->set_prop( 'bill_times', (int) $value ); |
|
605 | + } |
|
606 | + |
|
607 | + /** |
|
608 | + * Get transaction id of this subscription's parent invoice. |
|
609 | + * |
|
610 | + * @since 1.0.19 |
|
611 | + * @param string $value Bill times. |
|
235 | 612 | */ |
236 | - public function get_original_payment_id( $context = 'view' ) { |
|
237 | - return $this->get_parent_invoice_id( $context ); |
|
613 | + public function set_transaction_id( $value ) { |
|
614 | + $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
238 | 615 | } |
239 | 616 | |
240 | - /** |
|
241 | - * Get parent invoice. |
|
242 | - * |
|
243 | - * @since 1.0.19 |
|
244 | - * @param string $context View or edit context. |
|
245 | - * @return WPInv_Invoice |
|
246 | - */ |
|
247 | - public function get_parent_invoice( $context = 'view' ) { |
|
248 | - return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
249 | - } |
|
250 | - |
|
251 | - /** |
|
252 | - * Alias for self::get_parent_invoice(). |
|
253 | - * |
|
254 | - * @since 1.0.19 |
|
255 | - * @param string $context View or edit context. |
|
256 | - * @return WPInv_Invoice |
|
257 | - */ |
|
258 | - public function get_parent_payment( $context = 'view' ) { |
|
259 | - return $this->get_parent_invoice( $context ); |
|
260 | - } |
|
261 | - |
|
262 | - /** |
|
263 | - * Get subscription's product id. |
|
264 | - * |
|
265 | - * @since 1.0.19 |
|
266 | - * @param string $context View or edit context. |
|
267 | - * @return int |
|
268 | - */ |
|
269 | - public function get_product_id( $context = 'view' ) { |
|
270 | - return (int) $this->get_prop( 'product_id', $context ); |
|
271 | - } |
|
272 | - |
|
273 | - /** |
|
274 | - * Get the subscription product. |
|
275 | - * |
|
276 | - * @since 1.0.19 |
|
277 | - * @param string $context View or edit context. |
|
278 | - * @return WPInv_Item |
|
279 | - */ |
|
280 | - public function get_product( $context = 'view' ) { |
|
281 | - return new WPInv_Item( $this->get_product_id( $context ) ); |
|
282 | - } |
|
283 | - |
|
284 | - /** |
|
285 | - * Get parent invoice's gateway. |
|
286 | - * |
|
287 | - * Here for backwards compatibility. |
|
288 | - * |
|
289 | - * @since 1.0.19 |
|
290 | - * @param string $context View or edit context. |
|
291 | - * @return string |
|
292 | - */ |
|
293 | - public function get_gateway( $context = 'view' ) { |
|
294 | - return $this->get_parent_invoice( $context )->get_gateway(); |
|
295 | - } |
|
296 | - |
|
297 | - /** |
|
298 | - * Get the period of a renewal. |
|
299 | - * |
|
300 | - * @since 1.0.19 |
|
301 | - * @param string $context View or edit context. |
|
302 | - * @return string |
|
303 | - */ |
|
304 | - public function get_period( $context = 'view' ) { |
|
305 | - return $this->get_prop( 'period', $context ); |
|
306 | - } |
|
307 | - |
|
308 | - /** |
|
309 | - * Get number of periods each renewal is valid for. |
|
310 | - * |
|
311 | - * @since 1.0.19 |
|
312 | - * @param string $context View or edit context. |
|
313 | - * @return int |
|
314 | - */ |
|
315 | - public function get_frequency( $context = 'view' ) { |
|
316 | - return (int) $this->get_prop( 'frequency', $context ); |
|
317 | - } |
|
318 | - |
|
319 | - /** |
|
320 | - * Get the initial amount for the subscription. |
|
321 | - * |
|
322 | - * @since 1.0.19 |
|
323 | - * @param string $context View or edit context. |
|
324 | - * @return float |
|
325 | - */ |
|
326 | - public function get_initial_amount( $context = 'view' ) { |
|
327 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
328 | - } |
|
329 | - |
|
330 | - /** |
|
331 | - * Get the recurring amount for the subscription. |
|
332 | - * |
|
333 | - * @since 1.0.19 |
|
334 | - * @param string $context View or edit context. |
|
335 | - * @return float |
|
336 | - */ |
|
337 | - public function get_recurring_amount( $context = 'view' ) { |
|
338 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
339 | - } |
|
340 | - |
|
341 | - /** |
|
342 | - * Get number of times that this subscription can be renewed. |
|
343 | - * |
|
344 | - * @since 1.0.19 |
|
345 | - * @param string $context View or edit context. |
|
346 | - * @return int |
|
347 | - */ |
|
348 | - public function get_bill_times( $context = 'view' ) { |
|
349 | - return (int) $this->get_prop( 'bill_times', $context ); |
|
350 | - } |
|
351 | - |
|
352 | - /** |
|
353 | - * Get transaction id of this subscription's parent invoice. |
|
354 | - * |
|
355 | - * @since 1.0.19 |
|
356 | - * @param string $context View or edit context. |
|
357 | - * @return string |
|
358 | - */ |
|
359 | - public function get_transaction_id( $context = 'view' ) { |
|
360 | - return $this->get_prop( 'transaction_id', $context ); |
|
361 | - } |
|
362 | - |
|
363 | - /** |
|
364 | - * Get the date that the subscription was created. |
|
365 | - * |
|
366 | - * @since 1.0.19 |
|
367 | - * @param string $context View or edit context. |
|
368 | - * @return string |
|
369 | - */ |
|
370 | - public function get_created( $context = 'view' ) { |
|
371 | - return $this->get_prop( 'created', $context ); |
|
372 | - } |
|
373 | - |
|
374 | - /** |
|
375 | - * Alias for self::get_created(). |
|
376 | - * |
|
377 | - * @since 1.0.19 |
|
378 | - * @param string $context View or edit context. |
|
379 | - * @return string |
|
380 | - */ |
|
381 | - public function get_date_created( $context = 'view' ) { |
|
382 | - return $this->get_created( $context ); |
|
383 | - } |
|
384 | - |
|
385 | - /** |
|
386 | - * Retrieves the creation date in a timestamp |
|
387 | - * |
|
388 | - * @since 1.0.0 |
|
389 | - * @return int |
|
390 | - */ |
|
391 | - public function get_time_created() { |
|
392 | - $created = $this->get_date_created(); |
|
393 | - return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
394 | - } |
|
395 | - |
|
396 | - /** |
|
397 | - * Get GMT date when the subscription was created. |
|
398 | - * |
|
399 | - * @since 1.0.19 |
|
400 | - * @param string $context View or edit context. |
|
401 | - * @return string |
|
402 | - */ |
|
403 | - public function get_date_created_gmt( $context = 'view' ) { |
|
404 | - $date = $this->get_date_created( $context ); |
|
617 | + /** |
|
618 | + * Set date when this subscription started. |
|
619 | + * |
|
620 | + * @since 1.0.19 |
|
621 | + * @param string $value strtotime compliant date. |
|
622 | + */ |
|
623 | + public function set_created( $value ) { |
|
624 | + $date = strtotime( $value ); |
|
405 | 625 | |
406 | - if ( $date ) { |
|
407 | - $date = get_gmt_from_date( $date ); |
|
626 | + if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
627 | + $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
628 | + return; |
|
408 | 629 | } |
409 | - return $date; |
|
410 | - } |
|
411 | - |
|
412 | - /** |
|
413 | - * Get the date that the subscription will renew. |
|
414 | - * |
|
415 | - * @since 1.0.19 |
|
416 | - * @param string $context View or edit context. |
|
417 | - * @return string |
|
418 | - */ |
|
419 | - public function get_next_renewal_date( $context = 'view' ) { |
|
420 | - return $this->get_prop( 'expiration', $context ); |
|
421 | - } |
|
422 | - |
|
423 | - /** |
|
424 | - * Alias for self::get_next_renewal_date(). |
|
425 | - * |
|
426 | - * @since 1.0.19 |
|
427 | - * @param string $context View or edit context. |
|
428 | - * @return string |
|
429 | - */ |
|
430 | - public function get_expiration( $context = 'view' ) { |
|
431 | - return $this->get_next_renewal_date( $context ); |
|
432 | - } |
|
433 | - |
|
434 | - /** |
|
435 | - * Retrieves the expiration date in a timestamp |
|
436 | - * |
|
437 | - * @since 1.0.0 |
|
438 | - * @return int |
|
439 | - */ |
|
440 | - public function get_expiration_time() { |
|
441 | - $expiration = $this->get_expiration(); |
|
442 | - |
|
443 | - if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
444 | - return current_time( 'timestamp' ); |
|
445 | - } |
|
446 | - |
|
447 | - $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
448 | - return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
449 | - } |
|
450 | - |
|
451 | - /** |
|
452 | - * Get GMT date when the subscription will renew. |
|
453 | - * |
|
454 | - * @since 1.0.19 |
|
455 | - * @param string $context View or edit context. |
|
456 | - * @return string |
|
457 | - */ |
|
458 | - public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
459 | - $date = $this->get_next_renewal_date( $context ); |
|
460 | 630 | |
461 | - if ( $date ) { |
|
462 | - $date = get_gmt_from_date( $date ); |
|
463 | - } |
|
464 | - return $date; |
|
465 | - } |
|
466 | - |
|
467 | - /** |
|
468 | - * Get the subscription's trial period. |
|
469 | - * |
|
470 | - * @since 1.0.19 |
|
471 | - * @param string $context View or edit context. |
|
472 | - * @return string |
|
473 | - */ |
|
474 | - public function get_trial_period( $context = 'view' ) { |
|
475 | - return $this->get_prop( 'trial_period', $context ); |
|
476 | - } |
|
477 | - |
|
478 | - /** |
|
479 | - * Get the subscription's status. |
|
480 | - * |
|
481 | - * @since 1.0.19 |
|
482 | - * @param string $context View or edit context. |
|
483 | - * @return string |
|
484 | - */ |
|
485 | - public function get_status( $context = 'view' ) { |
|
486 | - return $this->get_prop( 'status', $context ); |
|
487 | - } |
|
488 | - |
|
489 | - /** |
|
490 | - * Get the subscription's profile id. |
|
491 | - * |
|
492 | - * @since 1.0.19 |
|
493 | - * @param string $context View or edit context. |
|
494 | - * @return string |
|
495 | - */ |
|
496 | - public function get_profile_id( $context = 'view' ) { |
|
497 | - return $this->get_prop( 'profile_id', $context ); |
|
498 | - } |
|
499 | - |
|
500 | - /* |
|
501 | - |-------------------------------------------------------------------------- |
|
502 | - | Setters |
|
503 | - |-------------------------------------------------------------------------- |
|
504 | - */ |
|
631 | + $this->set_prop( 'created', '' ); |
|
505 | 632 | |
506 | - /** |
|
507 | - * Set customer id. |
|
508 | - * |
|
509 | - * @since 1.0.19 |
|
510 | - * @param int $value The customer's id. |
|
511 | - */ |
|
512 | - public function set_customer_id( $value ) { |
|
513 | - $this->set_prop( 'customer_id', (int) $value ); |
|
514 | - } |
|
515 | - |
|
516 | - /** |
|
517 | - * Set parent invoice id. |
|
518 | - * |
|
519 | - * @since 1.0.19 |
|
520 | - * @param int $value The parent invoice id. |
|
521 | - */ |
|
522 | - public function set_parent_invoice_id( $value ) { |
|
523 | - $this->set_prop( 'parent_payment_id', (int) $value ); |
|
524 | - } |
|
525 | - |
|
526 | - /** |
|
527 | - * Alias for self::set_parent_invoice_id(). |
|
528 | - * |
|
529 | - * @since 1.0.19 |
|
530 | - * @param int $value The parent invoice id. |
|
531 | - */ |
|
532 | - public function set_parent_payment_id( $value ) { |
|
533 | - $this->set_parent_invoice_id( $value ); |
|
534 | - } |
|
633 | + } |
|
535 | 634 | |
536 | - /** |
|
537 | - * Alias for self::set_parent_invoice_id(). |
|
635 | + /** |
|
636 | + * Alias for self::set_created(). |
|
538 | 637 | * |
539 | 638 | * @since 1.0.19 |
540 | - * @param int $value The parent invoice id. |
|
639 | + * @param string $value strtotime compliant date. |
|
541 | 640 | */ |
542 | - public function set_original_payment_id( $value ) { |
|
543 | - $this->set_parent_invoice_id( $value ); |
|
544 | - } |
|
545 | - |
|
546 | - /** |
|
547 | - * Set subscription's product id. |
|
548 | - * |
|
549 | - * @since 1.0.19 |
|
550 | - * @param int $value The subscription product id. |
|
551 | - */ |
|
552 | - public function set_product_id( $value ) { |
|
553 | - $this->set_prop( 'product_id', (int) $value ); |
|
554 | - } |
|
555 | - |
|
556 | - /** |
|
557 | - * Set the period of a renewal. |
|
558 | - * |
|
559 | - * @since 1.0.19 |
|
560 | - * @param string $value The renewal period. |
|
561 | - */ |
|
562 | - public function set_period( $value ) { |
|
563 | - $this->set_prop( 'period', $value ); |
|
564 | - } |
|
565 | - |
|
566 | - /** |
|
567 | - * Set number of periods each renewal is valid for. |
|
568 | - * |
|
569 | - * @since 1.0.19 |
|
570 | - * @param int $value The subscription frequency. |
|
571 | - */ |
|
572 | - public function set_frequency( $value ) { |
|
573 | - $value = empty( $value ) ? 1 : (int) $value; |
|
574 | - $this->set_prop( 'frequency', absint( $value ) ); |
|
575 | - } |
|
576 | - |
|
577 | - /** |
|
578 | - * Set the initial amount for the subscription. |
|
579 | - * |
|
580 | - * @since 1.0.19 |
|
581 | - * @param float $value The initial subcription amount. |
|
582 | - */ |
|
583 | - public function set_initial_amount( $value ) { |
|
584 | - $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
585 | - } |
|
586 | - |
|
587 | - /** |
|
588 | - * Set the recurring amount for the subscription. |
|
589 | - * |
|
590 | - * @since 1.0.19 |
|
591 | - * @param float $value The recurring subcription amount. |
|
592 | - */ |
|
593 | - public function set_recurring_amount( $value ) { |
|
594 | - $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
595 | - } |
|
596 | - |
|
597 | - /** |
|
598 | - * Set number of times that this subscription can be renewed. |
|
599 | - * |
|
600 | - * @since 1.0.19 |
|
601 | - * @param int $value Bill times. |
|
602 | - */ |
|
603 | - public function set_bill_times( $value ) { |
|
604 | - $this->set_prop( 'bill_times', (int) $value ); |
|
605 | - } |
|
606 | - |
|
607 | - /** |
|
608 | - * Get transaction id of this subscription's parent invoice. |
|
609 | - * |
|
610 | - * @since 1.0.19 |
|
611 | - * @param string $value Bill times. |
|
612 | - */ |
|
613 | - public function set_transaction_id( $value ) { |
|
614 | - $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
615 | - } |
|
616 | - |
|
617 | - /** |
|
618 | - * Set date when this subscription started. |
|
619 | - * |
|
620 | - * @since 1.0.19 |
|
621 | - * @param string $value strtotime compliant date. |
|
622 | - */ |
|
623 | - public function set_created( $value ) { |
|
641 | + public function set_date_created( $value ) { |
|
642 | + $this->set_created( $value ); |
|
643 | + } |
|
644 | + |
|
645 | + /** |
|
646 | + * Set the date that the subscription will renew. |
|
647 | + * |
|
648 | + * @since 1.0.19 |
|
649 | + * @param string $value strtotime compliant date. |
|
650 | + */ |
|
651 | + public function set_next_renewal_date( $value ) { |
|
624 | 652 | $date = strtotime( $value ); |
625 | 653 | |
626 | 654 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
627 | - $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
655 | + $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
628 | 656 | return; |
629 | 657 | } |
630 | 658 | |
631 | - $this->set_prop( 'created', '' ); |
|
659 | + $this->set_prop( 'expiration', '' ); |
|
660 | + |
|
661 | + } |
|
632 | 662 | |
633 | - } |
|
663 | + /** |
|
664 | + * Alias for self::set_next_renewal_date(). |
|
665 | + * |
|
666 | + * @since 1.0.19 |
|
667 | + * @param string $value strtotime compliant date. |
|
668 | + */ |
|
669 | + public function set_expiration( $value ) { |
|
670 | + $this->set_next_renewal_date( $value ); |
|
671 | + } |
|
634 | 672 | |
635 | - /** |
|
636 | - * Alias for self::set_created(). |
|
637 | - * |
|
638 | - * @since 1.0.19 |
|
639 | - * @param string $value strtotime compliant date. |
|
640 | - */ |
|
641 | - public function set_date_created( $value ) { |
|
642 | - $this->set_created( $value ); |
|
673 | + /** |
|
674 | + * Set the subscription's trial period. |
|
675 | + * |
|
676 | + * @since 1.0.19 |
|
677 | + * @param string $value trial period e.g 1 year. |
|
678 | + */ |
|
679 | + public function set_trial_period( $value ) { |
|
680 | + $this->set_prop( 'trial_period', $value ); |
|
643 | 681 | } |
644 | 682 | |
645 | - /** |
|
646 | - * Set the date that the subscription will renew. |
|
647 | - * |
|
648 | - * @since 1.0.19 |
|
649 | - * @param string $value strtotime compliant date. |
|
650 | - */ |
|
651 | - public function set_next_renewal_date( $value ) { |
|
652 | - $date = strtotime( $value ); |
|
683 | + /** |
|
684 | + * Set the subscription's status. |
|
685 | + * |
|
686 | + * @since 1.0.19 |
|
687 | + * @param string $new_status New subscription status. |
|
688 | + */ |
|
689 | + public function set_status( $new_status ) { |
|
653 | 690 | |
654 | - if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
655 | - $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
691 | + // Abort if this is not a valid status; |
|
692 | + if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
656 | 693 | return; |
657 | - } |
|
658 | - |
|
659 | - $this->set_prop( 'expiration', '' ); |
|
660 | - |
|
661 | - } |
|
662 | - |
|
663 | - /** |
|
664 | - * Alias for self::set_next_renewal_date(). |
|
665 | - * |
|
666 | - * @since 1.0.19 |
|
667 | - * @param string $value strtotime compliant date. |
|
668 | - */ |
|
669 | - public function set_expiration( $value ) { |
|
670 | - $this->set_next_renewal_date( $value ); |
|
671 | - } |
|
672 | - |
|
673 | - /** |
|
674 | - * Set the subscription's trial period. |
|
675 | - * |
|
676 | - * @since 1.0.19 |
|
677 | - * @param string $value trial period e.g 1 year. |
|
678 | - */ |
|
679 | - public function set_trial_period( $value ) { |
|
680 | - $this->set_prop( 'trial_period', $value ); |
|
681 | - } |
|
682 | - |
|
683 | - /** |
|
684 | - * Set the subscription's status. |
|
685 | - * |
|
686 | - * @since 1.0.19 |
|
687 | - * @param string $new_status New subscription status. |
|
688 | - */ |
|
689 | - public function set_status( $new_status ) { |
|
690 | - |
|
691 | - // Abort if this is not a valid status; |
|
692 | - if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
693 | - return; |
|
694 | - } |
|
695 | - |
|
696 | - $old_status = $this->get_status(); |
|
697 | - $this->set_prop( 'status', $new_status ); |
|
698 | - |
|
699 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
700 | - $this->status_transition = array( |
|
701 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
702 | - 'to' => $new_status, |
|
703 | - ); |
|
704 | - } |
|
705 | - |
|
706 | - } |
|
707 | - |
|
708 | - /** |
|
709 | - * Set the subscription's (remote) profile id. |
|
710 | - * |
|
711 | - * @since 1.0.19 |
|
712 | - * @param string $value the remote profile id. |
|
713 | - */ |
|
714 | - public function set_profile_id( $value ) { |
|
715 | - $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
716 | - } |
|
717 | - |
|
718 | - /* |
|
694 | + } |
|
695 | + |
|
696 | + $old_status = $this->get_status(); |
|
697 | + $this->set_prop( 'status', $new_status ); |
|
698 | + |
|
699 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
700 | + $this->status_transition = array( |
|
701 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
702 | + 'to' => $new_status, |
|
703 | + ); |
|
704 | + } |
|
705 | + |
|
706 | + } |
|
707 | + |
|
708 | + /** |
|
709 | + * Set the subscription's (remote) profile id. |
|
710 | + * |
|
711 | + * @since 1.0.19 |
|
712 | + * @param string $value the remote profile id. |
|
713 | + */ |
|
714 | + public function set_profile_id( $value ) { |
|
715 | + $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
716 | + } |
|
717 | + |
|
718 | + /* |
|
719 | 719 | |-------------------------------------------------------------------------- |
720 | 720 | | Boolean methods |
721 | 721 | |-------------------------------------------------------------------------- |
@@ -724,55 +724,55 @@ discard block |
||
724 | 724 | | |
725 | 725 | */ |
726 | 726 | |
727 | - /** |
|
727 | + /** |
|
728 | 728 | * Checks if the subscription has a given status. |
729 | - * |
|
730 | - * @param string|array String or array of strings to check for. |
|
731 | - * @return bool |
|
729 | + * |
|
730 | + * @param string|array String or array of strings to check for. |
|
731 | + * @return bool |
|
732 | 732 | */ |
733 | 733 | public function has_status( $status ) { |
734 | 734 | return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) ); |
735 | - } |
|
735 | + } |
|
736 | 736 | |
737 | - /** |
|
737 | + /** |
|
738 | 738 | * Checks if the subscription has a trial period. |
739 | - * |
|
740 | - * @return bool |
|
739 | + * |
|
740 | + * @return bool |
|
741 | 741 | */ |
742 | 742 | public function has_trial_period() { |
743 | - $period = $this->get_trial_period(); |
|
743 | + $period = $this->get_trial_period(); |
|
744 | 744 | return ! empty( $period ); |
745 | - } |
|
746 | - |
|
747 | - /** |
|
748 | - * Is the subscription active? |
|
749 | - * |
|
750 | - * @return bool |
|
751 | - */ |
|
752 | - public function is_active() { |
|
753 | - return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
754 | - } |
|
755 | - |
|
756 | - /** |
|
757 | - * Is the subscription expired? |
|
758 | - * |
|
759 | - * @return bool |
|
760 | - */ |
|
761 | - public function is_expired() { |
|
762 | - return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) ); |
|
763 | - } |
|
764 | - |
|
765 | - /** |
|
766 | - * Is this the last renewals? |
|
767 | - * |
|
768 | - * @return bool |
|
769 | - */ |
|
770 | - public function is_last_renewal() { |
|
771 | - $max_bills = $this->get_bill_times(); |
|
772 | - return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
773 | - } |
|
774 | - |
|
775 | - /* |
|
745 | + } |
|
746 | + |
|
747 | + /** |
|
748 | + * Is the subscription active? |
|
749 | + * |
|
750 | + * @return bool |
|
751 | + */ |
|
752 | + public function is_active() { |
|
753 | + return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
754 | + } |
|
755 | + |
|
756 | + /** |
|
757 | + * Is the subscription expired? |
|
758 | + * |
|
759 | + * @return bool |
|
760 | + */ |
|
761 | + public function is_expired() { |
|
762 | + return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) ); |
|
763 | + } |
|
764 | + |
|
765 | + /** |
|
766 | + * Is this the last renewals? |
|
767 | + * |
|
768 | + * @return bool |
|
769 | + */ |
|
770 | + public function is_last_renewal() { |
|
771 | + $max_bills = $this->get_bill_times(); |
|
772 | + return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
773 | + } |
|
774 | + |
|
775 | + /* |
|
776 | 776 | |-------------------------------------------------------------------------- |
777 | 777 | | Additional methods |
778 | 778 | |-------------------------------------------------------------------------- |
@@ -781,27 +781,27 @@ discard block |
||
781 | 781 | | |
782 | 782 | */ |
783 | 783 | |
784 | - /** |
|
785 | - * Backwards compatibilty. |
|
786 | - */ |
|
787 | - public function create( $data = array() ) { |
|
784 | + /** |
|
785 | + * Backwards compatibilty. |
|
786 | + */ |
|
787 | + public function create( $data = array() ) { |
|
788 | 788 | |
789 | - // Set the properties. |
|
790 | - if ( is_array( $data ) ) { |
|
791 | - $this->set_props( $data ); |
|
792 | - } |
|
789 | + // Set the properties. |
|
790 | + if ( is_array( $data ) ) { |
|
791 | + $this->set_props( $data ); |
|
792 | + } |
|
793 | 793 | |
794 | - // Save the item. |
|
795 | - return $this->save(); |
|
794 | + // Save the item. |
|
795 | + return $this->save(); |
|
796 | 796 | |
797 | - } |
|
797 | + } |
|
798 | 798 | |
799 | - /** |
|
800 | - * Backwards compatibilty. |
|
801 | - */ |
|
802 | - public function update( $args = array() ) { |
|
803 | - return $this->create( $args ); |
|
804 | - } |
|
799 | + /** |
|
800 | + * Backwards compatibilty. |
|
801 | + */ |
|
802 | + public function update( $args = array() ) { |
|
803 | + return $this->create( $args ); |
|
804 | + } |
|
805 | 805 | |
806 | 806 | /** |
807 | 807 | * Retrieve renewal payments for a subscription |
@@ -811,22 +811,22 @@ discard block |
||
811 | 811 | */ |
812 | 812 | public function get_child_payments( $hide_pending = true ) { |
813 | 813 | |
814 | - $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
814 | + $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
815 | 815 | |
816 | - if ( ! $hide_pending ) { |
|
817 | - $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
818 | - } |
|
816 | + if ( ! $hide_pending ) { |
|
817 | + $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
818 | + } |
|
819 | 819 | |
820 | 820 | return get_posts( |
821 | - array( |
|
822 | - 'post_parent' => $this->get_parent_payment_id(), |
|
823 | - 'numberposts' => -1, |
|
824 | - 'post_status' => $statuses, |
|
825 | - 'orderby' => 'ID', |
|
826 | - 'order' => 'DESC', |
|
827 | - 'post_type' => 'wpi_invoice' |
|
828 | - ) |
|
829 | - ); |
|
821 | + array( |
|
822 | + 'post_parent' => $this->get_parent_payment_id(), |
|
823 | + 'numberposts' => -1, |
|
824 | + 'post_status' => $statuses, |
|
825 | + 'orderby' => 'ID', |
|
826 | + 'order' => 'DESC', |
|
827 | + 'post_type' => 'wpi_invoice' |
|
828 | + ) |
|
829 | + ); |
|
830 | 830 | } |
831 | 831 | |
832 | 832 | /** |
@@ -836,16 +836,16 @@ discard block |
||
836 | 836 | * @return int |
837 | 837 | */ |
838 | 838 | public function get_total_payments() { |
839 | - global $wpdb; |
|
839 | + global $wpdb; |
|
840 | 840 | |
841 | - $count = (int) $wpdb->get_var( |
|
842 | - $wpdb->prepare( |
|
843 | - "SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
844 | - $this->get_parent_invoice_id() |
|
845 | - ) |
|
846 | - ); |
|
841 | + $count = (int) $wpdb->get_var( |
|
842 | + $wpdb->prepare( |
|
843 | + "SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
844 | + $this->get_parent_invoice_id() |
|
845 | + ) |
|
846 | + ); |
|
847 | 847 | |
848 | - // Maybe include parent invoice. |
|
848 | + // Maybe include parent invoice. |
|
849 | 849 | if ( $this->get_parent_payment()->is_paid() ) { |
850 | 850 | $count++; |
851 | 851 | } |
@@ -874,57 +874,57 @@ discard block |
||
874 | 874 | * |
875 | 875 | * @since 2.4 |
876 | 876 | * @param array $args Array of values for the payment, including amount and transaction ID |
877 | - * @param WPInv_Invoice $invoice If adding an existing invoice. |
|
877 | + * @param WPInv_Invoice $invoice If adding an existing invoice. |
|
878 | 878 | * @return bool |
879 | 879 | */ |
880 | 880 | public function add_payment( $args = array(), $invoice = false ) { |
881 | 881 | |
882 | - // Process each payment once. |
|
882 | + // Process each payment once. |
|
883 | 883 | if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) { |
884 | 884 | return false; |
885 | 885 | } |
886 | 886 | |
887 | - // Are we creating a new invoice? |
|
888 | - if ( empty( $invoice ) ) { |
|
889 | - $invoice = $this->create_payment(); |
|
887 | + // Are we creating a new invoice? |
|
888 | + if ( empty( $invoice ) ) { |
|
889 | + $invoice = $this->create_payment(); |
|
890 | 890 | |
891 | - if ( empty( $invoice ) ) { |
|
892 | - return false; |
|
893 | - } |
|
891 | + if ( empty( $invoice ) ) { |
|
892 | + return false; |
|
893 | + } |
|
894 | 894 | |
895 | - } |
|
895 | + } |
|
896 | 896 | |
897 | - $invoice->set_status( 'wpi-renewal' ); |
|
897 | + $invoice->set_status( 'wpi-renewal' ); |
|
898 | 898 | |
899 | - // Maybe set a transaction id. |
|
900 | - if ( ! empty( $args['transaction_id'] ) ) { |
|
901 | - $invoice->set_transaction_id( $args['transaction_id'] ); |
|
902 | - } |
|
899 | + // Maybe set a transaction id. |
|
900 | + if ( ! empty( $args['transaction_id'] ) ) { |
|
901 | + $invoice->set_transaction_id( $args['transaction_id'] ); |
|
902 | + } |
|
903 | 903 | |
904 | - // Set the completed date. |
|
905 | - $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
904 | + // Set the completed date. |
|
905 | + $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
906 | 906 | |
907 | - // And the gateway. |
|
908 | - if ( ! empty( $args['gateway'] ) ) { |
|
909 | - $invoice->set_gateway( $args['gateway'] ); |
|
910 | - } |
|
907 | + // And the gateway. |
|
908 | + if ( ! empty( $args['gateway'] ) ) { |
|
909 | + $invoice->set_gateway( $args['gateway'] ); |
|
910 | + } |
|
911 | 911 | |
912 | - $invoice->save(); |
|
912 | + $invoice->save(); |
|
913 | 913 | |
914 | - if ( ! $invoice->exists() ) { |
|
915 | - return false; |
|
916 | - } |
|
914 | + if ( ! $invoice->exists() ) { |
|
915 | + return false; |
|
916 | + } |
|
917 | 917 | |
918 | - do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
919 | - do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
918 | + do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
919 | + do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
920 | 920 | do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() ); |
921 | 921 | |
922 | 922 | update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id ); |
923 | 923 | |
924 | 924 | return $invoice->get_id(); |
925 | - } |
|
925 | + } |
|
926 | 926 | |
927 | - /** |
|
927 | + /** |
|
928 | 928 | * Creates a new invoice and returns it. |
929 | 929 | * |
930 | 930 | * @since 1.0.19 |
@@ -932,97 +932,97 @@ discard block |
||
932 | 932 | */ |
933 | 933 | public function create_payment() { |
934 | 934 | |
935 | - $parent_invoice = $this->get_parent_payment(); |
|
936 | - |
|
937 | - if ( ! $parent_invoice->exists() ) { |
|
938 | - return false; |
|
939 | - } |
|
940 | - |
|
941 | - // Duplicate the parent invoice. |
|
942 | - $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
943 | - $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
944 | - $invoice->recalculate_total(); |
|
945 | - $invoice->set_status( 'wpi-pending' ); |
|
946 | - $invoice->save(); |
|
947 | - |
|
948 | - return $invoice->exists() ? $invoice : false; |
|
949 | - } |
|
950 | - |
|
951 | - /** |
|
952 | - * Renews or completes a subscription |
|
953 | - * |
|
954 | - * @since 1.0.0 |
|
955 | - * @return int The subscription's id |
|
956 | - */ |
|
957 | - public function renew() { |
|
958 | - |
|
959 | - // Complete subscription if applicable |
|
960 | - if ( $this->is_last_renewal() ) { |
|
961 | - return $this->complete(); |
|
962 | - } |
|
963 | - |
|
964 | - // Calculate new expiration |
|
965 | - $frequency = $this->get_frequency(); |
|
966 | - $period = $this->get_period(); |
|
967 | - $new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() ); |
|
968 | - |
|
969 | - $this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) ); |
|
970 | - $this->set_status( 'active' ); |
|
971 | - return $this->save(); |
|
972 | - |
|
973 | - do_action( 'getpaid_subscription_renewed', $this ); |
|
974 | - |
|
975 | - } |
|
976 | - |
|
977 | - /** |
|
978 | - * Marks a subscription as completed |
|
979 | - * |
|
980 | - * Subscription is completed when the number of payments matches the billing_times field |
|
981 | - * |
|
982 | - * @since 1.0.0 |
|
983 | - * @return int|bool Subscription id or false if the subscription is cancelled. |
|
984 | - */ |
|
985 | - public function complete() { |
|
986 | - |
|
987 | - // Only mark a subscription as complete if it's not already cancelled. |
|
988 | - if ( $this->has_status( 'cancelled' ) ) { |
|
989 | - return false; |
|
990 | - } |
|
991 | - |
|
992 | - $this->set_status( 'completed' ); |
|
993 | - return $this->save(); |
|
994 | - |
|
995 | - } |
|
996 | - |
|
997 | - /** |
|
998 | - * Marks a subscription as expired |
|
999 | - * |
|
1000 | - * @since 1.0.0 |
|
1001 | - * @param bool $check_expiration |
|
1002 | - * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
|
1003 | - */ |
|
1004 | - public function expire( $check_expiration = false ) { |
|
1005 | - |
|
1006 | - if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
1007 | - // Do not mark as expired since real expiration date is in the future |
|
1008 | - return false; |
|
1009 | - } |
|
1010 | - |
|
1011 | - $this->set_status( 'expired' ); |
|
1012 | - return $this->save(); |
|
1013 | - |
|
1014 | - } |
|
1015 | - |
|
1016 | - /** |
|
1017 | - * Marks a subscription as failing |
|
1018 | - * |
|
1019 | - * @since 2.4.2 |
|
1020 | - * @return int Subscription id. |
|
1021 | - */ |
|
1022 | - public function failing() { |
|
1023 | - $this->set_status( 'failing' ); |
|
1024 | - return $this->save(); |
|
1025 | - } |
|
935 | + $parent_invoice = $this->get_parent_payment(); |
|
936 | + |
|
937 | + if ( ! $parent_invoice->exists() ) { |
|
938 | + return false; |
|
939 | + } |
|
940 | + |
|
941 | + // Duplicate the parent invoice. |
|
942 | + $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
943 | + $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
944 | + $invoice->recalculate_total(); |
|
945 | + $invoice->set_status( 'wpi-pending' ); |
|
946 | + $invoice->save(); |
|
947 | + |
|
948 | + return $invoice->exists() ? $invoice : false; |
|
949 | + } |
|
950 | + |
|
951 | + /** |
|
952 | + * Renews or completes a subscription |
|
953 | + * |
|
954 | + * @since 1.0.0 |
|
955 | + * @return int The subscription's id |
|
956 | + */ |
|
957 | + public function renew() { |
|
958 | + |
|
959 | + // Complete subscription if applicable |
|
960 | + if ( $this->is_last_renewal() ) { |
|
961 | + return $this->complete(); |
|
962 | + } |
|
963 | + |
|
964 | + // Calculate new expiration |
|
965 | + $frequency = $this->get_frequency(); |
|
966 | + $period = $this->get_period(); |
|
967 | + $new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() ); |
|
968 | + |
|
969 | + $this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) ); |
|
970 | + $this->set_status( 'active' ); |
|
971 | + return $this->save(); |
|
972 | + |
|
973 | + do_action( 'getpaid_subscription_renewed', $this ); |
|
974 | + |
|
975 | + } |
|
976 | + |
|
977 | + /** |
|
978 | + * Marks a subscription as completed |
|
979 | + * |
|
980 | + * Subscription is completed when the number of payments matches the billing_times field |
|
981 | + * |
|
982 | + * @since 1.0.0 |
|
983 | + * @return int|bool Subscription id or false if the subscription is cancelled. |
|
984 | + */ |
|
985 | + public function complete() { |
|
986 | + |
|
987 | + // Only mark a subscription as complete if it's not already cancelled. |
|
988 | + if ( $this->has_status( 'cancelled' ) ) { |
|
989 | + return false; |
|
990 | + } |
|
991 | + |
|
992 | + $this->set_status( 'completed' ); |
|
993 | + return $this->save(); |
|
994 | + |
|
995 | + } |
|
996 | + |
|
997 | + /** |
|
998 | + * Marks a subscription as expired |
|
999 | + * |
|
1000 | + * @since 1.0.0 |
|
1001 | + * @param bool $check_expiration |
|
1002 | + * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
|
1003 | + */ |
|
1004 | + public function expire( $check_expiration = false ) { |
|
1005 | + |
|
1006 | + if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
1007 | + // Do not mark as expired since real expiration date is in the future |
|
1008 | + return false; |
|
1009 | + } |
|
1010 | + |
|
1011 | + $this->set_status( 'expired' ); |
|
1012 | + return $this->save(); |
|
1013 | + |
|
1014 | + } |
|
1015 | + |
|
1016 | + /** |
|
1017 | + * Marks a subscription as failing |
|
1018 | + * |
|
1019 | + * @since 2.4.2 |
|
1020 | + * @return int Subscription id. |
|
1021 | + */ |
|
1022 | + public function failing() { |
|
1023 | + $this->set_status( 'failing' ); |
|
1024 | + return $this->save(); |
|
1025 | + } |
|
1026 | 1026 | |
1027 | 1027 | /** |
1028 | 1028 | * Marks a subscription as cancelled |
@@ -1031,19 +1031,19 @@ discard block |
||
1031 | 1031 | * @return int Subscription id. |
1032 | 1032 | */ |
1033 | 1033 | public function cancel() { |
1034 | - $this->set_status( 'cancelled' ); |
|
1035 | - return $this->save(); |
|
1034 | + $this->set_status( 'cancelled' ); |
|
1035 | + return $this->save(); |
|
1036 | 1036 | } |
1037 | 1037 | |
1038 | - /** |
|
1039 | - * Determines if a subscription can be cancelled both locally and with a payment processor. |
|
1040 | - * |
|
1041 | - * @since 1.0.0 |
|
1042 | - * @return bool |
|
1043 | - */ |
|
1044 | - public function can_cancel() { |
|
1045 | - return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
1046 | - } |
|
1038 | + /** |
|
1039 | + * Determines if a subscription can be cancelled both locally and with a payment processor. |
|
1040 | + * |
|
1041 | + * @since 1.0.0 |
|
1042 | + * @return bool |
|
1043 | + */ |
|
1044 | + public function can_cancel() { |
|
1045 | + return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
1046 | + } |
|
1047 | 1047 | |
1048 | 1048 | /** |
1049 | 1049 | * Returns an array of subscription statuses that can be cancelled |
@@ -1056,96 +1056,96 @@ discard block |
||
1056 | 1056 | return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) ); |
1057 | 1057 | } |
1058 | 1058 | |
1059 | - /** |
|
1060 | - * Retrieves the URL to cancel subscription |
|
1061 | - * |
|
1062 | - * @since 1.0.0 |
|
1063 | - * @return string |
|
1064 | - */ |
|
1065 | - public function get_cancel_url() { |
|
1066 | - $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
1067 | - return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
1068 | - } |
|
1069 | - |
|
1070 | - /** |
|
1071 | - * Retrieves the URL to view a subscription |
|
1072 | - * |
|
1073 | - * @since 1.0.19 |
|
1074 | - * @return string |
|
1075 | - */ |
|
1076 | - public function get_view_url() { |
|
1077 | - |
|
1078 | - $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
1079 | - $url = add_query_arg( 'subscription', $this->get_id(), $url ); |
|
1080 | - |
|
1081 | - return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
1082 | - } |
|
1083 | - |
|
1084 | - /** |
|
1085 | - * Determines if subscription can be manually renewed |
|
1086 | - * |
|
1087 | - * This method is filtered by payment gateways in order to return true on subscriptions |
|
1088 | - * that can be renewed manually |
|
1089 | - * |
|
1090 | - * @since 2.5 |
|
1091 | - * @return bool |
|
1092 | - */ |
|
1093 | - public function can_renew() { |
|
1094 | - return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
1095 | - } |
|
1096 | - |
|
1097 | - /** |
|
1098 | - * Retrieves the URL to renew a subscription |
|
1099 | - * |
|
1100 | - * @since 2.5 |
|
1101 | - * @return string |
|
1102 | - */ |
|
1103 | - public function get_renew_url() { |
|
1104 | - $url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' ); |
|
1105 | - return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
1106 | - } |
|
1107 | - |
|
1108 | - /** |
|
1109 | - * Determines if subscription can have their payment method updated |
|
1110 | - * |
|
1111 | - * @since 1.0.0 |
|
1112 | - * @return bool |
|
1113 | - */ |
|
1114 | - public function can_update() { |
|
1115 | - return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
1116 | - } |
|
1117 | - |
|
1118 | - /** |
|
1119 | - * Retrieves the URL to update subscription |
|
1120 | - * |
|
1121 | - * @since 1.0.0 |
|
1122 | - * @return string |
|
1123 | - */ |
|
1124 | - public function get_update_url() { |
|
1125 | - $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) ); |
|
1126 | - return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
1127 | - } |
|
1128 | - |
|
1129 | - /** |
|
1130 | - * Retrieves the subscription status label |
|
1131 | - * |
|
1132 | - * @since 1.0.0 |
|
1133 | - * @return string |
|
1134 | - */ |
|
1135 | - public function get_status_label() { |
|
1136 | - return getpaid_get_subscription_status_label( $this->get_status() ); |
|
1137 | - } |
|
1138 | - |
|
1139 | - /** |
|
1140 | - * Retrieves the subscription status class |
|
1141 | - * |
|
1142 | - * @since 1.0.19 |
|
1143 | - * @return string |
|
1144 | - */ |
|
1145 | - public function get_status_class() { |
|
1146 | - $statuses = getpaid_get_subscription_status_classes(); |
|
1147 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
1148 | - } |
|
1059 | + /** |
|
1060 | + * Retrieves the URL to cancel subscription |
|
1061 | + * |
|
1062 | + * @since 1.0.0 |
|
1063 | + * @return string |
|
1064 | + */ |
|
1065 | + public function get_cancel_url() { |
|
1066 | + $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
1067 | + return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
1068 | + } |
|
1069 | + |
|
1070 | + /** |
|
1071 | + * Retrieves the URL to view a subscription |
|
1072 | + * |
|
1073 | + * @since 1.0.19 |
|
1074 | + * @return string |
|
1075 | + */ |
|
1076 | + public function get_view_url() { |
|
1077 | + |
|
1078 | + $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
1079 | + $url = add_query_arg( 'subscription', $this->get_id(), $url ); |
|
1080 | + |
|
1081 | + return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
1082 | + } |
|
1083 | + |
|
1084 | + /** |
|
1085 | + * Determines if subscription can be manually renewed |
|
1086 | + * |
|
1087 | + * This method is filtered by payment gateways in order to return true on subscriptions |
|
1088 | + * that can be renewed manually |
|
1089 | + * |
|
1090 | + * @since 2.5 |
|
1091 | + * @return bool |
|
1092 | + */ |
|
1093 | + public function can_renew() { |
|
1094 | + return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
1095 | + } |
|
1096 | + |
|
1097 | + /** |
|
1098 | + * Retrieves the URL to renew a subscription |
|
1099 | + * |
|
1100 | + * @since 2.5 |
|
1101 | + * @return string |
|
1102 | + */ |
|
1103 | + public function get_renew_url() { |
|
1104 | + $url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' ); |
|
1105 | + return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
1106 | + } |
|
1107 | + |
|
1108 | + /** |
|
1109 | + * Determines if subscription can have their payment method updated |
|
1110 | + * |
|
1111 | + * @since 1.0.0 |
|
1112 | + * @return bool |
|
1113 | + */ |
|
1114 | + public function can_update() { |
|
1115 | + return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
1116 | + } |
|
1117 | + |
|
1118 | + /** |
|
1119 | + * Retrieves the URL to update subscription |
|
1120 | + * |
|
1121 | + * @since 1.0.0 |
|
1122 | + * @return string |
|
1123 | + */ |
|
1124 | + public function get_update_url() { |
|
1125 | + $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) ); |
|
1126 | + return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
1127 | + } |
|
1128 | + |
|
1129 | + /** |
|
1130 | + * Retrieves the subscription status label |
|
1131 | + * |
|
1132 | + * @since 1.0.0 |
|
1133 | + * @return string |
|
1134 | + */ |
|
1135 | + public function get_status_label() { |
|
1136 | + return getpaid_get_subscription_status_label( $this->get_status() ); |
|
1137 | + } |
|
1138 | + |
|
1139 | + /** |
|
1140 | + * Retrieves the subscription status class |
|
1141 | + * |
|
1142 | + * @since 1.0.19 |
|
1143 | + * @return string |
|
1144 | + */ |
|
1145 | + public function get_status_class() { |
|
1146 | + $statuses = getpaid_get_subscription_status_classes(); |
|
1147 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
1148 | + } |
|
1149 | 1149 | |
1150 | 1150 | /** |
1151 | 1151 | * Retrieves the subscription status label |
@@ -1155,11 +1155,11 @@ discard block |
||
1155 | 1155 | */ |
1156 | 1156 | public function get_status_label_html() { |
1157 | 1157 | |
1158 | - $status_label = sanitize_text_field( $this->get_status_label() ); |
|
1159 | - $class = esc_attr( $this->get_status_class() ); |
|
1160 | - $status = sanitize_html_class( $this->get_status() ); |
|
1158 | + $status_label = sanitize_text_field( $this->get_status_label() ); |
|
1159 | + $class = esc_attr( $this->get_status_class() ); |
|
1160 | + $status = sanitize_html_class( $this->get_status() ); |
|
1161 | 1161 | |
1162 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
1162 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
1163 | 1163 | } |
1164 | 1164 | |
1165 | 1165 | /** |
@@ -1170,75 +1170,75 @@ discard block |
||
1170 | 1170 | * @return bool |
1171 | 1171 | */ |
1172 | 1172 | public function payment_exists( $txn_id = '' ) { |
1173 | - $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
1173 | + $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
1174 | 1174 | return ! empty( $invoice_id ); |
1175 | - } |
|
1176 | - |
|
1177 | - /** |
|
1178 | - * Handle the status transition. |
|
1179 | - */ |
|
1180 | - protected function status_transition() { |
|
1181 | - $status_transition = $this->status_transition; |
|
1182 | - |
|
1183 | - // Reset status transition variable. |
|
1184 | - $this->status_transition = false; |
|
1185 | - |
|
1186 | - if ( $status_transition ) { |
|
1187 | - try { |
|
1188 | - |
|
1189 | - // Fire a hook for the status change. |
|
1190 | - do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
1191 | - do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
1192 | - |
|
1193 | - if ( ! empty( $status_transition['from'] ) ) { |
|
1194 | - |
|
1195 | - /* translators: 1: old subscription status 2: new subscription status */ |
|
1196 | - $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
1197 | - |
|
1198 | - // Note the transition occurred. |
|
1199 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
1200 | - |
|
1201 | - // Fire another hook. |
|
1202 | - do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
1203 | - do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
1204 | - |
|
1205 | - } else { |
|
1206 | - /* translators: %s: new invoice status */ |
|
1207 | - $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
1208 | - |
|
1209 | - // Note the transition occurred. |
|
1210 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
1211 | - |
|
1212 | - } |
|
1213 | - } catch ( Exception $e ) { |
|
1214 | - $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
1215 | - } |
|
1216 | - } |
|
1217 | - |
|
1218 | - } |
|
1219 | - |
|
1220 | - /** |
|
1221 | - * Save data to the database. |
|
1222 | - * |
|
1223 | - * @since 1.0.19 |
|
1224 | - * @return int subscription ID |
|
1225 | - */ |
|
1226 | - public function save() { |
|
1227 | - parent::save(); |
|
1228 | - $this->status_transition(); |
|
1229 | - return $this->get_id(); |
|
1230 | - } |
|
1231 | - |
|
1232 | - /** |
|
1233 | - * Activates a subscription. |
|
1234 | - * |
|
1235 | - * @since 1.0.19 |
|
1236 | - * @return int subscription ID |
|
1237 | - */ |
|
1238 | - public function activate() { |
|
1239 | - $status = 'trialling' == $this->get_status() ? 'trialling' : 'active'; |
|
1240 | - $this->set_status( $status ); |
|
1241 | - return $this->save(); |
|
1242 | - } |
|
1175 | + } |
|
1176 | + |
|
1177 | + /** |
|
1178 | + * Handle the status transition. |
|
1179 | + */ |
|
1180 | + protected function status_transition() { |
|
1181 | + $status_transition = $this->status_transition; |
|
1182 | + |
|
1183 | + // Reset status transition variable. |
|
1184 | + $this->status_transition = false; |
|
1185 | + |
|
1186 | + if ( $status_transition ) { |
|
1187 | + try { |
|
1188 | + |
|
1189 | + // Fire a hook for the status change. |
|
1190 | + do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
1191 | + do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
1192 | + |
|
1193 | + if ( ! empty( $status_transition['from'] ) ) { |
|
1194 | + |
|
1195 | + /* translators: 1: old subscription status 2: new subscription status */ |
|
1196 | + $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
1197 | + |
|
1198 | + // Note the transition occurred. |
|
1199 | + $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
1200 | + |
|
1201 | + // Fire another hook. |
|
1202 | + do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
1203 | + do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
1204 | + |
|
1205 | + } else { |
|
1206 | + /* translators: %s: new invoice status */ |
|
1207 | + $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
1208 | + |
|
1209 | + // Note the transition occurred. |
|
1210 | + $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
1211 | + |
|
1212 | + } |
|
1213 | + } catch ( Exception $e ) { |
|
1214 | + $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
1215 | + } |
|
1216 | + } |
|
1217 | + |
|
1218 | + } |
|
1219 | + |
|
1220 | + /** |
|
1221 | + * Save data to the database. |
|
1222 | + * |
|
1223 | + * @since 1.0.19 |
|
1224 | + * @return int subscription ID |
|
1225 | + */ |
|
1226 | + public function save() { |
|
1227 | + parent::save(); |
|
1228 | + $this->status_transition(); |
|
1229 | + return $this->get_id(); |
|
1230 | + } |
|
1231 | + |
|
1232 | + /** |
|
1233 | + * Activates a subscription. |
|
1234 | + * |
|
1235 | + * @since 1.0.19 |
|
1236 | + * @return int subscription ID |
|
1237 | + */ |
|
1238 | + public function activate() { |
|
1239 | + $status = 'trialling' == $this->get_status() ? 'trialling' : 'active'; |
|
1240 | + $this->set_status( $status ); |
|
1241 | + return $this->save(); |
|
1242 | + } |
|
1243 | 1243 | |
1244 | 1244 | } |
@@ -13,38 +13,38 @@ |
||
13 | 13 | |
14 | 14 | foreach ( array_keys( $widget->get_subscriptions_table_columns() ) as $column ) : |
15 | 15 | |
16 | - $class = sanitize_html_class( $column ); |
|
17 | - echo "<td class='getpaid-subscriptions-table-column-$class'>"; |
|
16 | + $class = sanitize_html_class( $column ); |
|
17 | + echo "<td class='getpaid-subscriptions-table-column-$class'>"; |
|
18 | 18 | |
19 | - do_action( "getpaid_subscriptions_before_frontend_subscription_table_$column", $subscription ); |
|
19 | + do_action( "getpaid_subscriptions_before_frontend_subscription_table_$column", $subscription ); |
|
20 | 20 | |
21 | - switch( $column ) : |
|
21 | + switch( $column ) : |
|
22 | 22 | |
23 | - case 'subscription': |
|
24 | - $subscription_id = (int) $subscription->get_id(); |
|
25 | - $url = esc_url( $subscription->get_view_url() ); |
|
26 | - echo $widget->add_row_actions( "<a href='$url' class='font-weight-bold text-decoration-none'>#$subscription_id</a>", $subscription ); |
|
27 | - break; |
|
23 | + case 'subscription': |
|
24 | + $subscription_id = (int) $subscription->get_id(); |
|
25 | + $url = esc_url( $subscription->get_view_url() ); |
|
26 | + echo $widget->add_row_actions( "<a href='$url' class='font-weight-bold text-decoration-none'>#$subscription_id</a>", $subscription ); |
|
27 | + break; |
|
28 | 28 | |
29 | - case 'status': |
|
30 | - echo $subscription->get_status_label(); |
|
31 | - break; |
|
29 | + case 'status': |
|
30 | + echo $subscription->get_status_label(); |
|
31 | + break; |
|
32 | 32 | |
33 | - case 'renewal-date': |
|
34 | - $renewal = getpaid_format_date_value( $subscription->get_next_renewal_date() ); |
|
35 | - echo $subscription->is_active() ? $renewal : "—"; |
|
36 | - break; |
|
33 | + case 'renewal-date': |
|
34 | + $renewal = getpaid_format_date_value( $subscription->get_next_renewal_date() ); |
|
35 | + echo $subscription->is_active() ? $renewal : "—"; |
|
36 | + break; |
|
37 | 37 | |
38 | - case 'amount': |
|
39 | - $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
40 | - $amount = wpinv_price( wpinv_format_amount( wpinv_sanitize_amount( $subscription->get_recurring_amount() ) ), $subscription->get_parent_payment()->get_currency() ); |
|
41 | - echo "<span>$amount</span> / $frequency"; |
|
42 | - break; |
|
38 | + case 'amount': |
|
39 | + $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
40 | + $amount = wpinv_price( wpinv_format_amount( wpinv_sanitize_amount( $subscription->get_recurring_amount() ) ), $subscription->get_parent_payment()->get_currency() ); |
|
41 | + echo "<span>$amount</span> / $frequency"; |
|
42 | + break; |
|
43 | 43 | |
44 | - endswitch; |
|
44 | + endswitch; |
|
45 | 45 | |
46 | - do_action( "getpaid_subscriptions_frontend_subscription_table_$column", $subscription ); |
|
46 | + do_action( "getpaid_subscriptions_frontend_subscription_table_$column", $subscription ); |
|
47 | 47 | |
48 | - echo '</td>'; |
|
48 | + echo '</td>'; |
|
49 | 49 | |
50 | 50 | endforeach; |