@@ -36,36 +36,36 @@ discard block |
||
36 | 36 | 'desc_tip' => true, |
37 | 37 | 'default' => '', |
38 | 38 | 'advanced' => false |
39 | - ), |
|
39 | + ), |
|
40 | 40 | |
41 | 41 | 'form' => array( |
42 | - 'title' => __( 'Form', 'invoicing' ), |
|
43 | - 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
44 | - 'type' => 'text', |
|
45 | - 'desc_tip' => true, |
|
46 | - 'default' => '', |
|
47 | - 'placeholder' => __('1','invoicing'), |
|
48 | - 'advanced' => false |
|
49 | - ), |
|
50 | - |
|
51 | - 'item' => array( |
|
52 | - 'title' => __( 'Items', 'invoicing' ), |
|
53 | - 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
54 | - 'type' => 'text', |
|
55 | - 'desc_tip' => true, |
|
56 | - 'default' => '', |
|
57 | - 'placeholder' => __('1','invoicing'), |
|
58 | - 'advanced' => false |
|
59 | - ), |
|
42 | + 'title' => __( 'Form', 'invoicing' ), |
|
43 | + 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
44 | + 'type' => 'text', |
|
45 | + 'desc_tip' => true, |
|
46 | + 'default' => '', |
|
47 | + 'placeholder' => __('1','invoicing'), |
|
48 | + 'advanced' => false |
|
49 | + ), |
|
50 | + |
|
51 | + 'item' => array( |
|
52 | + 'title' => __( 'Items', 'invoicing' ), |
|
53 | + 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
54 | + 'type' => 'text', |
|
55 | + 'desc_tip' => true, |
|
56 | + 'default' => '', |
|
57 | + 'placeholder' => __('1','invoicing'), |
|
58 | + 'advanced' => false |
|
59 | + ), |
|
60 | 60 | |
61 | 61 | 'button' => array( |
62 | - 'title' => __( 'Button', 'invoicing' ), |
|
63 | - 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
64 | - 'type' => 'text', |
|
65 | - 'desc_tip' => true, |
|
66 | - 'default' => '', |
|
67 | - 'advanced' => false |
|
68 | - ) |
|
62 | + 'title' => __( 'Button', 'invoicing' ), |
|
63 | + 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
64 | + 'type' => 'text', |
|
65 | + 'desc_tip' => true, |
|
66 | + 'default' => '', |
|
67 | + 'advanced' => false |
|
68 | + ) |
|
69 | 69 | |
70 | 70 | ) |
71 | 71 | |
@@ -75,96 +75,96 @@ discard block |
||
75 | 75 | parent::__construct( $options ); |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * The Super block output function. |
|
80 | - * |
|
81 | - * @param array $args |
|
82 | - * @param array $widget_args |
|
83 | - * @param string $content |
|
84 | - * |
|
85 | - * @return string |
|
86 | - */ |
|
78 | + /** |
|
79 | + * The Super block output function. |
|
80 | + * |
|
81 | + * @param array $args |
|
82 | + * @param array $widget_args |
|
83 | + * @param string $content |
|
84 | + * |
|
85 | + * @return string |
|
86 | + */ |
|
87 | 87 | public function output( $args = array(), $widget_args = array(), $content = '' ) { |
88 | 88 | |
89 | - // Is the shortcode set up correctly? |
|
90 | - if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
91 | - return aui()->alert( |
|
92 | - array( |
|
93 | - 'type' => 'warning', |
|
94 | - 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
95 | - ) |
|
96 | - ); |
|
97 | - } |
|
98 | - |
|
99 | - // Payment form or button? |
|
100 | - if ( ! empty( $args['form'] ) ) { |
|
101 | - return $this->handle_payment_form( $args ); |
|
102 | - } else { |
|
103 | - return $this->handle_buy_item( $args ); |
|
104 | - } |
|
105 | - |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Displaying a payment form |
|
110 | - * |
|
111 | - * @return string |
|
112 | - */ |
|
89 | + // Is the shortcode set up correctly? |
|
90 | + if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
91 | + return aui()->alert( |
|
92 | + array( |
|
93 | + 'type' => 'warning', |
|
94 | + 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
95 | + ) |
|
96 | + ); |
|
97 | + } |
|
98 | + |
|
99 | + // Payment form or button? |
|
100 | + if ( ! empty( $args['form'] ) ) { |
|
101 | + return $this->handle_payment_form( $args ); |
|
102 | + } else { |
|
103 | + return $this->handle_buy_item( $args ); |
|
104 | + } |
|
105 | + |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Displaying a payment form |
|
110 | + * |
|
111 | + * @return string |
|
112 | + */ |
|
113 | 113 | protected function handle_payment_form( $args = array() ) { |
114 | 114 | |
115 | - if ( empty( $args['button'] ) ) { |
|
116 | - ob_start(); |
|
117 | - getpaid_display_payment_form( $args['form'] ); |
|
118 | - return ob_get_clean(); |
|
119 | - } |
|
115 | + if ( empty( $args['button'] ) ) { |
|
116 | + ob_start(); |
|
117 | + getpaid_display_payment_form( $args['form'] ); |
|
118 | + return ob_get_clean(); |
|
119 | + } |
|
120 | 120 | |
121 | - return $this->payment_form_button( $args['form'], $args['button'] ); |
|
122 | - } |
|
121 | + return $this->payment_form_button( $args['form'], $args['button'] ); |
|
122 | + } |
|
123 | 123 | |
124 | - /** |
|
125 | - * Displays a payment form button. |
|
126 | - * |
|
127 | - * @return string |
|
128 | - */ |
|
124 | + /** |
|
125 | + * Displays a payment form button. |
|
126 | + * |
|
127 | + * @return string |
|
128 | + */ |
|
129 | 129 | protected function payment_form_button( $form, $button ) { |
130 | - return getpaid_get_payment_button( $button, $form ); |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * Selling an item |
|
135 | - * |
|
136 | - * @return string |
|
137 | - */ |
|
130 | + return getpaid_get_payment_button( $button, $form ); |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * Selling an item |
|
135 | + * |
|
136 | + * @return string |
|
137 | + */ |
|
138 | 138 | protected function handle_buy_item( $args = array() ) { |
139 | 139 | |
140 | - if ( empty( $args['button'] ) ) { |
|
141 | - return $this->buy_item_form( $args['item'] ); |
|
142 | - } |
|
140 | + if ( empty( $args['button'] ) ) { |
|
141 | + return $this->buy_item_form( $args['item'] ); |
|
142 | + } |
|
143 | 143 | |
144 | - return $this->buy_item_button( $args['item'], $args['button'] ); |
|
144 | + return $this->buy_item_button( $args['item'], $args['button'] ); |
|
145 | 145 | |
146 | - } |
|
146 | + } |
|
147 | 147 | |
148 | - /** |
|
149 | - * Displays a buy item form. |
|
150 | - * |
|
151 | - * @return string |
|
152 | - */ |
|
148 | + /** |
|
149 | + * Displays a buy item form. |
|
150 | + * |
|
151 | + * @return string |
|
152 | + */ |
|
153 | 153 | protected function buy_item_form( $item ) { |
154 | - $items = getpaid_convert_items_to_array( $item ); |
|
155 | - ob_start(); |
|
156 | - getpaid_display_item_payment_form( $items ); |
|
157 | - return ob_get_clean(); |
|
158 | - } |
|
159 | - |
|
160 | - /** |
|
161 | - * Displays a buy item button. |
|
162 | - * |
|
163 | - * @return string |
|
164 | - */ |
|
154 | + $items = getpaid_convert_items_to_array( $item ); |
|
155 | + ob_start(); |
|
156 | + getpaid_display_item_payment_form( $items ); |
|
157 | + return ob_get_clean(); |
|
158 | + } |
|
159 | + |
|
160 | + /** |
|
161 | + * Displays a buy item button. |
|
162 | + * |
|
163 | + * @return string |
|
164 | + */ |
|
165 | 165 | protected function buy_item_button( $item, $button ) { |
166 | - $button = getpaid_get_payment_button( $button, null, $item ); |
|
167 | - return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
166 | + $button = getpaid_get_payment_button( $button, null, $item ); |
|
167 | + return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
168 | 168 | } |
169 | 169 | |
170 | 170 | } |
@@ -13,58 +13,58 @@ discard block |
||
13 | 13 | class GetPaid_Authorize_Net_Gateway extends GetPaid_Authorize_Net_Legacy_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'authorizenet'; |
21 | 21 | |
22 | 22 | /** |
23 | - * An array of features that this gateway supports. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
23 | + * An array of features that this gateway supports. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | 27 | protected $supports = array( 'subscription', 'sandbox', 'tokens', 'addons' ); |
28 | 28 | |
29 | 29 | /** |
30 | - * Payment method order. |
|
31 | - * |
|
32 | - * @var int |
|
33 | - */ |
|
30 | + * Payment method order. |
|
31 | + * |
|
32 | + * @var int |
|
33 | + */ |
|
34 | 34 | public $order = 4; |
35 | 35 | |
36 | 36 | /** |
37 | - * Endpoint for requests from Authorize.net. |
|
38 | - * |
|
39 | - * @var string |
|
40 | - */ |
|
41 | - protected $notify_url; |
|
42 | - |
|
43 | - /** |
|
44 | - * Endpoint for requests to Authorize.net. |
|
45 | - * |
|
46 | - * @var string |
|
47 | - */ |
|
37 | + * Endpoint for requests from Authorize.net. |
|
38 | + * |
|
39 | + * @var string |
|
40 | + */ |
|
41 | + protected $notify_url; |
|
42 | + |
|
43 | + /** |
|
44 | + * Endpoint for requests to Authorize.net. |
|
45 | + * |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $endpoint; |
49 | 49 | |
50 | 50 | /** |
51 | - * Currencies this gateway is allowed for. |
|
52 | - * |
|
53 | - * @var array |
|
54 | - */ |
|
55 | - public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' ); |
|
51 | + * Currencies this gateway is allowed for. |
|
52 | + * |
|
53 | + * @var array |
|
54 | + */ |
|
55 | + public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' ); |
|
56 | 56 | |
57 | 57 | /** |
58 | - * URL to view a transaction. |
|
59 | - * |
|
60 | - * @var string |
|
61 | - */ |
|
58 | + * URL to view a transaction. |
|
59 | + * |
|
60 | + * @var string |
|
61 | + */ |
|
62 | 62 | public $view_transaction_url = 'https://{sandbox}authorize.net/ui/themes/sandbox/Transaction/TransactionReceipt.aspx?transid=%s'; |
63 | 63 | |
64 | 64 | /** |
65 | - * Class constructor. |
|
66 | - */ |
|
67 | - public function __construct() { |
|
65 | + * Class constructor. |
|
66 | + */ |
|
67 | + public function __construct() { |
|
68 | 68 | |
69 | 69 | $this->title = __( 'Credit Card / Debit Card', 'invoicing' ); |
70 | 70 | $this->method_title = __( 'Authorize.Net', 'invoicing' ); |
@@ -76,11 +76,11 @@ discard block |
||
76 | 76 | } |
77 | 77 | |
78 | 78 | /** |
79 | - * Displays the payment method select field. |
|
80 | - * |
|
81 | - * @param int $invoice_id 0 or invoice id. |
|
82 | - * @param GetPaid_Payment_Form $form Current payment form. |
|
83 | - */ |
|
79 | + * Displays the payment method select field. |
|
80 | + * |
|
81 | + * @param int $invoice_id 0 or invoice id. |
|
82 | + * @param GetPaid_Payment_Form $form Current payment form. |
|
83 | + */ |
|
84 | 84 | public function payment_fields( $invoice_id, $form ) { |
85 | 85 | |
86 | 86 | // Let the user select a payment method. |
@@ -91,16 +91,16 @@ discard block |
||
91 | 91 | } |
92 | 92 | |
93 | 93 | /** |
94 | - * Creates a customer profile. |
|
95 | - * |
|
96 | - * |
|
97 | - * @param WPInv_Invoice $invoice Invoice. |
|
94 | + * Creates a customer profile. |
|
95 | + * |
|
96 | + * |
|
97 | + * @param WPInv_Invoice $invoice Invoice. |
|
98 | 98 | * @param array $submission_data Posted checkout fields. |
99 | 99 | * @param bool $save Whether or not to save the payment as a token. |
100 | 100 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile |
101 | - * @return string|WP_Error Payment profile id. |
|
102 | - */ |
|
103 | - public function create_customer_profile( $invoice, $submission_data, $save = true ) { |
|
101 | + * @return string|WP_Error Payment profile id. |
|
102 | + */ |
|
103 | + public function create_customer_profile( $invoice, $submission_data, $save = true ) { |
|
104 | 104 | |
105 | 105 | // Remove non-digits from the number |
106 | 106 | $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] ); |
@@ -167,14 +167,14 @@ discard block |
||
167 | 167 | } |
168 | 168 | |
169 | 169 | /** |
170 | - * Retrieves a customer profile. |
|
171 | - * |
|
172 | - * |
|
173 | - * @param string $profile_id profile id. |
|
174 | - * @return string|WP_Error Profile id. |
|
170 | + * Retrieves a customer profile. |
|
171 | + * |
|
172 | + * |
|
173 | + * @param string $profile_id profile id. |
|
174 | + * @return string|WP_Error Profile id. |
|
175 | 175 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile |
176 | - */ |
|
177 | - public function get_customer_profile( $profile_id ) { |
|
176 | + */ |
|
177 | + public function get_customer_profile( $profile_id ) { |
|
178 | 178 | |
179 | 179 | // Generate args. |
180 | 180 | $args = array( |
@@ -189,17 +189,17 @@ discard block |
||
189 | 189 | } |
190 | 190 | |
191 | 191 | /** |
192 | - * Creates a customer profile. |
|
193 | - * |
|
194 | - * |
|
192 | + * Creates a customer profile. |
|
193 | + * |
|
194 | + * |
|
195 | 195 | * @param string $profile_id profile id. |
196 | - * @param WPInv_Invoice $invoice Invoice. |
|
196 | + * @param WPInv_Invoice $invoice Invoice. |
|
197 | 197 | * @param array $submission_data Posted checkout fields. |
198 | 198 | * @param bool $save Whether or not to save the payment as a token. |
199 | 199 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile |
200 | - * @return string|WP_Error Profile id. |
|
201 | - */ |
|
202 | - public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) { |
|
200 | + * @return string|WP_Error Profile id. |
|
201 | + */ |
|
202 | + public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) { |
|
203 | 203 | |
204 | 204 | // Remove non-digits from the number |
205 | 205 | $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] ); |
@@ -259,15 +259,15 @@ discard block |
||
259 | 259 | } |
260 | 260 | |
261 | 261 | /** |
262 | - * Retrieves a customer payment profile. |
|
263 | - * |
|
264 | - * |
|
265 | - * @param string $customer_profile_id customer profile id. |
|
262 | + * Retrieves a customer payment profile. |
|
263 | + * |
|
264 | + * |
|
265 | + * @param string $customer_profile_id customer profile id. |
|
266 | 266 | * @param string $payment_profile_id payment profile id. |
267 | - * @return string|WP_Error Profile id. |
|
267 | + * @return string|WP_Error Profile id. |
|
268 | 268 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile |
269 | - */ |
|
270 | - public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) { |
|
269 | + */ |
|
270 | + public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) { |
|
271 | 271 | |
272 | 272 | // Generate args. |
273 | 273 | $args = array( |
@@ -283,15 +283,15 @@ discard block |
||
283 | 283 | } |
284 | 284 | |
285 | 285 | /** |
286 | - * Charges a customer payment profile. |
|
287 | - * |
|
286 | + * Charges a customer payment profile. |
|
287 | + * |
|
288 | 288 | * @param string $customer_profile_id customer profile id. |
289 | 289 | * @param string $payment_profile_id payment profile id. |
290 | - * @param WPInv_Invoice $invoice Invoice. |
|
290 | + * @param WPInv_Invoice $invoice Invoice. |
|
291 | 291 | * @link https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-customer-profile |
292 | - * @return WP_Error|object |
|
293 | - */ |
|
294 | - public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) { |
|
292 | + * @return WP_Error|object |
|
293 | + */ |
|
294 | + public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) { |
|
295 | 295 | |
296 | 296 | // Generate args. |
297 | 297 | $args = array( |
@@ -337,41 +337,41 @@ discard block |
||
337 | 337 | } |
338 | 338 | |
339 | 339 | /** |
340 | - * Processes a customer charge. |
|
341 | - * |
|
340 | + * Processes a customer charge. |
|
341 | + * |
|
342 | 342 | * @param stdClass $result Api response. |
343 | - * @param WPInv_Invoice $invoice Invoice. |
|
344 | - */ |
|
345 | - public function process_charge_response( $result, $invoice ) { |
|
343 | + * @param WPInv_Invoice $invoice Invoice. |
|
344 | + */ |
|
345 | + public function process_charge_response( $result, $invoice ) { |
|
346 | 346 | |
347 | 347 | wpinv_clear_errors(); |
348 | - $response_code = (int) $result->transactionResponse->responseCode; |
|
348 | + $response_code = (int) $result->transactionResponse->responseCode; |
|
349 | 349 | |
350 | - // Succeeded. |
|
351 | - if ( 1 == $response_code || 4 == $response_code ) { |
|
350 | + // Succeeded. |
|
351 | + if ( 1 == $response_code || 4 == $response_code ) { |
|
352 | 352 | |
353 | - // Maybe set a transaction id. |
|
354 | - if ( ! empty( $result->transactionResponse->transId ) ) { |
|
355 | - $invoice->set_transaction_id( $result->transactionResponse->transId ); |
|
356 | - } |
|
353 | + // Maybe set a transaction id. |
|
354 | + if ( ! empty( $result->transactionResponse->transId ) ) { |
|
355 | + $invoice->set_transaction_id( $result->transactionResponse->transId ); |
|
356 | + } |
|
357 | 357 | |
358 | - $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true ); |
|
358 | + $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true ); |
|
359 | 359 | |
360 | - if ( 1 == $response_code ) { |
|
361 | - return $invoice->mark_paid(); |
|
362 | - } |
|
360 | + if ( 1 == $response_code ) { |
|
361 | + return $invoice->mark_paid(); |
|
362 | + } |
|
363 | 363 | |
364 | - $invoice->set_status( 'wpi-onhold' ); |
|
365 | - $invoice->add_note( |
|
364 | + $invoice->set_status( 'wpi-onhold' ); |
|
365 | + $invoice->add_note( |
|
366 | 366 | sprintf( |
367 | 367 | __( 'Held for review: %s', 'invoicing' ), |
368 | 368 | $result->transactionResponse->messages->message[0]->description |
369 | 369 | ) |
370 | - ); |
|
370 | + ); |
|
371 | 371 | |
372 | - return $invoice->save(); |
|
372 | + return $invoice->save(); |
|
373 | 373 | |
374 | - } |
|
374 | + } |
|
375 | 375 | |
376 | 376 | wpinv_set_error( 'card_declined', __( 'Credit card declined.', 'invoicing' ) ); |
377 | 377 | |
@@ -383,13 +383,13 @@ discard block |
||
383 | 383 | } |
384 | 384 | |
385 | 385 | /** |
386 | - * Returns payment information. |
|
387 | - * |
|
388 | - * |
|
389 | - * @param array $card Card details. |
|
390 | - * @return array |
|
391 | - */ |
|
392 | - public function get_payment_information( $card ) { |
|
386 | + * Returns payment information. |
|
387 | + * |
|
388 | + * |
|
389 | + * @param array $card Card details. |
|
390 | + * @return array |
|
391 | + */ |
|
392 | + public function get_payment_information( $card ) { |
|
393 | 393 | return array( |
394 | 394 | |
395 | 395 | 'creditCard' => array ( |
@@ -402,25 +402,25 @@ discard block |
||
402 | 402 | } |
403 | 403 | |
404 | 404 | /** |
405 | - * Returns the customer profile meta name. |
|
406 | - * |
|
407 | - * |
|
408 | - * @param WPInv_Invoice $invoice Invoice. |
|
409 | - * @return string |
|
410 | - */ |
|
411 | - public function get_customer_profile_meta_name( $invoice ) { |
|
405 | + * Returns the customer profile meta name. |
|
406 | + * |
|
407 | + * |
|
408 | + * @param WPInv_Invoice $invoice Invoice. |
|
409 | + * @return string |
|
410 | + */ |
|
411 | + public function get_customer_profile_meta_name( $invoice ) { |
|
412 | 412 | return $this->is_sandbox( $invoice ) ? 'getpaid_authorizenet_sandbox_customer_profile_id' : 'getpaid_authorizenet_customer_profile_id'; |
413 | 413 | } |
414 | 414 | |
415 | 415 | /** |
416 | - * Validates the submitted data. |
|
417 | - * |
|
418 | - * |
|
419 | - * @param array $submission_data Posted checkout fields. |
|
416 | + * Validates the submitted data. |
|
417 | + * |
|
418 | + * |
|
419 | + * @param array $submission_data Posted checkout fields. |
|
420 | 420 | * @param WPInv_Invoice $invoice |
421 | - * @return WP_Error|string The payment profile id |
|
422 | - */ |
|
423 | - public function validate_submission_data( $submission_data, $invoice ) { |
|
421 | + * @return WP_Error|string The payment profile id |
|
422 | + */ |
|
423 | + public function validate_submission_data( $submission_data, $invoice ) { |
|
424 | 424 | |
425 | 425 | // Validate authentication details. |
426 | 426 | $auth = $this->get_auth_params(); |
@@ -452,13 +452,13 @@ discard block |
||
452 | 452 | } |
453 | 453 | |
454 | 454 | /** |
455 | - * Returns invoice line items. |
|
456 | - * |
|
457 | - * |
|
458 | - * @param WPInv_Invoice $invoice Invoice. |
|
459 | - * @return array |
|
460 | - */ |
|
461 | - public function get_line_items( $invoice ) { |
|
455 | + * Returns invoice line items. |
|
456 | + * |
|
457 | + * |
|
458 | + * @param WPInv_Invoice $invoice Invoice. |
|
459 | + * @return array |
|
460 | + */ |
|
461 | + public function get_line_items( $invoice ) { |
|
462 | 462 | $items = array(); |
463 | 463 | |
464 | 464 | foreach ( $invoice->get_items() as $item ) { |
@@ -496,15 +496,15 @@ discard block |
||
496 | 496 | } |
497 | 497 | |
498 | 498 | /** |
499 | - * Process Payment. |
|
500 | - * |
|
501 | - * |
|
502 | - * @param WPInv_Invoice $invoice Invoice. |
|
503 | - * @param array $submission_data Posted checkout fields. |
|
504 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
505 | - * @return array |
|
506 | - */ |
|
507 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
499 | + * Process Payment. |
|
500 | + * |
|
501 | + * |
|
502 | + * @param WPInv_Invoice $invoice Invoice. |
|
503 | + * @param array $submission_data Posted checkout fields. |
|
504 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
505 | + * @return array |
|
506 | + */ |
|
507 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
508 | 508 | |
509 | 509 | // Validate the submitted data. |
510 | 510 | $payment_profile_id = $this->validate_submission_data( $submission_data, $invoice ); |
@@ -537,69 +537,69 @@ discard block |
||
537 | 537 | |
538 | 538 | exit; |
539 | 539 | |
540 | - } |
|
540 | + } |
|
541 | 541 | |
542 | - /** |
|
543 | - * Processes the initial payment. |
|
544 | - * |
|
542 | + /** |
|
543 | + * Processes the initial payment. |
|
544 | + * |
|
545 | 545 | * @param WPInv_Invoice $invoice Invoice. |
546 | - */ |
|
547 | - protected function process_initial_payment( $invoice ) { |
|
546 | + */ |
|
547 | + protected function process_initial_payment( $invoice ) { |
|
548 | 548 | |
549 | - $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
549 | + $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
550 | 550 | $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
551 | - $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
|
551 | + $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
|
552 | 552 | |
553 | - // Do we have an error? |
|
554 | - if ( is_wp_error( $result ) ) { |
|
555 | - wpinv_set_error( $result->get_error_code(), $result->get_error_message() ); |
|
556 | - wpinv_send_back_to_checkout( $invoice ); |
|
557 | - } |
|
553 | + // Do we have an error? |
|
554 | + if ( is_wp_error( $result ) ) { |
|
555 | + wpinv_set_error( $result->get_error_code(), $result->get_error_message() ); |
|
556 | + wpinv_send_back_to_checkout( $invoice ); |
|
557 | + } |
|
558 | 558 | |
559 | - // Process the response. |
|
560 | - $this->process_charge_response( $result, $invoice ); |
|
559 | + // Process the response. |
|
560 | + $this->process_charge_response( $result, $invoice ); |
|
561 | 561 | |
562 | - if ( wpinv_get_errors() ) { |
|
563 | - wpinv_send_back_to_checkout( $invoice ); |
|
564 | - } |
|
562 | + if ( wpinv_get_errors() ) { |
|
563 | + wpinv_send_back_to_checkout( $invoice ); |
|
564 | + } |
|
565 | 565 | |
566 | - } |
|
566 | + } |
|
567 | 567 | |
568 | 568 | /** |
569 | - * Processes recurring payments. |
|
570 | - * |
|
569 | + * Processes recurring payments. |
|
570 | + * |
|
571 | 571 | * @param WPInv_Invoice $invoice Invoice. |
572 | 572 | * @param WPInv_Subscription $subscription Subscription. |
573 | - */ |
|
574 | - public function process_subscription( $invoice, $subscription ) { |
|
573 | + */ |
|
574 | + public function process_subscription( $invoice, $subscription ) { |
|
575 | 575 | |
576 | 576 | // Check if there is an initial amount to charge. |
577 | 577 | if ( (float) $invoice->get_total() > 0 ) { |
578 | - $this->process_initial_payment( $invoice ); |
|
578 | + $this->process_initial_payment( $invoice ); |
|
579 | 579 | } |
580 | 580 | |
581 | 581 | // Activate the subscription. |
582 | 582 | $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() ); |
583 | 583 | $expiry = date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ); |
584 | 584 | |
585 | - $subscription->set_next_renewal_date( $expiry ); |
|
586 | - $subscription->set_date_created( current_time( 'mysql' ) ); |
|
587 | - $subscription->set_profile_id( $invoice->generate_key() ); |
|
588 | - $subscription->activate(); |
|
585 | + $subscription->set_next_renewal_date( $expiry ); |
|
586 | + $subscription->set_date_created( current_time( 'mysql' ) ); |
|
587 | + $subscription->set_profile_id( $invoice->generate_key() ); |
|
588 | + $subscription->activate(); |
|
589 | 589 | |
590 | - // Redirect to the success page. |
|
590 | + // Redirect to the success page. |
|
591 | 591 | wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) ); |
592 | 592 | |
593 | 593 | } |
594 | 594 | |
595 | - /** |
|
596 | - * (Maybe) renews an authorize.net subscription profile. |
|
597 | - * |
|
598 | - * |
|
599 | - * @param bool $should_expire |
|
595 | + /** |
|
596 | + * (Maybe) renews an authorize.net subscription profile. |
|
597 | + * |
|
598 | + * |
|
599 | + * @param bool $should_expire |
|
600 | 600 | * @param WPInv_Subscription $subscription |
601 | - */ |
|
602 | - public function maybe_renew_subscription( $should_expire, $subscription ) { |
|
601 | + */ |
|
602 | + public function maybe_renew_subscription( $should_expire, $subscription ) { |
|
603 | 603 | |
604 | 604 | // Ensure its our subscription && it's active. |
605 | 605 | if ( $this->id != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) { |
@@ -616,18 +616,18 @@ discard block |
||
616 | 616 | |
617 | 617 | return false; |
618 | 618 | |
619 | - } |
|
619 | + } |
|
620 | 620 | |
621 | 621 | /** |
622 | - * Renews a subscription. |
|
623 | - * |
|
622 | + * Renews a subscription. |
|
623 | + * |
|
624 | 624 | * @param WPInv_Subscription $subscription |
625 | - */ |
|
626 | - public function renew_subscription( $subscription ) { |
|
625 | + */ |
|
626 | + public function renew_subscription( $subscription ) { |
|
627 | 627 | |
628 | - // Generate the renewal invoice. |
|
629 | - $new_invoice = $subscription->create_payment(); |
|
630 | - $old_invoice = $subscription->get_parent_payment(); |
|
628 | + // Generate the renewal invoice. |
|
629 | + $new_invoice = $subscription->create_payment(); |
|
630 | + $old_invoice = $subscription->get_parent_payment(); |
|
631 | 631 | |
632 | 632 | if ( empty( $new_invoice ) ) { |
633 | 633 | $old_invoice->add_note( __( 'Error generating a renewal invoice.', 'invoicing' ), false, false, false ); |
@@ -636,37 +636,37 @@ discard block |
||
636 | 636 | } |
637 | 637 | |
638 | 638 | // Charge the payment method. |
639 | - $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
640 | - $customer_profile = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true ); |
|
641 | - $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice ); |
|
642 | - |
|
643 | - // Do we have an error? |
|
644 | - if ( is_wp_error( $result ) ) { |
|
645 | - |
|
646 | - $old_invoice->add_note( |
|
647 | - sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ), |
|
648 | - true, |
|
649 | - false, |
|
650 | - true |
|
651 | - ); |
|
652 | - $subscription->failing(); |
|
653 | - return; |
|
654 | - |
|
655 | - } |
|
656 | - |
|
657 | - // Process the response. |
|
658 | - $this->process_charge_response( $result, $new_invoice ); |
|
659 | - |
|
660 | - if ( wpinv_get_errors() ) { |
|
661 | - |
|
662 | - $old_invoice->add_note( |
|
663 | - sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ), |
|
664 | - true, |
|
665 | - false, |
|
666 | - true |
|
667 | - ); |
|
668 | - $subscription->failing(); |
|
669 | - return; |
|
639 | + $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
640 | + $customer_profile = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true ); |
|
641 | + $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice ); |
|
642 | + |
|
643 | + // Do we have an error? |
|
644 | + if ( is_wp_error( $result ) ) { |
|
645 | + |
|
646 | + $old_invoice->add_note( |
|
647 | + sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ), |
|
648 | + true, |
|
649 | + false, |
|
650 | + true |
|
651 | + ); |
|
652 | + $subscription->failing(); |
|
653 | + return; |
|
654 | + |
|
655 | + } |
|
656 | + |
|
657 | + // Process the response. |
|
658 | + $this->process_charge_response( $result, $new_invoice ); |
|
659 | + |
|
660 | + if ( wpinv_get_errors() ) { |
|
661 | + |
|
662 | + $old_invoice->add_note( |
|
663 | + sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ), |
|
664 | + true, |
|
665 | + false, |
|
666 | + true |
|
667 | + ); |
|
668 | + $subscription->failing(); |
|
669 | + return; |
|
670 | 670 | |
671 | 671 | } |
672 | 672 | |
@@ -675,13 +675,13 @@ discard block |
||
675 | 675 | } |
676 | 676 | |
677 | 677 | /** |
678 | - * Processes invoice addons. |
|
679 | - * |
|
680 | - * @param WPInv_Invoice $invoice |
|
681 | - * @param GetPaid_Form_Item[] $items |
|
682 | - * @return WPInv_Invoice |
|
683 | - */ |
|
684 | - public function process_addons( $invoice, $items ) { |
|
678 | + * Processes invoice addons. |
|
679 | + * |
|
680 | + * @param WPInv_Invoice $invoice |
|
681 | + * @param GetPaid_Form_Item[] $items |
|
682 | + * @return WPInv_Invoice |
|
683 | + */ |
|
684 | + public function process_addons( $invoice, $items ) { |
|
685 | 685 | |
686 | 686 | global $getpaid_authorize_addons; |
687 | 687 | |
@@ -701,7 +701,7 @@ discard block |
||
701 | 701 | $invoice->recalculate_total(); |
702 | 702 | |
703 | 703 | $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
704 | - $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
|
704 | + $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
|
705 | 705 | |
706 | 706 | add_filter( 'getpaid_authorizenet_charge_customer_payment_profile_args', array( $this, 'filter_addons_request' ), 10, 2 ); |
707 | 707 | $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
@@ -716,11 +716,11 @@ discard block |
||
716 | 716 | } |
717 | 717 | |
718 | 718 | /** |
719 | - * Processes invoice addons. |
|
720 | - * |
|
719 | + * Processes invoice addons. |
|
720 | + * |
|
721 | 721 | * @param array $args |
722 | - * @return array |
|
723 | - */ |
|
722 | + * @return array |
|
723 | + */ |
|
724 | 724 | public function filter_addons_request( $args ) { |
725 | 725 | |
726 | 726 | global $getpaid_authorize_addons; |
@@ -754,11 +754,11 @@ discard block |
||
754 | 754 | } |
755 | 755 | |
756 | 756 | /** |
757 | - * Filters the gateway settings. |
|
758 | - * |
|
759 | - * @param array $admin_settings |
|
760 | - */ |
|
761 | - public function admin_settings( $admin_settings ) { |
|
757 | + * Filters the gateway settings. |
|
758 | + * |
|
759 | + * @param array $admin_settings |
|
760 | + */ |
|
761 | + public function admin_settings( $admin_settings ) { |
|
762 | 762 | |
763 | 763 | $currencies = sprintf( |
764 | 764 | __( 'Supported Currencies: %s', 'invoicing' ), |
@@ -798,7 +798,7 @@ discard block |
||
798 | 798 | 'readonly' => true, |
799 | 799 | ); |
800 | 800 | |
801 | - return $admin_settings; |
|
802 | - } |
|
801 | + return $admin_settings; |
|
802 | + } |
|
803 | 803 | |
804 | 804 | } |
@@ -235,7 +235,7 @@ |
||
235 | 235 | do_action( 'getpaid_checkout_invoice_exception', $invoice ); |
236 | 236 | } |
237 | 237 | |
238 | - // Do we have any errors? |
|
238 | + // Do we have any errors? |
|
239 | 239 | if ( wpinv_get_errors() ) { |
240 | 240 | wp_send_json_error( getpaid_get_errors_html( true, false ) ); |
241 | 241 | } |
@@ -14,70 +14,70 @@ discard block |
||
14 | 14 | class WPInv_Ajax { |
15 | 15 | |
16 | 16 | /** |
17 | - * Hook in ajax handlers. |
|
18 | - */ |
|
19 | - public static function init() { |
|
20 | - add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 ); |
|
21 | - add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 ); |
|
22 | - self::add_ajax_events(); |
|
17 | + * Hook in ajax handlers. |
|
18 | + */ |
|
19 | + public static function init() { |
|
20 | + add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 ); |
|
21 | + add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 ); |
|
22 | + self::add_ajax_events(); |
|
23 | 23 | } |
24 | 24 | |
25 | 25 | /** |
26 | - * Set GetPaid AJAX constant and headers. |
|
27 | - */ |
|
28 | - public static function define_ajax() { |
|
29 | - |
|
30 | - if ( ! empty( $_GET['wpinv-ajax'] ) ) { |
|
31 | - getpaid_maybe_define_constant( 'DOING_AJAX', true ); |
|
32 | - getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true ); |
|
33 | - if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) { |
|
34 | - /** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 ); |
|
35 | - } |
|
36 | - $GLOBALS['wpdb']->hide_errors(); |
|
37 | - } |
|
26 | + * Set GetPaid AJAX constant and headers. |
|
27 | + */ |
|
28 | + public static function define_ajax() { |
|
29 | + |
|
30 | + if ( ! empty( $_GET['wpinv-ajax'] ) ) { |
|
31 | + getpaid_maybe_define_constant( 'DOING_AJAX', true ); |
|
32 | + getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true ); |
|
33 | + if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) { |
|
34 | + /** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 ); |
|
35 | + } |
|
36 | + $GLOBALS['wpdb']->hide_errors(); |
|
37 | + } |
|
38 | 38 | |
39 | 39 | } |
40 | 40 | |
41 | 41 | /** |
42 | - * Send headers for GetPaid Ajax Requests. |
|
43 | - * |
|
44 | - * @since 1.0.18 |
|
45 | - */ |
|
46 | - private static function wpinv_ajax_headers() { |
|
47 | - if ( ! headers_sent() ) { |
|
48 | - send_origin_headers(); |
|
49 | - send_nosniff_header(); |
|
50 | - nocache_headers(); |
|
51 | - header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) ); |
|
52 | - header( 'X-Robots-Tag: noindex' ); |
|
53 | - status_header( 200 ); |
|
54 | - } |
|
42 | + * Send headers for GetPaid Ajax Requests. |
|
43 | + * |
|
44 | + * @since 1.0.18 |
|
45 | + */ |
|
46 | + private static function wpinv_ajax_headers() { |
|
47 | + if ( ! headers_sent() ) { |
|
48 | + send_origin_headers(); |
|
49 | + send_nosniff_header(); |
|
50 | + nocache_headers(); |
|
51 | + header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) ); |
|
52 | + header( 'X-Robots-Tag: noindex' ); |
|
53 | + status_header( 200 ); |
|
54 | + } |
|
55 | 55 | } |
56 | 56 | |
57 | 57 | /** |
58 | - * Check for GetPaid Ajax request and fire action. |
|
59 | - */ |
|
60 | - public static function do_wpinv_ajax() { |
|
61 | - global $wp_query; |
|
58 | + * Check for GetPaid Ajax request and fire action. |
|
59 | + */ |
|
60 | + public static function do_wpinv_ajax() { |
|
61 | + global $wp_query; |
|
62 | 62 | |
63 | - if ( ! empty( $_GET['wpinv-ajax'] ) ) { |
|
64 | - $wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) ); |
|
65 | - } |
|
63 | + if ( ! empty( $_GET['wpinv-ajax'] ) ) { |
|
64 | + $wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) ); |
|
65 | + } |
|
66 | 66 | |
67 | - $action = $wp_query->get( 'wpinv-ajax' ); |
|
67 | + $action = $wp_query->get( 'wpinv-ajax' ); |
|
68 | 68 | |
69 | - if ( $action ) { |
|
70 | - self::wpinv_ajax_headers(); |
|
71 | - $action = sanitize_text_field( $action ); |
|
72 | - do_action( 'wpinv_ajax_' . $action ); |
|
73 | - wp_die(); |
|
74 | - } |
|
69 | + if ( $action ) { |
|
70 | + self::wpinv_ajax_headers(); |
|
71 | + $action = sanitize_text_field( $action ); |
|
72 | + do_action( 'wpinv_ajax_' . $action ); |
|
73 | + wp_die(); |
|
74 | + } |
|
75 | 75 | |
76 | 76 | } |
77 | 77 | |
78 | 78 | /** |
79 | - * Hook in ajax methods. |
|
80 | - */ |
|
79 | + * Hook in ajax methods. |
|
80 | + */ |
|
81 | 81 | public static function add_ajax_events() { |
82 | 82 | |
83 | 83 | // array( 'event' => is_frontend ) |
@@ -255,24 +255,24 @@ discard block |
||
255 | 255 | check_ajax_referer( 'getpaid_form_nonce' ); |
256 | 256 | |
257 | 257 | // Is the request set up correctly? |
258 | - if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) ) { |
|
259 | - echo aui()->alert( |
|
260 | - array( |
|
261 | - 'type' => 'warning', |
|
262 | - 'content' => __( 'No payment form or item provided', 'invoicing' ), |
|
263 | - ) |
|
258 | + if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) ) { |
|
259 | + echo aui()->alert( |
|
260 | + array( |
|
261 | + 'type' => 'warning', |
|
262 | + 'content' => __( 'No payment form or item provided', 'invoicing' ), |
|
263 | + ) |
|
264 | 264 | ); |
265 | 265 | exit; |
266 | 266 | } |
267 | 267 | |
268 | 268 | // Payment form or button? |
269 | - if ( ! empty( $_GET['form'] ) ) { |
|
269 | + if ( ! empty( $_GET['form'] ) ) { |
|
270 | 270 | getpaid_display_payment_form( urldecode( $_GET['form'] ) ); |
271 | - } else if( ! empty( $_GET['invoice'] ) ) { |
|
272 | - getpaid_display_invoice_payment_form( urldecode( $_GET['invoice'] ) ); |
|
271 | + } else if( ! empty( $_GET['invoice'] ) ) { |
|
272 | + getpaid_display_invoice_payment_form( urldecode( $_GET['invoice'] ) ); |
|
273 | 273 | } else { |
274 | - $items = getpaid_convert_items_to_array( urldecode( $_GET['item'] ) ); |
|
275 | - getpaid_display_item_payment_form( $items ); |
|
274 | + $items = getpaid_convert_items_to_array( urldecode( $_GET['item'] ) ); |
|
275 | + getpaid_display_item_payment_form( $items ); |
|
276 | 276 | } |
277 | 277 | |
278 | 278 | exit; |
@@ -14,144 +14,144 @@ discard block |
||
14 | 14 | */ |
15 | 15 | class WPInv_Subscriptions_Widget extends WP_Super_Duper { |
16 | 16 | |
17 | - /** |
|
18 | - * Register the widget with WordPress. |
|
19 | - * |
|
20 | - */ |
|
21 | - public function __construct() { |
|
22 | - |
|
23 | - $options = array( |
|
24 | - 'textdomain' => 'invoicing', |
|
25 | - 'block-icon' => 'controls-repeat', |
|
26 | - 'block-category'=> 'widgets', |
|
27 | - 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
|
28 | - 'class_name' => __CLASS__, |
|
29 | - 'base_id' => 'wpinv_subscriptions', |
|
30 | - 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
31 | - 'widget_ops' => array( |
|
32 | - 'classname' => 'getpaid-subscriptions bsui', |
|
33 | - 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
34 | - ), |
|
35 | - 'arguments' => array( |
|
36 | - 'title' => array( |
|
37 | - 'title' => __( 'Widget title', 'invoicing' ), |
|
38 | - 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
39 | - 'type' => 'text', |
|
40 | - 'desc_tip' => true, |
|
41 | - 'default' => '', |
|
42 | - 'advanced' => false |
|
43 | - ), |
|
44 | - ) |
|
45 | - |
|
46 | - ); |
|
47 | - |
|
48 | - |
|
49 | - parent::__construct( $options ); |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Retrieves current user's subscriptions. |
|
54 | - * |
|
55 | - * @return GetPaid_Subscriptions_Query |
|
56 | - */ |
|
57 | - public function get_subscriptions() { |
|
58 | - |
|
59 | - // Prepare license args. |
|
60 | - $args = array( |
|
61 | - 'customer_in' => get_current_user_id(), |
|
62 | - 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
63 | - ); |
|
64 | - |
|
65 | - return new GetPaid_Subscriptions_Query( $args ); |
|
66 | - |
|
67 | - } |
|
68 | - |
|
69 | - /** |
|
70 | - * The Super block output function. |
|
71 | - * |
|
72 | - * @param array $args |
|
73 | - * @param array $widget_args |
|
74 | - * @param string $content |
|
75 | - * |
|
76 | - * @return mixed|string|bool |
|
77 | - */ |
|
78 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
79 | - |
|
80 | - // Ensure that the user is logged in. |
|
81 | - if ( ! is_user_logged_in() ) { |
|
82 | - |
|
83 | - return aui()->alert( |
|
84 | - array( |
|
85 | - 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
86 | - 'type' => 'error', |
|
87 | - ) |
|
88 | - ); |
|
89 | - |
|
90 | - } |
|
91 | - |
|
92 | - // Are we displaying a single subscription? |
|
93 | - if ( isset( $_GET['subscription'] ) ) { |
|
94 | - return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
95 | - } |
|
96 | - |
|
97 | - // Retrieve the user's subscriptions. |
|
98 | - $subscriptions = $this->get_subscriptions(); |
|
99 | - |
|
100 | - // Start the output buffer. |
|
101 | - ob_start(); |
|
102 | - |
|
103 | - // Backwards compatibility. |
|
104 | - do_action( 'wpinv_before_user_subscriptions' ); |
|
105 | - |
|
106 | - // Display errors and notices. |
|
107 | - wpinv_print_errors(); |
|
108 | - |
|
109 | - do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
110 | - |
|
111 | - // Print the table header. |
|
112 | - $this->print_table_header(); |
|
113 | - |
|
114 | - // Print table body. |
|
115 | - $this->print_table_body( $subscriptions->get_results() ); |
|
116 | - |
|
117 | - // Print table footer. |
|
118 | - $this->print_table_footer(); |
|
119 | - |
|
120 | - // Print the navigation. |
|
121 | - $this->print_navigation( $subscriptions->get_total() ); |
|
122 | - |
|
123 | - // Backwards compatibility. |
|
124 | - do_action( 'wpinv_after_user_subscriptions' ); |
|
125 | - |
|
126 | - // Return the output. |
|
127 | - return ob_get_clean(); |
|
128 | - |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * Retrieves the subscription columns. |
|
133 | - * |
|
134 | - * @return array |
|
135 | - */ |
|
136 | - public function get_subscriptions_table_columns() { |
|
17 | + /** |
|
18 | + * Register the widget with WordPress. |
|
19 | + * |
|
20 | + */ |
|
21 | + public function __construct() { |
|
22 | + |
|
23 | + $options = array( |
|
24 | + 'textdomain' => 'invoicing', |
|
25 | + 'block-icon' => 'controls-repeat', |
|
26 | + 'block-category'=> 'widgets', |
|
27 | + 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
|
28 | + 'class_name' => __CLASS__, |
|
29 | + 'base_id' => 'wpinv_subscriptions', |
|
30 | + 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
31 | + 'widget_ops' => array( |
|
32 | + 'classname' => 'getpaid-subscriptions bsui', |
|
33 | + 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
34 | + ), |
|
35 | + 'arguments' => array( |
|
36 | + 'title' => array( |
|
37 | + 'title' => __( 'Widget title', 'invoicing' ), |
|
38 | + 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
39 | + 'type' => 'text', |
|
40 | + 'desc_tip' => true, |
|
41 | + 'default' => '', |
|
42 | + 'advanced' => false |
|
43 | + ), |
|
44 | + ) |
|
45 | + |
|
46 | + ); |
|
47 | + |
|
48 | + |
|
49 | + parent::__construct( $options ); |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Retrieves current user's subscriptions. |
|
54 | + * |
|
55 | + * @return GetPaid_Subscriptions_Query |
|
56 | + */ |
|
57 | + public function get_subscriptions() { |
|
58 | + |
|
59 | + // Prepare license args. |
|
60 | + $args = array( |
|
61 | + 'customer_in' => get_current_user_id(), |
|
62 | + 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
63 | + ); |
|
64 | + |
|
65 | + return new GetPaid_Subscriptions_Query( $args ); |
|
66 | + |
|
67 | + } |
|
68 | + |
|
69 | + /** |
|
70 | + * The Super block output function. |
|
71 | + * |
|
72 | + * @param array $args |
|
73 | + * @param array $widget_args |
|
74 | + * @param string $content |
|
75 | + * |
|
76 | + * @return mixed|string|bool |
|
77 | + */ |
|
78 | + public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
79 | + |
|
80 | + // Ensure that the user is logged in. |
|
81 | + if ( ! is_user_logged_in() ) { |
|
82 | + |
|
83 | + return aui()->alert( |
|
84 | + array( |
|
85 | + 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
86 | + 'type' => 'error', |
|
87 | + ) |
|
88 | + ); |
|
89 | + |
|
90 | + } |
|
91 | + |
|
92 | + // Are we displaying a single subscription? |
|
93 | + if ( isset( $_GET['subscription'] ) ) { |
|
94 | + return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
95 | + } |
|
96 | + |
|
97 | + // Retrieve the user's subscriptions. |
|
98 | + $subscriptions = $this->get_subscriptions(); |
|
99 | + |
|
100 | + // Start the output buffer. |
|
101 | + ob_start(); |
|
102 | + |
|
103 | + // Backwards compatibility. |
|
104 | + do_action( 'wpinv_before_user_subscriptions' ); |
|
105 | + |
|
106 | + // Display errors and notices. |
|
107 | + wpinv_print_errors(); |
|
108 | + |
|
109 | + do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
110 | + |
|
111 | + // Print the table header. |
|
112 | + $this->print_table_header(); |
|
113 | + |
|
114 | + // Print table body. |
|
115 | + $this->print_table_body( $subscriptions->get_results() ); |
|
116 | + |
|
117 | + // Print table footer. |
|
118 | + $this->print_table_footer(); |
|
119 | + |
|
120 | + // Print the navigation. |
|
121 | + $this->print_navigation( $subscriptions->get_total() ); |
|
122 | + |
|
123 | + // Backwards compatibility. |
|
124 | + do_action( 'wpinv_after_user_subscriptions' ); |
|
125 | + |
|
126 | + // Return the output. |
|
127 | + return ob_get_clean(); |
|
128 | + |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * Retrieves the subscription columns. |
|
133 | + * |
|
134 | + * @return array |
|
135 | + */ |
|
136 | + public function get_subscriptions_table_columns() { |
|
137 | 137 | |
138 | - $columns = array( |
|
139 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
140 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
141 | - 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
142 | - 'status' => __( 'Status', 'invoicing' ), |
|
143 | - ); |
|
138 | + $columns = array( |
|
139 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
140 | + 'amount' => __( 'Amount', 'invoicing' ), |
|
141 | + 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
142 | + 'status' => __( 'Status', 'invoicing' ), |
|
143 | + ); |
|
144 | 144 | |
145 | - return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
146 | - } |
|
145 | + return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
146 | + } |
|
147 | 147 | |
148 | - /** |
|
149 | - * Displays the table header. |
|
150 | - * |
|
151 | - */ |
|
152 | - public function print_table_header() { |
|
148 | + /** |
|
149 | + * Displays the table header. |
|
150 | + * |
|
151 | + */ |
|
152 | + public function print_table_header() { |
|
153 | 153 | |
154 | - ?> |
|
154 | + ?> |
|
155 | 155 | |
156 | 156 | <table class="table table-bordered table-striped"> |
157 | 157 | |
@@ -167,121 +167,121 @@ discard block |
||
167 | 167 | |
168 | 168 | <?php |
169 | 169 | |
170 | - } |
|
170 | + } |
|
171 | 171 | |
172 | - /** |
|
173 | - * Displays the table body. |
|
174 | - * |
|
175 | - * @param WPInv_Subscription[] $subscriptions |
|
176 | - */ |
|
177 | - public function print_table_body( $subscriptions ) { |
|
172 | + /** |
|
173 | + * Displays the table body. |
|
174 | + * |
|
175 | + * @param WPInv_Subscription[] $subscriptions |
|
176 | + */ |
|
177 | + public function print_table_body( $subscriptions ) { |
|
178 | 178 | |
179 | - if ( empty( $subscriptions ) ) { |
|
180 | - $this->print_table_body_no_subscriptions(); |
|
181 | - } else { |
|
182 | - $this->print_table_body_subscriptions( $subscriptions ); |
|
183 | - } |
|
179 | + if ( empty( $subscriptions ) ) { |
|
180 | + $this->print_table_body_no_subscriptions(); |
|
181 | + } else { |
|
182 | + $this->print_table_body_subscriptions( $subscriptions ); |
|
183 | + } |
|
184 | 184 | |
185 | - } |
|
185 | + } |
|
186 | 186 | |
187 | - /** |
|
188 | - * Displays the table body if no subscriptions were found. |
|
189 | - * |
|
190 | - */ |
|
191 | - public function print_table_body_no_subscriptions() { |
|
187 | + /** |
|
188 | + * Displays the table body if no subscriptions were found. |
|
189 | + * |
|
190 | + */ |
|
191 | + public function print_table_body_no_subscriptions() { |
|
192 | 192 | |
193 | - ?> |
|
193 | + ?> |
|
194 | 194 | <tbody> |
195 | 195 | |
196 | 196 | <tr> |
197 | 197 | <td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>"> |
198 | 198 | |
199 | 199 | <?php |
200 | - echo aui()->alert( |
|
201 | - array( |
|
202 | - 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
203 | - 'type' => 'warning', |
|
204 | - ) |
|
205 | - ); |
|
206 | - ?> |
|
200 | + echo aui()->alert( |
|
201 | + array( |
|
202 | + 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
203 | + 'type' => 'warning', |
|
204 | + ) |
|
205 | + ); |
|
206 | + ?> |
|
207 | 207 | |
208 | 208 | </td> |
209 | 209 | </tr> |
210 | 210 | |
211 | 211 | </tbody> |
212 | 212 | <?php |
213 | - } |
|
213 | + } |
|
214 | 214 | |
215 | - /** |
|
216 | - * Displays the table body if subscriptions were found. |
|
217 | - * |
|
218 | - * @param WPInv_Subscription[] $subscriptions |
|
219 | - */ |
|
220 | - public function print_table_body_subscriptions( $subscriptions ) { |
|
215 | + /** |
|
216 | + * Displays the table body if subscriptions were found. |
|
217 | + * |
|
218 | + * @param WPInv_Subscription[] $subscriptions |
|
219 | + */ |
|
220 | + public function print_table_body_subscriptions( $subscriptions ) { |
|
221 | 221 | |
222 | - ?> |
|
222 | + ?> |
|
223 | 223 | <tbody> |
224 | 224 | |
225 | 225 | <?php foreach ( $subscriptions as $subscription ) : ?> |
226 | 226 | <tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>"> |
227 | 227 | <?php |
228 | - wpinv_get_template( |
|
229 | - 'subscriptions/subscriptions-table-row.php', |
|
230 | - array( |
|
231 | - 'subscription' => $subscription, |
|
232 | - 'widget' => $this |
|
233 | - ) |
|
234 | - ); |
|
235 | - ?> |
|
228 | + wpinv_get_template( |
|
229 | + 'subscriptions/subscriptions-table-row.php', |
|
230 | + array( |
|
231 | + 'subscription' => $subscription, |
|
232 | + 'widget' => $this |
|
233 | + ) |
|
234 | + ); |
|
235 | + ?> |
|
236 | 236 | </tr> |
237 | 237 | <?php endforeach; ?> |
238 | 238 | |
239 | 239 | </tbody> |
240 | 240 | <?php |
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Adds row actions to a column |
|
245 | - * |
|
246 | - * @param string $content column content |
|
247 | - * @param WPInv_Subscription $subscription |
|
248 | - * @since 1.0.0 |
|
249 | - * @return string |
|
250 | - */ |
|
251 | - public function add_row_actions( $content, $subscription ) { |
|
252 | - |
|
253 | - // Prepare row actions. |
|
254 | - $actions = array(); |
|
255 | - |
|
256 | - // View subscription action. |
|
257 | - $view_url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
258 | - $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) ); |
|
259 | - $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
260 | - |
|
261 | - // Filter the actions. |
|
262 | - $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
263 | - |
|
264 | - $sanitized = array(); |
|
265 | - foreach ( $actions as $key => $action ) { |
|
266 | - $key = sanitize_html_class( $key ); |
|
267 | - $action = wp_kses_post( $action ); |
|
268 | - $sanitized[] = "<span class='$key'>$action</span>"; |
|
269 | - } |
|
270 | - |
|
271 | - $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
|
272 | - $row_actions .= implode( ' | ', $sanitized ); |
|
273 | - $row_actions .= '</small>'; |
|
274 | - |
|
275 | - return $content . $row_actions; |
|
276 | - } |
|
277 | - |
|
278 | - /** |
|
279 | - * Displays the table footer. |
|
280 | - * |
|
281 | - */ |
|
282 | - public function print_table_footer() { |
|
283 | - |
|
284 | - ?> |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Adds row actions to a column |
|
245 | + * |
|
246 | + * @param string $content column content |
|
247 | + * @param WPInv_Subscription $subscription |
|
248 | + * @since 1.0.0 |
|
249 | + * @return string |
|
250 | + */ |
|
251 | + public function add_row_actions( $content, $subscription ) { |
|
252 | + |
|
253 | + // Prepare row actions. |
|
254 | + $actions = array(); |
|
255 | + |
|
256 | + // View subscription action. |
|
257 | + $view_url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
258 | + $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) ); |
|
259 | + $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
260 | + |
|
261 | + // Filter the actions. |
|
262 | + $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
263 | + |
|
264 | + $sanitized = array(); |
|
265 | + foreach ( $actions as $key => $action ) { |
|
266 | + $key = sanitize_html_class( $key ); |
|
267 | + $action = wp_kses_post( $action ); |
|
268 | + $sanitized[] = "<span class='$key'>$action</span>"; |
|
269 | + } |
|
270 | + |
|
271 | + $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
|
272 | + $row_actions .= implode( ' | ', $sanitized ); |
|
273 | + $row_actions .= '</small>'; |
|
274 | + |
|
275 | + return $content . $row_actions; |
|
276 | + } |
|
277 | + |
|
278 | + /** |
|
279 | + * Displays the table footer. |
|
280 | + * |
|
281 | + */ |
|
282 | + public function print_table_footer() { |
|
283 | + |
|
284 | + ?> |
|
285 | 285 | |
286 | 286 | <tfoot> |
287 | 287 | <tr> |
@@ -296,129 +296,129 @@ discard block |
||
296 | 296 | </table> |
297 | 297 | <?php |
298 | 298 | |
299 | - } |
|
299 | + } |
|
300 | 300 | |
301 | - /** |
|
302 | - * Displays the navigation. |
|
303 | - * |
|
304 | - * @param int $total |
|
305 | - */ |
|
306 | - public function print_navigation( $total ) { |
|
301 | + /** |
|
302 | + * Displays the navigation. |
|
303 | + * |
|
304 | + * @param int $total |
|
305 | + */ |
|
306 | + public function print_navigation( $total ) { |
|
307 | 307 | |
308 | - if ( $total < 1 ) { |
|
308 | + if ( $total < 1 ) { |
|
309 | 309 | |
310 | - // Out-of-bounds, run the query again without LIMIT for total count. |
|
311 | - $args = array( |
|
312 | - 'customer_in' => get_current_user_id(), |
|
313 | - 'fields' => 'id', |
|
314 | - ); |
|
310 | + // Out-of-bounds, run the query again without LIMIT for total count. |
|
311 | + $args = array( |
|
312 | + 'customer_in' => get_current_user_id(), |
|
313 | + 'fields' => 'id', |
|
314 | + ); |
|
315 | 315 | |
316 | - $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
317 | - $total = $count_query->get_total(); |
|
318 | - } |
|
316 | + $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
317 | + $total = $count_query->get_total(); |
|
318 | + } |
|
319 | 319 | |
320 | - // Abort if we do not have pages. |
|
321 | - if ( 2 > $total ) { |
|
322 | - return; |
|
323 | - } |
|
320 | + // Abort if we do not have pages. |
|
321 | + if ( 2 > $total ) { |
|
322 | + return; |
|
323 | + } |
|
324 | 324 | |
325 | - ?> |
|
325 | + ?> |
|
326 | 326 | |
327 | 327 | <div class="getpaid-subscriptions-pagination"> |
328 | 328 | <?php |
329 | - $big = 999999; |
|
330 | - |
|
331 | - echo getpaid_paginate_links( |
|
332 | - array( |
|
333 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
334 | - 'format' => '?paged=%#%', |
|
335 | - 'total' => (int) ceil( $total / 10 ), |
|
336 | - ) |
|
337 | - ); |
|
338 | - ?> |
|
329 | + $big = 999999; |
|
330 | + |
|
331 | + echo getpaid_paginate_links( |
|
332 | + array( |
|
333 | + 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
334 | + 'format' => '?paged=%#%', |
|
335 | + 'total' => (int) ceil( $total / 10 ), |
|
336 | + ) |
|
337 | + ); |
|
338 | + ?> |
|
339 | 339 | </div> |
340 | 340 | |
341 | 341 | <?php |
342 | - } |
|
343 | - |
|
344 | - /** |
|
345 | - * Returns a single subscription's columns. |
|
346 | - * |
|
347 | - * @param WPInv_Subscription $subscription |
|
348 | - * |
|
349 | - * @return array |
|
350 | - */ |
|
351 | - public function get_single_subscription_columns( $subscription ) { |
|
352 | - |
|
353 | - // Prepare subscription detail columns. |
|
354 | - $fields = apply_filters( |
|
355 | - 'getpaid_single_subscription_details_fields', |
|
356 | - array( |
|
357 | - 'status' => __( 'Status', 'invoicing' ), |
|
358 | - 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
359 | - 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
360 | - 'start_date' => __( 'Start date', 'invoicing' ), |
|
361 | - 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
362 | - 'payments' => __( 'Payments', 'invoicing' ), |
|
363 | - 'item' => __( 'Item', 'invoicing' ), |
|
364 | - ), |
|
365 | - $subscription |
|
366 | - ); |
|
367 | - |
|
368 | - if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
369 | - $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
370 | - } |
|
371 | - |
|
372 | - if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
373 | - unset( $fields['initial_amount'] ); |
|
374 | - } |
|
375 | - |
|
376 | - return $fields; |
|
377 | - } |
|
378 | - |
|
379 | - /** |
|
380 | - * Displays a single subscription. |
|
381 | - * |
|
382 | - * @param string $subscription |
|
383 | - * |
|
384 | - * @return string |
|
385 | - */ |
|
386 | - public function display_single_subscription( $subscription ) { |
|
387 | - |
|
388 | - // Fetch the subscription. |
|
389 | - $subscription = new WPInv_Subscription( (int) $subscription ); |
|
390 | - |
|
391 | - if ( ! $subscription->get_id() ) { |
|
392 | - |
|
393 | - return aui()->alert( |
|
394 | - array( |
|
395 | - 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
396 | - 'type' => 'error', |
|
397 | - ) |
|
398 | - ); |
|
399 | - |
|
400 | - } |
|
401 | - |
|
402 | - // Ensure that the user owns this subscription key. |
|
403 | - if ( get_current_user_id() != $subscription->get_customer_id() ) { |
|
404 | - |
|
405 | - return aui()->alert( |
|
406 | - array( |
|
407 | - 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
408 | - 'type' => 'error', |
|
409 | - ) |
|
410 | - ); |
|
411 | - |
|
412 | - } |
|
413 | - |
|
414 | - return wpinv_get_template_html( |
|
415 | - 'subscriptions/subscription-details.php', |
|
416 | - array( |
|
417 | - 'subscription' => $subscription, |
|
418 | - 'widget' => $this |
|
419 | - ) |
|
420 | - ); |
|
421 | - |
|
422 | - } |
|
342 | + } |
|
343 | + |
|
344 | + /** |
|
345 | + * Returns a single subscription's columns. |
|
346 | + * |
|
347 | + * @param WPInv_Subscription $subscription |
|
348 | + * |
|
349 | + * @return array |
|
350 | + */ |
|
351 | + public function get_single_subscription_columns( $subscription ) { |
|
352 | + |
|
353 | + // Prepare subscription detail columns. |
|
354 | + $fields = apply_filters( |
|
355 | + 'getpaid_single_subscription_details_fields', |
|
356 | + array( |
|
357 | + 'status' => __( 'Status', 'invoicing' ), |
|
358 | + 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
359 | + 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
360 | + 'start_date' => __( 'Start date', 'invoicing' ), |
|
361 | + 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
362 | + 'payments' => __( 'Payments', 'invoicing' ), |
|
363 | + 'item' => __( 'Item', 'invoicing' ), |
|
364 | + ), |
|
365 | + $subscription |
|
366 | + ); |
|
367 | + |
|
368 | + if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
369 | + $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
370 | + } |
|
371 | + |
|
372 | + if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
373 | + unset( $fields['initial_amount'] ); |
|
374 | + } |
|
375 | + |
|
376 | + return $fields; |
|
377 | + } |
|
378 | + |
|
379 | + /** |
|
380 | + * Displays a single subscription. |
|
381 | + * |
|
382 | + * @param string $subscription |
|
383 | + * |
|
384 | + * @return string |
|
385 | + */ |
|
386 | + public function display_single_subscription( $subscription ) { |
|
387 | + |
|
388 | + // Fetch the subscription. |
|
389 | + $subscription = new WPInv_Subscription( (int) $subscription ); |
|
390 | + |
|
391 | + if ( ! $subscription->get_id() ) { |
|
392 | + |
|
393 | + return aui()->alert( |
|
394 | + array( |
|
395 | + 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
396 | + 'type' => 'error', |
|
397 | + ) |
|
398 | + ); |
|
399 | + |
|
400 | + } |
|
401 | + |
|
402 | + // Ensure that the user owns this subscription key. |
|
403 | + if ( get_current_user_id() != $subscription->get_customer_id() ) { |
|
404 | + |
|
405 | + return aui()->alert( |
|
406 | + array( |
|
407 | + 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
408 | + 'type' => 'error', |
|
409 | + ) |
|
410 | + ); |
|
411 | + |
|
412 | + } |
|
413 | + |
|
414 | + return wpinv_get_template_html( |
|
415 | + 'subscriptions/subscription-details.php', |
|
416 | + array( |
|
417 | + 'subscription' => $subscription, |
|
418 | + 'widget' => $this |
|
419 | + ) |
|
420 | + ); |
|
421 | + |
|
422 | + } |
|
423 | 423 | |
424 | 424 | } |
@@ -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 | } |
@@ -13,30 +13,30 @@ discard block |
||
13 | 13 | class GetPaid_Bank_Transfer_Gateway extends GetPaid_Payment_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'bank_transfer'; |
21 | 21 | |
22 | - /** |
|
23 | - * An array of features that this gateway supports. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
27 | - protected $supports = array( 'addons' ); |
|
22 | + /** |
|
23 | + * An array of features that this gateway supports. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | + protected $supports = array( 'addons' ); |
|
28 | 28 | |
29 | 29 | /** |
30 | - * Payment method order. |
|
31 | - * |
|
32 | - * @var int |
|
33 | - */ |
|
34 | - public $order = 8; |
|
30 | + * Payment method order. |
|
31 | + * |
|
32 | + * @var int |
|
33 | + */ |
|
34 | + public $order = 8; |
|
35 | 35 | |
36 | 36 | /** |
37 | - * Class constructor. |
|
38 | - */ |
|
39 | - public function __construct() { |
|
37 | + * Class constructor. |
|
38 | + */ |
|
39 | + public function __construct() { |
|
40 | 40 | parent::__construct(); |
41 | 41 | |
42 | 42 | $this->title = __( 'Direct bank transfer', 'invoicing' ); |
@@ -44,23 +44,23 @@ discard block |
||
44 | 44 | $this->checkout_button_text = __( 'Proceed', 'invoicing' ); |
45 | 45 | $this->instructions = apply_filters( 'wpinv_bank_instructions', $this->get_option( 'info' ) ); |
46 | 46 | |
47 | - add_action( 'wpinv_receipt_end', array( $this, 'thankyou_page' ) ); |
|
48 | - add_action( 'getpaid_invoice_line_items', array( $this, 'thankyou_page' ), 40 ); |
|
49 | - add_action( 'wpinv_pdf_content_billing', array( $this, 'thankyou_page' ), 11 ); |
|
50 | - add_action( 'wpinv_email_invoice_details', array( $this, 'email_instructions' ), 10, 3 ); |
|
47 | + add_action( 'wpinv_receipt_end', array( $this, 'thankyou_page' ) ); |
|
48 | + add_action( 'getpaid_invoice_line_items', array( $this, 'thankyou_page' ), 40 ); |
|
49 | + add_action( 'wpinv_pdf_content_billing', array( $this, 'thankyou_page' ), 11 ); |
|
50 | + add_action( 'wpinv_email_invoice_details', array( $this, 'email_instructions' ), 10, 3 ); |
|
51 | 51 | |
52 | 52 | } |
53 | 53 | |
54 | 54 | /** |
55 | - * Process Payment. |
|
56 | - * |
|
57 | - * |
|
58 | - * @param WPInv_Invoice $invoice Invoice. |
|
59 | - * @param array $submission_data Posted checkout fields. |
|
60 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
61 | - * @return array |
|
62 | - */ |
|
63 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
55 | + * Process Payment. |
|
56 | + * |
|
57 | + * |
|
58 | + * @param WPInv_Invoice $invoice Invoice. |
|
59 | + * @param array $submission_data Posted checkout fields. |
|
60 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
61 | + * @return array |
|
62 | + */ |
|
63 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
64 | 64 | |
65 | 65 | // Add a transaction id. |
66 | 66 | $invoice->set_transaction_id( $invoice->generate_key('trans_') ); |
@@ -81,66 +81,66 @@ discard block |
||
81 | 81 | } |
82 | 82 | |
83 | 83 | /** |
84 | - * Output for the order received page. |
|
85 | - * |
|
86 | - * @param WPInv_Invoice $invoice Invoice. |
|
87 | - */ |
|
88 | - public function thankyou_page( $invoice ) { |
|
84 | + * Output for the order received page. |
|
85 | + * |
|
86 | + * @param WPInv_Invoice $invoice Invoice. |
|
87 | + */ |
|
88 | + public function thankyou_page( $invoice ) { |
|
89 | 89 | |
90 | 90 | if ( 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) { |
91 | 91 | |
92 | - echo '<div class="mt-4 mb-2 getpaid-bank-transfer-details">' . PHP_EOL; |
|
92 | + echo '<div class="mt-4 mb-2 getpaid-bank-transfer-details">' . PHP_EOL; |
|
93 | 93 | |
94 | 94 | if ( ! empty( $this->instructions ) ) { |
95 | 95 | echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) ); |
96 | - } |
|
96 | + } |
|
97 | 97 | |
98 | - $this->bank_details( $invoice ); |
|
98 | + $this->bank_details( $invoice ); |
|
99 | 99 | |
100 | - echo '</div>'; |
|
100 | + echo '</div>'; |
|
101 | 101 | |
102 | 102 | } |
103 | 103 | |
104 | - } |
|
104 | + } |
|
105 | 105 | |
106 | 106 | /** |
107 | - * Add content to the WPI emails. |
|
108 | - * |
|
109 | - * @param WPInv_Invoice $invoice Invoice. |
|
110 | - * @param string $email_type Email format: plain text or HTML. |
|
111 | - * @param bool $sent_to_admin Sent to admin. |
|
112 | - */ |
|
113 | - public function email_instructions( $invoice, $email_type, $sent_to_admin ) { |
|
107 | + * Add content to the WPI emails. |
|
108 | + * |
|
109 | + * @param WPInv_Invoice $invoice Invoice. |
|
110 | + * @param string $email_type Email format: plain text or HTML. |
|
111 | + * @param bool $sent_to_admin Sent to admin. |
|
112 | + */ |
|
113 | + public function email_instructions( $invoice, $email_type, $sent_to_admin ) { |
|
114 | 114 | |
115 | - if ( ! $sent_to_admin && 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) { |
|
115 | + if ( ! $sent_to_admin && 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) { |
|
116 | 116 | |
117 | - echo '<div class="wpi-email-row getpaid-bank-transfer-details">'; |
|
117 | + echo '<div class="wpi-email-row getpaid-bank-transfer-details">'; |
|
118 | 118 | |
119 | - if ( $this->instructions ) { |
|
120 | - echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL ); |
|
119 | + if ( $this->instructions ) { |
|
120 | + echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL ); |
|
121 | 121 | } |
122 | 122 | |
123 | - $this->bank_details( $invoice ); |
|
123 | + $this->bank_details( $invoice ); |
|
124 | 124 | |
125 | - echo '</div>'; |
|
125 | + echo '</div>'; |
|
126 | 126 | |
127 | - } |
|
127 | + } |
|
128 | 128 | |
129 | 129 | } |
130 | 130 | |
131 | 131 | /** |
132 | - * Get bank details and place into a list format. |
|
133 | - * |
|
134 | - * @param WPInv_Invoice $invoice Invoice. |
|
135 | - */ |
|
136 | - protected function bank_details( $invoice ) { |
|
132 | + * Get bank details and place into a list format. |
|
133 | + * |
|
134 | + * @param WPInv_Invoice $invoice Invoice. |
|
135 | + */ |
|
136 | + protected function bank_details( $invoice ) { |
|
137 | 137 | |
138 | - // Get the invoice country and country $locale. |
|
139 | - $country = $invoice->get_country(); |
|
140 | - $locale = $this->get_country_locale(); |
|
138 | + // Get the invoice country and country $locale. |
|
139 | + $country = $invoice->get_country(); |
|
140 | + $locale = $this->get_country_locale(); |
|
141 | 141 | |
142 | - // Get sortcode label in the $locale array and use appropriate one. |
|
143 | - $sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' ); |
|
142 | + // Get sortcode label in the $locale array and use appropriate one. |
|
143 | + $sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' ); |
|
144 | 144 | |
145 | 145 | $bank_fields = array( |
146 | 146 | 'ac_name' => __( 'Account Name', 'invoicing' ), |
@@ -169,144 +169,144 @@ discard block |
||
169 | 169 | return; |
170 | 170 | } |
171 | 171 | |
172 | - echo '<h3 class="getpaid-bank-transfer-title"> ' . apply_filters( 'wpinv_receipt_bank_details_title', __( 'Bank Details', 'invoicing' ) ) . '</h3>' . PHP_EOL; |
|
172 | + echo '<h3 class="getpaid-bank-transfer-title"> ' . apply_filters( 'wpinv_receipt_bank_details_title', __( 'Bank Details', 'invoicing' ) ) . '</h3>' . PHP_EOL; |
|
173 | 173 | |
174 | - echo '<table class="table table-bordered getpaid-bank-transfer-details">' . PHP_EOL; |
|
174 | + echo '<table class="table table-bordered getpaid-bank-transfer-details">' . PHP_EOL; |
|
175 | 175 | |
176 | - foreach ( $bank_info as $key => $data ) { |
|
176 | + foreach ( $bank_info as $key => $data ) { |
|
177 | 177 | |
178 | - $key = sanitize_html_class( $key ); |
|
179 | - $label = wp_kses_post( $data['label'] ); |
|
180 | - $value = wp_kses_post( wptexturize( $data['value'] ) ); |
|
178 | + $key = sanitize_html_class( $key ); |
|
179 | + $label = wp_kses_post( $data['label'] ); |
|
180 | + $value = wp_kses_post( wptexturize( $data['value'] ) ); |
|
181 | 181 | |
182 | - echo "<tr class='getpaid-bank-transfer-$key'><th>$label</th><td>$value</td></tr>" . PHP_EOL; |
|
183 | - } |
|
182 | + echo "<tr class='getpaid-bank-transfer-$key'><th>$label</th><td>$value</td></tr>" . PHP_EOL; |
|
183 | + } |
|
184 | 184 | |
185 | - echo '</table>'; |
|
185 | + echo '</table>'; |
|
186 | 186 | |
187 | 187 | } |
188 | 188 | |
189 | 189 | /** |
190 | - * Get country locale if localized. |
|
191 | - * |
|
192 | - * @return array |
|
193 | - */ |
|
194 | - public function get_country_locale() { |
|
195 | - |
|
196 | - if ( empty( $this->locale ) ) { |
|
197 | - |
|
198 | - // Locale information to be used - only those that are not 'Sort Code'. |
|
199 | - $this->locale = apply_filters( |
|
200 | - 'getpaid_get_bank_transfer_locale', |
|
201 | - array( |
|
202 | - 'AU' => array( |
|
203 | - 'sortcode' => array( |
|
204 | - 'label' => __( 'BSB', 'invoicing' ), |
|
205 | - ), |
|
206 | - ), |
|
207 | - 'CA' => array( |
|
208 | - 'sortcode' => array( |
|
209 | - 'label' => __( 'Bank transit number', 'invoicing' ), |
|
210 | - ), |
|
211 | - ), |
|
212 | - 'IN' => array( |
|
213 | - 'sortcode' => array( |
|
214 | - 'label' => __( 'IFSC', 'invoicing' ), |
|
215 | - ), |
|
216 | - ), |
|
217 | - 'IT' => array( |
|
218 | - 'sortcode' => array( |
|
219 | - 'label' => __( 'Branch sort', 'invoicing' ), |
|
220 | - ), |
|
221 | - ), |
|
222 | - 'NZ' => array( |
|
223 | - 'sortcode' => array( |
|
224 | - 'label' => __( 'Bank code', 'invoicing' ), |
|
225 | - ), |
|
226 | - ), |
|
227 | - 'SE' => array( |
|
228 | - 'sortcode' => array( |
|
229 | - 'label' => __( 'Bank code', 'invoicing' ), |
|
230 | - ), |
|
231 | - ), |
|
232 | - 'US' => array( |
|
233 | - 'sortcode' => array( |
|
234 | - 'label' => __( 'Routing number', 'invoicing' ), |
|
235 | - ), |
|
236 | - ), |
|
237 | - 'ZA' => array( |
|
238 | - 'sortcode' => array( |
|
239 | - 'label' => __( 'Branch code', 'invoicing' ), |
|
240 | - ), |
|
241 | - ), |
|
242 | - ) |
|
243 | - ); |
|
244 | - |
|
245 | - } |
|
246 | - |
|
247 | - return $this->locale; |
|
248 | - |
|
249 | - } |
|
250 | - |
|
251 | - /** |
|
252 | - * Filters the gateway settings. |
|
253 | - * |
|
254 | - * @param array $admin_settings |
|
255 | - */ |
|
256 | - public function admin_settings( $admin_settings ) { |
|
190 | + * Get country locale if localized. |
|
191 | + * |
|
192 | + * @return array |
|
193 | + */ |
|
194 | + public function get_country_locale() { |
|
195 | + |
|
196 | + if ( empty( $this->locale ) ) { |
|
197 | + |
|
198 | + // Locale information to be used - only those that are not 'Sort Code'. |
|
199 | + $this->locale = apply_filters( |
|
200 | + 'getpaid_get_bank_transfer_locale', |
|
201 | + array( |
|
202 | + 'AU' => array( |
|
203 | + 'sortcode' => array( |
|
204 | + 'label' => __( 'BSB', 'invoicing' ), |
|
205 | + ), |
|
206 | + ), |
|
207 | + 'CA' => array( |
|
208 | + 'sortcode' => array( |
|
209 | + 'label' => __( 'Bank transit number', 'invoicing' ), |
|
210 | + ), |
|
211 | + ), |
|
212 | + 'IN' => array( |
|
213 | + 'sortcode' => array( |
|
214 | + 'label' => __( 'IFSC', 'invoicing' ), |
|
215 | + ), |
|
216 | + ), |
|
217 | + 'IT' => array( |
|
218 | + 'sortcode' => array( |
|
219 | + 'label' => __( 'Branch sort', 'invoicing' ), |
|
220 | + ), |
|
221 | + ), |
|
222 | + 'NZ' => array( |
|
223 | + 'sortcode' => array( |
|
224 | + 'label' => __( 'Bank code', 'invoicing' ), |
|
225 | + ), |
|
226 | + ), |
|
227 | + 'SE' => array( |
|
228 | + 'sortcode' => array( |
|
229 | + 'label' => __( 'Bank code', 'invoicing' ), |
|
230 | + ), |
|
231 | + ), |
|
232 | + 'US' => array( |
|
233 | + 'sortcode' => array( |
|
234 | + 'label' => __( 'Routing number', 'invoicing' ), |
|
235 | + ), |
|
236 | + ), |
|
237 | + 'ZA' => array( |
|
238 | + 'sortcode' => array( |
|
239 | + 'label' => __( 'Branch code', 'invoicing' ), |
|
240 | + ), |
|
241 | + ), |
|
242 | + ) |
|
243 | + ); |
|
244 | + |
|
245 | + } |
|
246 | + |
|
247 | + return $this->locale; |
|
248 | + |
|
249 | + } |
|
250 | + |
|
251 | + /** |
|
252 | + * Filters the gateway settings. |
|
253 | + * |
|
254 | + * @param array $admin_settings |
|
255 | + */ |
|
256 | + public function admin_settings( $admin_settings ) { |
|
257 | 257 | |
258 | 258 | $admin_settings['bank_transfer_desc']['std'] = __( "Make your payment directly into our bank account. Please use your Invoice Number as the payment reference. Your invoice won't be processed until the funds have cleared in our account.", 'invoicing' ); |
259 | - $admin_settings['bank_transfer_active']['desc'] = __( 'Enable bank transfer', 'invoicing' ); |
|
259 | + $admin_settings['bank_transfer_active']['desc'] = __( 'Enable bank transfer', 'invoicing' ); |
|
260 | 260 | |
261 | - $locale = $this->get_country_locale(); |
|
261 | + $locale = $this->get_country_locale(); |
|
262 | 262 | |
263 | - // Get sortcode label in the $locale array and use appropriate one. |
|
264 | - $country = wpinv_default_billing_country(); |
|
265 | - $sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' ); |
|
263 | + // Get sortcode label in the $locale array and use appropriate one. |
|
264 | + $country = wpinv_default_billing_country(); |
|
265 | + $sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' ); |
|
266 | 266 | |
267 | - $admin_settings['bank_transfer_ac_name'] = array( |
|
267 | + $admin_settings['bank_transfer_ac_name'] = array( |
|
268 | 268 | 'type' => 'text', |
269 | 269 | 'id' => 'bank_transfer_ac_name', |
270 | 270 | 'name' => __( 'Account Name', 'invoicing' ), |
271 | - ); |
|
271 | + ); |
|
272 | 272 | |
273 | - $admin_settings['bank_transfer_ac_no'] = array( |
|
273 | + $admin_settings['bank_transfer_ac_no'] = array( |
|
274 | 274 | 'type' => 'text', |
275 | 275 | 'id' => 'bank_transfer_ac_no', |
276 | 276 | 'name' => __( 'Account Number', 'invoicing' ), |
277 | - ); |
|
277 | + ); |
|
278 | 278 | |
279 | - $admin_settings['bank_transfer_bank_name'] = array( |
|
279 | + $admin_settings['bank_transfer_bank_name'] = array( |
|
280 | 280 | 'type' => 'text', |
281 | 281 | 'id' => 'bank_transfer_bank_name', |
282 | 282 | 'name' => __( 'Bank Name', 'invoicing' ), |
283 | - ); |
|
283 | + ); |
|
284 | 284 | |
285 | - $admin_settings['bank_transfer_ifsc'] = array( |
|
285 | + $admin_settings['bank_transfer_ifsc'] = array( |
|
286 | 286 | 'type' => 'text', |
287 | 287 | 'id' => 'bank_transfer_ifsc', |
288 | 288 | 'name' => __( 'IFSC Code', 'invoicing' ), |
289 | - ); |
|
289 | + ); |
|
290 | 290 | |
291 | - $admin_settings['bank_transfer_iban'] = array( |
|
291 | + $admin_settings['bank_transfer_iban'] = array( |
|
292 | 292 | 'type' => 'text', |
293 | 293 | 'id' => 'bank_transfer_iban', |
294 | 294 | 'name' => __( 'IBAN', 'invoicing' ), |
295 | - ); |
|
295 | + ); |
|
296 | 296 | |
297 | - $admin_settings['bank_transfer_bic'] = array( |
|
297 | + $admin_settings['bank_transfer_bic'] = array( |
|
298 | 298 | 'type' => 'text', |
299 | 299 | 'id' => 'bank_transfer_bic', |
300 | 300 | 'name' => __( 'BIC/Swift Code', 'invoicing' ), |
301 | - ); |
|
301 | + ); |
|
302 | 302 | |
303 | - $admin_settings['bank_transfer_sort_code'] = array( |
|
304 | - 'type' => 'text', |
|
305 | - 'id' => 'bank_transfer_sort_code', |
|
306 | - 'name' => $sortcode, |
|
307 | - ); |
|
303 | + $admin_settings['bank_transfer_sort_code'] = array( |
|
304 | + 'type' => 'text', |
|
305 | + 'id' => 'bank_transfer_sort_code', |
|
306 | + 'name' => $sortcode, |
|
307 | + ); |
|
308 | 308 | |
309 | - $admin_settings['bank_transfer_info'] = array( |
|
309 | + $admin_settings['bank_transfer_info'] = array( |
|
310 | 310 | 'id' => 'bank_transfer_info', |
311 | 311 | 'name' => __( 'Instructions', 'invoicing' ), |
312 | 312 | 'desc' => __( 'Instructions that will be added to the thank you page and emails.', 'invoicing' ), |
@@ -316,17 +316,17 @@ discard block |
||
316 | 316 | 'rows' => 5 |
317 | 317 | ); |
318 | 318 | |
319 | - return $admin_settings; |
|
320 | - } |
|
319 | + return $admin_settings; |
|
320 | + } |
|
321 | 321 | |
322 | - /** |
|
323 | - * Processes invoice addons. |
|
324 | - * |
|
325 | - * @param WPInv_Invoice $invoice |
|
326 | - * @param GetPaid_Form_Item[] $items |
|
327 | - * @return WPInv_Invoice |
|
328 | - */ |
|
329 | - public function process_addons( $invoice, $items ) { |
|
322 | + /** |
|
323 | + * Processes invoice addons. |
|
324 | + * |
|
325 | + * @param WPInv_Invoice $invoice |
|
326 | + * @param GetPaid_Form_Item[] $items |
|
327 | + * @return WPInv_Invoice |
|
328 | + */ |
|
329 | + public function process_addons( $invoice, $items ) { |
|
330 | 330 | |
331 | 331 | foreach ( $items as $item ) { |
332 | 332 | $invoice->add_item( $item ); |
@@ -334,6 +334,6 @@ discard block |
||
334 | 334 | |
335 | 335 | $invoice->recalculate_total(); |
336 | 336 | $invoice->save(); |
337 | - } |
|
337 | + } |
|
338 | 338 | |
339 | 339 | } |
@@ -18,758 +18,758 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * An array of available settings. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $settings; |
|
27 | - |
|
28 | - /** |
|
29 | - * Route base. |
|
30 | - * |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $rest_base = 'settings'; |
|
34 | - |
|
35 | - /** |
|
36 | - * Registers the routes for the objects of the controller. |
|
37 | - * |
|
38 | - * @since 2.0.0 |
|
39 | - * |
|
40 | - * @see register_rest_route() |
|
41 | - */ |
|
42 | - public function register_namespace_routes( $namespace ) { |
|
43 | - |
|
44 | - // List all registered tabs. |
|
45 | - register_rest_route( |
|
46 | - $namespace, |
|
47 | - $this->rest_base, |
|
48 | - array( |
|
49 | - array( |
|
50 | - 'methods' => WP_REST_Server::READABLE, |
|
51 | - 'callback' => array( $this, 'get_tabs' ), |
|
52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | - ), |
|
54 | - 'schema' => '__return_empty_array', |
|
55 | - ) |
|
56 | - ); |
|
57 | - |
|
58 | - // View/Update a single setting. |
|
59 | - register_rest_route( |
|
60 | - $namespace, |
|
61 | - $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | - array( |
|
63 | - 'args' => array( |
|
64 | - 'id' => array( |
|
65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | - 'type' => 'string', |
|
67 | - 'required' => true, |
|
68 | - ), |
|
69 | - ), |
|
70 | - array( |
|
71 | - 'methods' => WP_REST_Server::READABLE, |
|
72 | - 'callback' => array( $this, 'get_item' ), |
|
73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | - ), |
|
75 | - array( |
|
76 | - 'methods' => WP_REST_Server::EDITABLE, |
|
77 | - 'callback' => array( $this, 'update_item' ), |
|
78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | - ), |
|
81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | - ) |
|
83 | - ); |
|
84 | - |
|
85 | - // List registered sections for a given tab. |
|
86 | - register_rest_route( |
|
87 | - $namespace, |
|
88 | - $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | - array( |
|
90 | - 'args' => array( |
|
91 | - 'tab' => array( |
|
92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | - 'type' => 'string', |
|
94 | - 'required' => true, |
|
95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | - ), |
|
97 | - ), |
|
98 | - array( |
|
99 | - 'methods' => WP_REST_Server::READABLE, |
|
100 | - 'callback' => array( $this, 'get_sections' ), |
|
101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | - ), |
|
103 | - 'schema' => '__return_empty_array', |
|
104 | - ) |
|
105 | - ); |
|
106 | - |
|
107 | - // List all registered settings for a given tab. |
|
108 | - register_rest_route( |
|
109 | - $namespace, |
|
110 | - $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | - array( |
|
112 | - 'args' => array( |
|
113 | - 'tab' => array( |
|
114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | - 'type' => 'string', |
|
116 | - 'required' => true, |
|
117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | - ), |
|
119 | - 'section' => array( |
|
120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | - 'type' => 'string', |
|
122 | - 'required' => true, |
|
123 | - ), |
|
124 | - ), |
|
125 | - array( |
|
126 | - 'methods' => WP_REST_Server::READABLE, |
|
127 | - 'callback' => array( $this, 'get_items' ), |
|
128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | - ), |
|
130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | - ) |
|
132 | - ); |
|
133 | - |
|
134 | - register_rest_route( |
|
135 | - $namespace, |
|
136 | - '/' . $this->rest_base . '/batch', |
|
137 | - array( |
|
138 | - 'args' => array( |
|
139 | - 'id' => array( |
|
140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | - 'type' => 'string', |
|
142 | - ), |
|
143 | - ), |
|
144 | - array( |
|
145 | - 'methods' => WP_REST_Server::EDITABLE, |
|
146 | - 'callback' => array( $this, 'batch_items' ), |
|
147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | - ), |
|
150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | - ) |
|
152 | - ); |
|
153 | - |
|
154 | - } |
|
21 | + /** |
|
22 | + * An array of available settings. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $settings; |
|
27 | + |
|
28 | + /** |
|
29 | + * Route base. |
|
30 | + * |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $rest_base = 'settings'; |
|
34 | + |
|
35 | + /** |
|
36 | + * Registers the routes for the objects of the controller. |
|
37 | + * |
|
38 | + * @since 2.0.0 |
|
39 | + * |
|
40 | + * @see register_rest_route() |
|
41 | + */ |
|
42 | + public function register_namespace_routes( $namespace ) { |
|
43 | + |
|
44 | + // List all registered tabs. |
|
45 | + register_rest_route( |
|
46 | + $namespace, |
|
47 | + $this->rest_base, |
|
48 | + array( |
|
49 | + array( |
|
50 | + 'methods' => WP_REST_Server::READABLE, |
|
51 | + 'callback' => array( $this, 'get_tabs' ), |
|
52 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | + ), |
|
54 | + 'schema' => '__return_empty_array', |
|
55 | + ) |
|
56 | + ); |
|
57 | + |
|
58 | + // View/Update a single setting. |
|
59 | + register_rest_route( |
|
60 | + $namespace, |
|
61 | + $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | + array( |
|
63 | + 'args' => array( |
|
64 | + 'id' => array( |
|
65 | + 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | + 'type' => 'string', |
|
67 | + 'required' => true, |
|
68 | + ), |
|
69 | + ), |
|
70 | + array( |
|
71 | + 'methods' => WP_REST_Server::READABLE, |
|
72 | + 'callback' => array( $this, 'get_item' ), |
|
73 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | + ), |
|
75 | + array( |
|
76 | + 'methods' => WP_REST_Server::EDITABLE, |
|
77 | + 'callback' => array( $this, 'update_item' ), |
|
78 | + 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | + ), |
|
81 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | + ) |
|
83 | + ); |
|
84 | + |
|
85 | + // List registered sections for a given tab. |
|
86 | + register_rest_route( |
|
87 | + $namespace, |
|
88 | + $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | + array( |
|
90 | + 'args' => array( |
|
91 | + 'tab' => array( |
|
92 | + 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | + 'type' => 'string', |
|
94 | + 'required' => true, |
|
95 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | + ), |
|
97 | + ), |
|
98 | + array( |
|
99 | + 'methods' => WP_REST_Server::READABLE, |
|
100 | + 'callback' => array( $this, 'get_sections' ), |
|
101 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | + ), |
|
103 | + 'schema' => '__return_empty_array', |
|
104 | + ) |
|
105 | + ); |
|
106 | + |
|
107 | + // List all registered settings for a given tab. |
|
108 | + register_rest_route( |
|
109 | + $namespace, |
|
110 | + $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | + array( |
|
112 | + 'args' => array( |
|
113 | + 'tab' => array( |
|
114 | + 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | + 'type' => 'string', |
|
116 | + 'required' => true, |
|
117 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | + ), |
|
119 | + 'section' => array( |
|
120 | + 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | + 'type' => 'string', |
|
122 | + 'required' => true, |
|
123 | + ), |
|
124 | + ), |
|
125 | + array( |
|
126 | + 'methods' => WP_REST_Server::READABLE, |
|
127 | + 'callback' => array( $this, 'get_items' ), |
|
128 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | + ), |
|
130 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | + ) |
|
132 | + ); |
|
133 | + |
|
134 | + register_rest_route( |
|
135 | + $namespace, |
|
136 | + '/' . $this->rest_base . '/batch', |
|
137 | + array( |
|
138 | + 'args' => array( |
|
139 | + 'id' => array( |
|
140 | + 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | + 'type' => 'string', |
|
142 | + ), |
|
143 | + ), |
|
144 | + array( |
|
145 | + 'methods' => WP_REST_Server::EDITABLE, |
|
146 | + 'callback' => array( $this, 'batch_items' ), |
|
147 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | + ), |
|
150 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | + ) |
|
152 | + ); |
|
153 | + |
|
154 | + } |
|
155 | 155 | |
156 | - /** |
|
157 | - * Return all settings. |
|
158 | - * |
|
159 | - * @since 2.0.0 |
|
160 | - * @param WP_REST_Request $request Request data. |
|
161 | - * @return WP_Error|WP_REST_Response |
|
162 | - */ |
|
163 | - public function get_items( $request ) { |
|
164 | - |
|
165 | - $settings = $this->get_settings(); |
|
166 | - |
|
167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | - } |
|
170 | - |
|
171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | - } |
|
174 | - |
|
175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | - $prepared = array(); |
|
177 | - |
|
178 | - foreach ( $settings as $setting ) { |
|
179 | - |
|
180 | - $setting = $this->sanitize_setting( $setting ); |
|
181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | - |
|
184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | - $prepared[] = $setting_data; |
|
186 | - } |
|
187 | - |
|
188 | - } |
|
189 | - |
|
190 | - return rest_ensure_response( $prepared ); |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * Return a single setting. |
|
195 | - * |
|
196 | - * @since 2.0.0 |
|
197 | - * @param WP_REST_Request $request Request data. |
|
198 | - * @return WP_Error|WP_REST_Response |
|
199 | - */ |
|
200 | - public function get_item( $request ) { |
|
201 | - $setting = $this->get_setting( $request['id'] ); |
|
202 | - |
|
203 | - if ( is_wp_error( $setting ) ) { |
|
204 | - return $setting; |
|
205 | - } |
|
206 | - |
|
207 | - $setting = $this->sanitize_setting( $setting ); |
|
208 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
209 | - return rest_ensure_response( $response ); |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Update a single setting. |
|
214 | - * |
|
215 | - * @since 2.0.0 |
|
216 | - * @param WP_REST_Request $request Request data. |
|
217 | - * @return WP_Error|WP_REST_Response |
|
218 | - */ |
|
219 | - public function update_item( $request ) { |
|
220 | - $setting = $this->get_setting( $request['id'] ); |
|
221 | - |
|
222 | - if ( is_wp_error( $setting ) ) { |
|
223 | - return $setting; |
|
224 | - } |
|
225 | - |
|
226 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
227 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
228 | - } else { |
|
229 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
230 | - } |
|
231 | - |
|
232 | - if ( is_wp_error( $value ) ) { |
|
233 | - return $value; |
|
234 | - } |
|
235 | - |
|
236 | - wpinv_update_option( $request['id'], $value ); |
|
237 | - $setting['value'] = $value; |
|
238 | - $setting = $this->sanitize_setting( $setting ); |
|
239 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
240 | - |
|
241 | - return rest_ensure_response( $response ); |
|
242 | - } |
|
243 | - |
|
244 | - /** |
|
245 | - * Makes sure the current user has access to READ the settings APIs. |
|
246 | - * |
|
247 | - * @since 2.0.0 |
|
248 | - * @param WP_REST_Request $request Full data about the request. |
|
249 | - * @return WP_Error|boolean |
|
250 | - */ |
|
251 | - public function get_items_permissions_check( $request ) { |
|
252 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
253 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
254 | - } |
|
255 | - |
|
256 | - return true; |
|
257 | - } |
|
258 | - |
|
259 | - /** |
|
260 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
261 | - * |
|
262 | - * @since 2.0.0 |
|
263 | - * @param WP_REST_Request $request Full data about the request. |
|
264 | - * @return WP_Error|boolean |
|
265 | - */ |
|
266 | - public function update_items_permissions_check( $request ) { |
|
267 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
268 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
269 | - } |
|
270 | - |
|
271 | - return true; |
|
272 | - } |
|
273 | - |
|
274 | - /** |
|
275 | - * Check if a given request has access batch create, update and delete items. |
|
276 | - * |
|
277 | - * @param WP_REST_Request $request Full details about the request. |
|
278 | - * |
|
279 | - * @return boolean|WP_Error |
|
280 | - */ |
|
281 | - public function batch_items_permissions_check( $request ) { |
|
282 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Prepare links for the request. |
|
287 | - * |
|
288 | - * @param string $setting_id Setting ID. |
|
289 | - * @return array Links for the given setting. |
|
290 | - */ |
|
291 | - protected function prepare_links( $setting_id ) { |
|
292 | - |
|
293 | - $links = array( |
|
294 | - 'self' => array( |
|
295 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
296 | - ), |
|
297 | - 'collection' => array( |
|
298 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
299 | - ), |
|
300 | - ); |
|
301 | - |
|
302 | - return $links; |
|
303 | - } |
|
304 | - |
|
305 | - /** |
|
306 | - * Prepare a settings object for serialization. |
|
307 | - * |
|
308 | - * @since 2.0.0 |
|
309 | - * @param array $item Setting object. |
|
310 | - * @param WP_REST_Request $request Request object. |
|
311 | - * @return WP_REST_Response $response Response data. |
|
312 | - */ |
|
313 | - public function prepare_item_for_response( $item, $request ) { |
|
314 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
315 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
316 | - $data = $this->filter_response_by_context( $data, $context ); |
|
317 | - |
|
318 | - $response = rest_ensure_response( $data ); |
|
319 | - |
|
320 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
321 | - |
|
322 | - return $response; |
|
323 | - } |
|
324 | - |
|
325 | - /** |
|
326 | - * Filters out bad values from the settings array/filter so we |
|
327 | - * only return known values via the API. |
|
328 | - * |
|
329 | - * @since 2.0.0 |
|
330 | - * @param array $setting Setting. |
|
331 | - * @return array |
|
332 | - */ |
|
333 | - public function filter_setting( $setting ) { |
|
334 | - return array_intersect_key( |
|
335 | - $setting, |
|
336 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
337 | - ); |
|
338 | - } |
|
339 | - |
|
340 | - /** |
|
341 | - * Callback for allowed keys for each setting response. |
|
342 | - * |
|
343 | - * @param string $key Key to check. |
|
344 | - * @return boolean |
|
345 | - */ |
|
346 | - public function allowed_setting_keys( $key ) { |
|
347 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
348 | - } |
|
349 | - |
|
350 | - /** |
|
351 | - * Returns default options for a setting. null means the field is required. |
|
352 | - * |
|
353 | - * @since 2.0.0 |
|
354 | - * @return array |
|
355 | - */ |
|
356 | - protected function setting_defaults() { |
|
357 | - return array( |
|
358 | - 'id' => null, |
|
359 | - 'name' => null, |
|
360 | - 'desc' => '', |
|
361 | - 'options' => array(), |
|
362 | - 'std' => false, |
|
363 | - 'value' => false, |
|
364 | - 'placeholder' => '', |
|
365 | - 'readonly' => false, |
|
366 | - 'faux' => false, |
|
367 | - 'section' => 'main', |
|
368 | - 'tab' => 'general', |
|
369 | - 'type' => 'text', |
|
370 | - ); |
|
371 | - } |
|
372 | - |
|
373 | - /** |
|
374 | - * Sanitizes a setting's field. |
|
375 | - * |
|
376 | - * @param array $setting The setting to sanitize. |
|
377 | - * @return array |
|
378 | - */ |
|
379 | - public function sanitize_setting( $setting ) { |
|
156 | + /** |
|
157 | + * Return all settings. |
|
158 | + * |
|
159 | + * @since 2.0.0 |
|
160 | + * @param WP_REST_Request $request Request data. |
|
161 | + * @return WP_Error|WP_REST_Response |
|
162 | + */ |
|
163 | + public function get_items( $request ) { |
|
164 | + |
|
165 | + $settings = $this->get_settings(); |
|
166 | + |
|
167 | + if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | + return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | + } |
|
170 | + |
|
171 | + if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | + return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | + } |
|
174 | + |
|
175 | + $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | + $prepared = array(); |
|
177 | + |
|
178 | + foreach ( $settings as $setting ) { |
|
179 | + |
|
180 | + $setting = $this->sanitize_setting( $setting ); |
|
181 | + $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | + $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | + |
|
184 | + if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | + $prepared[] = $setting_data; |
|
186 | + } |
|
187 | + |
|
188 | + } |
|
189 | + |
|
190 | + return rest_ensure_response( $prepared ); |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * Return a single setting. |
|
195 | + * |
|
196 | + * @since 2.0.0 |
|
197 | + * @param WP_REST_Request $request Request data. |
|
198 | + * @return WP_Error|WP_REST_Response |
|
199 | + */ |
|
200 | + public function get_item( $request ) { |
|
201 | + $setting = $this->get_setting( $request['id'] ); |
|
202 | + |
|
203 | + if ( is_wp_error( $setting ) ) { |
|
204 | + return $setting; |
|
205 | + } |
|
206 | + |
|
207 | + $setting = $this->sanitize_setting( $setting ); |
|
208 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
209 | + return rest_ensure_response( $response ); |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Update a single setting. |
|
214 | + * |
|
215 | + * @since 2.0.0 |
|
216 | + * @param WP_REST_Request $request Request data. |
|
217 | + * @return WP_Error|WP_REST_Response |
|
218 | + */ |
|
219 | + public function update_item( $request ) { |
|
220 | + $setting = $this->get_setting( $request['id'] ); |
|
221 | + |
|
222 | + if ( is_wp_error( $setting ) ) { |
|
223 | + return $setting; |
|
224 | + } |
|
225 | + |
|
226 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
227 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
228 | + } else { |
|
229 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
230 | + } |
|
231 | + |
|
232 | + if ( is_wp_error( $value ) ) { |
|
233 | + return $value; |
|
234 | + } |
|
235 | + |
|
236 | + wpinv_update_option( $request['id'], $value ); |
|
237 | + $setting['value'] = $value; |
|
238 | + $setting = $this->sanitize_setting( $setting ); |
|
239 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
240 | + |
|
241 | + return rest_ensure_response( $response ); |
|
242 | + } |
|
243 | + |
|
244 | + /** |
|
245 | + * Makes sure the current user has access to READ the settings APIs. |
|
246 | + * |
|
247 | + * @since 2.0.0 |
|
248 | + * @param WP_REST_Request $request Full data about the request. |
|
249 | + * @return WP_Error|boolean |
|
250 | + */ |
|
251 | + public function get_items_permissions_check( $request ) { |
|
252 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
253 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
254 | + } |
|
255 | + |
|
256 | + return true; |
|
257 | + } |
|
258 | + |
|
259 | + /** |
|
260 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
261 | + * |
|
262 | + * @since 2.0.0 |
|
263 | + * @param WP_REST_Request $request Full data about the request. |
|
264 | + * @return WP_Error|boolean |
|
265 | + */ |
|
266 | + public function update_items_permissions_check( $request ) { |
|
267 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
268 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
269 | + } |
|
270 | + |
|
271 | + return true; |
|
272 | + } |
|
273 | + |
|
274 | + /** |
|
275 | + * Check if a given request has access batch create, update and delete items. |
|
276 | + * |
|
277 | + * @param WP_REST_Request $request Full details about the request. |
|
278 | + * |
|
279 | + * @return boolean|WP_Error |
|
280 | + */ |
|
281 | + public function batch_items_permissions_check( $request ) { |
|
282 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Prepare links for the request. |
|
287 | + * |
|
288 | + * @param string $setting_id Setting ID. |
|
289 | + * @return array Links for the given setting. |
|
290 | + */ |
|
291 | + protected function prepare_links( $setting_id ) { |
|
292 | + |
|
293 | + $links = array( |
|
294 | + 'self' => array( |
|
295 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
296 | + ), |
|
297 | + 'collection' => array( |
|
298 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
299 | + ), |
|
300 | + ); |
|
301 | + |
|
302 | + return $links; |
|
303 | + } |
|
304 | + |
|
305 | + /** |
|
306 | + * Prepare a settings object for serialization. |
|
307 | + * |
|
308 | + * @since 2.0.0 |
|
309 | + * @param array $item Setting object. |
|
310 | + * @param WP_REST_Request $request Request object. |
|
311 | + * @return WP_REST_Response $response Response data. |
|
312 | + */ |
|
313 | + public function prepare_item_for_response( $item, $request ) { |
|
314 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
315 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
316 | + $data = $this->filter_response_by_context( $data, $context ); |
|
317 | + |
|
318 | + $response = rest_ensure_response( $data ); |
|
319 | + |
|
320 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
321 | + |
|
322 | + return $response; |
|
323 | + } |
|
324 | + |
|
325 | + /** |
|
326 | + * Filters out bad values from the settings array/filter so we |
|
327 | + * only return known values via the API. |
|
328 | + * |
|
329 | + * @since 2.0.0 |
|
330 | + * @param array $setting Setting. |
|
331 | + * @return array |
|
332 | + */ |
|
333 | + public function filter_setting( $setting ) { |
|
334 | + return array_intersect_key( |
|
335 | + $setting, |
|
336 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
337 | + ); |
|
338 | + } |
|
339 | + |
|
340 | + /** |
|
341 | + * Callback for allowed keys for each setting response. |
|
342 | + * |
|
343 | + * @param string $key Key to check. |
|
344 | + * @return boolean |
|
345 | + */ |
|
346 | + public function allowed_setting_keys( $key ) { |
|
347 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
348 | + } |
|
349 | + |
|
350 | + /** |
|
351 | + * Returns default options for a setting. null means the field is required. |
|
352 | + * |
|
353 | + * @since 2.0.0 |
|
354 | + * @return array |
|
355 | + */ |
|
356 | + protected function setting_defaults() { |
|
357 | + return array( |
|
358 | + 'id' => null, |
|
359 | + 'name' => null, |
|
360 | + 'desc' => '', |
|
361 | + 'options' => array(), |
|
362 | + 'std' => false, |
|
363 | + 'value' => false, |
|
364 | + 'placeholder' => '', |
|
365 | + 'readonly' => false, |
|
366 | + 'faux' => false, |
|
367 | + 'section' => 'main', |
|
368 | + 'tab' => 'general', |
|
369 | + 'type' => 'text', |
|
370 | + ); |
|
371 | + } |
|
372 | + |
|
373 | + /** |
|
374 | + * Sanitizes a setting's field. |
|
375 | + * |
|
376 | + * @param array $setting The setting to sanitize. |
|
377 | + * @return array |
|
378 | + */ |
|
379 | + public function sanitize_setting( $setting ) { |
|
380 | 380 | |
381 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
382 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
383 | - return $this->filter_setting( $setting ); |
|
384 | - |
|
385 | - } |
|
386 | - |
|
387 | - /** |
|
388 | - * Get setting data. |
|
389 | - * |
|
390 | - * @since 2.0.0 |
|
391 | - * @param string $setting_id Setting ID. |
|
392 | - * @return array|WP_Error |
|
393 | - */ |
|
394 | - public function get_setting( $setting_id ) { |
|
395 | - |
|
396 | - if ( empty( $setting_id ) ) { |
|
397 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
398 | - } |
|
399 | - |
|
400 | - $settings = $this->get_settings(); |
|
401 | - |
|
402 | - foreach ( $settings as $tabs ) { |
|
403 | - |
|
404 | - foreach ( $tabs as $sections ) { |
|
405 | - |
|
406 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
407 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
408 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
409 | - } |
|
410 | - |
|
411 | - return $sections[ $setting_id ]; |
|
412 | - } |
|
413 | - |
|
414 | - } |
|
415 | - |
|
416 | - } |
|
417 | - |
|
418 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
419 | - } |
|
420 | - |
|
421 | - /** |
|
422 | - * Get all tabs. |
|
423 | - * |
|
424 | - * @param WP_REST_Request $request Request data. |
|
425 | - * @return array |
|
426 | - */ |
|
427 | - public function get_tabs( $request ) { |
|
428 | - $tabs = wpinv_get_settings_tabs(); |
|
429 | - $prepared = array(); |
|
430 | - |
|
431 | - foreach ( $tabs as $id => $tab ) { |
|
432 | - |
|
433 | - $_request = $request; |
|
434 | - $_request['tab'] = sanitize_title( $id ); |
|
435 | - $data = array( |
|
436 | - 'id' => sanitize_title( $id ), |
|
437 | - 'label' => sanitize_text_field( $tab ), |
|
438 | - 'sections' => $this->get_sections( $_request ), |
|
439 | - ); |
|
440 | - |
|
441 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
442 | - $response = rest_ensure_response( $data ); |
|
443 | - |
|
444 | - if ( ! is_wp_error( $response ) ) { |
|
445 | - $links = array( |
|
446 | - 'sections' => array( |
|
447 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
448 | - ), |
|
449 | - 'collection' => array( |
|
450 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
451 | - ), |
|
452 | - ); |
|
453 | - $response->add_links( $links ); |
|
454 | - $response = $this->prepare_response_for_collection( $response ); |
|
455 | - } |
|
456 | - |
|
457 | - $prepared[] = $response; |
|
458 | - |
|
459 | - } |
|
460 | - |
|
461 | - return rest_ensure_response( $prepared ); |
|
462 | - } |
|
463 | - |
|
464 | - /** |
|
465 | - * Get all sections. |
|
466 | - * |
|
467 | - * @param WP_REST_Request $request Request data. |
|
468 | - * @return array |
|
469 | - */ |
|
470 | - public function get_sections( $request ) { |
|
471 | - |
|
472 | - $tab = sanitize_title( $request['tab'] ); |
|
473 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
474 | - $prepared = array(); |
|
475 | - |
|
476 | - foreach ( $sections as $id => $section ) { |
|
477 | - |
|
478 | - $data = array( |
|
479 | - 'id' => sanitize_title( $id ), |
|
480 | - 'label' => sanitize_text_field( $section ), |
|
481 | - ); |
|
482 | - |
|
483 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
484 | - $response = rest_ensure_response( $data ); |
|
485 | - |
|
486 | - if ( ! is_wp_error( $response ) ) { |
|
487 | - $links = array( |
|
488 | - 'settings' => array( |
|
489 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
490 | - ), |
|
491 | - 'collection' => array( |
|
492 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
493 | - ), |
|
494 | - 'tabs' => array( |
|
495 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
496 | - ), |
|
497 | - ); |
|
498 | - $response->add_links( $links ); |
|
499 | - $response = $this->prepare_response_for_collection( $response ); |
|
500 | - } |
|
501 | - |
|
502 | - $prepared[] = $response; |
|
503 | - |
|
504 | - } |
|
505 | - |
|
506 | - return rest_ensure_response( $prepared ); |
|
507 | - } |
|
508 | - |
|
509 | - /** |
|
510 | - * Get all settings. |
|
511 | - * |
|
512 | - * @return array |
|
513 | - */ |
|
514 | - public function get_settings() { |
|
515 | - |
|
516 | - if ( empty( $this->settings ) ) { |
|
517 | - $this->settings = wpinv_get_registered_settings(); |
|
518 | - } |
|
519 | - |
|
520 | - return $this->settings; |
|
521 | - |
|
522 | - } |
|
523 | - |
|
524 | - /** |
|
525 | - * Boolean for if a setting type is a valid supported setting type. |
|
526 | - * |
|
527 | - * @since 2.0.0 |
|
528 | - * @param string $type Type. |
|
529 | - * @return bool |
|
530 | - */ |
|
531 | - public function is_setting_type_valid( $type ) { |
|
532 | - |
|
533 | - return in_array( |
|
534 | - $type, array( |
|
535 | - 'text', // Validates with validate_setting_text_field. |
|
536 | - 'email', // Validates with validate_setting_text_field. |
|
537 | - 'number', // Validates with validate_setting_text_field. |
|
538 | - 'color', // Validates with validate_setting_text_field. |
|
539 | - 'password', // Validates with validate_setting_text_field. |
|
540 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
541 | - 'select', // Validates with validate_setting_select_field. |
|
542 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
543 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
544 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
545 | - 'header', // Validates with validate_setting_text_field. |
|
546 | - ) |
|
547 | - ); |
|
548 | - |
|
549 | - } |
|
550 | - |
|
551 | - /** |
|
552 | - * Get the settings schema, conforming to JSON Schema. |
|
553 | - * |
|
554 | - * @return array |
|
555 | - */ |
|
556 | - public function get_item_schema() { |
|
557 | - |
|
558 | - // Maybe retrieve the schema from cache. |
|
559 | - if ( ! empty( $this->schema ) ) { |
|
560 | - return $this->add_additional_fields_schema( $this->schema ); |
|
561 | - } |
|
562 | - |
|
563 | - $schema = array( |
|
564 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
565 | - 'title' => 'setting', |
|
566 | - 'type' => 'object', |
|
567 | - 'properties' => array( |
|
568 | - 'id' => array( |
|
569 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
570 | - 'type' => 'string', |
|
571 | - 'arg_options' => array( |
|
572 | - 'sanitize_callback' => 'sanitize_title', |
|
573 | - ), |
|
574 | - 'context' => array( 'view', 'edit' ), |
|
575 | - 'readonly' => true, |
|
576 | - ), |
|
577 | - 'tab' => array( |
|
578 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
579 | - 'type' => 'string', |
|
580 | - 'arg_options' => array( |
|
581 | - 'sanitize_callback' => 'sanitize_title', |
|
582 | - ), |
|
583 | - 'context' => array( 'view', 'edit' ), |
|
584 | - 'readonly' => true, |
|
585 | - ), |
|
586 | - 'section' => array( |
|
587 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
588 | - 'type' => 'string', |
|
589 | - 'arg_options' => array( |
|
590 | - 'sanitize_callback' => 'sanitize_title', |
|
591 | - ), |
|
592 | - 'context' => array( 'view', 'edit' ), |
|
593 | - 'readonly' => true, |
|
594 | - ), |
|
595 | - 'name' => array( |
|
596 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
597 | - 'type' => 'string', |
|
598 | - 'arg_options' => array( |
|
599 | - 'sanitize_callback' => 'sanitize_text_field', |
|
600 | - ), |
|
601 | - 'context' => array( 'view', 'edit' ), |
|
602 | - 'readonly' => true, |
|
603 | - ), |
|
604 | - 'desc' => array( |
|
605 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
606 | - 'type' => 'string', |
|
607 | - 'context' => array( 'view', 'edit' ), |
|
608 | - 'readonly' => true, |
|
609 | - ), |
|
610 | - 'value' => array( |
|
611 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
612 | - 'type' => 'mixed', |
|
613 | - 'context' => array( 'view', 'edit' ), |
|
614 | - ), |
|
615 | - 'default' => array( |
|
616 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
617 | - 'type' => 'mixed', |
|
618 | - 'context' => array( 'view', 'edit' ), |
|
619 | - 'readonly' => true, |
|
620 | - ), |
|
621 | - 'placeholder' => array( |
|
622 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
623 | - 'type' => 'string', |
|
624 | - 'arg_options' => array( |
|
625 | - 'sanitize_callback' => 'sanitize_text_field', |
|
626 | - ), |
|
627 | - 'context' => array( 'view', 'edit' ), |
|
628 | - 'readonly' => true, |
|
629 | - ), |
|
630 | - 'type' => array( |
|
631 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
632 | - 'type' => 'string', |
|
633 | - 'arg_options' => array( |
|
634 | - 'sanitize_callback' => 'sanitize_text_field', |
|
635 | - ), |
|
636 | - 'context' => array( 'view', 'edit' ), |
|
637 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
638 | - 'readonly' => true, |
|
639 | - ), |
|
640 | - 'options' => array( |
|
641 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
642 | - 'type' => 'object', |
|
643 | - 'context' => array( 'view', 'edit' ), |
|
644 | - 'readonly' => true, |
|
645 | - ), |
|
646 | - 'readonly' => array( |
|
647 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
648 | - 'type' => 'string', |
|
649 | - 'context' => array( 'view' ), |
|
650 | - 'readonly' => true, |
|
651 | - ), |
|
652 | - 'faux' => array( |
|
653 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
654 | - 'type' => 'string', |
|
655 | - 'context' => array( 'view' ), |
|
656 | - 'readonly' => true, |
|
657 | - ), |
|
658 | - ), |
|
659 | - ); |
|
660 | - |
|
661 | - // Filters the settings schema for the REST API. |
|
381 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
382 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
383 | + return $this->filter_setting( $setting ); |
|
384 | + |
|
385 | + } |
|
386 | + |
|
387 | + /** |
|
388 | + * Get setting data. |
|
389 | + * |
|
390 | + * @since 2.0.0 |
|
391 | + * @param string $setting_id Setting ID. |
|
392 | + * @return array|WP_Error |
|
393 | + */ |
|
394 | + public function get_setting( $setting_id ) { |
|
395 | + |
|
396 | + if ( empty( $setting_id ) ) { |
|
397 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
398 | + } |
|
399 | + |
|
400 | + $settings = $this->get_settings(); |
|
401 | + |
|
402 | + foreach ( $settings as $tabs ) { |
|
403 | + |
|
404 | + foreach ( $tabs as $sections ) { |
|
405 | + |
|
406 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
407 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
408 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
409 | + } |
|
410 | + |
|
411 | + return $sections[ $setting_id ]; |
|
412 | + } |
|
413 | + |
|
414 | + } |
|
415 | + |
|
416 | + } |
|
417 | + |
|
418 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
419 | + } |
|
420 | + |
|
421 | + /** |
|
422 | + * Get all tabs. |
|
423 | + * |
|
424 | + * @param WP_REST_Request $request Request data. |
|
425 | + * @return array |
|
426 | + */ |
|
427 | + public function get_tabs( $request ) { |
|
428 | + $tabs = wpinv_get_settings_tabs(); |
|
429 | + $prepared = array(); |
|
430 | + |
|
431 | + foreach ( $tabs as $id => $tab ) { |
|
432 | + |
|
433 | + $_request = $request; |
|
434 | + $_request['tab'] = sanitize_title( $id ); |
|
435 | + $data = array( |
|
436 | + 'id' => sanitize_title( $id ), |
|
437 | + 'label' => sanitize_text_field( $tab ), |
|
438 | + 'sections' => $this->get_sections( $_request ), |
|
439 | + ); |
|
440 | + |
|
441 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
442 | + $response = rest_ensure_response( $data ); |
|
443 | + |
|
444 | + if ( ! is_wp_error( $response ) ) { |
|
445 | + $links = array( |
|
446 | + 'sections' => array( |
|
447 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
448 | + ), |
|
449 | + 'collection' => array( |
|
450 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
451 | + ), |
|
452 | + ); |
|
453 | + $response->add_links( $links ); |
|
454 | + $response = $this->prepare_response_for_collection( $response ); |
|
455 | + } |
|
456 | + |
|
457 | + $prepared[] = $response; |
|
458 | + |
|
459 | + } |
|
460 | + |
|
461 | + return rest_ensure_response( $prepared ); |
|
462 | + } |
|
463 | + |
|
464 | + /** |
|
465 | + * Get all sections. |
|
466 | + * |
|
467 | + * @param WP_REST_Request $request Request data. |
|
468 | + * @return array |
|
469 | + */ |
|
470 | + public function get_sections( $request ) { |
|
471 | + |
|
472 | + $tab = sanitize_title( $request['tab'] ); |
|
473 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
474 | + $prepared = array(); |
|
475 | + |
|
476 | + foreach ( $sections as $id => $section ) { |
|
477 | + |
|
478 | + $data = array( |
|
479 | + 'id' => sanitize_title( $id ), |
|
480 | + 'label' => sanitize_text_field( $section ), |
|
481 | + ); |
|
482 | + |
|
483 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
484 | + $response = rest_ensure_response( $data ); |
|
485 | + |
|
486 | + if ( ! is_wp_error( $response ) ) { |
|
487 | + $links = array( |
|
488 | + 'settings' => array( |
|
489 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
490 | + ), |
|
491 | + 'collection' => array( |
|
492 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
493 | + ), |
|
494 | + 'tabs' => array( |
|
495 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
496 | + ), |
|
497 | + ); |
|
498 | + $response->add_links( $links ); |
|
499 | + $response = $this->prepare_response_for_collection( $response ); |
|
500 | + } |
|
501 | + |
|
502 | + $prepared[] = $response; |
|
503 | + |
|
504 | + } |
|
505 | + |
|
506 | + return rest_ensure_response( $prepared ); |
|
507 | + } |
|
508 | + |
|
509 | + /** |
|
510 | + * Get all settings. |
|
511 | + * |
|
512 | + * @return array |
|
513 | + */ |
|
514 | + public function get_settings() { |
|
515 | + |
|
516 | + if ( empty( $this->settings ) ) { |
|
517 | + $this->settings = wpinv_get_registered_settings(); |
|
518 | + } |
|
519 | + |
|
520 | + return $this->settings; |
|
521 | + |
|
522 | + } |
|
523 | + |
|
524 | + /** |
|
525 | + * Boolean for if a setting type is a valid supported setting type. |
|
526 | + * |
|
527 | + * @since 2.0.0 |
|
528 | + * @param string $type Type. |
|
529 | + * @return bool |
|
530 | + */ |
|
531 | + public function is_setting_type_valid( $type ) { |
|
532 | + |
|
533 | + return in_array( |
|
534 | + $type, array( |
|
535 | + 'text', // Validates with validate_setting_text_field. |
|
536 | + 'email', // Validates with validate_setting_text_field. |
|
537 | + 'number', // Validates with validate_setting_text_field. |
|
538 | + 'color', // Validates with validate_setting_text_field. |
|
539 | + 'password', // Validates with validate_setting_text_field. |
|
540 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
541 | + 'select', // Validates with validate_setting_select_field. |
|
542 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
543 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
544 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
545 | + 'header', // Validates with validate_setting_text_field. |
|
546 | + ) |
|
547 | + ); |
|
548 | + |
|
549 | + } |
|
550 | + |
|
551 | + /** |
|
552 | + * Get the settings schema, conforming to JSON Schema. |
|
553 | + * |
|
554 | + * @return array |
|
555 | + */ |
|
556 | + public function get_item_schema() { |
|
557 | + |
|
558 | + // Maybe retrieve the schema from cache. |
|
559 | + if ( ! empty( $this->schema ) ) { |
|
560 | + return $this->add_additional_fields_schema( $this->schema ); |
|
561 | + } |
|
562 | + |
|
563 | + $schema = array( |
|
564 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
565 | + 'title' => 'setting', |
|
566 | + 'type' => 'object', |
|
567 | + 'properties' => array( |
|
568 | + 'id' => array( |
|
569 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
570 | + 'type' => 'string', |
|
571 | + 'arg_options' => array( |
|
572 | + 'sanitize_callback' => 'sanitize_title', |
|
573 | + ), |
|
574 | + 'context' => array( 'view', 'edit' ), |
|
575 | + 'readonly' => true, |
|
576 | + ), |
|
577 | + 'tab' => array( |
|
578 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
579 | + 'type' => 'string', |
|
580 | + 'arg_options' => array( |
|
581 | + 'sanitize_callback' => 'sanitize_title', |
|
582 | + ), |
|
583 | + 'context' => array( 'view', 'edit' ), |
|
584 | + 'readonly' => true, |
|
585 | + ), |
|
586 | + 'section' => array( |
|
587 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
588 | + 'type' => 'string', |
|
589 | + 'arg_options' => array( |
|
590 | + 'sanitize_callback' => 'sanitize_title', |
|
591 | + ), |
|
592 | + 'context' => array( 'view', 'edit' ), |
|
593 | + 'readonly' => true, |
|
594 | + ), |
|
595 | + 'name' => array( |
|
596 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
597 | + 'type' => 'string', |
|
598 | + 'arg_options' => array( |
|
599 | + 'sanitize_callback' => 'sanitize_text_field', |
|
600 | + ), |
|
601 | + 'context' => array( 'view', 'edit' ), |
|
602 | + 'readonly' => true, |
|
603 | + ), |
|
604 | + 'desc' => array( |
|
605 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
606 | + 'type' => 'string', |
|
607 | + 'context' => array( 'view', 'edit' ), |
|
608 | + 'readonly' => true, |
|
609 | + ), |
|
610 | + 'value' => array( |
|
611 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
612 | + 'type' => 'mixed', |
|
613 | + 'context' => array( 'view', 'edit' ), |
|
614 | + ), |
|
615 | + 'default' => array( |
|
616 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
617 | + 'type' => 'mixed', |
|
618 | + 'context' => array( 'view', 'edit' ), |
|
619 | + 'readonly' => true, |
|
620 | + ), |
|
621 | + 'placeholder' => array( |
|
622 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
623 | + 'type' => 'string', |
|
624 | + 'arg_options' => array( |
|
625 | + 'sanitize_callback' => 'sanitize_text_field', |
|
626 | + ), |
|
627 | + 'context' => array( 'view', 'edit' ), |
|
628 | + 'readonly' => true, |
|
629 | + ), |
|
630 | + 'type' => array( |
|
631 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
632 | + 'type' => 'string', |
|
633 | + 'arg_options' => array( |
|
634 | + 'sanitize_callback' => 'sanitize_text_field', |
|
635 | + ), |
|
636 | + 'context' => array( 'view', 'edit' ), |
|
637 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
638 | + 'readonly' => true, |
|
639 | + ), |
|
640 | + 'options' => array( |
|
641 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
642 | + 'type' => 'object', |
|
643 | + 'context' => array( 'view', 'edit' ), |
|
644 | + 'readonly' => true, |
|
645 | + ), |
|
646 | + 'readonly' => array( |
|
647 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
648 | + 'type' => 'string', |
|
649 | + 'context' => array( 'view' ), |
|
650 | + 'readonly' => true, |
|
651 | + ), |
|
652 | + 'faux' => array( |
|
653 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
654 | + 'type' => 'string', |
|
655 | + 'context' => array( 'view' ), |
|
656 | + 'readonly' => true, |
|
657 | + ), |
|
658 | + ), |
|
659 | + ); |
|
660 | + |
|
661 | + // Filters the settings schema for the REST API. |
|
662 | 662 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
663 | 663 | |
664 | - // Cache the settings schema. |
|
665 | - $this->schema = $schema; |
|
666 | - |
|
667 | - return $this->add_additional_fields_schema( $this->schema ); |
|
668 | - |
|
669 | - } |
|
670 | - |
|
671 | - /** |
|
672 | - * Validate a text value for a text based setting. |
|
673 | - * |
|
674 | - * @since 2.0.0 |
|
675 | - * @param string $value Value. |
|
676 | - * @param array $setting Setting. |
|
677 | - * @return string |
|
678 | - */ |
|
679 | - public function validate_setting_text_field( $value ) { |
|
680 | - $value = is_null( $value ) ? '' : $value; |
|
681 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
682 | - } |
|
683 | - |
|
684 | - /** |
|
685 | - * Validate select based settings. |
|
686 | - * |
|
687 | - * @since 2.0.0 |
|
688 | - * @param string $value Value. |
|
689 | - * @param array $setting Setting. |
|
690 | - * @return string|WP_Error |
|
691 | - */ |
|
692 | - public function validate_setting_select_field( $value, $setting ) { |
|
693 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
694 | - return $value; |
|
695 | - } else { |
|
696 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
697 | - } |
|
698 | - } |
|
699 | - |
|
700 | - /** |
|
701 | - * Validate multiselect based settings. |
|
702 | - * |
|
703 | - * @since 2.0.0 |
|
704 | - * @param array $values Values. |
|
705 | - * @param array $setting Setting. |
|
706 | - * @return array|WP_Error |
|
707 | - */ |
|
708 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
709 | - if ( empty( $values ) ) { |
|
710 | - return array(); |
|
711 | - } |
|
712 | - |
|
713 | - if ( ! is_array( $values ) ) { |
|
714 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
715 | - } |
|
716 | - |
|
717 | - $final_values = array(); |
|
718 | - foreach ( $values as $value ) { |
|
719 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
720 | - $final_values[] = $value; |
|
721 | - } |
|
722 | - } |
|
723 | - |
|
724 | - return $final_values; |
|
725 | - } |
|
726 | - |
|
727 | - /** |
|
728 | - * Validate radio based settings. |
|
729 | - * |
|
730 | - * @since 2.0.0 |
|
731 | - * @param string $value Value. |
|
732 | - * @param array $setting Setting. |
|
733 | - * @return string|WP_Error |
|
734 | - */ |
|
735 | - public function validate_setting_radio_field( $value, $setting ) { |
|
736 | - return $this->validate_setting_select_field( $value, $setting ); |
|
737 | - } |
|
738 | - |
|
739 | - /** |
|
740 | - * Validate checkbox based settings. |
|
741 | - * |
|
742 | - * @since 2.0.0 |
|
743 | - * @param string $value Value. |
|
744 | - * @return int |
|
745 | - */ |
|
746 | - public function validate_setting_checkbox_field( $value ) { |
|
747 | - return (int) ! empty( $value ); |
|
748 | - } |
|
749 | - |
|
750 | - /** |
|
751 | - * Validate textarea based settings. |
|
752 | - * |
|
753 | - * @since 2.0.0 |
|
754 | - * @param string $value Value. |
|
755 | - * @return string |
|
756 | - */ |
|
757 | - public function validate_setting_textarea_field( $value ) { |
|
758 | - $value = is_null( $value ) ? '' : $value; |
|
759 | - return wp_kses( |
|
760 | - trim( stripslashes( $value ) ), |
|
761 | - array_merge( |
|
762 | - array( |
|
763 | - 'iframe' => array( |
|
764 | - 'src' => true, |
|
765 | - 'style' => true, |
|
766 | - 'id' => true, |
|
767 | - 'class' => true, |
|
768 | - ), |
|
769 | - ), |
|
770 | - wp_kses_allowed_html( 'post' ) |
|
771 | - ) |
|
772 | - ); |
|
773 | - } |
|
664 | + // Cache the settings schema. |
|
665 | + $this->schema = $schema; |
|
666 | + |
|
667 | + return $this->add_additional_fields_schema( $this->schema ); |
|
668 | + |
|
669 | + } |
|
670 | + |
|
671 | + /** |
|
672 | + * Validate a text value for a text based setting. |
|
673 | + * |
|
674 | + * @since 2.0.0 |
|
675 | + * @param string $value Value. |
|
676 | + * @param array $setting Setting. |
|
677 | + * @return string |
|
678 | + */ |
|
679 | + public function validate_setting_text_field( $value ) { |
|
680 | + $value = is_null( $value ) ? '' : $value; |
|
681 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
682 | + } |
|
683 | + |
|
684 | + /** |
|
685 | + * Validate select based settings. |
|
686 | + * |
|
687 | + * @since 2.0.0 |
|
688 | + * @param string $value Value. |
|
689 | + * @param array $setting Setting. |
|
690 | + * @return string|WP_Error |
|
691 | + */ |
|
692 | + public function validate_setting_select_field( $value, $setting ) { |
|
693 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
694 | + return $value; |
|
695 | + } else { |
|
696 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
697 | + } |
|
698 | + } |
|
699 | + |
|
700 | + /** |
|
701 | + * Validate multiselect based settings. |
|
702 | + * |
|
703 | + * @since 2.0.0 |
|
704 | + * @param array $values Values. |
|
705 | + * @param array $setting Setting. |
|
706 | + * @return array|WP_Error |
|
707 | + */ |
|
708 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
709 | + if ( empty( $values ) ) { |
|
710 | + return array(); |
|
711 | + } |
|
712 | + |
|
713 | + if ( ! is_array( $values ) ) { |
|
714 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
715 | + } |
|
716 | + |
|
717 | + $final_values = array(); |
|
718 | + foreach ( $values as $value ) { |
|
719 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
720 | + $final_values[] = $value; |
|
721 | + } |
|
722 | + } |
|
723 | + |
|
724 | + return $final_values; |
|
725 | + } |
|
726 | + |
|
727 | + /** |
|
728 | + * Validate radio based settings. |
|
729 | + * |
|
730 | + * @since 2.0.0 |
|
731 | + * @param string $value Value. |
|
732 | + * @param array $setting Setting. |
|
733 | + * @return string|WP_Error |
|
734 | + */ |
|
735 | + public function validate_setting_radio_field( $value, $setting ) { |
|
736 | + return $this->validate_setting_select_field( $value, $setting ); |
|
737 | + } |
|
738 | + |
|
739 | + /** |
|
740 | + * Validate checkbox based settings. |
|
741 | + * |
|
742 | + * @since 2.0.0 |
|
743 | + * @param string $value Value. |
|
744 | + * @return int |
|
745 | + */ |
|
746 | + public function validate_setting_checkbox_field( $value ) { |
|
747 | + return (int) ! empty( $value ); |
|
748 | + } |
|
749 | + |
|
750 | + /** |
|
751 | + * Validate textarea based settings. |
|
752 | + * |
|
753 | + * @since 2.0.0 |
|
754 | + * @param string $value Value. |
|
755 | + * @return string |
|
756 | + */ |
|
757 | + public function validate_setting_textarea_field( $value ) { |
|
758 | + $value = is_null( $value ) ? '' : $value; |
|
759 | + return wp_kses( |
|
760 | + trim( stripslashes( $value ) ), |
|
761 | + array_merge( |
|
762 | + array( |
|
763 | + 'iframe' => array( |
|
764 | + 'src' => true, |
|
765 | + 'style' => true, |
|
766 | + 'id' => true, |
|
767 | + 'class' => true, |
|
768 | + ), |
|
769 | + ), |
|
770 | + wp_kses_allowed_html( 'post' ) |
|
771 | + ) |
|
772 | + ); |
|
773 | + } |
|
774 | 774 | |
775 | 775 | } |
@@ -12,294 +12,294 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Reports_Helper { |
14 | 14 | |
15 | - /** |
|
16 | - * Get report totals such as invoice totals and discount amounts. |
|
17 | - * |
|
18 | - * Data example: |
|
19 | - * |
|
20 | - * 'subtotal' => array( |
|
21 | - * 'type' => 'invoice_data', |
|
22 | - * 'function' => 'SUM', |
|
23 | - * 'name' => 'subtotal' |
|
24 | - * ) |
|
25 | - * |
|
26 | - * @param array $args |
|
27 | - * @return mixed depending on query_type |
|
28 | - */ |
|
29 | - public static function get_invoice_report_data( $args = array() ) { |
|
30 | - global $wpdb; |
|
31 | - |
|
32 | - $default_args = array( |
|
33 | - 'data' => array(), // The data to retrieve. |
|
34 | - 'where' => array(), // An array of where queries. |
|
35 | - 'query_type' => 'get_row', // wpdb query to run. |
|
36 | - 'group_by' => '', // What to group results by. |
|
37 | - 'order_by' => '', // What to order by. |
|
38 | - 'limit' => '', // Results limit. |
|
39 | - 'filter_range' => array(), // An array of before and after dates to limit results by. |
|
40 | - 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
41 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
42 | - 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
|
43 | - ); |
|
44 | - |
|
45 | - $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
46 | - $args = wp_parse_args( $args, $default_args ); |
|
47 | - |
|
48 | - extract( $args ); |
|
49 | - |
|
50 | - if ( empty( $data ) ) { |
|
51 | - return ''; |
|
52 | - } |
|
53 | - |
|
54 | - $query = array(); |
|
55 | - $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
56 | - $query['from'] = "FROM {$wpdb->posts} AS posts"; |
|
57 | - $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
58 | - |
|
59 | - $query['where'] = " |
|
15 | + /** |
|
16 | + * Get report totals such as invoice totals and discount amounts. |
|
17 | + * |
|
18 | + * Data example: |
|
19 | + * |
|
20 | + * 'subtotal' => array( |
|
21 | + * 'type' => 'invoice_data', |
|
22 | + * 'function' => 'SUM', |
|
23 | + * 'name' => 'subtotal' |
|
24 | + * ) |
|
25 | + * |
|
26 | + * @param array $args |
|
27 | + * @return mixed depending on query_type |
|
28 | + */ |
|
29 | + public static function get_invoice_report_data( $args = array() ) { |
|
30 | + global $wpdb; |
|
31 | + |
|
32 | + $default_args = array( |
|
33 | + 'data' => array(), // The data to retrieve. |
|
34 | + 'where' => array(), // An array of where queries. |
|
35 | + 'query_type' => 'get_row', // wpdb query to run. |
|
36 | + 'group_by' => '', // What to group results by. |
|
37 | + 'order_by' => '', // What to order by. |
|
38 | + 'limit' => '', // Results limit. |
|
39 | + 'filter_range' => array(), // An array of before and after dates to limit results by. |
|
40 | + 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
41 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
42 | + 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
|
43 | + ); |
|
44 | + |
|
45 | + $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
46 | + $args = wp_parse_args( $args, $default_args ); |
|
47 | + |
|
48 | + extract( $args ); |
|
49 | + |
|
50 | + if ( empty( $data ) ) { |
|
51 | + return ''; |
|
52 | + } |
|
53 | + |
|
54 | + $query = array(); |
|
55 | + $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
56 | + $query['from'] = "FROM {$wpdb->posts} AS posts"; |
|
57 | + $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
58 | + |
|
59 | + $query['where'] = " |
|
60 | 60 | WHERE posts.post_type IN ( '" . implode( "','", $invoice_types ) . "' ) |
61 | 61 | "; |
62 | 62 | |
63 | - if ( ! empty( $invoice_status ) ) { |
|
64 | - $query['where'] .= " |
|
63 | + if ( ! empty( $invoice_status ) ) { |
|
64 | + $query['where'] .= " |
|
65 | 65 | AND posts.post_status IN ( '" . implode( "','", $invoice_status ) . "' ) |
66 | 66 | "; |
67 | - } |
|
68 | - |
|
69 | - if ( ! empty( $parent_invoice_status ) ) { |
|
70 | - if ( ! empty( $invoice_status ) ) { |
|
71 | - $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
72 | - } else { |
|
73 | - $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
74 | - } |
|
75 | - } |
|
76 | - |
|
77 | - if ( ! empty( $filter_range['before'] ) ) { |
|
78 | - $query['where'] .= " |
|
67 | + } |
|
68 | + |
|
69 | + if ( ! empty( $parent_invoice_status ) ) { |
|
70 | + if ( ! empty( $invoice_status ) ) { |
|
71 | + $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
72 | + } else { |
|
73 | + $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
74 | + } |
|
75 | + } |
|
76 | + |
|
77 | + if ( ! empty( $filter_range['before'] ) ) { |
|
78 | + $query['where'] .= " |
|
79 | 79 | AND posts.post_date < '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['before'] ) ) . "' |
80 | 80 | "; |
81 | - } |
|
81 | + } |
|
82 | 82 | |
83 | - if ( ! empty( $filter_range['after'] ) ) { |
|
84 | - $query['where'] .= " |
|
83 | + if ( ! empty( $filter_range['after'] ) ) { |
|
84 | + $query['where'] .= " |
|
85 | 85 | AND posts.post_date > '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['after'] ) ) . "' |
86 | 86 | "; |
87 | - } |
|
87 | + } |
|
88 | 88 | |
89 | - if ( ! empty( $where ) ) { |
|
89 | + if ( ! empty( $where ) ) { |
|
90 | 90 | |
91 | - foreach ( $where as $value ) { |
|
91 | + foreach ( $where as $value ) { |
|
92 | 92 | |
93 | - if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) { |
|
94 | - |
|
95 | - if ( is_array( $value['value'] ) ) { |
|
96 | - $value['value'] = implode( "','", $value['value'] ); |
|
97 | - } |
|
98 | - |
|
99 | - if ( ! empty( $value['value'] ) ) { |
|
100 | - $where_value = "{$value['operator']} ('{$value['value']}')"; |
|
101 | - } |
|
102 | - } else { |
|
103 | - $where_value = "{$value['operator']} '{$value['value']}'"; |
|
104 | - } |
|
105 | - |
|
106 | - if ( ! empty( $where_value ) ) { |
|
107 | - $query['where'] .= " AND {$value['key']} {$where_value}"; |
|
108 | - } |
|
109 | - } |
|
110 | - } |
|
111 | - |
|
112 | - if ( $group_by ) { |
|
113 | - $query['group_by'] = "GROUP BY {$group_by}"; |
|
114 | - } |
|
115 | - |
|
116 | - if ( $order_by ) { |
|
117 | - $query['order_by'] = "ORDER BY {$order_by}"; |
|
118 | - } |
|
119 | - |
|
120 | - if ( $limit ) { |
|
121 | - $query['limit'] = "LIMIT {$limit}"; |
|
122 | - } |
|
123 | - |
|
124 | - $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
125 | - $query = implode( ' ', $query ); |
|
126 | - |
|
127 | - return self::execute( $query_type, $query ); |
|
128 | - |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * Prepares the data to select. |
|
133 | - * |
|
134 | - * |
|
135 | - * @param array $data |
|
136 | - * @return array |
|
137 | - */ |
|
138 | - public static function prepare_invoice_data( $data ) { |
|
139 | - |
|
140 | - $prepared = array(); |
|
141 | - |
|
142 | - foreach ( $data as $raw_key => $value ) { |
|
143 | - $key = sanitize_key( $raw_key ); |
|
144 | - $distinct = ''; |
|
145 | - |
|
146 | - if ( isset( $value['distinct'] ) ) { |
|
147 | - $distinct = 'DISTINCT'; |
|
148 | - } |
|
149 | - |
|
150 | - $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
151 | - |
|
152 | - if ( false === $get_key ) { |
|
153 | - // Skip to the next foreach iteration else the query will be invalid. |
|
154 | - continue; |
|
155 | - } |
|
156 | - |
|
157 | - if ( ! empty( $value['function'] ) ) { |
|
158 | - $get = "{$value['function']}({$distinct} {$get_key})"; |
|
159 | - } else { |
|
160 | - $get = "{$distinct} {$get_key}"; |
|
161 | - } |
|
162 | - |
|
163 | - $prepared[] = "{$get} as {$value['name']}"; |
|
164 | - } |
|
165 | - |
|
166 | - return $prepared; |
|
167 | - |
|
168 | - } |
|
169 | - |
|
170 | - /** |
|
171 | - * Prepares the joins to use. |
|
172 | - * |
|
173 | - * |
|
174 | - * @param array $data |
|
175 | - * @param bool $with_parent |
|
176 | - * @return array |
|
177 | - */ |
|
178 | - public static function prepare_invoice_joins( $data, $with_parent ) { |
|
179 | - global $wpdb; |
|
180 | - |
|
181 | - $prepared = array(); |
|
182 | - |
|
183 | - foreach ( $data as $raw_key => $value ) { |
|
184 | - $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
185 | - $type = isset( $value['type'] ) ? $value['type'] : false; |
|
186 | - $key = sanitize_key( $raw_key ); |
|
187 | - |
|
188 | - switch ( $type ) { |
|
189 | - case 'meta': |
|
190 | - $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
191 | - break; |
|
192 | - case 'parent_meta': |
|
193 | - $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
194 | - break; |
|
195 | - case 'invoice_data': |
|
196 | - $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
|
197 | - break; |
|
198 | - case 'invoice_item': |
|
199 | - $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id"; |
|
200 | - break; |
|
201 | - } |
|
202 | - } |
|
203 | - |
|
204 | - if ( $with_parent ) { |
|
205 | - $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
|
206 | - } |
|
207 | - |
|
208 | - return $prepared; |
|
209 | - |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Retrieves the appropriate table key to use. |
|
214 | - * |
|
215 | - * |
|
216 | - * @param string $key |
|
217 | - * @param string $table |
|
218 | - * @return string|false |
|
219 | - */ |
|
220 | - public static function get_invoice_table_key( $key, $table ) { |
|
221 | - |
|
222 | - $keys = array( |
|
223 | - 'meta' => "meta_{$key}.meta_value", |
|
224 | - 'parent_meta' => "parent_meta_{$key}.meta_value", |
|
225 | - 'post_data' => "posts.{$key}", |
|
226 | - 'invoice_data' => "invoices.{$key}", |
|
227 | - 'invoice_item' => "invoice_items.{$key}", |
|
228 | - ); |
|
229 | - |
|
230 | - return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
231 | - |
|
232 | - } |
|
233 | - |
|
234 | - /** |
|
235 | - * Executes a query and caches the result for a minute. |
|
236 | - * |
|
237 | - * |
|
238 | - * @param string $query_type |
|
239 | - * @param string $query |
|
240 | - * @return mixed depending on query_type |
|
241 | - */ |
|
242 | - public static function execute( $query_type, $query ) { |
|
243 | - global $wpdb; |
|
244 | - |
|
245 | - $query_hash = md5( $query_type . $query ); |
|
246 | - $result = self::get_cached_query( $query_hash ); |
|
247 | - if ( $result === false ) { |
|
248 | - self::enable_big_selects(); |
|
249 | - |
|
250 | - $result = $wpdb->$query_type( $query ); |
|
251 | - self::set_cached_query( $query_hash, $result ); |
|
252 | - } |
|
253 | - |
|
254 | - return $result; |
|
255 | - |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Enables big mysql selects for reports, just once for this session. |
|
260 | - */ |
|
261 | - protected static function enable_big_selects() { |
|
262 | - static $big_selects = false; |
|
263 | - |
|
264 | - global $wpdb; |
|
265 | - |
|
266 | - if ( ! $big_selects ) { |
|
267 | - $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
268 | - $big_selects = true; |
|
269 | - } |
|
270 | - } |
|
271 | - |
|
272 | - /** |
|
273 | - * Get the cached query result or null if it's not in the cache. |
|
274 | - * |
|
275 | - * @param string $query_hash The query hash. |
|
276 | - * |
|
277 | - * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
|
278 | - */ |
|
279 | - protected static function get_cached_query( $query_hash ) { |
|
280 | - |
|
281 | - return wp_cache_get( |
|
282 | - $query_hash, |
|
283 | - strtolower( __CLASS__ ) |
|
284 | - ); |
|
285 | - |
|
286 | - } |
|
287 | - |
|
288 | - /** |
|
289 | - * Set the cached query result. |
|
290 | - * |
|
291 | - * @param string $query_hash The query hash. |
|
292 | - * @param mixed $data The data to cache. |
|
293 | - */ |
|
294 | - protected static function set_cached_query( $query_hash, $data ) { |
|
295 | - |
|
296 | - wp_cache_set( |
|
297 | - $query_hash, |
|
298 | - $data, |
|
299 | - strtolower( __CLASS__ ), |
|
300 | - 5 * MINUTE_IN_SECONDS |
|
301 | - ); |
|
302 | - |
|
303 | - } |
|
93 | + if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) { |
|
94 | + |
|
95 | + if ( is_array( $value['value'] ) ) { |
|
96 | + $value['value'] = implode( "','", $value['value'] ); |
|
97 | + } |
|
98 | + |
|
99 | + if ( ! empty( $value['value'] ) ) { |
|
100 | + $where_value = "{$value['operator']} ('{$value['value']}')"; |
|
101 | + } |
|
102 | + } else { |
|
103 | + $where_value = "{$value['operator']} '{$value['value']}'"; |
|
104 | + } |
|
105 | + |
|
106 | + if ( ! empty( $where_value ) ) { |
|
107 | + $query['where'] .= " AND {$value['key']} {$where_value}"; |
|
108 | + } |
|
109 | + } |
|
110 | + } |
|
111 | + |
|
112 | + if ( $group_by ) { |
|
113 | + $query['group_by'] = "GROUP BY {$group_by}"; |
|
114 | + } |
|
115 | + |
|
116 | + if ( $order_by ) { |
|
117 | + $query['order_by'] = "ORDER BY {$order_by}"; |
|
118 | + } |
|
119 | + |
|
120 | + if ( $limit ) { |
|
121 | + $query['limit'] = "LIMIT {$limit}"; |
|
122 | + } |
|
123 | + |
|
124 | + $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
125 | + $query = implode( ' ', $query ); |
|
126 | + |
|
127 | + return self::execute( $query_type, $query ); |
|
128 | + |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * Prepares the data to select. |
|
133 | + * |
|
134 | + * |
|
135 | + * @param array $data |
|
136 | + * @return array |
|
137 | + */ |
|
138 | + public static function prepare_invoice_data( $data ) { |
|
139 | + |
|
140 | + $prepared = array(); |
|
141 | + |
|
142 | + foreach ( $data as $raw_key => $value ) { |
|
143 | + $key = sanitize_key( $raw_key ); |
|
144 | + $distinct = ''; |
|
145 | + |
|
146 | + if ( isset( $value['distinct'] ) ) { |
|
147 | + $distinct = 'DISTINCT'; |
|
148 | + } |
|
149 | + |
|
150 | + $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
151 | + |
|
152 | + if ( false === $get_key ) { |
|
153 | + // Skip to the next foreach iteration else the query will be invalid. |
|
154 | + continue; |
|
155 | + } |
|
156 | + |
|
157 | + if ( ! empty( $value['function'] ) ) { |
|
158 | + $get = "{$value['function']}({$distinct} {$get_key})"; |
|
159 | + } else { |
|
160 | + $get = "{$distinct} {$get_key}"; |
|
161 | + } |
|
162 | + |
|
163 | + $prepared[] = "{$get} as {$value['name']}"; |
|
164 | + } |
|
165 | + |
|
166 | + return $prepared; |
|
167 | + |
|
168 | + } |
|
169 | + |
|
170 | + /** |
|
171 | + * Prepares the joins to use. |
|
172 | + * |
|
173 | + * |
|
174 | + * @param array $data |
|
175 | + * @param bool $with_parent |
|
176 | + * @return array |
|
177 | + */ |
|
178 | + public static function prepare_invoice_joins( $data, $with_parent ) { |
|
179 | + global $wpdb; |
|
180 | + |
|
181 | + $prepared = array(); |
|
182 | + |
|
183 | + foreach ( $data as $raw_key => $value ) { |
|
184 | + $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
185 | + $type = isset( $value['type'] ) ? $value['type'] : false; |
|
186 | + $key = sanitize_key( $raw_key ); |
|
187 | + |
|
188 | + switch ( $type ) { |
|
189 | + case 'meta': |
|
190 | + $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
191 | + break; |
|
192 | + case 'parent_meta': |
|
193 | + $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
194 | + break; |
|
195 | + case 'invoice_data': |
|
196 | + $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
|
197 | + break; |
|
198 | + case 'invoice_item': |
|
199 | + $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id"; |
|
200 | + break; |
|
201 | + } |
|
202 | + } |
|
203 | + |
|
204 | + if ( $with_parent ) { |
|
205 | + $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
|
206 | + } |
|
207 | + |
|
208 | + return $prepared; |
|
209 | + |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Retrieves the appropriate table key to use. |
|
214 | + * |
|
215 | + * |
|
216 | + * @param string $key |
|
217 | + * @param string $table |
|
218 | + * @return string|false |
|
219 | + */ |
|
220 | + public static function get_invoice_table_key( $key, $table ) { |
|
221 | + |
|
222 | + $keys = array( |
|
223 | + 'meta' => "meta_{$key}.meta_value", |
|
224 | + 'parent_meta' => "parent_meta_{$key}.meta_value", |
|
225 | + 'post_data' => "posts.{$key}", |
|
226 | + 'invoice_data' => "invoices.{$key}", |
|
227 | + 'invoice_item' => "invoice_items.{$key}", |
|
228 | + ); |
|
229 | + |
|
230 | + return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
231 | + |
|
232 | + } |
|
233 | + |
|
234 | + /** |
|
235 | + * Executes a query and caches the result for a minute. |
|
236 | + * |
|
237 | + * |
|
238 | + * @param string $query_type |
|
239 | + * @param string $query |
|
240 | + * @return mixed depending on query_type |
|
241 | + */ |
|
242 | + public static function execute( $query_type, $query ) { |
|
243 | + global $wpdb; |
|
244 | + |
|
245 | + $query_hash = md5( $query_type . $query ); |
|
246 | + $result = self::get_cached_query( $query_hash ); |
|
247 | + if ( $result === false ) { |
|
248 | + self::enable_big_selects(); |
|
249 | + |
|
250 | + $result = $wpdb->$query_type( $query ); |
|
251 | + self::set_cached_query( $query_hash, $result ); |
|
252 | + } |
|
253 | + |
|
254 | + return $result; |
|
255 | + |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Enables big mysql selects for reports, just once for this session. |
|
260 | + */ |
|
261 | + protected static function enable_big_selects() { |
|
262 | + static $big_selects = false; |
|
263 | + |
|
264 | + global $wpdb; |
|
265 | + |
|
266 | + if ( ! $big_selects ) { |
|
267 | + $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
268 | + $big_selects = true; |
|
269 | + } |
|
270 | + } |
|
271 | + |
|
272 | + /** |
|
273 | + * Get the cached query result or null if it's not in the cache. |
|
274 | + * |
|
275 | + * @param string $query_hash The query hash. |
|
276 | + * |
|
277 | + * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
|
278 | + */ |
|
279 | + protected static function get_cached_query( $query_hash ) { |
|
280 | + |
|
281 | + return wp_cache_get( |
|
282 | + $query_hash, |
|
283 | + strtolower( __CLASS__ ) |
|
284 | + ); |
|
285 | + |
|
286 | + } |
|
287 | + |
|
288 | + /** |
|
289 | + * Set the cached query result. |
|
290 | + * |
|
291 | + * @param string $query_hash The query hash. |
|
292 | + * @param mixed $data The data to cache. |
|
293 | + */ |
|
294 | + protected static function set_cached_query( $query_hash, $data ) { |
|
295 | + |
|
296 | + wp_cache_set( |
|
297 | + $query_hash, |
|
298 | + $data, |
|
299 | + strtolower( __CLASS__ ), |
|
300 | + 5 * MINUTE_IN_SECONDS |
|
301 | + ); |
|
302 | + |
|
303 | + } |
|
304 | 304 | |
305 | 305 | } |