@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | -function wpinv_get_subscriptions( $args = array() ) { |
|
3 | - if ( empty( $args['parent_invoice_id'] ) ) { |
|
2 | +function wpinv_get_subscriptions($args = array()) { |
|
3 | + if (empty($args['parent_invoice_id'])) { |
|
4 | 4 | return false; |
5 | 5 | } |
6 | 6 | |
@@ -14,18 +14,18 @@ discard block |
||
14 | 14 | ); |
15 | 15 | |
16 | 16 | $args['post_parent'] = $args['parent_invoice_id']; |
17 | - $args = wp_parse_args( $args, $defaults ); |
|
17 | + $args = wp_parse_args($args, $defaults); |
|
18 | 18 | |
19 | - if( $args['numberposts'] < 1 ) { |
|
19 | + if ($args['numberposts'] < 1) { |
|
20 | 20 | $args['numberposts'] = 999999999999; |
21 | 21 | } |
22 | 22 | |
23 | - $posts = get_posts( $args ); |
|
23 | + $posts = get_posts($args); |
|
24 | 24 | $subscriptions = array(); |
25 | - if ( !empty( $posts ) ) { |
|
26 | - foreach ( $posts as $post ) { |
|
27 | - if ( !empty( $post->ID ) ) { |
|
28 | - $subscriptions[] = wpinv_get_invoice( $post->ID ); |
|
25 | + if (!empty($posts)) { |
|
26 | + foreach ($posts as $post) { |
|
27 | + if (!empty($post->ID)) { |
|
28 | + $subscriptions[] = wpinv_get_invoice($post->ID); |
|
29 | 29 | } |
30 | 30 | } |
31 | 31 | } |
@@ -33,19 +33,19 @@ discard block |
||
33 | 33 | |
34 | 34 | return $subscriptions; |
35 | 35 | } |
36 | -function wpinv_get_subscription( $id = 0, $by_profile_id = false ) { |
|
36 | +function wpinv_get_subscription($id = 0, $by_profile_id = false) { |
|
37 | 37 | global $wpdb; |
38 | 38 | |
39 | - if ( empty( $id ) ) { |
|
39 | + if (empty($id)) { |
|
40 | 40 | return false; |
41 | 41 | } |
42 | 42 | |
43 | - $id = esc_sql( $id ); |
|
43 | + $id = esc_sql($id); |
|
44 | 44 | |
45 | - $invoice_id = $wpdb->get_var( "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wpinv_profile_id' AND meta_value = '{$id}' LIMIT 1" ); |
|
45 | + $invoice_id = $wpdb->get_var("SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wpinv_profile_id' AND meta_value = '{$id}' LIMIT 1"); |
|
46 | 46 | |
47 | - if ( $invoice_id != null ) { |
|
48 | - return wpinv_get_invoice( $invoice_id ); |
|
47 | + if ($invoice_id != null) { |
|
48 | + return wpinv_get_invoice($invoice_id); |
|
49 | 49 | } |
50 | 50 | |
51 | 51 | return false; |
@@ -55,49 +55,49 @@ discard block |
||
55 | 55 | * Records a new payment on the subscription |
56 | 56 | * |
57 | 57 | */ |
58 | -function wpinv_recurring_add_subscription_payment( $parent_invoice_id, $subscription_args = array() ) { |
|
59 | - $args = wp_parse_args( $subscription_args, array( |
|
58 | +function wpinv_recurring_add_subscription_payment($parent_invoice_id, $subscription_args = array()) { |
|
59 | + $args = wp_parse_args($subscription_args, array( |
|
60 | 60 | 'amount' => '', |
61 | 61 | 'transaction_id' => '', |
62 | 62 | 'gateway' => '' |
63 | - ) ); |
|
63 | + )); |
|
64 | 64 | |
65 | - if ( wpinv_payment_exists( $args['transaction_id'] ) ) { |
|
65 | + if (wpinv_payment_exists($args['transaction_id'])) { |
|
66 | 66 | return false; |
67 | 67 | } |
68 | 68 | |
69 | - $parent_invoice = wpinv_get_invoice( $parent_invoice_id ); |
|
70 | - if ( empty( $parent_invoice ) ) { |
|
69 | + $parent_invoice = wpinv_get_invoice($parent_invoice_id); |
|
70 | + if (empty($parent_invoice)) { |
|
71 | 71 | return; |
72 | 72 | } |
73 | 73 | |
74 | 74 | $invoice = new WPInv_Invoice(); |
75 | - $invoice->set( 'parent_invoice', $parent_invoice_id ); |
|
76 | - $invoice->set( 'currency', $parent_invoice->get_currency() ); |
|
75 | + $invoice->set('parent_invoice', $parent_invoice_id); |
|
76 | + $invoice->set('currency', $parent_invoice->get_currency()); |
|
77 | 77 | //$invoice->set( 'status', 'publish' ); |
78 | - $invoice->set( 'transaction_id', $args['transaction_id'] ); |
|
79 | - $invoice->set( 'key', $parent_invoice->get_key() ); |
|
78 | + $invoice->set('transaction_id', $args['transaction_id']); |
|
79 | + $invoice->set('key', $parent_invoice->get_key()); |
|
80 | 80 | |
81 | - $invoice->set( 'ip', $parent_invoice->ip ); |
|
82 | - $invoice->set( 'user_id', $parent_invoice->get_user_id() ); |
|
83 | - $invoice->set( 'first_name', $parent_invoice->get_first_name() ); |
|
84 | - $invoice->set( 'last_name', $parent_invoice->get_last_name() ); |
|
81 | + $invoice->set('ip', $parent_invoice->ip); |
|
82 | + $invoice->set('user_id', $parent_invoice->get_user_id()); |
|
83 | + $invoice->set('first_name', $parent_invoice->get_first_name()); |
|
84 | + $invoice->set('last_name', $parent_invoice->get_last_name()); |
|
85 | 85 | ///$invoice->set( 'email', $parent_invoice->get_email() ); |
86 | - $invoice->set( 'phone', $parent_invoice->phone ); |
|
87 | - $invoice->set( 'address', $parent_invoice->address ); |
|
88 | - $invoice->set( 'city', $parent_invoice->city ); |
|
89 | - $invoice->set( 'country', $parent_invoice->country ); |
|
90 | - $invoice->set( 'state', $parent_invoice->state ); |
|
91 | - $invoice->set( 'zip', $parent_invoice->zip ); |
|
92 | - $invoice->set( 'company', $parent_invoice->company ); |
|
93 | - $invoice->set( 'vat_number', $parent_invoice->vat_number ); |
|
94 | - $invoice->set( 'vat_rate', $parent_invoice->vat_rate ); |
|
95 | - $invoice->set( 'adddress_confirmed', $parent_invoice->adddress_confirmed ); |
|
96 | - |
|
97 | - if ( empty( $args['gateway'] ) ) { |
|
98 | - $invoice->set( 'gateway', $parent_invoice->get_gateway() ); |
|
86 | + $invoice->set('phone', $parent_invoice->phone); |
|
87 | + $invoice->set('address', $parent_invoice->address); |
|
88 | + $invoice->set('city', $parent_invoice->city); |
|
89 | + $invoice->set('country', $parent_invoice->country); |
|
90 | + $invoice->set('state', $parent_invoice->state); |
|
91 | + $invoice->set('zip', $parent_invoice->zip); |
|
92 | + $invoice->set('company', $parent_invoice->company); |
|
93 | + $invoice->set('vat_number', $parent_invoice->vat_number); |
|
94 | + $invoice->set('vat_rate', $parent_invoice->vat_rate); |
|
95 | + $invoice->set('adddress_confirmed', $parent_invoice->adddress_confirmed); |
|
96 | + |
|
97 | + if (empty($args['gateway'])) { |
|
98 | + $invoice->set('gateway', $parent_invoice->get_gateway()); |
|
99 | 99 | } else { |
100 | - $invoice->set( 'gateway', $args['gateway'] ); |
|
100 | + $invoice->set('gateway', $args['gateway']); |
|
101 | 101 | } |
102 | 102 | |
103 | 103 | $recurring_details = $parent_invoice->get_recurring_details(); |
@@ -105,11 +105,11 @@ discard block |
||
105 | 105 | // increase the earnings for each item in the subscription |
106 | 106 | $items = $recurring_details['cart_details']; |
107 | 107 | |
108 | - if ( $items ) { |
|
108 | + if ($items) { |
|
109 | 109 | $add_items = array(); |
110 | 110 | $cart_details = array(); |
111 | 111 | |
112 | - foreach ( $items as $item ) { |
|
112 | + foreach ($items as $item) { |
|
113 | 113 | $add_item = array(); |
114 | 114 | $add_item['id'] = $item['id']; |
115 | 115 | $add_item['quantity'] = $item['quantity']; |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | break; |
120 | 120 | } |
121 | 121 | |
122 | - $invoice->set( 'items', $add_items ); |
|
122 | + $invoice->set('items', $add_items); |
|
123 | 123 | $invoice->cart_details = $cart_details; |
124 | 124 | } |
125 | 125 | |
@@ -129,277 +129,277 @@ discard block |
||
129 | 129 | $tax = $recurring_details['tax']; |
130 | 130 | $discount = $recurring_details['discount']; |
131 | 131 | |
132 | - if ( $discount > 0 ) { |
|
133 | - $invoice->set( 'discount_code', $parent_invoice->discount_code ); |
|
132 | + if ($discount > 0) { |
|
133 | + $invoice->set('discount_code', $parent_invoice->discount_code); |
|
134 | 134 | } |
135 | 135 | |
136 | - $invoice->subtotal = wpinv_format_amount( $subtotal, NULL, true ); |
|
137 | - $invoice->tax = wpinv_format_amount( $tax, NULL, true ); |
|
138 | - $invoice->discount = wpinv_format_amount( $discount, NULL, true ); |
|
139 | - $invoice->total = wpinv_format_amount( $total, NULL, true ); |
|
136 | + $invoice->subtotal = wpinv_format_amount($subtotal, NULL, true); |
|
137 | + $invoice->tax = wpinv_format_amount($tax, NULL, true); |
|
138 | + $invoice->discount = wpinv_format_amount($discount, NULL, true); |
|
139 | + $invoice->total = wpinv_format_amount($total, NULL, true); |
|
140 | 140 | $invoice->save(); |
141 | 141 | |
142 | - wpinv_update_payment_status( $invoice->ID, 'publish' ); |
|
142 | + wpinv_update_payment_status($invoice->ID, 'publish'); |
|
143 | 143 | sleep(1); |
144 | - wpinv_update_payment_status( $invoice->ID, 'renewal' ); |
|
144 | + wpinv_update_payment_status($invoice->ID, 'renewal'); |
|
145 | 145 | |
146 | - $invoice = wpinv_get_invoice( $invoice->ID ); |
|
146 | + $invoice = wpinv_get_invoice($invoice->ID); |
|
147 | 147 | |
148 | - $subscription_data = wpinv_payment_subscription_data( $parent_invoice ); |
|
148 | + $subscription_data = wpinv_payment_subscription_data($parent_invoice); |
|
149 | 149 | $subscription_data['recurring_amount'] = $invoice->get_total(); |
150 | - $subscription_data['created'] = current_time( 'mysql', 0 ); |
|
151 | - $subscription_data['expiration'] = $invoice->get_new_expiration( $subscription_data['item_id'] ); |
|
150 | + $subscription_data['created'] = current_time('mysql', 0); |
|
151 | + $subscription_data['expiration'] = $invoice->get_new_expiration($subscription_data['item_id']); |
|
152 | 152 | |
153 | 153 | // Retrieve pending subscription from database and update it's status to active and set proper profile ID |
154 | - $invoice->update_subscription( $subscription_data ); |
|
154 | + $invoice->update_subscription($subscription_data); |
|
155 | 155 | |
156 | - do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $parent_invoice, $subscription_args ); |
|
157 | - do_action( 'wpinv_recurring_record_payment', $invoice->ID, $parent_invoice_id, $subscription_args ); |
|
156 | + do_action('wpinv_recurring_add_subscription_payment', $invoice, $parent_invoice, $subscription_args); |
|
157 | + do_action('wpinv_recurring_record_payment', $invoice->ID, $parent_invoice_id, $subscription_args); |
|
158 | 158 | |
159 | 159 | return $invoice; |
160 | 160 | } |
161 | 161 | |
162 | -function wpinv_payment_exists( $txn_id = '' ) { |
|
162 | +function wpinv_payment_exists($txn_id = '') { |
|
163 | 163 | global $wpdb; |
164 | 164 | |
165 | - if ( empty( $txn_id ) ) { |
|
165 | + if (empty($txn_id)) { |
|
166 | 166 | return false; |
167 | 167 | } |
168 | 168 | |
169 | - $txn_id = esc_sql( $txn_id ); |
|
169 | + $txn_id = esc_sql($txn_id); |
|
170 | 170 | |
171 | - $invoice = $wpdb->get_var( "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wpinv_transaction_id' AND meta_value = '{$txn_id}' LIMIT 1" ); |
|
171 | + $invoice = $wpdb->get_var("SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wpinv_transaction_id' AND meta_value = '{$txn_id}' LIMIT 1"); |
|
172 | 172 | |
173 | - if ( $invoice != null ) { |
|
173 | + if ($invoice != null) { |
|
174 | 174 | return true; |
175 | 175 | } |
176 | 176 | |
177 | 177 | return false; |
178 | 178 | } |
179 | 179 | |
180 | -function wpinv_is_subscription_payment( $invoice = '' ) { |
|
181 | - if ( empty( $invoice ) ) { |
|
180 | +function wpinv_is_subscription_payment($invoice = '') { |
|
181 | + if (empty($invoice)) { |
|
182 | 182 | return false; |
183 | 183 | } |
184 | 184 | |
185 | - if ( !is_object( $invoice ) && is_scalar( $invoice ) ) { |
|
186 | - $invoice = wpinv_get_invoice( $invoice ); |
|
185 | + if (!is_object($invoice) && is_scalar($invoice)) { |
|
186 | + $invoice = wpinv_get_invoice($invoice); |
|
187 | 187 | } |
188 | 188 | |
189 | - if ( empty( $invoice ) ) { |
|
189 | + if (empty($invoice)) { |
|
190 | 190 | return false; |
191 | 191 | } |
192 | 192 | |
193 | - if ( $invoice->is_renewal() ) { |
|
193 | + if ($invoice->is_renewal()) { |
|
194 | 194 | return true; |
195 | 195 | } |
196 | 196 | |
197 | 197 | return false; |
198 | 198 | } |
199 | 199 | |
200 | -function wpinv_payment_subscription_data( $invoice = '' ) { |
|
201 | - if ( empty( $invoice ) ) { |
|
200 | +function wpinv_payment_subscription_data($invoice = '') { |
|
201 | + if (empty($invoice)) { |
|
202 | 202 | return false; |
203 | 203 | } |
204 | 204 | |
205 | - if ( !is_object( $invoice ) && is_scalar( $invoice ) ) { |
|
206 | - $invoice = wpinv_get_invoice( $invoice ); |
|
205 | + if (!is_object($invoice) && is_scalar($invoice)) { |
|
206 | + $invoice = wpinv_get_invoice($invoice); |
|
207 | 207 | } |
208 | 208 | |
209 | - if ( empty( $invoice ) ) { |
|
209 | + if (empty($invoice)) { |
|
210 | 210 | return false; |
211 | 211 | } |
212 | 212 | |
213 | 213 | return $invoice->get_subscription_data(); |
214 | 214 | } |
215 | 215 | |
216 | -function wpinv_payment_link_transaction_id( $invoice = '' ) { |
|
217 | - if ( empty( $invoice ) ) { |
|
216 | +function wpinv_payment_link_transaction_id($invoice = '') { |
|
217 | + if (empty($invoice)) { |
|
218 | 218 | return false; |
219 | 219 | } |
220 | 220 | |
221 | - if ( !is_object( $invoice ) && is_scalar( $invoice ) ) { |
|
222 | - $invoice = wpinv_get_invoice( $invoice ); |
|
221 | + if (!is_object($invoice) && is_scalar($invoice)) { |
|
222 | + $invoice = wpinv_get_invoice($invoice); |
|
223 | 223 | } |
224 | 224 | |
225 | - if ( empty( $invoice ) ) { |
|
225 | + if (empty($invoice)) { |
|
226 | 226 | return false; |
227 | 227 | } |
228 | 228 | |
229 | - return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice ); |
|
229 | + return apply_filters('wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice); |
|
230 | 230 | } |
231 | 231 | |
232 | -function wpinv_get_pretty_subscription_period( $period ) { |
|
232 | +function wpinv_get_pretty_subscription_period($period) { |
|
233 | 233 | $frequency = ''; |
234 | 234 | //Format period details |
235 | - switch ( $period ) { |
|
235 | + switch ($period) { |
|
236 | 236 | case 'D' : |
237 | 237 | case 'day' : |
238 | - $frequency = __( 'Daily', 'invoicing' ); |
|
238 | + $frequency = __('Daily', 'invoicing'); |
|
239 | 239 | break; |
240 | 240 | case 'W' : |
241 | 241 | case 'week' : |
242 | - $frequency = __( 'Weekly', 'invoicing' ); |
|
242 | + $frequency = __('Weekly', 'invoicing'); |
|
243 | 243 | break; |
244 | 244 | case 'M' : |
245 | 245 | case 'month' : |
246 | - $frequency = __( 'Monthly', 'invoicing' ); |
|
246 | + $frequency = __('Monthly', 'invoicing'); |
|
247 | 247 | break; |
248 | 248 | case 'Y' : |
249 | 249 | case 'year' : |
250 | - $frequency = __( 'Yearly', 'invoicing' ); |
|
250 | + $frequency = __('Yearly', 'invoicing'); |
|
251 | 251 | break; |
252 | 252 | default : |
253 | - $frequency = apply_filters( 'wpinv_pretty_subscription_period', $frequency, $period ); |
|
253 | + $frequency = apply_filters('wpinv_pretty_subscription_period', $frequency, $period); |
|
254 | 254 | break; |
255 | 255 | } |
256 | 256 | |
257 | 257 | return $frequency; |
258 | 258 | } |
259 | 259 | |
260 | -function wpinv_get_pretty_subscription_period_name( $period ) { |
|
260 | +function wpinv_get_pretty_subscription_period_name($period) { |
|
261 | 261 | $frequency = ''; |
262 | 262 | //Format period details |
263 | - switch ( $period ) { |
|
263 | + switch ($period) { |
|
264 | 264 | case 'D' : |
265 | 265 | case 'day' : |
266 | - $frequency = __( 'Day', 'invoicing' ); |
|
266 | + $frequency = __('Day', 'invoicing'); |
|
267 | 267 | break; |
268 | 268 | case 'W' : |
269 | 269 | case 'week' : |
270 | - $frequency = __( 'Week', 'invoicing' ); |
|
270 | + $frequency = __('Week', 'invoicing'); |
|
271 | 271 | break; |
272 | 272 | case 'M' : |
273 | 273 | case 'month' : |
274 | - $frequency = __( 'Month', 'invoicing' ); |
|
274 | + $frequency = __('Month', 'invoicing'); |
|
275 | 275 | break; |
276 | 276 | case 'Y' : |
277 | 277 | case 'year' : |
278 | - $frequency = __( 'Year', 'invoicing' ); |
|
278 | + $frequency = __('Year', 'invoicing'); |
|
279 | 279 | break; |
280 | 280 | default : |
281 | - $frequency = apply_filters( 'wpinv_pretty_subscription_period_name', $frequency, $period ); |
|
281 | + $frequency = apply_filters('wpinv_pretty_subscription_period_name', $frequency, $period); |
|
282 | 282 | break; |
283 | 283 | } |
284 | 284 | |
285 | 285 | return $frequency; |
286 | 286 | } |
287 | 287 | |
288 | -function wpinv_subscription_initial_payment_desc( $amount, $period, $interval, $trial_period = '', $trial_interval = 0 ) { |
|
288 | +function wpinv_subscription_initial_payment_desc($amount, $period, $interval, $trial_period = '', $trial_interval = 0) { |
|
289 | 289 | $interval = (int)$interval > 0 ? (int)$interval : 1; |
290 | 290 | |
291 | - if ( $trial_interval > 0 && !empty( $trial_period ) ) { |
|
292 | - $amount = __( 'Free', 'invoicing' ); |
|
291 | + if ($trial_interval > 0 && !empty($trial_period)) { |
|
292 | + $amount = __('Free', 'invoicing'); |
|
293 | 293 | $interval = $trial_interval; |
294 | 294 | $period = $trial_period; |
295 | 295 | } |
296 | 296 | |
297 | 297 | $description = ''; |
298 | - switch ( $period ) { |
|
298 | + switch ($period) { |
|
299 | 299 | case 'D' : |
300 | 300 | case 'day' : |
301 | - $description = wp_sprintf( _n( '%s for the first day.', '%s for the first %d days.', $interval, 'invoicing' ), $amount, $interval ); |
|
301 | + $description = wp_sprintf(_n('%s for the first day.', '%s for the first %d days.', $interval, 'invoicing'), $amount, $interval); |
|
302 | 302 | break; |
303 | 303 | case 'W' : |
304 | 304 | case 'week' : |
305 | - $description = wp_sprintf( _n( '%s for the first week.', '%s for the first %d weeks.', $interval, 'invoicing' ), $amount, $interval ); |
|
305 | + $description = wp_sprintf(_n('%s for the first week.', '%s for the first %d weeks.', $interval, 'invoicing'), $amount, $interval); |
|
306 | 306 | break; |
307 | 307 | case 'M' : |
308 | 308 | case 'month' : |
309 | - $description = wp_sprintf( _n( '%s for the first month.', '%s for the first %d months.', $interval, 'invoicing' ), $amount, $interval ); |
|
309 | + $description = wp_sprintf(_n('%s for the first month.', '%s for the first %d months.', $interval, 'invoicing'), $amount, $interval); |
|
310 | 310 | break; |
311 | 311 | case 'Y' : |
312 | 312 | case 'year' : |
313 | - $description = wp_sprintf( _n( '%s for the first year.', '%s for the first %d years.', $interval, 'invoicing' ), $amount, $interval ); |
|
313 | + $description = wp_sprintf(_n('%s for the first year.', '%s for the first %d years.', $interval, 'invoicing'), $amount, $interval); |
|
314 | 314 | break; |
315 | 315 | } |
316 | 316 | |
317 | - return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval ); |
|
317 | + return apply_filters('wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval); |
|
318 | 318 | } |
319 | 319 | |
320 | -function wpinv_subscription_recurring_payment_desc( $amount, $period, $interval, $bill_times = 0, $trial_period = '', $trial_interval = 0 ) { |
|
320 | +function wpinv_subscription_recurring_payment_desc($amount, $period, $interval, $bill_times = 0, $trial_period = '', $trial_interval = 0) { |
|
321 | 321 | $interval = (int)$interval > 0 ? (int)$interval : 1; |
322 | 322 | $bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0; |
323 | 323 | |
324 | 324 | $description = ''; |
325 | - switch ( $period ) { |
|
325 | + switch ($period) { |
|
326 | 326 | case 'D' : |
327 | 327 | case 'day' : |
328 | - if ( (int)$bill_times > 0 ) { |
|
329 | - if ( $interval > 1 ) { |
|
330 | - if ( $bill_times > 1 ) { |
|
331 | - $description = wp_sprintf( __( '%s for each %d days, for %d installments.', 'invoicing' ), $amount, $interval, $bill_times ); |
|
328 | + if ((int)$bill_times > 0) { |
|
329 | + if ($interval > 1) { |
|
330 | + if ($bill_times > 1) { |
|
331 | + $description = wp_sprintf(__('%s for each %d days, for %d installments.', 'invoicing'), $amount, $interval, $bill_times); |
|
332 | 332 | } else { |
333 | - $description = wp_sprintf( __( '%s for %d days.', 'invoicing' ), $amount, $interval ); |
|
333 | + $description = wp_sprintf(__('%s for %d days.', 'invoicing'), $amount, $interval); |
|
334 | 334 | } |
335 | 335 | } else { |
336 | - $description = wp_sprintf( _n( '%s for one day.', '%s for each day, for %d installments.', $bill_times, 'invoicing' ), $amount, $bill_times ); |
|
336 | + $description = wp_sprintf(_n('%s for one day.', '%s for each day, for %d installments.', $bill_times, 'invoicing'), $amount, $bill_times); |
|
337 | 337 | } |
338 | 338 | } else { |
339 | - $description = wp_sprintf( _n( '%s for each day.', '%s for each %d days.', $interval, 'invoicing'), $amount, $interval ); |
|
339 | + $description = wp_sprintf(_n('%s for each day.', '%s for each %d days.', $interval, 'invoicing'), $amount, $interval); |
|
340 | 340 | } |
341 | 341 | break; |
342 | 342 | case 'W' : |
343 | 343 | case 'week' : |
344 | - if ( (int)$bill_times > 0 ) { |
|
345 | - if ( $interval > 1 ) { |
|
346 | - if ( $bill_times > 1 ) { |
|
347 | - $description = wp_sprintf( __( '%s for each %d weeks, for %d installments.', 'invoicing' ), $amount, $interval, $bill_times ); |
|
344 | + if ((int)$bill_times > 0) { |
|
345 | + if ($interval > 1) { |
|
346 | + if ($bill_times > 1) { |
|
347 | + $description = wp_sprintf(__('%s for each %d weeks, for %d installments.', 'invoicing'), $amount, $interval, $bill_times); |
|
348 | 348 | } else { |
349 | - $description = wp_sprintf( __( '%s for %d weeks.', 'invoicing' ), $amount, $interval ); |
|
349 | + $description = wp_sprintf(__('%s for %d weeks.', 'invoicing'), $amount, $interval); |
|
350 | 350 | } |
351 | 351 | } else { |
352 | - $description = wp_sprintf( _n( '%s for one week.', '%s for each week, for %d installments.', $bill_times, 'invoicing' ), $amount, $bill_times ); |
|
352 | + $description = wp_sprintf(_n('%s for one week.', '%s for each week, for %d installments.', $bill_times, 'invoicing'), $amount, $bill_times); |
|
353 | 353 | } |
354 | 354 | } else { |
355 | - $description = wp_sprintf( _n( '%s for each week.', '%s for each %d weeks.', $interval, 'invoicing' ), $amount, $interval ); |
|
355 | + $description = wp_sprintf(_n('%s for each week.', '%s for each %d weeks.', $interval, 'invoicing'), $amount, $interval); |
|
356 | 356 | } |
357 | 357 | break; |
358 | 358 | case 'M' : |
359 | 359 | case 'month' : |
360 | - if ( (int)$bill_times > 0 ) { |
|
361 | - if ( $interval > 1 ) { |
|
362 | - if ( $bill_times > 1 ) { |
|
363 | - $description = wp_sprintf( __( '%s for each %d months, for %d installments.', 'invoicing' ), $amount, $interval, $bill_times ); |
|
360 | + if ((int)$bill_times > 0) { |
|
361 | + if ($interval > 1) { |
|
362 | + if ($bill_times > 1) { |
|
363 | + $description = wp_sprintf(__('%s for each %d months, for %d installments.', 'invoicing'), $amount, $interval, $bill_times); |
|
364 | 364 | } else { |
365 | - $description = wp_sprintf( __( '%s for %d months.', 'invoicing' ), $amount, $interval ); |
|
365 | + $description = wp_sprintf(__('%s for %d months.', 'invoicing'), $amount, $interval); |
|
366 | 366 | } |
367 | 367 | } else { |
368 | - $description = wp_sprintf( _n( '%s for one month.', '%s for each month, for %d installments.', $bill_times, 'invoicing' ), $amount, $bill_times ); |
|
368 | + $description = wp_sprintf(_n('%s for one month.', '%s for each month, for %d installments.', $bill_times, 'invoicing'), $amount, $bill_times); |
|
369 | 369 | } |
370 | 370 | } else { |
371 | - $description = wp_sprintf( _n( '%s for each month.', '%s for each %d months.', $interval, 'invoicing' ), $amount, $interval ); |
|
371 | + $description = wp_sprintf(_n('%s for each month.', '%s for each %d months.', $interval, 'invoicing'), $amount, $interval); |
|
372 | 372 | } |
373 | 373 | break; |
374 | 374 | case 'Y' : |
375 | 375 | case 'year' : |
376 | - if ( (int)$bill_times > 0 ) { |
|
377 | - if ( $interval > 1 ) { |
|
378 | - if ( $bill_times > 1 ) { |
|
379 | - $description = wp_sprintf( __( '%s for each %d years, for %d installments.', 'invoicing' ), $amount, $interval, $bill_times ); |
|
376 | + if ((int)$bill_times > 0) { |
|
377 | + if ($interval > 1) { |
|
378 | + if ($bill_times > 1) { |
|
379 | + $description = wp_sprintf(__('%s for each %d years, for %d installments.', 'invoicing'), $amount, $interval, $bill_times); |
|
380 | 380 | } else { |
381 | - $description = wp_sprintf( __( '%s for %d years.', 'invoicing'), $amount, $interval ); |
|
381 | + $description = wp_sprintf(__('%s for %d years.', 'invoicing'), $amount, $interval); |
|
382 | 382 | } |
383 | 383 | } else { |
384 | - $description = wp_sprintf( _n( '%s for one year.', '%s for each year, for %d installments.', $bill_times, 'invoicing' ), $amount, $bill_times ); |
|
384 | + $description = wp_sprintf(_n('%s for one year.', '%s for each year, for %d installments.', $bill_times, 'invoicing'), $amount, $bill_times); |
|
385 | 385 | } |
386 | 386 | } else { |
387 | - $description = wp_sprintf( _n( '%s for each year.', '%s for each %d years.', $interval, 'invoicing' ), $amount, $interval ); |
|
387 | + $description = wp_sprintf(_n('%s for each year.', '%s for each %d years.', $interval, 'invoicing'), $amount, $interval); |
|
388 | 388 | } |
389 | 389 | break; |
390 | 390 | } |
391 | 391 | |
392 | - return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval ); |
|
392 | + return apply_filters('wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval); |
|
393 | 393 | } |
394 | 394 | |
395 | -function wpinv_subscription_payment_desc( $invoice ) { |
|
396 | - if ( empty( $invoice ) ) { |
|
395 | +function wpinv_subscription_payment_desc($invoice) { |
|
396 | + if (empty($invoice)) { |
|
397 | 397 | return NULL; |
398 | 398 | } |
399 | 399 | |
400 | 400 | $description = ''; |
401 | - if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) { |
|
402 | - if ( $item->has_free_trial() ) { |
|
401 | + if ($invoice->is_parent() && $item = $invoice->get_recurring(true)) { |
|
402 | + if ($item->has_free_trial()) { |
|
403 | 403 | $trial_period = $item->get_trial_period(); |
404 | 404 | $trial_interval = $item->get_trial_interval(); |
405 | 405 | } else { |
@@ -407,45 +407,45 @@ discard block |
||
407 | 407 | $trial_interval = 0; |
408 | 408 | } |
409 | 409 | |
410 | - $description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() ); |
|
410 | + $description = wpinv_get_billing_cycle($invoice->get_total(), $invoice->get_recurring_details('total'), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency()); |
|
411 | 411 | } |
412 | 412 | |
413 | - return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice ); |
|
413 | + return apply_filters('wpinv_subscription_payment_desc', $description, $invoice); |
|
414 | 414 | } |
415 | 415 | |
416 | -function wpinv_get_billing_cycle( $initial, $recurring, $period, $interval, $bill_times, $trial_period = '', $trial_interval = 0, $currency = '' ) { |
|
417 | - $initial_total = wpinv_format_amount( $initial ); |
|
418 | - $recurring_total = wpinv_format_amount( $recurring ); |
|
416 | +function wpinv_get_billing_cycle($initial, $recurring, $period, $interval, $bill_times, $trial_period = '', $trial_interval = 0, $currency = '') { |
|
417 | + $initial_total = wpinv_format_amount($initial); |
|
418 | + $recurring_total = wpinv_format_amount($recurring); |
|
419 | 419 | |
420 | - if ( $trial_interval > 0 && !empty( $trial_period ) ) { |
|
420 | + if ($trial_interval > 0 && !empty($trial_period)) { |
|
421 | 421 | // Free trial |
422 | 422 | } else { |
423 | - if ( $bill_times == 1 ) { |
|
423 | + if ($bill_times == 1) { |
|
424 | 424 | $recurring_total = $initial_total; |
425 | - } else if ( $bill_times > 1 && $initial_total != $recurring_total ) { |
|
425 | + } else if ($bill_times > 1 && $initial_total != $recurring_total) { |
|
426 | 426 | $bill_times--; |
427 | 427 | } |
428 | 428 | } |
429 | 429 | |
430 | - $initial_amount = wpinv_price( $initial_total, $currency ); |
|
431 | - $recurring_amount = wpinv_price( $recurring_total, $currency ); |
|
430 | + $initial_amount = wpinv_price($initial_total, $currency); |
|
431 | + $recurring_amount = wpinv_price($recurring_total, $currency); |
|
432 | 432 | |
433 | - $recurring = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval ); |
|
433 | + $recurring = wpinv_subscription_recurring_payment_desc($recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval); |
|
434 | 434 | |
435 | - if ( $initial_total != $recurring_total ) { |
|
436 | - $initial = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval ); |
|
435 | + if ($initial_total != $recurring_total) { |
|
436 | + $initial = wpinv_subscription_initial_payment_desc($initial_amount, $period, $interval, $trial_period, $trial_interval); |
|
437 | 437 | |
438 | - $description = wp_sprintf( __( '%s Then %s', 'invoicing' ), $initial, $recurring ); |
|
438 | + $description = wp_sprintf(__('%s Then %s', 'invoicing'), $initial, $recurring); |
|
439 | 439 | } else { |
440 | 440 | $description = $recurring; |
441 | 441 | } |
442 | 442 | |
443 | - return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency ); |
|
443 | + return apply_filters('wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency); |
|
444 | 444 | } |
445 | 445 | |
446 | -function wpinv_recurring_send_payment_failed( $invoice ) { |
|
447 | - if ( !empty( $invoice->ID ) ) { |
|
448 | - wpinv_failed_invoice_notification( $invoice->ID ); |
|
446 | +function wpinv_recurring_send_payment_failed($invoice) { |
|
447 | + if (!empty($invoice->ID)) { |
|
448 | + wpinv_failed_invoice_notification($invoice->ID); |
|
449 | 449 | } |
450 | 450 | } |
451 | -add_action( 'wpinv_recurring_payment_failed', 'wpinv_recurring_send_payment_failed', 10, 1 ); |
|
452 | 451 | \ No newline at end of file |
452 | +add_action('wpinv_recurring_payment_failed', 'wpinv_recurring_send_payment_failed', 10, 1); |
|
453 | 453 | \ No newline at end of file |
@@ -140,8 +140,8 @@ discard block |
||
140 | 140 | |
141 | 141 | function wpinv_get_default_labels() { |
142 | 142 | $defaults = array( |
143 | - 'singular' => __( 'Invoice', 'invoicing' ), |
|
144 | - 'plural' => __( 'Invoices', 'invoicing' ) |
|
143 | + 'singular' => __( 'Invoice', 'invoicing' ), |
|
144 | + 'plural' => __( 'Invoices', 'invoicing' ) |
|
145 | 145 | ); |
146 | 146 | |
147 | 147 | return apply_filters( 'wpinv_default_invoices_name', $defaults ); |
@@ -160,20 +160,20 @@ discard block |
||
160 | 160 | } |
161 | 161 | |
162 | 162 | function wpinv_change_default_title( $title ) { |
163 | - if ( !is_admin() ) { |
|
163 | + if ( !is_admin() ) { |
|
164 | 164 | $label = wpinv_get_label_singular(); |
165 | 165 | $title = sprintf( __( 'Enter %s name here', 'invoicing' ), $label ); |
166 | 166 | return $title; |
167 | - } |
|
167 | + } |
|
168 | 168 | |
169 | - $screen = get_current_screen(); |
|
169 | + $screen = get_current_screen(); |
|
170 | 170 | |
171 | - if ( 'wpi_invoice' == $screen->post_type ) { |
|
171 | + if ( 'wpi_invoice' == $screen->post_type ) { |
|
172 | 172 | $label = wpinv_get_label_singular(); |
173 | 173 | $title = sprintf( __( 'Enter %s name here', 'invoicing' ), $label ); |
174 | - } |
|
174 | + } |
|
175 | 175 | |
176 | - return $title; |
|
176 | + return $title; |
|
177 | 177 | } |
178 | 178 | add_filter( 'enter_title_here', 'wpinv_change_default_title' ); |
179 | 179 |
@@ -7,36 +7,36 @@ discard block |
||
7 | 7 | */ |
8 | 8 | |
9 | 9 | // MUST have WordPress. |
10 | -if ( !defined( 'WPINC' ) ) { |
|
11 | - exit( 'Do NOT access this file directly: ' . basename( __FILE__ ) ); |
|
10 | +if (!defined('WPINC')) { |
|
11 | + exit('Do NOT access this file directly: ' . basename(__FILE__)); |
|
12 | 12 | } |
13 | 13 | |
14 | -add_action( 'init', 'wpinv_register_post_types', 1 ); |
|
14 | +add_action('init', 'wpinv_register_post_types', 1); |
|
15 | 15 | function wpinv_register_post_types() { |
16 | 16 | $labels = array( |
17 | - 'name' => _x( 'Invoices', 'post type general name', 'invoicing' ), |
|
18 | - 'singular_name' => _x( 'Invoice', 'post type singular name', 'invoicing' ), |
|
19 | - 'menu_name' => _x( 'Invoices', 'admin menu', 'invoicing' ), |
|
20 | - 'name_admin_bar' => _x( 'Invoice', 'add new on admin bar', 'invoicing' ), |
|
21 | - 'add_new' => _x( 'Add New', 'book', 'invoicing' ), |
|
22 | - 'add_new_item' => __( 'Add New Invoice', 'invoicing' ), |
|
23 | - 'new_item' => __( 'New Invoice', 'invoicing' ), |
|
24 | - 'edit_item' => __( 'Edit Invoice', 'invoicing' ), |
|
25 | - 'view_item' => __( 'View Invoice', 'invoicing' ), |
|
26 | - 'all_items' => __( 'Invoices', 'invoicing' ), |
|
27 | - 'search_items' => __( 'Search Invoices', 'invoicing' ), |
|
28 | - 'parent_item_colon' => __( 'Parent Invoices:', 'invoicing' ), |
|
29 | - 'not_found' => __( 'No invoices found.', 'invoicing' ), |
|
30 | - 'not_found_in_trash' => __( 'No invoices found in trash.', 'invoicing' ) |
|
17 | + 'name' => _x('Invoices', 'post type general name', 'invoicing'), |
|
18 | + 'singular_name' => _x('Invoice', 'post type singular name', 'invoicing'), |
|
19 | + 'menu_name' => _x('Invoices', 'admin menu', 'invoicing'), |
|
20 | + 'name_admin_bar' => _x('Invoice', 'add new on admin bar', 'invoicing'), |
|
21 | + 'add_new' => _x('Add New', 'book', 'invoicing'), |
|
22 | + 'add_new_item' => __('Add New Invoice', 'invoicing'), |
|
23 | + 'new_item' => __('New Invoice', 'invoicing'), |
|
24 | + 'edit_item' => __('Edit Invoice', 'invoicing'), |
|
25 | + 'view_item' => __('View Invoice', 'invoicing'), |
|
26 | + 'all_items' => __('Invoices', 'invoicing'), |
|
27 | + 'search_items' => __('Search Invoices', 'invoicing'), |
|
28 | + 'parent_item_colon' => __('Parent Invoices:', 'invoicing'), |
|
29 | + 'not_found' => __('No invoices found.', 'invoicing'), |
|
30 | + 'not_found_in_trash' => __('No invoices found in trash.', 'invoicing') |
|
31 | 31 | ); |
32 | - $labels = apply_filters( 'wpinv_labels', $labels ); |
|
32 | + $labels = apply_filters('wpinv_labels', $labels); |
|
33 | 33 | |
34 | 34 | $menu_icon = WPINV_PLUGIN_URL . '/assets/images/favicon.ico'; |
35 | - $menu_icon = apply_filters( 'wpinv_menu_icon_invoice', $menu_icon ); |
|
35 | + $menu_icon = apply_filters('wpinv_menu_icon_invoice', $menu_icon); |
|
36 | 36 | |
37 | 37 | $args = array( |
38 | 38 | 'labels' => $labels, |
39 | - 'description' => __( 'This is where invoices are stored.', 'invoicing' ), |
|
39 | + 'description' => __('This is where invoices are stored.', 'invoicing'), |
|
40 | 40 | 'public' => true, |
41 | 41 | 'can_export' => true, |
42 | 42 | '_builtin' => false, |
@@ -50,68 +50,68 @@ discard block |
||
50 | 50 | 'has_archive' => false, |
51 | 51 | 'hierarchical' => false, |
52 | 52 | 'menu_position' => null, |
53 | - 'supports' => array( 'title', 'author' ), |
|
53 | + 'supports' => array('title', 'author'), |
|
54 | 54 | 'menu_icon' => $menu_icon, |
55 | 55 | ); |
56 | 56 | |
57 | - $args = apply_filters( 'wpinv_register_post_type_invoice', $args ); |
|
57 | + $args = apply_filters('wpinv_register_post_type_invoice', $args); |
|
58 | 58 | |
59 | - register_post_type( 'wpi_invoice', $args ); |
|
59 | + register_post_type('wpi_invoice', $args); |
|
60 | 60 | |
61 | 61 | $items_labels = array( |
62 | - 'name' => _x( 'Items', 'post type general name', 'invoicing' ), |
|
63 | - 'singular_name' => _x( 'Item', 'post type singular name', 'invoicing' ), |
|
64 | - 'menu_name' => _x( 'Items', 'admin menu', 'invoicing' ), |
|
65 | - 'add_new' => _x( 'Add New', 'wpi_item', 'invoicing' ), |
|
66 | - 'add_new_item' => __( 'Add New Item', 'invoicing' ), |
|
67 | - 'new_item' => __( 'New Item', 'invoicing' ), |
|
68 | - 'edit_item' => __( 'Edit Item', 'invoicing' ), |
|
69 | - 'view_item' => __( 'View Item', 'invoicing' ), |
|
70 | - 'all_items' => __( 'Items', 'invoicing' ), |
|
71 | - 'search_items' => __( 'Search Items', 'invoicing' ), |
|
62 | + 'name' => _x('Items', 'post type general name', 'invoicing'), |
|
63 | + 'singular_name' => _x('Item', 'post type singular name', 'invoicing'), |
|
64 | + 'menu_name' => _x('Items', 'admin menu', 'invoicing'), |
|
65 | + 'add_new' => _x('Add New', 'wpi_item', 'invoicing'), |
|
66 | + 'add_new_item' => __('Add New Item', 'invoicing'), |
|
67 | + 'new_item' => __('New Item', 'invoicing'), |
|
68 | + 'edit_item' => __('Edit Item', 'invoicing'), |
|
69 | + 'view_item' => __('View Item', 'invoicing'), |
|
70 | + 'all_items' => __('Items', 'invoicing'), |
|
71 | + 'search_items' => __('Search Items', 'invoicing'), |
|
72 | 72 | 'parent_item_colon' => '', |
73 | - 'not_found' => __( 'No items found.', 'invoicing' ), |
|
74 | - 'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' ) |
|
73 | + 'not_found' => __('No items found.', 'invoicing'), |
|
74 | + 'not_found_in_trash' => __('No items found in trash.', 'invoicing') |
|
75 | 75 | ); |
76 | - $items_labels = apply_filters( 'wpinv_items_labels', $items_labels ); |
|
76 | + $items_labels = apply_filters('wpinv_items_labels', $items_labels); |
|
77 | 77 | |
78 | 78 | $invoice_item_args = array( |
79 | 79 | 'labels' => $items_labels, |
80 | 80 | 'public' => false, |
81 | 81 | 'show_ui' => true, |
82 | 82 | 'show_in_menu' => 'wpinv', |
83 | - 'supports' => array( 'title', 'excerpt' ), |
|
83 | + 'supports' => array('title', 'excerpt'), |
|
84 | 84 | 'register_meta_box_cb' => 'wpinv_register_item_meta_boxes', |
85 | 85 | 'rewrite' => false, |
86 | 86 | 'query_var' => false, |
87 | 87 | 'map_meta_cap' => true, |
88 | 88 | 'can_export' => true, |
89 | 89 | ); |
90 | - $invoice_item_args = apply_filters( 'wpinv_register_post_type_invoice_item', $invoice_item_args ); |
|
90 | + $invoice_item_args = apply_filters('wpinv_register_post_type_invoice_item', $invoice_item_args); |
|
91 | 91 | |
92 | - register_post_type( 'wpi_item', $invoice_item_args ); |
|
92 | + register_post_type('wpi_item', $invoice_item_args); |
|
93 | 93 | |
94 | 94 | $labels = array( |
95 | - 'name' => _x( 'Discounts', 'post type general name', 'invoicing' ), |
|
96 | - 'singular_name' => _x( 'Discount', 'post type singular name', 'invoicing' ), |
|
97 | - 'menu_name' => _x( 'Discounts', 'admin menu', 'invoicing' ), |
|
98 | - 'name_admin_bar' => _x( 'Discount', 'add new on admin bar', 'invoicing' ), |
|
99 | - 'add_new' => _x( 'Add New', 'book', 'invoicing' ), |
|
100 | - 'add_new_item' => __( 'Add New Discount', 'invoicing' ), |
|
101 | - 'new_item' => __( 'New Discount', 'invoicing' ), |
|
102 | - 'edit_item' => __( 'Edit Discount', 'invoicing' ), |
|
103 | - 'view_item' => __( 'View Discount', 'invoicing' ), |
|
104 | - 'all_items' => __( 'Discounts', 'invoicing' ), |
|
105 | - 'search_items' => __( 'Search Discounts', 'invoicing' ), |
|
106 | - 'parent_item_colon' => __( 'Parent Discounts:', 'invoicing' ), |
|
107 | - 'not_found' => __( 'No discounts found.', 'invoicing' ), |
|
108 | - 'not_found_in_trash' => __( 'No discounts found in trash.', 'invoicing' ) |
|
95 | + 'name' => _x('Discounts', 'post type general name', 'invoicing'), |
|
96 | + 'singular_name' => _x('Discount', 'post type singular name', 'invoicing'), |
|
97 | + 'menu_name' => _x('Discounts', 'admin menu', 'invoicing'), |
|
98 | + 'name_admin_bar' => _x('Discount', 'add new on admin bar', 'invoicing'), |
|
99 | + 'add_new' => _x('Add New', 'book', 'invoicing'), |
|
100 | + 'add_new_item' => __('Add New Discount', 'invoicing'), |
|
101 | + 'new_item' => __('New Discount', 'invoicing'), |
|
102 | + 'edit_item' => __('Edit Discount', 'invoicing'), |
|
103 | + 'view_item' => __('View Discount', 'invoicing'), |
|
104 | + 'all_items' => __('Discounts', 'invoicing'), |
|
105 | + 'search_items' => __('Search Discounts', 'invoicing'), |
|
106 | + 'parent_item_colon' => __('Parent Discounts:', 'invoicing'), |
|
107 | + 'not_found' => __('No discounts found.', 'invoicing'), |
|
108 | + 'not_found_in_trash' => __('No discounts found in trash.', 'invoicing') |
|
109 | 109 | ); |
110 | - $labels = apply_filters( 'wpinv_discounts_labels', $labels ); |
|
110 | + $labels = apply_filters('wpinv_discounts_labels', $labels); |
|
111 | 111 | |
112 | 112 | $args = array( |
113 | 113 | 'labels' => $labels, |
114 | - 'description' => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ), |
|
114 | + 'description' => __('This is where you can add new discounts that users can use in invoices.', 'invoicing'), |
|
115 | 115 | 'public' => false, |
116 | 116 | 'can_export' => true, |
117 | 117 | '_builtin' => false, |
@@ -125,7 +125,7 @@ discard block |
||
125 | 125 | 'map_meta_cap' => true, |
126 | 126 | 'has_archive' => false, |
127 | 127 | 'hierarchical' => false, |
128 | - 'supports' => array( 'title', 'excerpt' ), |
|
128 | + 'supports' => array('title', 'excerpt'), |
|
129 | 129 | 'register_meta_box_cb' => 'wpinv_register_discount_meta_boxes', |
130 | 130 | 'show_in_nav_menus' => false, |
131 | 131 | 'show_in_admin_bar' => true, |
@@ -133,99 +133,99 @@ discard block |
||
133 | 133 | 'menu_position' => null, |
134 | 134 | ); |
135 | 135 | |
136 | - $args = apply_filters( 'wpinv_register_post_type_discount', $args ); |
|
136 | + $args = apply_filters('wpinv_register_post_type_discount', $args); |
|
137 | 137 | |
138 | - register_post_type( 'wpi_discount', $args ); |
|
138 | + register_post_type('wpi_discount', $args); |
|
139 | 139 | } |
140 | 140 | |
141 | 141 | function wpinv_get_default_labels() { |
142 | 142 | $defaults = array( |
143 | - 'singular' => __( 'Invoice', 'invoicing' ), |
|
144 | - 'plural' => __( 'Invoices', 'invoicing' ) |
|
143 | + 'singular' => __('Invoice', 'invoicing'), |
|
144 | + 'plural' => __('Invoices', 'invoicing') |
|
145 | 145 | ); |
146 | 146 | |
147 | - return apply_filters( 'wpinv_default_invoices_name', $defaults ); |
|
147 | + return apply_filters('wpinv_default_invoices_name', $defaults); |
|
148 | 148 | } |
149 | 149 | |
150 | -function wpinv_get_label_singular( $lowercase = false ) { |
|
150 | +function wpinv_get_label_singular($lowercase = false) { |
|
151 | 151 | $defaults = wpinv_get_default_labels(); |
152 | 152 | |
153 | - return ($lowercase) ? strtolower( $defaults['singular'] ) : $defaults['singular']; |
|
153 | + return ($lowercase) ? strtolower($defaults['singular']) : $defaults['singular']; |
|
154 | 154 | } |
155 | 155 | |
156 | -function wpinv_get_label_plural( $lowercase = false ) { |
|
156 | +function wpinv_get_label_plural($lowercase = false) { |
|
157 | 157 | $defaults = wpinv_get_default_labels(); |
158 | 158 | |
159 | - return ( $lowercase ) ? strtolower( $defaults['plural'] ) : $defaults['plural']; |
|
159 | + return ($lowercase) ? strtolower($defaults['plural']) : $defaults['plural']; |
|
160 | 160 | } |
161 | 161 | |
162 | -function wpinv_change_default_title( $title ) { |
|
163 | - if ( !is_admin() ) { |
|
162 | +function wpinv_change_default_title($title) { |
|
163 | + if (!is_admin()) { |
|
164 | 164 | $label = wpinv_get_label_singular(); |
165 | - $title = sprintf( __( 'Enter %s name here', 'invoicing' ), $label ); |
|
165 | + $title = sprintf(__('Enter %s name here', 'invoicing'), $label); |
|
166 | 166 | return $title; |
167 | 167 | } |
168 | 168 | |
169 | 169 | $screen = get_current_screen(); |
170 | 170 | |
171 | - if ( 'wpi_invoice' == $screen->post_type ) { |
|
171 | + if ('wpi_invoice' == $screen->post_type) { |
|
172 | 172 | $label = wpinv_get_label_singular(); |
173 | - $title = sprintf( __( 'Enter %s name here', 'invoicing' ), $label ); |
|
173 | + $title = sprintf(__('Enter %s name here', 'invoicing'), $label); |
|
174 | 174 | } |
175 | 175 | |
176 | 176 | return $title; |
177 | 177 | } |
178 | -add_filter( 'enter_title_here', 'wpinv_change_default_title' ); |
|
178 | +add_filter('enter_title_here', 'wpinv_change_default_title'); |
|
179 | 179 | |
180 | 180 | function wpinv_register_post_status() { |
181 | - register_post_status( 'processing', array( |
|
182 | - 'label' => _x( 'Processing', 'Invoice status', 'invoicing' ), |
|
181 | + register_post_status('processing', array( |
|
182 | + 'label' => _x('Processing', 'Invoice status', 'invoicing'), |
|
183 | 183 | 'public' => true, |
184 | 184 | 'exclude_from_search' => true, |
185 | 185 | 'show_in_admin_all_list' => true, |
186 | 186 | 'show_in_admin_status_list' => true, |
187 | - 'label_count' => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' ) |
|
188 | - ) ); |
|
189 | - register_post_status( 'onhold', array( |
|
190 | - 'label' => _x( 'On Hold', 'Invoice status', 'invoicing' ), |
|
187 | + 'label_count' => _n_noop('Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing') |
|
188 | + )); |
|
189 | + register_post_status('onhold', array( |
|
190 | + 'label' => _x('On Hold', 'Invoice status', 'invoicing'), |
|
191 | 191 | 'public' => true, |
192 | 192 | 'exclude_from_search' => true, |
193 | 193 | 'show_in_admin_all_list' => true, |
194 | 194 | 'show_in_admin_status_list' => true, |
195 | - 'label_count' => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' ) |
|
196 | - ) ); |
|
197 | - register_post_status( 'cancelled', array( |
|
198 | - 'label' => _x( 'Cancelled', 'Invoice status', 'invoicing' ), |
|
195 | + 'label_count' => _n_noop('On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing') |
|
196 | + )); |
|
197 | + register_post_status('cancelled', array( |
|
198 | + 'label' => _x('Cancelled', 'Invoice status', 'invoicing'), |
|
199 | 199 | 'public' => true, |
200 | 200 | 'exclude_from_search' => true, |
201 | 201 | 'show_in_admin_all_list' => true, |
202 | 202 | 'show_in_admin_status_list' => true, |
203 | - 'label_count' => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' ) |
|
204 | - ) ); |
|
205 | - register_post_status( 'refunded', array( |
|
206 | - 'label' => _x( 'Refunded', 'Invoice status', 'invoicing' ), |
|
203 | + 'label_count' => _n_noop('Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing') |
|
204 | + )); |
|
205 | + register_post_status('refunded', array( |
|
206 | + 'label' => _x('Refunded', 'Invoice status', 'invoicing'), |
|
207 | 207 | 'public' => true, |
208 | 208 | 'exclude_from_search' => true, |
209 | 209 | 'show_in_admin_all_list' => true, |
210 | 210 | 'show_in_admin_status_list' => true, |
211 | - 'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' ) |
|
212 | - ) ); |
|
213 | - register_post_status( 'failed', array( |
|
214 | - 'label' => _x( 'Failed', 'Invoice status', 'invoicing' ), |
|
211 | + 'label_count' => _n_noop('Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing') |
|
212 | + )); |
|
213 | + register_post_status('failed', array( |
|
214 | + 'label' => _x('Failed', 'Invoice status', 'invoicing'), |
|
215 | 215 | 'public' => true, |
216 | 216 | 'exclude_from_search' => true, |
217 | 217 | 'show_in_admin_all_list' => true, |
218 | 218 | 'show_in_admin_status_list' => true, |
219 | - 'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' ) |
|
220 | - ) ); |
|
221 | - register_post_status( 'renewal', array( |
|
222 | - 'label' => _x( 'Renewal', 'Invoice status', 'invoicing' ), |
|
219 | + 'label_count' => _n_noop('Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing') |
|
220 | + )); |
|
221 | + register_post_status('renewal', array( |
|
222 | + 'label' => _x('Renewal', 'Invoice status', 'invoicing'), |
|
223 | 223 | 'public' => true, |
224 | 224 | 'exclude_from_search' => true, |
225 | 225 | 'show_in_admin_all_list' => true, |
226 | 226 | 'show_in_admin_status_list' => true, |
227 | - 'label_count' => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' ) |
|
228 | - ) ); |
|
227 | + 'label_count' => _n_noop('Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing') |
|
228 | + )); |
|
229 | 229 | } |
230 | -add_action( 'init', 'wpinv_register_post_status', 10 ); |
|
230 | +add_action('init', 'wpinv_register_post_status', 10); |
|
231 | 231 |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php |
2 | -if ( ! defined( 'ABSPATH' ) ) { |
|
2 | +if (!defined('ABSPATH')) { |
|
3 | 3 | exit; // Exit if accessed directly |
4 | 4 | } |
5 | 5 | |
@@ -14,65 +14,65 @@ discard block |
||
14 | 14 | } |
15 | 15 | |
16 | 16 | public function init() { |
17 | - do_action( 'wpinv_class_notes_init', $this ); |
|
17 | + do_action('wpinv_class_notes_init', $this); |
|
18 | 18 | } |
19 | 19 | |
20 | 20 | public function includes() { |
21 | - do_action( 'wpinv_class_notes_includes', $this ); |
|
21 | + do_action('wpinv_class_notes_includes', $this); |
|
22 | 22 | } |
23 | 23 | |
24 | 24 | public function actions() { |
25 | 25 | // Secure inovice notes |
26 | - add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 ); |
|
26 | + add_action('pre_get_comments', array($this, 'set_invoice_note_type'), 11, 1); |
|
27 | 27 | |
28 | - do_action( 'wpinv_class_notes_actions', $this ); |
|
28 | + do_action('wpinv_class_notes_actions', $this); |
|
29 | 29 | } |
30 | 30 | |
31 | - public function set_invoice_note_type( $query ) { |
|
32 | - $post_ID = !empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id']; |
|
31 | + public function set_invoice_note_type($query) { |
|
32 | + $post_ID = !empty($query->query_vars['post_ID']) ? $query->query_vars['post_ID'] : $query->query_vars['post_id']; |
|
33 | 33 | |
34 | - if ( $post_ID && get_post_type( $post_ID ) == $this->invoice_post_type ) { |
|
34 | + if ($post_ID && get_post_type($post_ID) == $this->invoice_post_type) { |
|
35 | 35 | $query->query_vars['type__in'] = $this->comment_type; |
36 | 36 | $query->query_vars['type__not_in'] = ''; |
37 | 37 | } else { |
38 | - if ( isset( $query->query_vars['type__in'] ) && $type_in = $query->query_vars['type__in'] ) { |
|
39 | - if ( is_array( $type_in ) && in_array( $this->comment_type, $type_in ) ) { |
|
40 | - $key = array_search( $this->comment_type, $type_in ); |
|
41 | - unset( $query->query_vars['type__in'][$key] ); |
|
42 | - } else if ( !is_array( $type_in ) && $type_in == $this->comment_type ) { |
|
38 | + if (isset($query->query_vars['type__in']) && $type_in = $query->query_vars['type__in']) { |
|
39 | + if (is_array($type_in) && in_array($this->comment_type, $type_in)) { |
|
40 | + $key = array_search($this->comment_type, $type_in); |
|
41 | + unset($query->query_vars['type__in'][$key]); |
|
42 | + } else if (!is_array($type_in) && $type_in == $this->comment_type) { |
|
43 | 43 | $query->query_vars['type__in'] = ''; |
44 | 44 | } |
45 | 45 | } |
46 | 46 | |
47 | - if ( isset( $query->query_vars['type__not_in'] ) && $type_not_in = $query->query_vars['type__not_in'] ) { |
|
48 | - if ( is_array( $type_not_in ) && !in_array( $this->comment_type, $type_not_in ) ) { |
|
47 | + if (isset($query->query_vars['type__not_in']) && $type_not_in = $query->query_vars['type__not_in']) { |
|
48 | + if (is_array($type_not_in) && !in_array($this->comment_type, $type_not_in)) { |
|
49 | 49 | $query->query_vars['type__not_in'][] = $this->comment_type; |
50 | - } else if ( !is_array( $type_not_in ) && $type_not_in != $this->comment_type ) { |
|
50 | + } else if (!is_array($type_not_in) && $type_not_in != $this->comment_type) { |
|
51 | 51 | $query->query_vars['type__not_in'] = (array)$query->query_vars['type__not_in']; |
52 | 52 | $query->query_vars['type__not_in'][] = $this->comment_type; |
53 | 53 | } |
54 | 54 | } else { |
55 | - $query->query_vars['type__not_in'] = $this->comment_type; |
|
55 | + $query->query_vars['type__not_in'] = $this->comment_type; |
|
56 | 56 | } |
57 | 57 | } |
58 | 58 | |
59 | 59 | return $query; |
60 | 60 | } |
61 | 61 | |
62 | - public function get_invoice_notes( $invoice_id = 0, $type = '' ) { |
|
62 | + public function get_invoice_notes($invoice_id = 0, $type = '') { |
|
63 | 63 | $args = array( |
64 | 64 | 'post_id' => $invoice_id, |
65 | 65 | 'order' => 'comment_date_gmt', |
66 | 66 | 'order' => 'DESC', |
67 | 67 | ); |
68 | 68 | |
69 | - if ( $type == 'customer' ) { |
|
69 | + if ($type == 'customer') { |
|
70 | 70 | $args['meta_key'] = '_wpi_customer_note'; |
71 | 71 | $args['meta_value'] = 1; |
72 | 72 | } |
73 | 73 | |
74 | - $args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type ); |
|
74 | + $args = apply_filters('wpinv_invoice_notes_args', $args, $this, $invoice_id, $type); |
|
75 | 75 | |
76 | - return get_comments( $args ); |
|
76 | + return get_comments($args); |
|
77 | 77 | } |
78 | 78 | } |
@@ -166,13 +166,13 @@ |
||
166 | 166 | $is_writeable = $is_dir && is_writeable( $this->export_dir ); |
167 | 167 | |
168 | 168 | if ( $is_dir && $is_writeable ) { |
169 | - return true; |
|
169 | + return true; |
|
170 | 170 | } else if ( $is_dir && !$is_writeable ) { |
171 | - if ( !$this->wp_filesystem->chmod( $this->export_dir, FS_CHMOD_DIR ) ) { |
|
172 | - return wp_sprintf( __( 'Filesystem ERROR: Export location %s is not writable, check your file permissions.', 'invoicing' ), $this->export_dir ); |
|
173 | - } |
|
171 | + if ( !$this->wp_filesystem->chmod( $this->export_dir, FS_CHMOD_DIR ) ) { |
|
172 | + return wp_sprintf( __( 'Filesystem ERROR: Export location %s is not writable, check your file permissions.', 'invoicing' ), $this->export_dir ); |
|
173 | + } |
|
174 | 174 | |
175 | - return true; |
|
175 | + return true; |
|
176 | 176 | } else { |
177 | 177 | if ( !$this->wp_filesystem->mkdir( $this->export_dir, FS_CHMOD_DIR ) ) { |
178 | 178 | return wp_sprintf( __( 'Filesystem ERROR: Could not create directory %s. This is usually due to inconsistent file permissions.', 'invoicing' ), $this->export_dir ); |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php |
2 | -if ( ! defined( 'ABSPATH' ) ) { |
|
2 | +if (!defined('ABSPATH')) { |
|
3 | 3 | exit; // Exit if accessed directly |
4 | 4 | } |
5 | 5 | |
@@ -21,68 +21,68 @@ discard block |
||
21 | 21 | public function init() { |
22 | 22 | global $wp_filesystem; |
23 | 23 | |
24 | - if ( empty( $wp_filesystem ) ) { |
|
25 | - require_once( ABSPATH . '/wp-admin/includes/file.php' ); |
|
24 | + if (empty($wp_filesystem)) { |
|
25 | + require_once(ABSPATH . '/wp-admin/includes/file.php'); |
|
26 | 26 | WP_Filesystem(); |
27 | 27 | global $wp_filesystem; |
28 | 28 | } |
29 | 29 | $this->wp_filesystem = $wp_filesystem; |
30 | 30 | |
31 | 31 | $this->export_dir = $this->export_location(); |
32 | - $this->export_url = $this->export_location( true ); |
|
32 | + $this->export_url = $this->export_location(true); |
|
33 | 33 | $this->export = 'invoicing'; |
34 | 34 | $this->filetype = 'csv'; |
35 | 35 | $this->per_page = 20; |
36 | 36 | |
37 | - do_action( 'wpinv_class_reports_init', $this ); |
|
37 | + do_action('wpinv_class_reports_init', $this); |
|
38 | 38 | } |
39 | 39 | |
40 | 40 | public function includes() { |
41 | - do_action( 'wpinv_class_reports_includes', $this ); |
|
41 | + do_action('wpinv_class_reports_includes', $this); |
|
42 | 42 | } |
43 | 43 | |
44 | 44 | public function actions() { |
45 | - if ( is_admin() ) { |
|
46 | - add_action( 'admin_menu', array( $this, 'add_submenu' ), 10 ); |
|
47 | - add_action( 'wpinv_reports_tab_export', array( $this, 'export' ) ); |
|
48 | - add_action( 'wp_ajax_wpinv_ajax_export', array( $this, 'ajax_export' ) ); |
|
45 | + if (is_admin()) { |
|
46 | + add_action('admin_menu', array($this, 'add_submenu'), 10); |
|
47 | + add_action('wpinv_reports_tab_export', array($this, 'export')); |
|
48 | + add_action('wp_ajax_wpinv_ajax_export', array($this, 'ajax_export')); |
|
49 | 49 | |
50 | 50 | // Export Invoices. |
51 | - add_action( 'wpinv_export_set_params_invoices', array( $this, 'set_invoices_export' ) ); |
|
52 | - add_filter( 'wpinv_export_get_columns_invoices', array( $this, 'get_invoices_columns' ) ); |
|
53 | - add_filter( 'wpinv_export_get_data_invoices', array( $this, 'get_invoices_data' ) ); |
|
54 | - add_filter( 'wpinv_get_export_status_invoices', array( $this, 'invoices_export_status' ) ); |
|
51 | + add_action('wpinv_export_set_params_invoices', array($this, 'set_invoices_export')); |
|
52 | + add_filter('wpinv_export_get_columns_invoices', array($this, 'get_invoices_columns')); |
|
53 | + add_filter('wpinv_export_get_data_invoices', array($this, 'get_invoices_data')); |
|
54 | + add_filter('wpinv_get_export_status_invoices', array($this, 'invoices_export_status')); |
|
55 | 55 | } |
56 | - do_action( 'wpinv_class_reports_actions', $this ); |
|
56 | + do_action('wpinv_class_reports_actions', $this); |
|
57 | 57 | } |
58 | 58 | |
59 | 59 | public function add_submenu() { |
60 | 60 | global $wpi_reports_page; |
61 | - $wpi_reports_page = add_submenu_page( 'wpinv', __( 'Reports', 'invoicing' ), __( 'Reports', 'invoicing' ), 'manage_options', 'wpinv-reports', array( $this, 'reports_page' ) ); |
|
61 | + $wpi_reports_page = add_submenu_page('wpinv', __('Reports', 'invoicing'), __('Reports', 'invoicing'), 'manage_options', 'wpinv-reports', array($this, 'reports_page')); |
|
62 | 62 | } |
63 | 63 | |
64 | 64 | public function reports_page() { |
65 | - if ( !wp_script_is( 'postbox', 'enqueued' ) ) { |
|
66 | - wp_enqueue_script( 'postbox' ); |
|
65 | + if (!wp_script_is('postbox', 'enqueued')) { |
|
66 | + wp_enqueue_script('postbox'); |
|
67 | 67 | } |
68 | - if ( !wp_script_is( 'jquery-ui-datepicker', 'enqueued' ) ) { |
|
69 | - wp_enqueue_script( 'jquery-ui-datepicker' ); |
|
68 | + if (!wp_script_is('jquery-ui-datepicker', 'enqueued')) { |
|
69 | + wp_enqueue_script('jquery-ui-datepicker'); |
|
70 | 70 | } |
71 | 71 | |
72 | - $current_page = admin_url( 'admin.php?page=wpinv-reports' ); |
|
73 | - $active_tab = isset( $_GET['tab'] ) ? $_GET['tab'] : 'export'; |
|
72 | + $current_page = admin_url('admin.php?page=wpinv-reports'); |
|
73 | + $active_tab = isset($_GET['tab']) ? $_GET['tab'] : 'export'; |
|
74 | 74 | ?> |
75 | 75 | <div class="wrap wpi-reports-wrap"> |
76 | - <h1><?php echo esc_html( __( 'Reports', 'invoicing' ) ); ?></h1> |
|
76 | + <h1><?php echo esc_html(__('Reports', 'invoicing')); ?></h1> |
|
77 | 77 | <h2 class="nav-tab-wrapper wp-clearfix"> |
78 | - <a href="<?php echo add_query_arg( array( 'tab' => 'export', 'settings-updated' => false ), $current_page ); ?>" class="nav-tab <?php echo $active_tab == 'export' ? 'nav-tab-active' : ''; ?>"><?php _e( 'Export', 'invoicing' ); ?></a> |
|
79 | - <?php do_action( 'wpinv_reports_page_tabs' ); ;?> |
|
78 | + <a href="<?php echo add_query_arg(array('tab' => 'export', 'settings-updated' => false), $current_page); ?>" class="nav-tab <?php echo $active_tab == 'export' ? 'nav-tab-active' : ''; ?>"><?php _e('Export', 'invoicing'); ?></a> |
|
79 | + <?php do_action('wpinv_reports_page_tabs'); ;?> |
|
80 | 80 | </h2> |
81 | 81 | <div class="wpi-reports-content wpi-reports-<?php echo $active_tab; ?>"> |
82 | 82 | <?php |
83 | - do_action( 'wpinv_reports_page_top' ); |
|
84 | - do_action( 'wpinv_reports_tab_' . $active_tab ); |
|
85 | - do_action( 'wpinv_reports_page_bottom' ); |
|
83 | + do_action('wpinv_reports_page_top'); |
|
84 | + do_action('wpinv_reports_tab_' . $active_tab); |
|
85 | + do_action('wpinv_reports_page_bottom'); |
|
86 | 86 | ?> |
87 | 87 | </div> |
88 | 88 | <?php |
@@ -90,97 +90,97 @@ discard block |
||
90 | 90 | |
91 | 91 | public function export() { |
92 | 92 | $statuses = wpinv_get_invoice_statuses(); |
93 | - $statuses = array_merge( array( 'any' => __( 'All Statuses', 'invoicing' ) ), $statuses ); |
|
93 | + $statuses = array_merge(array('any' => __('All Statuses', 'invoicing')), $statuses); |
|
94 | 94 | ?> |
95 | 95 | <div class="metabox-holder"> |
96 | 96 | <div id="post-body"> |
97 | 97 | <div id="post-body-content"> |
98 | - <?php do_action( 'wpinv_reports_tab_export_content_top' ); ?> |
|
98 | + <?php do_action('wpinv_reports_tab_export_content_top'); ?> |
|
99 | 99 | |
100 | 100 | <div class="postbox wpi-export-invoices"> |
101 | - <h2 class="hndle ui-sortabled-handle"><span><?php _e( 'Invoices','invoicing' ); ?></span></h2> |
|
101 | + <h2 class="hndle ui-sortabled-handle"><span><?php _e('Invoices', 'invoicing'); ?></span></h2> |
|
102 | 102 | <div class="inside"> |
103 | - <p><?php _e( 'Download a CSV of all payment invoices.', 'invoicing' ); ?></p> |
|
103 | + <p><?php _e('Download a CSV of all payment invoices.', 'invoicing'); ?></p> |
|
104 | 104 | <form id="wpi-export-invoices" class="wpi-export-form" method="post"> |
105 | - <?php echo wpinv_html_date_field( array( |
|
105 | + <?php echo wpinv_html_date_field(array( |
|
106 | 106 | 'id' => 'wpi_export_from_date', |
107 | 107 | 'name' => 'from_date', |
108 | 108 | 'data' => array( |
109 | 109 | 'dateFormat' => 'yy-mm-dd' |
110 | 110 | ), |
111 | - 'placeholder' => __( 'From date', 'invoicing' ) ) |
|
111 | + 'placeholder' => __('From date', 'invoicing') ) |
|
112 | 112 | ); ?> |
113 | - <?php echo wpinv_html_date_field( array( |
|
113 | + <?php echo wpinv_html_date_field(array( |
|
114 | 114 | 'id' => 'wpi_export_to_date', |
115 | 115 | 'name' => 'to_date', |
116 | 116 | 'data' => array( |
117 | 117 | 'dateFormat' => 'yy-mm-dd' |
118 | 118 | ), |
119 | - 'placeholder' => __( 'To date', 'invoicing' ) ) |
|
119 | + 'placeholder' => __('To date', 'invoicing') ) |
|
120 | 120 | ); ?> |
121 | 121 | <span id="wpinv-status-wrap"> |
122 | - <?php echo wpinv_html_select( array( |
|
122 | + <?php echo wpinv_html_select(array( |
|
123 | 123 | 'options' => $statuses, |
124 | 124 | 'name' => 'status', |
125 | 125 | 'id' => 'wpi_export_status', |
126 | 126 | 'show_option_all' => false, |
127 | 127 | 'show_option_none' => false, |
128 | 128 | 'class' => '', |
129 | - ) ); ?> |
|
130 | - <?php wp_nonce_field( 'wpi_ajax_export', 'wpi_ajax_export' ); ?> |
|
129 | + )); ?> |
|
130 | + <?php wp_nonce_field('wpi_ajax_export', 'wpi_ajax_export'); ?> |
|
131 | 131 | </span> |
132 | 132 | <span id="wpinv-submit-wrap"> |
133 | 133 | <input type="hidden" value="invoices" name="export" /> |
134 | - <input type="submit" value="<?php _e( 'Generate CSV', 'invoicing' ); ?>" class="button-primary" /> |
|
134 | + <input type="submit" value="<?php _e('Generate CSV', 'invoicing'); ?>" class="button-primary" /> |
|
135 | 135 | </span> |
136 | 136 | </form> |
137 | 137 | </div> |
138 | 138 | </div> |
139 | 139 | |
140 | - <?php do_action( 'wpinv_reports_tab_export_content_bottom' ); ?> |
|
140 | + <?php do_action('wpinv_reports_tab_export_content_bottom'); ?> |
|
141 | 141 | </div> |
142 | 142 | </div> |
143 | 143 | </div> |
144 | 144 | <?php |
145 | 145 | } |
146 | 146 | |
147 | - public function export_location( $relative = false ) { |
|
147 | + public function export_location($relative = false) { |
|
148 | 148 | $upload_dir = wp_upload_dir(); |
149 | - $export_location = $relative ? trailingslashit( $upload_dir['baseurl'] ) . 'cache' : trailingslashit( $upload_dir['basedir'] ) . 'cache'; |
|
150 | - $export_location = apply_filters( 'wpinv_export_location', $export_location, $relative ); |
|
149 | + $export_location = $relative ? trailingslashit($upload_dir['baseurl']) . 'cache' : trailingslashit($upload_dir['basedir']) . 'cache'; |
|
150 | + $export_location = apply_filters('wpinv_export_location', $export_location, $relative); |
|
151 | 151 | |
152 | - return trailingslashit( $export_location ); |
|
152 | + return trailingslashit($export_location); |
|
153 | 153 | } |
154 | 154 | |
155 | 155 | public function check_export_location() { |
156 | 156 | try { |
157 | - if ( empty( $this->wp_filesystem ) ) { |
|
158 | - return __( 'Filesystem ERROR: Could not access filesystem.', 'invoicing' ); |
|
157 | + if (empty($this->wp_filesystem)) { |
|
158 | + return __('Filesystem ERROR: Could not access filesystem.', 'invoicing'); |
|
159 | 159 | } |
160 | 160 | |
161 | - if ( is_wp_error( $this->wp_filesystem ) ) { |
|
162 | - return __( 'Filesystem ERROR: ' . $this->wp_filesystem->get_error_message(), 'invoicing' ); |
|
161 | + if (is_wp_error($this->wp_filesystem)) { |
|
162 | + return __('Filesystem ERROR: ' . $this->wp_filesystem->get_error_message(), 'invoicing'); |
|
163 | 163 | } |
164 | 164 | |
165 | - $is_dir = $this->wp_filesystem->is_dir( $this->export_dir ); |
|
166 | - $is_writeable = $is_dir && is_writeable( $this->export_dir ); |
|
165 | + $is_dir = $this->wp_filesystem->is_dir($this->export_dir); |
|
166 | + $is_writeable = $is_dir && is_writeable($this->export_dir); |
|
167 | 167 | |
168 | - if ( $is_dir && $is_writeable ) { |
|
168 | + if ($is_dir && $is_writeable) { |
|
169 | 169 | return true; |
170 | - } else if ( $is_dir && !$is_writeable ) { |
|
171 | - if ( !$this->wp_filesystem->chmod( $this->export_dir, FS_CHMOD_DIR ) ) { |
|
172 | - return wp_sprintf( __( 'Filesystem ERROR: Export location %s is not writable, check your file permissions.', 'invoicing' ), $this->export_dir ); |
|
170 | + } else if ($is_dir && !$is_writeable) { |
|
171 | + if (!$this->wp_filesystem->chmod($this->export_dir, FS_CHMOD_DIR)) { |
|
172 | + return wp_sprintf(__('Filesystem ERROR: Export location %s is not writable, check your file permissions.', 'invoicing'), $this->export_dir); |
|
173 | 173 | } |
174 | 174 | |
175 | 175 | return true; |
176 | 176 | } else { |
177 | - if ( !$this->wp_filesystem->mkdir( $this->export_dir, FS_CHMOD_DIR ) ) { |
|
178 | - return wp_sprintf( __( 'Filesystem ERROR: Could not create directory %s. This is usually due to inconsistent file permissions.', 'invoicing' ), $this->export_dir ); |
|
177 | + if (!$this->wp_filesystem->mkdir($this->export_dir, FS_CHMOD_DIR)) { |
|
178 | + return wp_sprintf(__('Filesystem ERROR: Could not create directory %s. This is usually due to inconsistent file permissions.', 'invoicing'), $this->export_dir); |
|
179 | 179 | } |
180 | 180 | |
181 | 181 | return true; |
182 | 182 | } |
183 | - } catch ( Exception $e ) { |
|
183 | + } catch (Exception $e) { |
|
184 | 184 | return $e->getMessage(); |
185 | 185 | } |
186 | 186 | } |
@@ -188,130 +188,130 @@ discard block |
||
188 | 188 | public function ajax_export() { |
189 | 189 | $response = array(); |
190 | 190 | $response['success'] = false; |
191 | - $response['msg'] = __( 'Invalid export request found.', 'invoicing' ); |
|
191 | + $response['msg'] = __('Invalid export request found.', 'invoicing'); |
|
192 | 192 | |
193 | - if ( empty( $_POST['data'] ) || !current_user_can( 'manage_options' ) ) { |
|
194 | - wp_send_json( $response ); |
|
193 | + if (empty($_POST['data']) || !current_user_can('manage_options')) { |
|
194 | + wp_send_json($response); |
|
195 | 195 | } |
196 | 196 | |
197 | - parse_str( $_POST['data'], $data ); |
|
197 | + parse_str($_POST['data'], $data); |
|
198 | 198 | |
199 | - $data['step'] = !empty( $_POST['step'] ) ? absint( $_POST['step'] ) : 1; |
|
199 | + $data['step'] = !empty($_POST['step']) ? absint($_POST['step']) : 1; |
|
200 | 200 | |
201 | 201 | $_REQUEST = (array)$data; |
202 | - if ( !( !empty( $_REQUEST['wpi_ajax_export'] ) && wp_verify_nonce( $_REQUEST['wpi_ajax_export'], 'wpi_ajax_export' ) ) ) { |
|
203 | - $response['msg'] = __( 'Security check failed.', 'invoicing' ); |
|
204 | - wp_send_json( $response ); |
|
202 | + if (!(!empty($_REQUEST['wpi_ajax_export']) && wp_verify_nonce($_REQUEST['wpi_ajax_export'], 'wpi_ajax_export'))) { |
|
203 | + $response['msg'] = __('Security check failed.', 'invoicing'); |
|
204 | + wp_send_json($response); |
|
205 | 205 | } |
206 | 206 | |
207 | - if ( ( $error = $this->check_export_location( true ) ) !== true ) { |
|
208 | - $response['msg'] = __( 'Filesystem ERROR: ' . $error, 'invoicing' ); |
|
209 | - wp_send_json( $response ); |
|
207 | + if (($error = $this->check_export_location(true)) !== true) { |
|
208 | + $response['msg'] = __('Filesystem ERROR: ' . $error, 'invoicing'); |
|
209 | + wp_send_json($response); |
|
210 | 210 | } |
211 | 211 | |
212 | - $this->set_export_params( $_REQUEST ); |
|
212 | + $this->set_export_params($_REQUEST); |
|
213 | 213 | |
214 | 214 | $return = $this->process_export_step(); |
215 | 215 | $done = $this->get_export_status(); |
216 | 216 | |
217 | - if ( $return ) { |
|
217 | + if ($return) { |
|
218 | 218 | $this->step += 1; |
219 | 219 | |
220 | 220 | $response['success'] = true; |
221 | 221 | $response['msg'] = ''; |
222 | 222 | |
223 | - if ( $done >= 100 ) { |
|
223 | + if ($done >= 100) { |
|
224 | 224 | $this->step = 'done'; |
225 | - $new_filename = 'wpi-' . $this->export . '-' . date( 'y-m-d-H-i' ) . '.' . $this->filetype; |
|
225 | + $new_filename = 'wpi-' . $this->export . '-' . date('y-m-d-H-i') . '.' . $this->filetype; |
|
226 | 226 | $new_file = $this->export_dir . $new_filename; |
227 | 227 | |
228 | - if ( file_exists( $this->file ) ) { |
|
229 | - $this->wp_filesystem->move( $this->file, $new_file, true ); |
|
228 | + if (file_exists($this->file)) { |
|
229 | + $this->wp_filesystem->move($this->file, $new_file, true); |
|
230 | 230 | } |
231 | 231 | |
232 | - if ( file_exists( $new_file ) ) { |
|
233 | - $response['data']['file'] = array( 'u' => $this->export_url . $new_filename, 's' => size_format( filesize( $new_file ), 2 ) ); |
|
232 | + if (file_exists($new_file)) { |
|
233 | + $response['data']['file'] = array('u' => $this->export_url . $new_filename, 's' => size_format(filesize($new_file), 2)); |
|
234 | 234 | } |
235 | 235 | } |
236 | 236 | |
237 | 237 | $response['data']['step'] = $this->step; |
238 | 238 | $response['data']['done'] = $done; |
239 | 239 | } else { |
240 | - $response['msg'] = __( 'No data found for export.', 'invoicing' ); |
|
240 | + $response['msg'] = __('No data found for export.', 'invoicing'); |
|
241 | 241 | } |
242 | 242 | |
243 | - wp_send_json( $response ); |
|
243 | + wp_send_json($response); |
|
244 | 244 | } |
245 | 245 | |
246 | - public function set_export_params( $request ) { |
|
246 | + public function set_export_params($request) { |
|
247 | 247 | $this->empty = false; |
248 | - $this->step = !empty( $request['step'] ) ? absint( $request['step'] ) : 1; |
|
249 | - $this->export = !empty( $request['export'] ) ? $request['export'] : $this->export; |
|
248 | + $this->step = !empty($request['step']) ? absint($request['step']) : 1; |
|
249 | + $this->export = !empty($request['export']) ? $request['export'] : $this->export; |
|
250 | 250 | $this->filename = 'wpi-' . $this->export . '-' . $request['wpi_ajax_export'] . '.' . $this->filetype; |
251 | 251 | $this->file = $this->export_dir . $this->filename; |
252 | 252 | |
253 | - do_action( 'wpinv_export_set_params_' . $this->export, $request ); |
|
253 | + do_action('wpinv_export_set_params_' . $this->export, $request); |
|
254 | 254 | } |
255 | 255 | |
256 | 256 | public function get_columns() { |
257 | 257 | $columns = array( |
258 | - 'id' => __( 'ID', 'invoicing' ), |
|
259 | - 'date' => __( 'Date', 'invoicing' ) |
|
258 | + 'id' => __('ID', 'invoicing'), |
|
259 | + 'date' => __('Date', 'invoicing') |
|
260 | 260 | ); |
261 | 261 | |
262 | - return apply_filters( 'wpinv_export_get_columns_' . $this->export, $columns ); |
|
262 | + return apply_filters('wpinv_export_get_columns_' . $this->export, $columns); |
|
263 | 263 | } |
264 | 264 | |
265 | 265 | protected function get_export_file() { |
266 | 266 | $file = ''; |
267 | 267 | |
268 | - if ( $this->wp_filesystem->exists( $this->file ) ) { |
|
269 | - $file = $this->wp_filesystem->get_contents( $this->file ); |
|
268 | + if ($this->wp_filesystem->exists($this->file)) { |
|
269 | + $file = $this->wp_filesystem->get_contents($this->file); |
|
270 | 270 | } else { |
271 | - $this->wp_filesystem->put_contents( $this->file, '' ); |
|
271 | + $this->wp_filesystem->put_contents($this->file, ''); |
|
272 | 272 | } |
273 | 273 | |
274 | 274 | return $file; |
275 | 275 | } |
276 | 276 | |
277 | - protected function attach_export_data( $data = '' ) { |
|
278 | - $filedata = $this->get_export_file(); |
|
279 | - $filedata .= $data; |
|
277 | + protected function attach_export_data($data = '') { |
|
278 | + $filedata = $this->get_export_file(); |
|
279 | + $filedata .= $data; |
|
280 | 280 | |
281 | - $this->wp_filesystem->put_contents( $this->file, $filedata ); |
|
281 | + $this->wp_filesystem->put_contents($this->file, $filedata); |
|
282 | 282 | |
283 | - $rows = file( $this->file, FILE_SKIP_EMPTY_LINES ); |
|
283 | + $rows = file($this->file, FILE_SKIP_EMPTY_LINES); |
|
284 | 284 | $columns = $this->get_columns(); |
285 | - $columns = empty( $columns ) ? 0 : 1; |
|
285 | + $columns = empty($columns) ? 0 : 1; |
|
286 | 286 | |
287 | - $this->empty = count( $rows ) == $columns ? true : false; |
|
287 | + $this->empty = count($rows) == $columns ? true : false; |
|
288 | 288 | } |
289 | 289 | |
290 | 290 | public function print_columns() { |
291 | 291 | $column_data = ''; |
292 | 292 | $columns = $this->get_columns(); |
293 | 293 | $i = 1; |
294 | - foreach( $columns as $key => $column ) { |
|
295 | - $column_data .= '"' . addslashes( $column ) . '"'; |
|
296 | - $column_data .= $i == count( $columns ) ? '' : ','; |
|
294 | + foreach ($columns as $key => $column) { |
|
295 | + $column_data .= '"' . addslashes($column) . '"'; |
|
296 | + $column_data .= $i == count($columns) ? '' : ','; |
|
297 | 297 | $i++; |
298 | 298 | } |
299 | 299 | $column_data .= "\r\n"; |
300 | 300 | |
301 | - $this->attach_export_data( $column_data ); |
|
301 | + $this->attach_export_data($column_data); |
|
302 | 302 | |
303 | 303 | return $column_data; |
304 | 304 | } |
305 | 305 | |
306 | 306 | public function process_export_step() { |
307 | - if ( $this->step < 2 ) { |
|
308 | - @unlink( $this->file ); |
|
307 | + if ($this->step < 2) { |
|
308 | + @unlink($this->file); |
|
309 | 309 | $this->print_columns(); |
310 | 310 | } |
311 | 311 | |
312 | 312 | $return = $this->print_rows(); |
313 | 313 | |
314 | - if ( $return ) { |
|
314 | + if ($return) { |
|
315 | 315 | return true; |
316 | 316 | } else { |
317 | 317 | return false; |
@@ -320,23 +320,23 @@ discard block |
||
320 | 320 | |
321 | 321 | public function get_export_status() { |
322 | 322 | $status = 100; |
323 | - return apply_filters( 'wpinv_get_export_status_' . $this->export, $status ); |
|
323 | + return apply_filters('wpinv_get_export_status_' . $this->export, $status); |
|
324 | 324 | } |
325 | 325 | |
326 | 326 | public function get_export_data() { |
327 | 327 | $data = array( |
328 | 328 | 0 => array( |
329 | 329 | 'id' => '', |
330 | - 'data' => date( 'F j, Y' ) |
|
330 | + 'data' => date('F j, Y') |
|
331 | 331 | ), |
332 | 332 | 1 => array( |
333 | 333 | 'id' => '', |
334 | - 'data' => date( 'F j, Y' ) |
|
334 | + 'data' => date('F j, Y') |
|
335 | 335 | ) |
336 | 336 | ); |
337 | 337 | |
338 | - $data = apply_filters( 'wpinv_export_get_data', $data ); |
|
339 | - $data = apply_filters( 'wpinv_export_get_data_' . $this->export, $data ); |
|
338 | + $data = apply_filters('wpinv_export_get_data', $data); |
|
339 | + $data = apply_filters('wpinv_export_get_data_' . $this->export, $data); |
|
340 | 340 | |
341 | 341 | return $data; |
342 | 342 | } |
@@ -346,20 +346,20 @@ discard block |
||
346 | 346 | $data = $this->get_export_data(); |
347 | 347 | $columns = $this->get_columns(); |
348 | 348 | |
349 | - if ( $data ) { |
|
350 | - foreach ( $data as $row ) { |
|
349 | + if ($data) { |
|
350 | + foreach ($data as $row) { |
|
351 | 351 | $i = 1; |
352 | - foreach ( $row as $key => $column ) { |
|
353 | - if ( array_key_exists( $key, $columns ) ) { |
|
354 | - $row_data .= '"' . addslashes( preg_replace( "/\"/","'", $column ) ) . '"'; |
|
355 | - $row_data .= $i == count( $columns ) ? '' : ','; |
|
352 | + foreach ($row as $key => $column) { |
|
353 | + if (array_key_exists($key, $columns)) { |
|
354 | + $row_data .= '"' . addslashes(preg_replace("/\"/", "'", $column)) . '"'; |
|
355 | + $row_data .= $i == count($columns) ? '' : ','; |
|
356 | 356 | $i++; |
357 | 357 | } |
358 | 358 | } |
359 | 359 | $row_data .= "\r\n"; |
360 | 360 | } |
361 | 361 | |
362 | - $this->attach_export_data( $row_data ); |
|
362 | + $this->attach_export_data($row_data); |
|
363 | 363 | |
364 | 364 | return $row_data; |
365 | 365 | } |
@@ -368,46 +368,46 @@ discard block |
||
368 | 368 | } |
369 | 369 | |
370 | 370 | // Export Invoices. |
371 | - public function set_invoices_export( $request ) { |
|
372 | - $this->from_date = isset( $request['from_date'] ) ? sanitize_text_field( $request['from_date'] ) : ''; |
|
373 | - $this->to_date = isset( $request['to_date'] ) ? sanitize_text_field( $request['to_date'] ) : ''; |
|
374 | - $this->status = isset( $request['status'] ) ? sanitize_text_field( $request['status'] ) : 'publich'; |
|
371 | + public function set_invoices_export($request) { |
|
372 | + $this->from_date = isset($request['from_date']) ? sanitize_text_field($request['from_date']) : ''; |
|
373 | + $this->to_date = isset($request['to_date']) ? sanitize_text_field($request['to_date']) : ''; |
|
374 | + $this->status = isset($request['status']) ? sanitize_text_field($request['status']) : 'publich'; |
|
375 | 375 | } |
376 | 376 | |
377 | - public function get_invoices_columns( $columns = array() ) { |
|
377 | + public function get_invoices_columns($columns = array()) { |
|
378 | 378 | $columns = array( |
379 | - 'id' => __( 'ID', 'invoicing' ), |
|
380 | - 'number' => __( 'Number', 'invoicing' ), |
|
381 | - 'date' => __( 'Date', 'invoicing' ), |
|
382 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
383 | - 'status_nicename' => __( 'Status Nicename', 'invoicing' ), |
|
384 | - 'status' => __( 'Status', 'invoicing' ), |
|
385 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
386 | - 'discount' => __( 'Discount', 'invoicing' ), |
|
387 | - 'user_id' => __( 'User ID', 'invoicing' ), |
|
388 | - 'email' => __( 'Email', 'invoicing' ), |
|
389 | - 'first_name' => __( 'First Name', 'invoicing' ), |
|
390 | - 'last_name' => __( 'Last Name', 'invoicing' ), |
|
391 | - 'address' => __( 'Address', 'invoicing' ), |
|
392 | - 'city' => __( 'City', 'invoicing' ), |
|
393 | - 'state' => __( 'State', 'invoicing' ), |
|
394 | - 'country' => __( 'Country', 'invoicing' ), |
|
395 | - 'zip' => __( 'Zipcode', 'invoicing' ), |
|
396 | - 'phone' => __( 'Phone', 'invoicing' ), |
|
397 | - 'company' => __( 'Company', 'invoicing' ), |
|
398 | - 'vat_number' => __( 'Vat Number', 'invoicing' ), |
|
399 | - 'ip' => __( 'IP', 'invoicing' ), |
|
400 | - 'gateway' => __( 'Gateway', 'invoicing' ), |
|
401 | - 'gateway_nicename' => __( 'Gateway Nicename', 'invoicing' ), |
|
402 | - 'transaction_id'=> __( 'Transaction ID', 'invoicing' ), |
|
403 | - 'currency' => __( 'Currency', 'invoicing' ), |
|
404 | - 'due_date' => __( 'Due Date', 'invoicing' ), |
|
379 | + 'id' => __('ID', 'invoicing'), |
|
380 | + 'number' => __('Number', 'invoicing'), |
|
381 | + 'date' => __('Date', 'invoicing'), |
|
382 | + 'amount' => __('Amount', 'invoicing'), |
|
383 | + 'status_nicename' => __('Status Nicename', 'invoicing'), |
|
384 | + 'status' => __('Status', 'invoicing'), |
|
385 | + 'tax' => __('Tax', 'invoicing'), |
|
386 | + 'discount' => __('Discount', 'invoicing'), |
|
387 | + 'user_id' => __('User ID', 'invoicing'), |
|
388 | + 'email' => __('Email', 'invoicing'), |
|
389 | + 'first_name' => __('First Name', 'invoicing'), |
|
390 | + 'last_name' => __('Last Name', 'invoicing'), |
|
391 | + 'address' => __('Address', 'invoicing'), |
|
392 | + 'city' => __('City', 'invoicing'), |
|
393 | + 'state' => __('State', 'invoicing'), |
|
394 | + 'country' => __('Country', 'invoicing'), |
|
395 | + 'zip' => __('Zipcode', 'invoicing'), |
|
396 | + 'phone' => __('Phone', 'invoicing'), |
|
397 | + 'company' => __('Company', 'invoicing'), |
|
398 | + 'vat_number' => __('Vat Number', 'invoicing'), |
|
399 | + 'ip' => __('IP', 'invoicing'), |
|
400 | + 'gateway' => __('Gateway', 'invoicing'), |
|
401 | + 'gateway_nicename' => __('Gateway Nicename', 'invoicing'), |
|
402 | + 'transaction_id'=> __('Transaction ID', 'invoicing'), |
|
403 | + 'currency' => __('Currency', 'invoicing'), |
|
404 | + 'due_date' => __('Due Date', 'invoicing'), |
|
405 | 405 | ); |
406 | 406 | |
407 | 407 | return $columns; |
408 | 408 | } |
409 | 409 | |
410 | - public function get_invoices_data( $response = array() ) { |
|
410 | + public function get_invoices_data($response = array()) { |
|
411 | 411 | $args = array( |
412 | 412 | 'limit' => $this->per_page, |
413 | 413 | 'page' => $this->step, |
@@ -415,35 +415,35 @@ discard block |
||
415 | 415 | 'orderby' => 'date', |
416 | 416 | ); |
417 | 417 | |
418 | - if ( $this->status != 'any' ) { |
|
418 | + if ($this->status != 'any') { |
|
419 | 419 | $args['status'] = $this->status; |
420 | 420 | } |
421 | 421 | |
422 | - if ( !empty( $this->from_date ) || !empty( $this->to_date ) ) { |
|
422 | + if (!empty($this->from_date) || !empty($this->to_date)) { |
|
423 | 423 | $args['date_query'] = array( |
424 | 424 | array( |
425 | - 'after' => date( 'Y-n-d 00:00:00', strtotime( $this->from_date ) ), |
|
426 | - 'before' => date( 'Y-n-d 23:59:59', strtotime( $this->to_date ) ), |
|
425 | + 'after' => date('Y-n-d 00:00:00', strtotime($this->from_date)), |
|
426 | + 'before' => date('Y-n-d 23:59:59', strtotime($this->to_date)), |
|
427 | 427 | 'inclusive' => true |
428 | 428 | ) |
429 | 429 | ); |
430 | 430 | } |
431 | 431 | |
432 | - $invoices = wpinv_get_invoices( $args ); |
|
432 | + $invoices = wpinv_get_invoices($args); |
|
433 | 433 | |
434 | 434 | $data = array(); |
435 | 435 | |
436 | - if ( !empty( $invoices ) ) { |
|
437 | - foreach ( $invoices as $invoice ) { |
|
436 | + if (!empty($invoices)) { |
|
437 | + foreach ($invoices as $invoice) { |
|
438 | 438 | $row = array( |
439 | 439 | 'id' => $invoice->ID, |
440 | 440 | 'number' => $invoice->get_number(), |
441 | - 'date' => $invoice->get_invoice_date( false ), |
|
442 | - 'amount' => wpinv_format_amount( $invoice->get_total(), NULL, true ), |
|
443 | - 'status_nicename' => $invoice->get_status( true ), |
|
441 | + 'date' => $invoice->get_invoice_date(false), |
|
442 | + 'amount' => wpinv_format_amount($invoice->get_total(), NULL, true), |
|
443 | + 'status_nicename' => $invoice->get_status(true), |
|
444 | 444 | 'status' => $invoice->get_status(), |
445 | - 'tax' => $invoice->get_tax() > 0 ? wpinv_format_amount( $invoice->get_tax(), NULL, true ) : '', |
|
446 | - 'discount' => $invoice->get_discount() > 0 ? wpinv_format_amount( $invoice->get_discount(), NULL, true ) : '', |
|
445 | + 'tax' => $invoice->get_tax() > 0 ? wpinv_format_amount($invoice->get_tax(), NULL, true) : '', |
|
446 | + 'discount' => $invoice->get_discount() > 0 ? wpinv_format_amount($invoice->get_discount(), NULL, true) : '', |
|
447 | 447 | 'user_id' => $invoice->get_user_id(), |
448 | 448 | 'email' => $invoice->get_email(), |
449 | 449 | 'first_name' => $invoice->get_first_name(), |
@@ -464,7 +464,7 @@ discard block |
||
464 | 464 | 'due_date' => $invoice->needs_payment() ? $invoice->get_due_date() : '', |
465 | 465 | ); |
466 | 466 | |
467 | - $data[] = apply_filters( 'wpinv_export_invoice_row', $row, $invoice ); |
|
467 | + $data[] = apply_filters('wpinv_export_invoice_row', $row, $invoice); |
|
468 | 468 | } |
469 | 469 | |
470 | 470 | return $data; |
@@ -480,29 +480,29 @@ discard block |
||
480 | 480 | 'return' => 'ids', |
481 | 481 | ); |
482 | 482 | |
483 | - if ( $this->status != 'any' ) { |
|
483 | + if ($this->status != 'any') { |
|
484 | 484 | $args['status'] = $this->status; |
485 | 485 | } |
486 | 486 | |
487 | - if ( !empty( $this->from_date ) || !empty( $this->to_date ) ) { |
|
487 | + if (!empty($this->from_date) || !empty($this->to_date)) { |
|
488 | 488 | $args['date_query'] = array( |
489 | 489 | array( |
490 | - 'after' => date( 'Y-n-d 00:00:00', strtotime( $this->from_date ) ), |
|
491 | - 'before' => date( 'Y-n-d 23:59:59', strtotime( $this->to_date ) ), |
|
490 | + 'after' => date('Y-n-d 00:00:00', strtotime($this->from_date)), |
|
491 | + 'before' => date('Y-n-d 23:59:59', strtotime($this->to_date)), |
|
492 | 492 | 'inclusive' => true |
493 | 493 | ) |
494 | 494 | ); |
495 | 495 | } |
496 | 496 | |
497 | - $invoices = wpinv_get_invoices( $args ); |
|
498 | - $total = !empty( $invoices ) ? count( $invoices ) : 0; |
|
497 | + $invoices = wpinv_get_invoices($args); |
|
498 | + $total = !empty($invoices) ? count($invoices) : 0; |
|
499 | 499 | $status = 100; |
500 | 500 | |
501 | - if ( $total > 0 ) { |
|
502 | - $status = ( ( $this->per_page * $this->step ) / $total ) * 100; |
|
501 | + if ($total > 0) { |
|
502 | + $status = (($this->per_page * $this->step) / $total) * 100; |
|
503 | 503 | } |
504 | 504 | |
505 | - if ( $status > 100 ) { |
|
505 | + if ($status > 100) { |
|
506 | 506 | $status = 100; |
507 | 507 | } |
508 | 508 |
@@ -130,7 +130,6 @@ |
||
130 | 130 | private function mostSpecificSubdivision() |
131 | 131 | { |
132 | 132 | return empty($this->subdivisions) ? |
133 | - new \GeoIp2\Record\Subdivision(array(), $this->locales) : |
|
134 | - end($this->subdivisions); |
|
133 | + new \GeoIp2\Record\Subdivision(array(), $this->locales) : end($this->subdivisions); |
|
135 | 134 | } |
136 | 135 | } |
@@ -5,12 +5,12 @@ |
||
5 | 5 | // @codingStandardsIgnoreFile |
6 | 6 | |
7 | 7 | /** |
8 | - * This interface exists to provide backwards compatibility with PHP 5.3 |
|
9 | - * |
|
10 | - * This should _not_ be used by any third-party code. |
|
11 | - * |
|
12 | - * @ignore |
|
13 | - */ |
|
8 | + * This interface exists to provide backwards compatibility with PHP 5.3 |
|
9 | + * |
|
10 | + * This should _not_ be used by any third-party code. |
|
11 | + * |
|
12 | + * @ignore |
|
13 | + */ |
|
14 | 14 | if (interface_exists('JsonSerializable')) { |
15 | 15 | interface JsonSerializable extends \JsonSerializable |
16 | 16 | { |
@@ -9,780 +9,780 @@ |
||
9 | 9 | * @author Roman Ožana <[email protected]> |
10 | 10 | */ |
11 | 11 | class Emogrifier { |
12 | - /** |
|
13 | - * @var string |
|
14 | - */ |
|
15 | - const ENCODING = 'UTF-8'; |
|
16 | - |
|
17 | - /** |
|
18 | - * @var integer |
|
19 | - */ |
|
20 | - const CACHE_KEY_CSS = 0; |
|
21 | - |
|
22 | - /** |
|
23 | - * @var integer |
|
24 | - */ |
|
25 | - const CACHE_KEY_SELECTOR = 1; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var integer |
|
29 | - */ |
|
30 | - const CACHE_KEY_XPATH = 2; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var integer |
|
34 | - */ |
|
35 | - const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
36 | - |
|
37 | - /** |
|
38 | - * for calculating nth-of-type and nth-child selectors. |
|
39 | - * |
|
40 | - * @var integer |
|
41 | - */ |
|
42 | - const INDEX = 0; |
|
43 | - |
|
44 | - /** |
|
45 | - * for calculating nth-of-type and nth-child selectors. |
|
46 | - * |
|
47 | - * @var integer |
|
48 | - */ |
|
49 | - const MULTIPLIER = 1; |
|
50 | - |
|
51 | - /** |
|
52 | - * @var string |
|
53 | - */ |
|
54 | - const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
55 | - |
|
56 | - /** |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
60 | - |
|
61 | - /** |
|
62 | - * @var string |
|
63 | - */ |
|
64 | - private $html = ''; |
|
65 | - |
|
66 | - /** |
|
67 | - * @var string |
|
68 | - */ |
|
69 | - private $css = ''; |
|
70 | - |
|
71 | - /** |
|
72 | - * @var array<string> |
|
73 | - */ |
|
74 | - private $unprocessableHtmlTags = array('wbr'); |
|
75 | - |
|
76 | - /** |
|
77 | - * @var array<array> |
|
78 | - */ |
|
79 | - private $caches = array( |
|
80 | - self::CACHE_KEY_CSS => array(), |
|
81 | - self::CACHE_KEY_SELECTOR => array(), |
|
82 | - self::CACHE_KEY_XPATH => array(), |
|
83 | - self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
84 | - ); |
|
85 | - |
|
86 | - /** |
|
87 | - * the visited nodes with the XPath paths as array keys. |
|
88 | - * |
|
89 | - * @var array<\DOMNode> |
|
90 | - */ |
|
91 | - private $visitedNodes = array(); |
|
92 | - |
|
93 | - /** |
|
94 | - * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
95 | - * as key/value pairs for the inner array. |
|
96 | - * |
|
97 | - * @var array<array><string> |
|
98 | - */ |
|
99 | - private $styleAttributesForNodes = array(); |
|
100 | - |
|
101 | - /** |
|
102 | - * This attribute applies to the case where you want to preserve your original text encoding. |
|
103 | - * |
|
104 | - * By default, emogrifier translates your text into HTML entities for two reasons: |
|
105 | - * |
|
106 | - * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
107 | - * |
|
108 | - * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
109 | - * |
|
110 | - * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
111 | - * |
|
112 | - * @var boolean |
|
113 | - */ |
|
114 | - public $preserveEncoding = false; |
|
115 | - |
|
116 | - public static $_media = ''; |
|
117 | - |
|
118 | - /** |
|
119 | - * The constructor. |
|
120 | - * |
|
121 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
122 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
123 | - */ |
|
124 | - public function __construct($html = '', $css = '') { |
|
125 | - $this->setHtml($html); |
|
126 | - $this->setCss($css); |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * The destructor. |
|
131 | - */ |
|
132 | - public function __destruct() { |
|
133 | - $this->purgeVisitedNodes(); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Sets the HTML to emogrify. |
|
138 | - * |
|
139 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
140 | - */ |
|
141 | - public function setHtml($html = '') { |
|
142 | - $this->html = $html; |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Sets the CSS to merge with the HTML. |
|
147 | - * |
|
148 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
149 | - */ |
|
150 | - public function setCss($css = '') { |
|
151 | - $this->css = $css; |
|
152 | - } |
|
153 | - |
|
154 | - /** |
|
155 | - * Clears all caches. |
|
156 | - */ |
|
157 | - private function clearAllCaches() { |
|
158 | - $this->clearCache(self::CACHE_KEY_CSS); |
|
159 | - $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
160 | - $this->clearCache(self::CACHE_KEY_XPATH); |
|
161 | - $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * Clears a single cache by key. |
|
166 | - * |
|
167 | - * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
168 | - * |
|
169 | - * @throws InvalidArgumentException |
|
170 | - */ |
|
171 | - private function clearCache($key) { |
|
172 | - $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
173 | - if (!in_array($key, $allowedCacheKeys, true)) { |
|
174 | - throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
175 | - } |
|
176 | - |
|
177 | - $this->caches[$key] = array(); |
|
178 | - } |
|
179 | - |
|
180 | - /** |
|
181 | - * Purges the visited nodes. |
|
182 | - */ |
|
183 | - private function purgeVisitedNodes() { |
|
184 | - $this->visitedNodes = array(); |
|
185 | - $this->styleAttributesForNodes = array(); |
|
186 | - } |
|
187 | - |
|
188 | - /** |
|
189 | - * Marks a tag for removal. |
|
190 | - * |
|
191 | - * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
192 | - * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
193 | - * |
|
194 | - * Note: The tags will not be removed if they have any content. |
|
195 | - * |
|
196 | - * @param string $tagName the tag name, e.g., "p" |
|
197 | - */ |
|
198 | - public function addUnprocessableHtmlTag($tagName) { |
|
199 | - $this->unprocessableHtmlTags[] = $tagName; |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Drops a tag from the removal list. |
|
204 | - * |
|
205 | - * @param string $tagName the tag name, e.g., "p" |
|
206 | - */ |
|
207 | - public function removeUnprocessableHtmlTag($tagName) { |
|
208 | - $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
209 | - if ($key !== false) { |
|
210 | - unset($this->unprocessableHtmlTags[$key]); |
|
211 | - } |
|
212 | - } |
|
213 | - |
|
214 | - /** |
|
215 | - * Applies the CSS you submit to the HTML you submit. |
|
216 | - * |
|
217 | - * This method places the CSS inline. |
|
218 | - * |
|
219 | - * @return string |
|
220 | - * |
|
221 | - * @throws BadMethodCallException |
|
222 | - */ |
|
223 | - public function emogrify() { |
|
224 | - if ($this->html === '') { |
|
225 | - throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
226 | - } |
|
227 | - |
|
228 | - $xmlDocument = $this->createXmlDocument(); |
|
229 | - $xpath = new DOMXPath($xmlDocument); |
|
230 | - $this->clearAllCaches(); |
|
231 | - |
|
232 | - // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
233 | - // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
234 | - // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
235 | - $this->purgeVisitedNodes(); |
|
236 | - |
|
237 | - $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
238 | - if ($nodesWithStyleAttributes !== false) { |
|
239 | - /** @var $nodeWithStyleAttribute DOMNode */ |
|
240 | - foreach ($nodesWithStyleAttributes as $node) { |
|
241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
242 | - |
|
243 | - // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
244 | - $nodePath = $node->getNodePath(); |
|
245 | - if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
246 | - $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
247 | - $this->visitedNodes[$nodePath] = $node; |
|
248 | - } |
|
249 | - |
|
250 | - $node->setAttribute('style', $normalizedOriginalStyle); |
|
251 | - } |
|
252 | - } |
|
253 | - |
|
254 | - // grab any existing style blocks from the html and append them to the existing CSS |
|
255 | - // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
256 | - $allCss = $this->css; |
|
257 | - |
|
258 | - $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
259 | - |
|
260 | - $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
261 | - self::$_media = ''; // reset |
|
262 | - |
|
263 | - $cssKey = md5($cssParts['css']); |
|
264 | - if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
265 | - // process the CSS file for selectors and definitions |
|
266 | - preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
267 | - |
|
268 | - $allSelectors = array(); |
|
269 | - foreach ($matches as $key => $selectorString) { |
|
270 | - // if there is a blank definition, skip |
|
271 | - if (!strlen(trim($selectorString[2]))) { |
|
272 | - continue; |
|
273 | - } |
|
274 | - |
|
275 | - // else split by commas and duplicate attributes so we can sort by selector precedence |
|
276 | - $selectors = explode(',', $selectorString[1]); |
|
277 | - foreach ($selectors as $selector) { |
|
278 | - // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
279 | - if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
280 | - continue; |
|
281 | - } |
|
282 | - |
|
283 | - $allSelectors[] = array('selector' => trim($selector), |
|
284 | - 'attributes' => trim($selectorString[2]), |
|
285 | - // keep track of where it appears in the file, since order is important |
|
286 | - 'line' => $key, |
|
287 | - ); |
|
288 | - } |
|
289 | - } |
|
290 | - |
|
291 | - // now sort the selectors by precedence |
|
292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
293 | - |
|
294 | - $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
295 | - } |
|
296 | - |
|
297 | - foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
298 | - // query the body for the xpath selector |
|
299 | - $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
300 | - |
|
301 | - /** @var $node \DOMNode */ |
|
302 | - foreach ($nodesMatchingCssSelectors as $node) { |
|
303 | - // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
304 | - if ($node->hasAttribute('style')) { |
|
305 | - // break it up into an associative array |
|
306 | - $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
307 | - } else { |
|
308 | - $oldStyleDeclarations = array(); |
|
309 | - } |
|
310 | - $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
311 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
312 | - } |
|
313 | - } |
|
314 | - |
|
315 | - // now iterate through the nodes that contained inline styles in the original HTML |
|
316 | - foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
317 | - $node = $this->visitedNodes[$nodePath]; |
|
318 | - $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
319 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
320 | - } |
|
321 | - |
|
322 | - // This removes styles from your email that contain display:none. |
|
323 | - // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
324 | - // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
325 | - // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
326 | - $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
327 | - // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
328 | - // we don't try to call removeChild on a nonexistent child node |
|
329 | - if ($nodesWithStyleDisplayNone->length > 0) { |
|
330 | - /** @var $node \DOMNode */ |
|
331 | - foreach ($nodesWithStyleDisplayNone as $node) { |
|
332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
333 | - $node->parentNode->removeChild($node); |
|
334 | - } |
|
335 | - } |
|
336 | - } |
|
337 | - |
|
338 | - $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
339 | - |
|
340 | - if ($this->preserveEncoding) { |
|
341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
343 | - } else { |
|
344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
345 | - } |
|
346 | - } else { |
|
347 | - return $xmlDocument->saveHTML(); |
|
348 | - } |
|
349 | - } |
|
350 | - |
|
351 | - public function strtolower(array $m) { |
|
352 | - return strtolower($m[0]); |
|
353 | - } |
|
354 | - |
|
355 | - |
|
356 | - /** |
|
357 | - * This method merges old or existing name/value array with new name/value array. |
|
358 | - * and then generates a string of the combined style suitable for placing inline. |
|
359 | - * This becomes the single point for CSS string generation allowing for consistent. |
|
360 | - * CSS output no matter where the CSS originally came from. |
|
361 | - * @param array $oldStyles |
|
362 | - * @param array $newStyles |
|
363 | - * @return string |
|
364 | - */ |
|
365 | - private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
366 | - $combinedStyles = array_merge($oldStyles, $newStyles); |
|
367 | - $style = ''; |
|
368 | - foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
369 | - $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
370 | - } |
|
371 | - return trim($style); |
|
372 | - } |
|
373 | - |
|
374 | - |
|
375 | - /** |
|
376 | - * Copies the media part from CSS array parts to $xmlDocument. |
|
377 | - * |
|
378 | - * @param array $cssParts |
|
379 | - * @param DOMDocument $xmlDocument |
|
380 | - */ |
|
381 | - public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
382 | - if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
383 | - $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
384 | - } |
|
385 | - } |
|
386 | - |
|
387 | - /** |
|
388 | - * Returns CSS content. |
|
389 | - * |
|
390 | - * @param DOMXPath $xpath |
|
391 | - * @return string |
|
392 | - */ |
|
393 | - private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
394 | - $styleNodes = $xpath->query('//style'); |
|
395 | - |
|
396 | - if ($styleNodes === false) { |
|
397 | - return ''; |
|
398 | - } |
|
399 | - |
|
400 | - $css = ''; |
|
401 | - /** @var $styleNode DOMNode */ |
|
402 | - foreach ($styleNodes as $styleNode) { |
|
403 | - $css .= "\n\n" . $styleNode->nodeValue; |
|
404 | - $styleNode->parentNode->removeChild($styleNode); |
|
405 | - } |
|
406 | - |
|
407 | - return $css; |
|
408 | - } |
|
409 | - |
|
410 | - /** |
|
411 | - * Adds a style element with $css to $document. |
|
412 | - * |
|
413 | - * @param DOMDocument $document |
|
414 | - * @param string $css |
|
415 | - */ |
|
416 | - private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
417 | - $styleElement = $document->createElement('style', $css); |
|
418 | - $styleAttribute = $document->createAttribute('type'); |
|
419 | - $styleAttribute->value = 'text/css'; |
|
420 | - $styleElement->appendChild($styleAttribute); |
|
421 | - |
|
422 | - $head = $this->getOrCreateHeadElement($document); |
|
423 | - $head->appendChild($styleElement); |
|
424 | - } |
|
425 | - |
|
426 | - /** |
|
427 | - * Returns the existing or creates a new head element in $document. |
|
428 | - * |
|
429 | - * @param DOMDocument $document |
|
430 | - * @return DOMNode the head element |
|
431 | - */ |
|
432 | - private function getOrCreateHeadElement(DOMDocument $document) { |
|
433 | - $head = $document->getElementsByTagName('head')->item(0); |
|
434 | - |
|
435 | - if ($head === null) { |
|
436 | - $head = $document->createElement('head'); |
|
437 | - $html = $document->getElementsByTagName('html')->item(0); |
|
438 | - $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
439 | - } |
|
440 | - |
|
441 | - return $head; |
|
442 | - } |
|
443 | - |
|
444 | - /** |
|
445 | - * Splits input CSS code to an array where: |
|
446 | - * |
|
447 | - * - key "css" will be contains clean CSS code. |
|
448 | - * - key "media" will be contains all valuable media queries. |
|
449 | - * |
|
450 | - * Example: |
|
451 | - * |
|
452 | - * The CSS code. |
|
453 | - * |
|
454 | - * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
455 | - * |
|
456 | - * will be parsed into the following array: |
|
457 | - * |
|
458 | - * "css" => "h1 { color:red; }" |
|
459 | - * "media" => "@media { h1 {}}" |
|
460 | - * |
|
461 | - * @param string $css |
|
462 | - * @return array |
|
463 | - */ |
|
464 | - private function splitCssAndMediaQuery($css) { |
|
465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
466 | - |
|
467 | - // filter the CSS |
|
468 | - $search = array( |
|
469 | - // get rid of css comment code |
|
470 | - '/\\/\\*.*\\*\\//sU', |
|
471 | - // strip out any import directives |
|
472 | - '/^\\s*@import\\s[^;]+;/misU', |
|
473 | - // strip remains media enclosures |
|
474 | - '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
475 | - ); |
|
476 | - |
|
477 | - $replace = array( |
|
478 | - '', |
|
479 | - '', |
|
480 | - '', |
|
481 | - ); |
|
482 | - |
|
483 | - // clean CSS before output |
|
484 | - $css = preg_replace($search, $replace, $css); |
|
485 | - |
|
486 | - return array('css' => $css, 'media' => self::$_media); |
|
487 | - } |
|
488 | - |
|
489 | - private function _media_concat( $matches ) { |
|
490 | - self::$_media .= $matches[0]; |
|
491 | - } |
|
492 | - |
|
493 | - /** |
|
494 | - * Creates a DOMDocument instance with the current HTML. |
|
495 | - * |
|
496 | - * @return DOMDocument |
|
497 | - */ |
|
498 | - private function createXmlDocument() { |
|
499 | - $xmlDocument = new DOMDocument; |
|
500 | - $xmlDocument->encoding = self::ENCODING; |
|
501 | - $xmlDocument->strictErrorChecking = false; |
|
502 | - $xmlDocument->formatOutput = true; |
|
503 | - $libXmlState = libxml_use_internal_errors(true); |
|
504 | - $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
505 | - libxml_clear_errors(); |
|
506 | - libxml_use_internal_errors($libXmlState); |
|
507 | - $xmlDocument->normalizeDocument(); |
|
508 | - |
|
509 | - return $xmlDocument; |
|
510 | - } |
|
511 | - |
|
512 | - /** |
|
513 | - * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
514 | - * |
|
515 | - * @return string the unified HTML |
|
516 | - * |
|
517 | - * @throws BadMethodCallException |
|
518 | - */ |
|
519 | - private function getUnifiedHtml() { |
|
520 | - if (!empty($this->unprocessableHtmlTags)) { |
|
521 | - $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
522 | - $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
523 | - } else { |
|
524 | - $bodyWithoutUnprocessableTags = $this->html; |
|
525 | - } |
|
526 | - |
|
527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
529 | - } else { |
|
530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
531 | - } |
|
532 | - } |
|
533 | - |
|
534 | - /** |
|
535 | - * @param array $a |
|
536 | - * @param array $b |
|
537 | - * |
|
538 | - * @return integer |
|
539 | - */ |
|
540 | - private function sortBySelectorPrecedence(array $a, array $b) { |
|
541 | - $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
542 | - $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
543 | - |
|
544 | - // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
545 | - // selectors with greater precedence get sorted last. |
|
546 | - // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
547 | - // arithmetic operators. |
|
548 | - // @see http://forge.typo3.org/issues/55605 |
|
549 | - $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
550 | - $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
551 | - return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
552 | - } |
|
553 | - |
|
554 | - /** |
|
555 | - * @param string $selector |
|
556 | - * |
|
557 | - * @return integer |
|
558 | - */ |
|
559 | - private function getCssSelectorPrecedence($selector) { |
|
560 | - $selectorKey = md5($selector); |
|
561 | - if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
562 | - $precedence = 0; |
|
563 | - $value = 100; |
|
564 | - // ids: worth 100, classes: worth 10, elements: worth 1 |
|
565 | - $search = array('\\#','\\.',''); |
|
566 | - |
|
567 | - foreach ($search as $s) { |
|
568 | - if (trim($selector == '')) { |
|
569 | - break; |
|
570 | - } |
|
571 | - $number = 0; |
|
572 | - $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
573 | - $precedence += ($value * $number); |
|
574 | - $value /= 10; |
|
575 | - } |
|
576 | - $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
577 | - } |
|
578 | - |
|
579 | - return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
580 | - } |
|
581 | - |
|
582 | - /** |
|
583 | - * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
584 | - * |
|
585 | - * @see http://plasmasturm.org/log/444/ |
|
586 | - * |
|
587 | - * @param string $paramCssSelector |
|
588 | - * |
|
589 | - * @return string |
|
590 | - */ |
|
591 | - private function translateCssToXpath($paramCssSelector) { |
|
592 | - $cssSelector = ' ' . $paramCssSelector . ' '; |
|
593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
594 | - $cssSelector = trim($cssSelector); |
|
595 | - $xpathKey = md5($cssSelector); |
|
596 | - if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
597 | - // returns an Xpath selector |
|
598 | - $search = array( |
|
599 | - // Matches any element that is a child of parent. |
|
600 | - '/\\s+>\\s+/', |
|
601 | - // Matches any element that is an adjacent sibling. |
|
602 | - '/\\s+\\+\\s+/', |
|
603 | - // Matches any element that is a descendant of an parent element element. |
|
604 | - '/\\s+/', |
|
605 | - // first-child pseudo-selector |
|
606 | - '/([^\\/]+):first-child/i', |
|
607 | - // last-child pseudo-selector |
|
608 | - '/([^\\/]+):last-child/i', |
|
609 | - // Matches attribute only selector |
|
610 | - '/^\\[(\\w+)\\]/', |
|
611 | - // Matches element with attribute |
|
612 | - '/(\\w)\\[(\\w+)\\]/', |
|
613 | - // Matches element with EXACT attribute |
|
614 | - '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
615 | - ); |
|
616 | - $replace = array( |
|
617 | - '/', |
|
618 | - '/following-sibling::*[1]/self::', |
|
619 | - '//', |
|
620 | - '*[1]/self::\\1', |
|
621 | - '*[last()]/self::\\1', |
|
622 | - '*[@\\1]', |
|
623 | - '\\1[@\\2]', |
|
624 | - '\\1[@\\2="\\3"]', |
|
625 | - ); |
|
626 | - |
|
627 | - $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
628 | - |
|
629 | - $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
630 | - $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
631 | - |
|
632 | - // Advanced selectors are going to require a bit more advanced emogrification. |
|
633 | - // When we required PHP 5.3, we could do this with closures. |
|
634 | - $cssSelector = preg_replace_callback( |
|
635 | - '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
636 | - array($this, 'translateNthChild'), $cssSelector |
|
637 | - ); |
|
638 | - $cssSelector = preg_replace_callback( |
|
639 | - '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
640 | - array($this, 'translateNthOfType'), $cssSelector |
|
641 | - ); |
|
642 | - |
|
643 | - $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
644 | - } |
|
645 | - return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
646 | - } |
|
647 | - |
|
648 | - /** |
|
649 | - * @param array $match |
|
650 | - * |
|
651 | - * @return string |
|
652 | - */ |
|
653 | - private function matchIdAttributes(array $match) { |
|
654 | - return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
655 | - } |
|
656 | - |
|
657 | - /** |
|
658 | - * @param array $match |
|
659 | - * |
|
660 | - * @return string |
|
661 | - */ |
|
662 | - private function matchClassAttributes(array $match) { |
|
663 | - return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
664 | - implode( |
|
665 | - '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
666 | - explode('.', substr($match[2], 1)) |
|
667 | - ) . '"," "))]'; |
|
668 | - } |
|
669 | - |
|
670 | - /** |
|
671 | - * @param array $match |
|
672 | - * |
|
673 | - * @return string |
|
674 | - */ |
|
675 | - private function translateNthChild(array $match) { |
|
676 | - $result = $this->parseNth($match); |
|
677 | - |
|
678 | - if (isset($result[self::MULTIPLIER])) { |
|
679 | - if ($result[self::MULTIPLIER] < 0) { |
|
680 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
681 | - return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
682 | - } else { |
|
683 | - return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
684 | - } |
|
685 | - } else { |
|
686 | - return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
687 | - } |
|
688 | - } |
|
689 | - |
|
690 | - /** |
|
691 | - * @param array $match |
|
692 | - * |
|
693 | - * @return string |
|
694 | - */ |
|
695 | - private function translateNthOfType(array $match) { |
|
696 | - $result = $this->parseNth($match); |
|
697 | - |
|
698 | - if (isset($result[self::MULTIPLIER])) { |
|
699 | - if ($result[self::MULTIPLIER] < 0) { |
|
700 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
701 | - return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
702 | - } else { |
|
703 | - return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
704 | - } |
|
705 | - } else { |
|
706 | - return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
707 | - } |
|
708 | - } |
|
709 | - |
|
710 | - /** |
|
711 | - * @param array $match |
|
712 | - * |
|
713 | - * @return array |
|
714 | - */ |
|
715 | - private function parseNth(array $match) { |
|
716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
717 | - $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
718 | - return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
719 | - } elseif (stripos($match[2], 'n') === false) { |
|
720 | - // if there is a multiplier |
|
721 | - $index = intval(str_replace(' ', '', $match[2])); |
|
722 | - return array(self::INDEX => $index); |
|
723 | - } else { |
|
724 | - if (isset($match[3])) { |
|
725 | - $multipleTerm = str_replace($match[3], '', $match[2]); |
|
726 | - $index = intval(str_replace(' ', '', $match[3])); |
|
727 | - } else { |
|
728 | - $multipleTerm = $match[2]; |
|
729 | - $index = 0; |
|
730 | - } |
|
731 | - |
|
732 | - $multiplier = str_ireplace('n', '', $multipleTerm); |
|
733 | - |
|
734 | - if (!strlen($multiplier)) { |
|
735 | - $multiplier = 1; |
|
736 | - } elseif ($multiplier == 0) { |
|
737 | - return array(self::INDEX => $index); |
|
738 | - } else { |
|
739 | - $multiplier = intval($multiplier); |
|
740 | - } |
|
741 | - |
|
742 | - while ($index < 0) { |
|
743 | - $index += abs($multiplier); |
|
744 | - } |
|
745 | - |
|
746 | - return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
747 | - } |
|
748 | - } |
|
749 | - |
|
750 | - /** |
|
751 | - * Parses a CSS declaration block into property name/value pairs. |
|
752 | - * |
|
753 | - * Example: |
|
754 | - * |
|
755 | - * The declaration block. |
|
756 | - * |
|
757 | - * "color: #000; font-weight: bold;". |
|
758 | - * |
|
759 | - * will be parsed into the following array: |
|
760 | - * |
|
761 | - * "color" => "#000" |
|
762 | - * "font-weight" => "bold" |
|
763 | - * |
|
764 | - * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
765 | - * |
|
766 | - * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
767 | - */ |
|
768 | - private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
769 | - if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
770 | - return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
771 | - } |
|
772 | - |
|
773 | - $properties = array(); |
|
774 | - $declarations = explode(';', $cssDeclarationBlock); |
|
775 | - foreach ($declarations as $declaration) { |
|
776 | - $matches = array(); |
|
777 | - if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
778 | - continue; |
|
779 | - } |
|
780 | - $propertyName = strtolower($matches[1]); |
|
781 | - $propertyValue = $matches[2]; |
|
782 | - $properties[$propertyName] = $propertyValue; |
|
783 | - } |
|
784 | - $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
785 | - |
|
786 | - return $properties; |
|
787 | - } |
|
12 | + /** |
|
13 | + * @var string |
|
14 | + */ |
|
15 | + const ENCODING = 'UTF-8'; |
|
16 | + |
|
17 | + /** |
|
18 | + * @var integer |
|
19 | + */ |
|
20 | + const CACHE_KEY_CSS = 0; |
|
21 | + |
|
22 | + /** |
|
23 | + * @var integer |
|
24 | + */ |
|
25 | + const CACHE_KEY_SELECTOR = 1; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var integer |
|
29 | + */ |
|
30 | + const CACHE_KEY_XPATH = 2; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var integer |
|
34 | + */ |
|
35 | + const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
36 | + |
|
37 | + /** |
|
38 | + * for calculating nth-of-type and nth-child selectors. |
|
39 | + * |
|
40 | + * @var integer |
|
41 | + */ |
|
42 | + const INDEX = 0; |
|
43 | + |
|
44 | + /** |
|
45 | + * for calculating nth-of-type and nth-child selectors. |
|
46 | + * |
|
47 | + * @var integer |
|
48 | + */ |
|
49 | + const MULTIPLIER = 1; |
|
50 | + |
|
51 | + /** |
|
52 | + * @var string |
|
53 | + */ |
|
54 | + const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
55 | + |
|
56 | + /** |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
60 | + |
|
61 | + /** |
|
62 | + * @var string |
|
63 | + */ |
|
64 | + private $html = ''; |
|
65 | + |
|
66 | + /** |
|
67 | + * @var string |
|
68 | + */ |
|
69 | + private $css = ''; |
|
70 | + |
|
71 | + /** |
|
72 | + * @var array<string> |
|
73 | + */ |
|
74 | + private $unprocessableHtmlTags = array('wbr'); |
|
75 | + |
|
76 | + /** |
|
77 | + * @var array<array> |
|
78 | + */ |
|
79 | + private $caches = array( |
|
80 | + self::CACHE_KEY_CSS => array(), |
|
81 | + self::CACHE_KEY_SELECTOR => array(), |
|
82 | + self::CACHE_KEY_XPATH => array(), |
|
83 | + self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
84 | + ); |
|
85 | + |
|
86 | + /** |
|
87 | + * the visited nodes with the XPath paths as array keys. |
|
88 | + * |
|
89 | + * @var array<\DOMNode> |
|
90 | + */ |
|
91 | + private $visitedNodes = array(); |
|
92 | + |
|
93 | + /** |
|
94 | + * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
95 | + * as key/value pairs for the inner array. |
|
96 | + * |
|
97 | + * @var array<array><string> |
|
98 | + */ |
|
99 | + private $styleAttributesForNodes = array(); |
|
100 | + |
|
101 | + /** |
|
102 | + * This attribute applies to the case where you want to preserve your original text encoding. |
|
103 | + * |
|
104 | + * By default, emogrifier translates your text into HTML entities for two reasons: |
|
105 | + * |
|
106 | + * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
107 | + * |
|
108 | + * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
109 | + * |
|
110 | + * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
111 | + * |
|
112 | + * @var boolean |
|
113 | + */ |
|
114 | + public $preserveEncoding = false; |
|
115 | + |
|
116 | + public static $_media = ''; |
|
117 | + |
|
118 | + /** |
|
119 | + * The constructor. |
|
120 | + * |
|
121 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
122 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
123 | + */ |
|
124 | + public function __construct($html = '', $css = '') { |
|
125 | + $this->setHtml($html); |
|
126 | + $this->setCss($css); |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * The destructor. |
|
131 | + */ |
|
132 | + public function __destruct() { |
|
133 | + $this->purgeVisitedNodes(); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Sets the HTML to emogrify. |
|
138 | + * |
|
139 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
140 | + */ |
|
141 | + public function setHtml($html = '') { |
|
142 | + $this->html = $html; |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Sets the CSS to merge with the HTML. |
|
147 | + * |
|
148 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
149 | + */ |
|
150 | + public function setCss($css = '') { |
|
151 | + $this->css = $css; |
|
152 | + } |
|
153 | + |
|
154 | + /** |
|
155 | + * Clears all caches. |
|
156 | + */ |
|
157 | + private function clearAllCaches() { |
|
158 | + $this->clearCache(self::CACHE_KEY_CSS); |
|
159 | + $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
160 | + $this->clearCache(self::CACHE_KEY_XPATH); |
|
161 | + $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * Clears a single cache by key. |
|
166 | + * |
|
167 | + * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
168 | + * |
|
169 | + * @throws InvalidArgumentException |
|
170 | + */ |
|
171 | + private function clearCache($key) { |
|
172 | + $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
173 | + if (!in_array($key, $allowedCacheKeys, true)) { |
|
174 | + throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
175 | + } |
|
176 | + |
|
177 | + $this->caches[$key] = array(); |
|
178 | + } |
|
179 | + |
|
180 | + /** |
|
181 | + * Purges the visited nodes. |
|
182 | + */ |
|
183 | + private function purgeVisitedNodes() { |
|
184 | + $this->visitedNodes = array(); |
|
185 | + $this->styleAttributesForNodes = array(); |
|
186 | + } |
|
187 | + |
|
188 | + /** |
|
189 | + * Marks a tag for removal. |
|
190 | + * |
|
191 | + * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
192 | + * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
193 | + * |
|
194 | + * Note: The tags will not be removed if they have any content. |
|
195 | + * |
|
196 | + * @param string $tagName the tag name, e.g., "p" |
|
197 | + */ |
|
198 | + public function addUnprocessableHtmlTag($tagName) { |
|
199 | + $this->unprocessableHtmlTags[] = $tagName; |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Drops a tag from the removal list. |
|
204 | + * |
|
205 | + * @param string $tagName the tag name, e.g., "p" |
|
206 | + */ |
|
207 | + public function removeUnprocessableHtmlTag($tagName) { |
|
208 | + $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
209 | + if ($key !== false) { |
|
210 | + unset($this->unprocessableHtmlTags[$key]); |
|
211 | + } |
|
212 | + } |
|
213 | + |
|
214 | + /** |
|
215 | + * Applies the CSS you submit to the HTML you submit. |
|
216 | + * |
|
217 | + * This method places the CSS inline. |
|
218 | + * |
|
219 | + * @return string |
|
220 | + * |
|
221 | + * @throws BadMethodCallException |
|
222 | + */ |
|
223 | + public function emogrify() { |
|
224 | + if ($this->html === '') { |
|
225 | + throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
226 | + } |
|
227 | + |
|
228 | + $xmlDocument = $this->createXmlDocument(); |
|
229 | + $xpath = new DOMXPath($xmlDocument); |
|
230 | + $this->clearAllCaches(); |
|
231 | + |
|
232 | + // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
233 | + // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
234 | + // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
235 | + $this->purgeVisitedNodes(); |
|
236 | + |
|
237 | + $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
238 | + if ($nodesWithStyleAttributes !== false) { |
|
239 | + /** @var $nodeWithStyleAttribute DOMNode */ |
|
240 | + foreach ($nodesWithStyleAttributes as $node) { |
|
241 | + $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
242 | + |
|
243 | + // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
244 | + $nodePath = $node->getNodePath(); |
|
245 | + if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
246 | + $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
247 | + $this->visitedNodes[$nodePath] = $node; |
|
248 | + } |
|
249 | + |
|
250 | + $node->setAttribute('style', $normalizedOriginalStyle); |
|
251 | + } |
|
252 | + } |
|
253 | + |
|
254 | + // grab any existing style blocks from the html and append them to the existing CSS |
|
255 | + // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
256 | + $allCss = $this->css; |
|
257 | + |
|
258 | + $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
259 | + |
|
260 | + $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
261 | + self::$_media = ''; // reset |
|
262 | + |
|
263 | + $cssKey = md5($cssParts['css']); |
|
264 | + if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
265 | + // process the CSS file for selectors and definitions |
|
266 | + preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
267 | + |
|
268 | + $allSelectors = array(); |
|
269 | + foreach ($matches as $key => $selectorString) { |
|
270 | + // if there is a blank definition, skip |
|
271 | + if (!strlen(trim($selectorString[2]))) { |
|
272 | + continue; |
|
273 | + } |
|
274 | + |
|
275 | + // else split by commas and duplicate attributes so we can sort by selector precedence |
|
276 | + $selectors = explode(',', $selectorString[1]); |
|
277 | + foreach ($selectors as $selector) { |
|
278 | + // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
279 | + if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
280 | + continue; |
|
281 | + } |
|
282 | + |
|
283 | + $allSelectors[] = array('selector' => trim($selector), |
|
284 | + 'attributes' => trim($selectorString[2]), |
|
285 | + // keep track of where it appears in the file, since order is important |
|
286 | + 'line' => $key, |
|
287 | + ); |
|
288 | + } |
|
289 | + } |
|
290 | + |
|
291 | + // now sort the selectors by precedence |
|
292 | + usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
293 | + |
|
294 | + $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
295 | + } |
|
296 | + |
|
297 | + foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
298 | + // query the body for the xpath selector |
|
299 | + $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
300 | + |
|
301 | + /** @var $node \DOMNode */ |
|
302 | + foreach ($nodesMatchingCssSelectors as $node) { |
|
303 | + // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
304 | + if ($node->hasAttribute('style')) { |
|
305 | + // break it up into an associative array |
|
306 | + $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
307 | + } else { |
|
308 | + $oldStyleDeclarations = array(); |
|
309 | + } |
|
310 | + $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
311 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
312 | + } |
|
313 | + } |
|
314 | + |
|
315 | + // now iterate through the nodes that contained inline styles in the original HTML |
|
316 | + foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
317 | + $node = $this->visitedNodes[$nodePath]; |
|
318 | + $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
319 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
320 | + } |
|
321 | + |
|
322 | + // This removes styles from your email that contain display:none. |
|
323 | + // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
324 | + // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
325 | + // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
326 | + $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
327 | + // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
328 | + // we don't try to call removeChild on a nonexistent child node |
|
329 | + if ($nodesWithStyleDisplayNone->length > 0) { |
|
330 | + /** @var $node \DOMNode */ |
|
331 | + foreach ($nodesWithStyleDisplayNone as $node) { |
|
332 | + if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
333 | + $node->parentNode->removeChild($node); |
|
334 | + } |
|
335 | + } |
|
336 | + } |
|
337 | + |
|
338 | + $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
339 | + |
|
340 | + if ($this->preserveEncoding) { |
|
341 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
342 | + return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
343 | + } else { |
|
344 | + return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
345 | + } |
|
346 | + } else { |
|
347 | + return $xmlDocument->saveHTML(); |
|
348 | + } |
|
349 | + } |
|
350 | + |
|
351 | + public function strtolower(array $m) { |
|
352 | + return strtolower($m[0]); |
|
353 | + } |
|
354 | + |
|
355 | + |
|
356 | + /** |
|
357 | + * This method merges old or existing name/value array with new name/value array. |
|
358 | + * and then generates a string of the combined style suitable for placing inline. |
|
359 | + * This becomes the single point for CSS string generation allowing for consistent. |
|
360 | + * CSS output no matter where the CSS originally came from. |
|
361 | + * @param array $oldStyles |
|
362 | + * @param array $newStyles |
|
363 | + * @return string |
|
364 | + */ |
|
365 | + private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
366 | + $combinedStyles = array_merge($oldStyles, $newStyles); |
|
367 | + $style = ''; |
|
368 | + foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
369 | + $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
370 | + } |
|
371 | + return trim($style); |
|
372 | + } |
|
373 | + |
|
374 | + |
|
375 | + /** |
|
376 | + * Copies the media part from CSS array parts to $xmlDocument. |
|
377 | + * |
|
378 | + * @param array $cssParts |
|
379 | + * @param DOMDocument $xmlDocument |
|
380 | + */ |
|
381 | + public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
382 | + if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
383 | + $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
384 | + } |
|
385 | + } |
|
386 | + |
|
387 | + /** |
|
388 | + * Returns CSS content. |
|
389 | + * |
|
390 | + * @param DOMXPath $xpath |
|
391 | + * @return string |
|
392 | + */ |
|
393 | + private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
394 | + $styleNodes = $xpath->query('//style'); |
|
395 | + |
|
396 | + if ($styleNodes === false) { |
|
397 | + return ''; |
|
398 | + } |
|
399 | + |
|
400 | + $css = ''; |
|
401 | + /** @var $styleNode DOMNode */ |
|
402 | + foreach ($styleNodes as $styleNode) { |
|
403 | + $css .= "\n\n" . $styleNode->nodeValue; |
|
404 | + $styleNode->parentNode->removeChild($styleNode); |
|
405 | + } |
|
406 | + |
|
407 | + return $css; |
|
408 | + } |
|
409 | + |
|
410 | + /** |
|
411 | + * Adds a style element with $css to $document. |
|
412 | + * |
|
413 | + * @param DOMDocument $document |
|
414 | + * @param string $css |
|
415 | + */ |
|
416 | + private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
417 | + $styleElement = $document->createElement('style', $css); |
|
418 | + $styleAttribute = $document->createAttribute('type'); |
|
419 | + $styleAttribute->value = 'text/css'; |
|
420 | + $styleElement->appendChild($styleAttribute); |
|
421 | + |
|
422 | + $head = $this->getOrCreateHeadElement($document); |
|
423 | + $head->appendChild($styleElement); |
|
424 | + } |
|
425 | + |
|
426 | + /** |
|
427 | + * Returns the existing or creates a new head element in $document. |
|
428 | + * |
|
429 | + * @param DOMDocument $document |
|
430 | + * @return DOMNode the head element |
|
431 | + */ |
|
432 | + private function getOrCreateHeadElement(DOMDocument $document) { |
|
433 | + $head = $document->getElementsByTagName('head')->item(0); |
|
434 | + |
|
435 | + if ($head === null) { |
|
436 | + $head = $document->createElement('head'); |
|
437 | + $html = $document->getElementsByTagName('html')->item(0); |
|
438 | + $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
439 | + } |
|
440 | + |
|
441 | + return $head; |
|
442 | + } |
|
443 | + |
|
444 | + /** |
|
445 | + * Splits input CSS code to an array where: |
|
446 | + * |
|
447 | + * - key "css" will be contains clean CSS code. |
|
448 | + * - key "media" will be contains all valuable media queries. |
|
449 | + * |
|
450 | + * Example: |
|
451 | + * |
|
452 | + * The CSS code. |
|
453 | + * |
|
454 | + * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
455 | + * |
|
456 | + * will be parsed into the following array: |
|
457 | + * |
|
458 | + * "css" => "h1 { color:red; }" |
|
459 | + * "media" => "@media { h1 {}}" |
|
460 | + * |
|
461 | + * @param string $css |
|
462 | + * @return array |
|
463 | + */ |
|
464 | + private function splitCssAndMediaQuery($css) { |
|
465 | + $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
466 | + |
|
467 | + // filter the CSS |
|
468 | + $search = array( |
|
469 | + // get rid of css comment code |
|
470 | + '/\\/\\*.*\\*\\//sU', |
|
471 | + // strip out any import directives |
|
472 | + '/^\\s*@import\\s[^;]+;/misU', |
|
473 | + // strip remains media enclosures |
|
474 | + '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
475 | + ); |
|
476 | + |
|
477 | + $replace = array( |
|
478 | + '', |
|
479 | + '', |
|
480 | + '', |
|
481 | + ); |
|
482 | + |
|
483 | + // clean CSS before output |
|
484 | + $css = preg_replace($search, $replace, $css); |
|
485 | + |
|
486 | + return array('css' => $css, 'media' => self::$_media); |
|
487 | + } |
|
488 | + |
|
489 | + private function _media_concat( $matches ) { |
|
490 | + self::$_media .= $matches[0]; |
|
491 | + } |
|
492 | + |
|
493 | + /** |
|
494 | + * Creates a DOMDocument instance with the current HTML. |
|
495 | + * |
|
496 | + * @return DOMDocument |
|
497 | + */ |
|
498 | + private function createXmlDocument() { |
|
499 | + $xmlDocument = new DOMDocument; |
|
500 | + $xmlDocument->encoding = self::ENCODING; |
|
501 | + $xmlDocument->strictErrorChecking = false; |
|
502 | + $xmlDocument->formatOutput = true; |
|
503 | + $libXmlState = libxml_use_internal_errors(true); |
|
504 | + $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
505 | + libxml_clear_errors(); |
|
506 | + libxml_use_internal_errors($libXmlState); |
|
507 | + $xmlDocument->normalizeDocument(); |
|
508 | + |
|
509 | + return $xmlDocument; |
|
510 | + } |
|
511 | + |
|
512 | + /** |
|
513 | + * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
514 | + * |
|
515 | + * @return string the unified HTML |
|
516 | + * |
|
517 | + * @throws BadMethodCallException |
|
518 | + */ |
|
519 | + private function getUnifiedHtml() { |
|
520 | + if (!empty($this->unprocessableHtmlTags)) { |
|
521 | + $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
522 | + $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
523 | + } else { |
|
524 | + $bodyWithoutUnprocessableTags = $this->html; |
|
525 | + } |
|
526 | + |
|
527 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
528 | + return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
529 | + } else { |
|
530 | + return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
531 | + } |
|
532 | + } |
|
533 | + |
|
534 | + /** |
|
535 | + * @param array $a |
|
536 | + * @param array $b |
|
537 | + * |
|
538 | + * @return integer |
|
539 | + */ |
|
540 | + private function sortBySelectorPrecedence(array $a, array $b) { |
|
541 | + $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
542 | + $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
543 | + |
|
544 | + // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
545 | + // selectors with greater precedence get sorted last. |
|
546 | + // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
547 | + // arithmetic operators. |
|
548 | + // @see http://forge.typo3.org/issues/55605 |
|
549 | + $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
550 | + $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
551 | + return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
552 | + } |
|
553 | + |
|
554 | + /** |
|
555 | + * @param string $selector |
|
556 | + * |
|
557 | + * @return integer |
|
558 | + */ |
|
559 | + private function getCssSelectorPrecedence($selector) { |
|
560 | + $selectorKey = md5($selector); |
|
561 | + if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
562 | + $precedence = 0; |
|
563 | + $value = 100; |
|
564 | + // ids: worth 100, classes: worth 10, elements: worth 1 |
|
565 | + $search = array('\\#','\\.',''); |
|
566 | + |
|
567 | + foreach ($search as $s) { |
|
568 | + if (trim($selector == '')) { |
|
569 | + break; |
|
570 | + } |
|
571 | + $number = 0; |
|
572 | + $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
573 | + $precedence += ($value * $number); |
|
574 | + $value /= 10; |
|
575 | + } |
|
576 | + $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
577 | + } |
|
578 | + |
|
579 | + return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
580 | + } |
|
581 | + |
|
582 | + /** |
|
583 | + * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
584 | + * |
|
585 | + * @see http://plasmasturm.org/log/444/ |
|
586 | + * |
|
587 | + * @param string $paramCssSelector |
|
588 | + * |
|
589 | + * @return string |
|
590 | + */ |
|
591 | + private function translateCssToXpath($paramCssSelector) { |
|
592 | + $cssSelector = ' ' . $paramCssSelector . ' '; |
|
593 | + $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
594 | + $cssSelector = trim($cssSelector); |
|
595 | + $xpathKey = md5($cssSelector); |
|
596 | + if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
597 | + // returns an Xpath selector |
|
598 | + $search = array( |
|
599 | + // Matches any element that is a child of parent. |
|
600 | + '/\\s+>\\s+/', |
|
601 | + // Matches any element that is an adjacent sibling. |
|
602 | + '/\\s+\\+\\s+/', |
|
603 | + // Matches any element that is a descendant of an parent element element. |
|
604 | + '/\\s+/', |
|
605 | + // first-child pseudo-selector |
|
606 | + '/([^\\/]+):first-child/i', |
|
607 | + // last-child pseudo-selector |
|
608 | + '/([^\\/]+):last-child/i', |
|
609 | + // Matches attribute only selector |
|
610 | + '/^\\[(\\w+)\\]/', |
|
611 | + // Matches element with attribute |
|
612 | + '/(\\w)\\[(\\w+)\\]/', |
|
613 | + // Matches element with EXACT attribute |
|
614 | + '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
615 | + ); |
|
616 | + $replace = array( |
|
617 | + '/', |
|
618 | + '/following-sibling::*[1]/self::', |
|
619 | + '//', |
|
620 | + '*[1]/self::\\1', |
|
621 | + '*[last()]/self::\\1', |
|
622 | + '*[@\\1]', |
|
623 | + '\\1[@\\2]', |
|
624 | + '\\1[@\\2="\\3"]', |
|
625 | + ); |
|
626 | + |
|
627 | + $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
628 | + |
|
629 | + $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
630 | + $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
631 | + |
|
632 | + // Advanced selectors are going to require a bit more advanced emogrification. |
|
633 | + // When we required PHP 5.3, we could do this with closures. |
|
634 | + $cssSelector = preg_replace_callback( |
|
635 | + '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
636 | + array($this, 'translateNthChild'), $cssSelector |
|
637 | + ); |
|
638 | + $cssSelector = preg_replace_callback( |
|
639 | + '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
640 | + array($this, 'translateNthOfType'), $cssSelector |
|
641 | + ); |
|
642 | + |
|
643 | + $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
644 | + } |
|
645 | + return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
646 | + } |
|
647 | + |
|
648 | + /** |
|
649 | + * @param array $match |
|
650 | + * |
|
651 | + * @return string |
|
652 | + */ |
|
653 | + private function matchIdAttributes(array $match) { |
|
654 | + return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
655 | + } |
|
656 | + |
|
657 | + /** |
|
658 | + * @param array $match |
|
659 | + * |
|
660 | + * @return string |
|
661 | + */ |
|
662 | + private function matchClassAttributes(array $match) { |
|
663 | + return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
664 | + implode( |
|
665 | + '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
666 | + explode('.', substr($match[2], 1)) |
|
667 | + ) . '"," "))]'; |
|
668 | + } |
|
669 | + |
|
670 | + /** |
|
671 | + * @param array $match |
|
672 | + * |
|
673 | + * @return string |
|
674 | + */ |
|
675 | + private function translateNthChild(array $match) { |
|
676 | + $result = $this->parseNth($match); |
|
677 | + |
|
678 | + if (isset($result[self::MULTIPLIER])) { |
|
679 | + if ($result[self::MULTIPLIER] < 0) { |
|
680 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
681 | + return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
682 | + } else { |
|
683 | + return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
684 | + } |
|
685 | + } else { |
|
686 | + return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
687 | + } |
|
688 | + } |
|
689 | + |
|
690 | + /** |
|
691 | + * @param array $match |
|
692 | + * |
|
693 | + * @return string |
|
694 | + */ |
|
695 | + private function translateNthOfType(array $match) { |
|
696 | + $result = $this->parseNth($match); |
|
697 | + |
|
698 | + if (isset($result[self::MULTIPLIER])) { |
|
699 | + if ($result[self::MULTIPLIER] < 0) { |
|
700 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
701 | + return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
702 | + } else { |
|
703 | + return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
704 | + } |
|
705 | + } else { |
|
706 | + return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
707 | + } |
|
708 | + } |
|
709 | + |
|
710 | + /** |
|
711 | + * @param array $match |
|
712 | + * |
|
713 | + * @return array |
|
714 | + */ |
|
715 | + private function parseNth(array $match) { |
|
716 | + if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
717 | + $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
718 | + return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
719 | + } elseif (stripos($match[2], 'n') === false) { |
|
720 | + // if there is a multiplier |
|
721 | + $index = intval(str_replace(' ', '', $match[2])); |
|
722 | + return array(self::INDEX => $index); |
|
723 | + } else { |
|
724 | + if (isset($match[3])) { |
|
725 | + $multipleTerm = str_replace($match[3], '', $match[2]); |
|
726 | + $index = intval(str_replace(' ', '', $match[3])); |
|
727 | + } else { |
|
728 | + $multipleTerm = $match[2]; |
|
729 | + $index = 0; |
|
730 | + } |
|
731 | + |
|
732 | + $multiplier = str_ireplace('n', '', $multipleTerm); |
|
733 | + |
|
734 | + if (!strlen($multiplier)) { |
|
735 | + $multiplier = 1; |
|
736 | + } elseif ($multiplier == 0) { |
|
737 | + return array(self::INDEX => $index); |
|
738 | + } else { |
|
739 | + $multiplier = intval($multiplier); |
|
740 | + } |
|
741 | + |
|
742 | + while ($index < 0) { |
|
743 | + $index += abs($multiplier); |
|
744 | + } |
|
745 | + |
|
746 | + return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
747 | + } |
|
748 | + } |
|
749 | + |
|
750 | + /** |
|
751 | + * Parses a CSS declaration block into property name/value pairs. |
|
752 | + * |
|
753 | + * Example: |
|
754 | + * |
|
755 | + * The declaration block. |
|
756 | + * |
|
757 | + * "color: #000; font-weight: bold;". |
|
758 | + * |
|
759 | + * will be parsed into the following array: |
|
760 | + * |
|
761 | + * "color" => "#000" |
|
762 | + * "font-weight" => "bold" |
|
763 | + * |
|
764 | + * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
765 | + * |
|
766 | + * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
767 | + */ |
|
768 | + private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
769 | + if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
770 | + return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
771 | + } |
|
772 | + |
|
773 | + $properties = array(); |
|
774 | + $declarations = explode(';', $cssDeclarationBlock); |
|
775 | + foreach ($declarations as $declaration) { |
|
776 | + $matches = array(); |
|
777 | + if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
778 | + continue; |
|
779 | + } |
|
780 | + $propertyName = strtolower($matches[1]); |
|
781 | + $propertyValue = $matches[2]; |
|
782 | + $properties[$propertyName] = $propertyValue; |
|
783 | + } |
|
784 | + $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
785 | + |
|
786 | + return $properties; |
|
787 | + } |
|
788 | 788 | } |
@@ -238,7 +238,7 @@ discard block |
||
238 | 238 | if ($nodesWithStyleAttributes !== false) { |
239 | 239 | /** @var $nodeWithStyleAttribute DOMNode */ |
240 | 240 | foreach ($nodesWithStyleAttributes as $node) { |
241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
241 | + $normalizedOriginalStyle = preg_replace_callback('/[A-z\\-]+(?=\\:)/S', array($this, 'strtolower'), $node->getAttribute('style')); |
|
242 | 242 | |
243 | 243 | // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
244 | 244 | $nodePath = $node->getNodePath(); |
@@ -289,7 +289,7 @@ discard block |
||
289 | 289 | } |
290 | 290 | |
291 | 291 | // now sort the selectors by precedence |
292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
292 | + usort($allSelectors, array($this, 'sortBySelectorPrecedence')); |
|
293 | 293 | |
294 | 294 | $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
295 | 295 | } |
@@ -329,7 +329,7 @@ discard block |
||
329 | 329 | if ($nodesWithStyleDisplayNone->length > 0) { |
330 | 330 | /** @var $node \DOMNode */ |
331 | 331 | foreach ($nodesWithStyleDisplayNone as $node) { |
332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
332 | + if ($node->parentNode && is_callable(array($node->parentNode, 'removeChild'))) { |
|
333 | 333 | $node->parentNode->removeChild($node); |
334 | 334 | } |
335 | 335 | } |
@@ -338,10 +338,10 @@ discard block |
||
338 | 338 | $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
339 | 339 | |
340 | 340 | if ($this->preserveEncoding) { |
341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
341 | + if (function_exists('mb_convert_encoding')) { |
|
342 | + return mb_convert_encoding($xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES'); |
|
343 | 343 | } else { |
344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
344 | + return htmlspecialchars_decode(utf8_encode(html_entity_decode($xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING))); |
|
345 | 345 | } |
346 | 346 | } else { |
347 | 347 | return $xmlDocument->saveHTML(); |
@@ -462,7 +462,7 @@ discard block |
||
462 | 462 | * @return array |
463 | 463 | */ |
464 | 464 | private function splitCssAndMediaQuery($css) { |
465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
465 | + $css = preg_replace_callback('#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array($this, '_media_concat'), $css); |
|
466 | 466 | |
467 | 467 | // filter the CSS |
468 | 468 | $search = array( |
@@ -486,7 +486,7 @@ discard block |
||
486 | 486 | return array('css' => $css, 'media' => self::$_media); |
487 | 487 | } |
488 | 488 | |
489 | - private function _media_concat( $matches ) { |
|
489 | + private function _media_concat($matches) { |
|
490 | 490 | self::$_media .= $matches[0]; |
491 | 491 | } |
492 | 492 | |
@@ -524,10 +524,10 @@ discard block |
||
524 | 524 | $bodyWithoutUnprocessableTags = $this->html; |
525 | 525 | } |
526 | 526 | |
527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
527 | + if (function_exists('mb_convert_encoding')) { |
|
528 | + return mb_convert_encoding($bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING); |
|
529 | 529 | } else { |
530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
530 | + return htmlspecialchars_decode(utf8_decode(htmlentities($bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false))); |
|
531 | 531 | } |
532 | 532 | } |
533 | 533 | |
@@ -562,7 +562,7 @@ discard block |
||
562 | 562 | $precedence = 0; |
563 | 563 | $value = 100; |
564 | 564 | // ids: worth 100, classes: worth 10, elements: worth 1 |
565 | - $search = array('\\#','\\.',''); |
|
565 | + $search = array('\\#', '\\.', ''); |
|
566 | 566 | |
567 | 567 | foreach ($search as $s) { |
568 | 568 | if (trim($selector == '')) { |
@@ -590,7 +590,7 @@ discard block |
||
590 | 590 | */ |
591 | 591 | private function translateCssToXpath($paramCssSelector) { |
592 | 592 | $cssSelector = ' ' . $paramCssSelector . ' '; |
593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
593 | + $cssSelector = preg_replace_callback('/\s+\w+\s+/', array($this, 'strtolower'), $cssSelector); |
|
594 | 594 | $cssSelector = trim($cssSelector); |
595 | 595 | $xpathKey = md5($cssSelector); |
596 | 596 | if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
@@ -713,7 +713,7 @@ discard block |
||
713 | 713 | * @return array |
714 | 714 | */ |
715 | 715 | private function parseNth(array $match) { |
716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
716 | + if (in_array(strtolower($match[2]), array('even', 'odd'))) { |
|
717 | 717 | $index = strtolower($match[2]) == 'even' ? 0 : 1; |
718 | 718 | return array(self::MULTIPLIER => 2, self::INDEX => $index); |
719 | 719 | } elseif (stripos($match[2], 'n') === false) { |
@@ -8,151 +8,151 @@ |
||
8 | 8 | */ |
9 | 9 | class WP_Session_Command extends \WP_CLI_Command { |
10 | 10 | |
11 | - /** |
|
12 | - * Count the total number of sessions stored in the database. |
|
13 | - * |
|
14 | - * |
|
15 | - * ## EXAMPLES |
|
16 | - * |
|
17 | - * wp session count |
|
18 | - * |
|
19 | - * @global wpdb $wpdb |
|
20 | - * |
|
21 | - * @param array $args |
|
22 | - * @param array $assoc_args |
|
23 | - */ |
|
24 | - public function count( $args, $assoc_args ) { |
|
25 | - $sessions = WP_Session_Utils::count_sessions(); |
|
26 | - |
|
27 | - \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
28 | - } |
|
29 | - |
|
30 | - /** |
|
31 | - * Delete sessions from the database. |
|
32 | - * |
|
33 | - * ## OPTIONS |
|
34 | - * |
|
35 | - * [--all] |
|
36 | - * : Flag whether or not to purge all sessions from the database. |
|
37 | - * |
|
38 | - * [--batch=<batch>] |
|
39 | - * : Set the batch size for deleting old sessions |
|
40 | - * |
|
41 | - * [--limit=<limit>] |
|
42 | - * : Delete just this number of old sessions |
|
43 | - * |
|
44 | - * ## EXAMPLES |
|
45 | - * |
|
46 | - * wp session delete |
|
47 | - * wp session delete [--batch=<batch>] |
|
48 | - * wp session delete [--limit=<limit>] |
|
49 | - * wp session delete [--all] |
|
50 | - * |
|
51 | - * @synopsis [--all] [--batch=<batch>] [--limit=<limit>] |
|
52 | - * |
|
53 | - * @param array $args |
|
54 | - * @param array $assoc_args |
|
55 | - */ |
|
56 | - public function delete( $args, $assoc_args ) { |
|
57 | - if ( isset( $assoc_args['limit'] ) ) { |
|
58 | - $limit = absint( $assoc_args['limit'] ); |
|
59 | - |
|
60 | - $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
61 | - |
|
62 | - if ( $count > 0 ) { |
|
63 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
64 | - } |
|
65 | - |
|
66 | - // Clear memory |
|
67 | - self::free_up_memory(); |
|
68 | - return; |
|
69 | - } |
|
70 | - |
|
71 | - // Determine if we're deleting all sessions or just a subset. |
|
72 | - $all = isset( $assoc_args['all'] ); |
|
73 | - |
|
74 | - /** |
|
75 | - * Determine the size of each batch for deletion. |
|
76 | - * |
|
77 | - * @param int |
|
78 | - */ |
|
79 | - $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
80 | - |
|
81 | - switch ( $all ) { |
|
82 | - case true: |
|
83 | - $count = WP_Session_Utils::delete_all_sessions(); |
|
84 | - |
|
85 | - \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
86 | - break; |
|
87 | - case false: |
|
88 | - do { |
|
89 | - $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
90 | - |
|
91 | - if ( $count > 0 ) { |
|
92 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
93 | - } |
|
94 | - |
|
95 | - // Clear memory |
|
96 | - self::free_up_memory(); |
|
97 | - } while ( $count > 0 ); |
|
98 | - break; |
|
99 | - } |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * Generate a number of dummy sessions for testing purposes. |
|
104 | - * |
|
105 | - * ## OPTIONS |
|
106 | - * |
|
107 | - * <count> |
|
108 | - * : Number of sessions to create. |
|
109 | - * |
|
110 | - * [--expires=<date>] |
|
111 | - * : Optional expiration time tagged for each session. Will use WordPress' local time. |
|
112 | - * |
|
113 | - * ## EXAMPLES |
|
114 | - * |
|
115 | - * wp session generate 5000 |
|
116 | - * wp session generate 5000 --expires="2014-11-09T08:00" |
|
117 | - * |
|
118 | - * @synopsis <count> [--expires=<date>] |
|
119 | - * |
|
120 | - * @param array $args |
|
121 | - * @param array $assoc_args |
|
122 | - */ |
|
123 | - public function generate( $args, $assoc_args ) { |
|
124 | - $count = absint( $args[0] ); |
|
125 | - $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
126 | - |
|
127 | - $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
128 | - |
|
129 | - for ( $i = 0; $i < $count; $i ++ ) { |
|
130 | - WP_Session_Utils::create_dummy_session( $date ); |
|
131 | - $notify->tick(); |
|
132 | - } |
|
133 | - |
|
134 | - $notify->finish(); |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Free up memory |
|
139 | - * |
|
140 | - * @global WP_Object_Cache $wp_object_cache |
|
141 | - * @global wpdb $wpdb |
|
142 | - */ |
|
143 | - private function free_up_memory() { |
|
144 | - global $wp_object_cache, $wpdb; |
|
145 | - $wpdb->queries = array(); |
|
146 | - |
|
147 | - if ( ! is_object( $wp_object_cache ) ) { |
|
148 | - return; |
|
149 | - } |
|
150 | - |
|
151 | - $wp_object_cache->group_ops = array(); |
|
152 | - $wp_object_cache->stats = array(); |
|
153 | - $wp_object_cache->memcache_debug = array(); |
|
154 | - $wp_object_cache->cache = array(); |
|
155 | - } |
|
11 | + /** |
|
12 | + * Count the total number of sessions stored in the database. |
|
13 | + * |
|
14 | + * |
|
15 | + * ## EXAMPLES |
|
16 | + * |
|
17 | + * wp session count |
|
18 | + * |
|
19 | + * @global wpdb $wpdb |
|
20 | + * |
|
21 | + * @param array $args |
|
22 | + * @param array $assoc_args |
|
23 | + */ |
|
24 | + public function count( $args, $assoc_args ) { |
|
25 | + $sessions = WP_Session_Utils::count_sessions(); |
|
26 | + |
|
27 | + \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
28 | + } |
|
29 | + |
|
30 | + /** |
|
31 | + * Delete sessions from the database. |
|
32 | + * |
|
33 | + * ## OPTIONS |
|
34 | + * |
|
35 | + * [--all] |
|
36 | + * : Flag whether or not to purge all sessions from the database. |
|
37 | + * |
|
38 | + * [--batch=<batch>] |
|
39 | + * : Set the batch size for deleting old sessions |
|
40 | + * |
|
41 | + * [--limit=<limit>] |
|
42 | + * : Delete just this number of old sessions |
|
43 | + * |
|
44 | + * ## EXAMPLES |
|
45 | + * |
|
46 | + * wp session delete |
|
47 | + * wp session delete [--batch=<batch>] |
|
48 | + * wp session delete [--limit=<limit>] |
|
49 | + * wp session delete [--all] |
|
50 | + * |
|
51 | + * @synopsis [--all] [--batch=<batch>] [--limit=<limit>] |
|
52 | + * |
|
53 | + * @param array $args |
|
54 | + * @param array $assoc_args |
|
55 | + */ |
|
56 | + public function delete( $args, $assoc_args ) { |
|
57 | + if ( isset( $assoc_args['limit'] ) ) { |
|
58 | + $limit = absint( $assoc_args['limit'] ); |
|
59 | + |
|
60 | + $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
61 | + |
|
62 | + if ( $count > 0 ) { |
|
63 | + \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
64 | + } |
|
65 | + |
|
66 | + // Clear memory |
|
67 | + self::free_up_memory(); |
|
68 | + return; |
|
69 | + } |
|
70 | + |
|
71 | + // Determine if we're deleting all sessions or just a subset. |
|
72 | + $all = isset( $assoc_args['all'] ); |
|
73 | + |
|
74 | + /** |
|
75 | + * Determine the size of each batch for deletion. |
|
76 | + * |
|
77 | + * @param int |
|
78 | + */ |
|
79 | + $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
80 | + |
|
81 | + switch ( $all ) { |
|
82 | + case true: |
|
83 | + $count = WP_Session_Utils::delete_all_sessions(); |
|
84 | + |
|
85 | + \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
86 | + break; |
|
87 | + case false: |
|
88 | + do { |
|
89 | + $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
90 | + |
|
91 | + if ( $count > 0 ) { |
|
92 | + \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
93 | + } |
|
94 | + |
|
95 | + // Clear memory |
|
96 | + self::free_up_memory(); |
|
97 | + } while ( $count > 0 ); |
|
98 | + break; |
|
99 | + } |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * Generate a number of dummy sessions for testing purposes. |
|
104 | + * |
|
105 | + * ## OPTIONS |
|
106 | + * |
|
107 | + * <count> |
|
108 | + * : Number of sessions to create. |
|
109 | + * |
|
110 | + * [--expires=<date>] |
|
111 | + * : Optional expiration time tagged for each session. Will use WordPress' local time. |
|
112 | + * |
|
113 | + * ## EXAMPLES |
|
114 | + * |
|
115 | + * wp session generate 5000 |
|
116 | + * wp session generate 5000 --expires="2014-11-09T08:00" |
|
117 | + * |
|
118 | + * @synopsis <count> [--expires=<date>] |
|
119 | + * |
|
120 | + * @param array $args |
|
121 | + * @param array $assoc_args |
|
122 | + */ |
|
123 | + public function generate( $args, $assoc_args ) { |
|
124 | + $count = absint( $args[0] ); |
|
125 | + $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
126 | + |
|
127 | + $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
128 | + |
|
129 | + for ( $i = 0; $i < $count; $i ++ ) { |
|
130 | + WP_Session_Utils::create_dummy_session( $date ); |
|
131 | + $notify->tick(); |
|
132 | + } |
|
133 | + |
|
134 | + $notify->finish(); |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Free up memory |
|
139 | + * |
|
140 | + * @global WP_Object_Cache $wp_object_cache |
|
141 | + * @global wpdb $wpdb |
|
142 | + */ |
|
143 | + private function free_up_memory() { |
|
144 | + global $wp_object_cache, $wpdb; |
|
145 | + $wpdb->queries = array(); |
|
146 | + |
|
147 | + if ( ! is_object( $wp_object_cache ) ) { |
|
148 | + return; |
|
149 | + } |
|
150 | + |
|
151 | + $wp_object_cache->group_ops = array(); |
|
152 | + $wp_object_cache->stats = array(); |
|
153 | + $wp_object_cache->memcache_debug = array(); |
|
154 | + $wp_object_cache->cache = array(); |
|
155 | + } |
|
156 | 156 | } |
157 | 157 | |
158 | 158 | \WP_CLI::add_command( 'session', 'WP_Session_Command' ); |
159 | 159 | \ No newline at end of file |
@@ -21,10 +21,10 @@ discard block |
||
21 | 21 | * @param array $args |
22 | 22 | * @param array $assoc_args |
23 | 23 | */ |
24 | - public function count( $args, $assoc_args ) { |
|
24 | + public function count($args, $assoc_args) { |
|
25 | 25 | $sessions = WP_Session_Utils::count_sessions(); |
26 | 26 | |
27 | - \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
27 | + \WP_CLI::line(sprintf('%d sessions currently exist.', absint($sessions))); |
|
28 | 28 | } |
29 | 29 | |
30 | 30 | /** |
@@ -53,14 +53,14 @@ discard block |
||
53 | 53 | * @param array $args |
54 | 54 | * @param array $assoc_args |
55 | 55 | */ |
56 | - public function delete( $args, $assoc_args ) { |
|
57 | - if ( isset( $assoc_args['limit'] ) ) { |
|
58 | - $limit = absint( $assoc_args['limit'] ); |
|
56 | + public function delete($args, $assoc_args) { |
|
57 | + if (isset($assoc_args['limit'])) { |
|
58 | + $limit = absint($assoc_args['limit']); |
|
59 | 59 | |
60 | - $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
60 | + $count = WP_Session_Utils::delete_old_sessions($limit); |
|
61 | 61 | |
62 | - if ( $count > 0 ) { |
|
63 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
62 | + if ($count > 0) { |
|
63 | + \WP_CLI::line(sprintf('Deleted %d sessions.', $count)); |
|
64 | 64 | } |
65 | 65 | |
66 | 66 | // Clear memory |
@@ -69,32 +69,32 @@ discard block |
||
69 | 69 | } |
70 | 70 | |
71 | 71 | // Determine if we're deleting all sessions or just a subset. |
72 | - $all = isset( $assoc_args['all'] ); |
|
72 | + $all = isset($assoc_args['all']); |
|
73 | 73 | |
74 | 74 | /** |
75 | 75 | * Determine the size of each batch for deletion. |
76 | 76 | * |
77 | 77 | * @param int |
78 | 78 | */ |
79 | - $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
79 | + $batch = isset($assoc_args['batch']) ? absint($assoc_args['batch']) : apply_filters('wp_session_delete_batch_size', 1000); |
|
80 | 80 | |
81 | - switch ( $all ) { |
|
81 | + switch ($all) { |
|
82 | 82 | case true: |
83 | 83 | $count = WP_Session_Utils::delete_all_sessions(); |
84 | 84 | |
85 | - \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
85 | + \WP_CLI::line(sprintf('Deleted all %d sessions.', $count)); |
|
86 | 86 | break; |
87 | 87 | case false: |
88 | 88 | do { |
89 | - $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
89 | + $count = WP_Session_Utils::delete_old_sessions($batch); |
|
90 | 90 | |
91 | - if ( $count > 0 ) { |
|
92 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
91 | + if ($count > 0) { |
|
92 | + \WP_CLI::line(sprintf('Deleted %d sessions.', $count)); |
|
93 | 93 | } |
94 | 94 | |
95 | 95 | // Clear memory |
96 | 96 | self::free_up_memory(); |
97 | - } while ( $count > 0 ); |
|
97 | + } while ($count > 0); |
|
98 | 98 | break; |
99 | 99 | } |
100 | 100 | } |
@@ -120,14 +120,14 @@ discard block |
||
120 | 120 | * @param array $args |
121 | 121 | * @param array $assoc_args |
122 | 122 | */ |
123 | - public function generate( $args, $assoc_args ) { |
|
124 | - $count = absint( $args[0] ); |
|
125 | - $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
123 | + public function generate($args, $assoc_args) { |
|
124 | + $count = absint($args[0]); |
|
125 | + $date = isset($assoc_args['expires']) ? $assoc_args['expires'] : null; |
|
126 | 126 | |
127 | - $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
127 | + $notify = \WP_CLI\Utils\make_progress_bar('Generating sessions', $count); |
|
128 | 128 | |
129 | - for ( $i = 0; $i < $count; $i ++ ) { |
|
130 | - WP_Session_Utils::create_dummy_session( $date ); |
|
129 | + for ($i = 0; $i < $count; $i++) { |
|
130 | + WP_Session_Utils::create_dummy_session($date); |
|
131 | 131 | $notify->tick(); |
132 | 132 | } |
133 | 133 | |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | global $wp_object_cache, $wpdb; |
145 | 145 | $wpdb->queries = array(); |
146 | 146 | |
147 | - if ( ! is_object( $wp_object_cache ) ) { |
|
147 | + if (!is_object($wp_object_cache)) { |
|
148 | 148 | return; |
149 | 149 | } |
150 | 150 | |
@@ -155,4 +155,4 @@ discard block |
||
155 | 155 | } |
156 | 156 | } |
157 | 157 | |
158 | -\WP_CLI::add_command( 'session', 'WP_Session_Command' ); |
|
159 | 158 | \ No newline at end of file |
159 | +\WP_CLI::add_command('session', 'WP_Session_Command'); |
|
160 | 160 | \ No newline at end of file |
@@ -16,16 +16,16 @@ discard block |
||
16 | 16 | * @return int |
17 | 17 | */ |
18 | 18 | function wp_session_cache_expire() { |
19 | - $wp_session = WP_Session::get_instance(); |
|
19 | + $wp_session = WP_Session::get_instance(); |
|
20 | 20 | |
21 | - return $wp_session->cache_expiration(); |
|
21 | + return $wp_session->cache_expiration(); |
|
22 | 22 | } |
23 | 23 | |
24 | 24 | /** |
25 | 25 | * Alias of wp_session_write_close() |
26 | 26 | */ |
27 | 27 | function wp_session_commit() { |
28 | - wp_session_write_close(); |
|
28 | + wp_session_write_close(); |
|
29 | 29 | } |
30 | 30 | |
31 | 31 | /** |
@@ -34,9 +34,9 @@ discard block |
||
34 | 34 | * @param string $data |
35 | 35 | */ |
36 | 36 | function wp_session_decode( $data ) { |
37 | - $wp_session = WP_Session::get_instance(); |
|
37 | + $wp_session = WP_Session::get_instance(); |
|
38 | 38 | |
39 | - return $wp_session->json_in( $data ); |
|
39 | + return $wp_session->json_in( $data ); |
|
40 | 40 | } |
41 | 41 | |
42 | 42 | /** |
@@ -45,9 +45,9 @@ discard block |
||
45 | 45 | * @return string |
46 | 46 | */ |
47 | 47 | function wp_session_encode() { |
48 | - $wp_session = WP_Session::get_instance(); |
|
48 | + $wp_session = WP_Session::get_instance(); |
|
49 | 49 | |
50 | - return $wp_session->json_out(); |
|
50 | + return $wp_session->json_out(); |
|
51 | 51 | } |
52 | 52 | |
53 | 53 | /** |
@@ -58,11 +58,11 @@ discard block |
||
58 | 58 | * @return bool |
59 | 59 | */ |
60 | 60 | function wp_session_regenerate_id( $delete_old_session = false ) { |
61 | - $wp_session = WP_Session::get_instance(); |
|
61 | + $wp_session = WP_Session::get_instance(); |
|
62 | 62 | |
63 | - $wp_session->regenerate_id( $delete_old_session ); |
|
63 | + $wp_session->regenerate_id( $delete_old_session ); |
|
64 | 64 | |
65 | - return true; |
|
65 | + return true; |
|
66 | 66 | } |
67 | 67 | |
68 | 68 | /** |
@@ -73,13 +73,13 @@ discard block |
||
73 | 73 | * @return bool |
74 | 74 | */ |
75 | 75 | function wp_session_start() { |
76 | - $wp_session = WP_Session::get_instance(); |
|
77 | - do_action( 'wp_session_start' ); |
|
76 | + $wp_session = WP_Session::get_instance(); |
|
77 | + do_action( 'wp_session_start' ); |
|
78 | 78 | |
79 | - return $wp_session->session_started(); |
|
79 | + return $wp_session->session_started(); |
|
80 | 80 | } |
81 | 81 | if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
82 | - add_action( 'plugins_loaded', 'wp_session_start' ); |
|
82 | + add_action( 'plugins_loaded', 'wp_session_start' ); |
|
83 | 83 | } |
84 | 84 | |
85 | 85 | /** |
@@ -88,35 +88,35 @@ discard block |
||
88 | 88 | * @return int |
89 | 89 | */ |
90 | 90 | function wp_session_status() { |
91 | - $wp_session = WP_Session::get_instance(); |
|
91 | + $wp_session = WP_Session::get_instance(); |
|
92 | 92 | |
93 | - if ( $wp_session->session_started() ) { |
|
94 | - return PHP_SESSION_ACTIVE; |
|
95 | - } |
|
93 | + if ( $wp_session->session_started() ) { |
|
94 | + return PHP_SESSION_ACTIVE; |
|
95 | + } |
|
96 | 96 | |
97 | - return PHP_SESSION_NONE; |
|
97 | + return PHP_SESSION_NONE; |
|
98 | 98 | } |
99 | 99 | |
100 | 100 | /** |
101 | 101 | * Unset all session variables. |
102 | 102 | */ |
103 | 103 | function wp_session_unset() { |
104 | - $wp_session = WP_Session::get_instance(); |
|
104 | + $wp_session = WP_Session::get_instance(); |
|
105 | 105 | |
106 | - $wp_session->reset(); |
|
106 | + $wp_session->reset(); |
|
107 | 107 | } |
108 | 108 | |
109 | 109 | /** |
110 | 110 | * Write session data and end session |
111 | 111 | */ |
112 | 112 | function wp_session_write_close() { |
113 | - $wp_session = WP_Session::get_instance(); |
|
113 | + $wp_session = WP_Session::get_instance(); |
|
114 | 114 | |
115 | - $wp_session->write_data(); |
|
116 | - do_action( 'wp_session_commit' ); |
|
115 | + $wp_session->write_data(); |
|
116 | + do_action( 'wp_session_commit' ); |
|
117 | 117 | } |
118 | 118 | if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
119 | - add_action( 'shutdown', 'wp_session_write_close' ); |
|
119 | + add_action( 'shutdown', 'wp_session_write_close' ); |
|
120 | 120 | } |
121 | 121 | |
122 | 122 | /** |
@@ -127,24 +127,24 @@ discard block |
||
127 | 127 | * of a scheduled task or cron job. |
128 | 128 | */ |
129 | 129 | function wp_session_cleanup() { |
130 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
131 | - return; |
|
132 | - } |
|
133 | - |
|
134 | - if ( ! defined( 'WP_INSTALLING' ) ) { |
|
135 | - /** |
|
136 | - * Determine the size of each batch for deletion. |
|
137 | - * |
|
138 | - * @param int |
|
139 | - */ |
|
140 | - $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
141 | - |
|
142 | - // Delete a batch of old sessions |
|
143 | - WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
144 | - } |
|
145 | - |
|
146 | - // Allow other plugins to hook in to the garbage collection process. |
|
147 | - do_action( 'wp_session_cleanup' ); |
|
130 | + if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
131 | + return; |
|
132 | + } |
|
133 | + |
|
134 | + if ( ! defined( 'WP_INSTALLING' ) ) { |
|
135 | + /** |
|
136 | + * Determine the size of each batch for deletion. |
|
137 | + * |
|
138 | + * @param int |
|
139 | + */ |
|
140 | + $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
141 | + |
|
142 | + // Delete a batch of old sessions |
|
143 | + WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
144 | + } |
|
145 | + |
|
146 | + // Allow other plugins to hook in to the garbage collection process. |
|
147 | + do_action( 'wp_session_cleanup' ); |
|
148 | 148 | } |
149 | 149 | add_action( 'wp_session_garbage_collection', 'wp_session_cleanup' ); |
150 | 150 | |
@@ -152,8 +152,8 @@ discard block |
||
152 | 152 | * Register the garbage collector as a twice daily event. |
153 | 153 | */ |
154 | 154 | function wp_session_register_garbage_collection() { |
155 | - if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
156 | - wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
157 | - } |
|
155 | + if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
156 | + wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
157 | + } |
|
158 | 158 | } |
159 | 159 | add_action( 'wp', 'wp_session_register_garbage_collection' ); |
@@ -33,10 +33,10 @@ discard block |
||
33 | 33 | * |
34 | 34 | * @param string $data |
35 | 35 | */ |
36 | -function wp_session_decode( $data ) { |
|
36 | +function wp_session_decode($data) { |
|
37 | 37 | $wp_session = WP_Session::get_instance(); |
38 | 38 | |
39 | - return $wp_session->json_in( $data ); |
|
39 | + return $wp_session->json_in($data); |
|
40 | 40 | } |
41 | 41 | |
42 | 42 | /** |
@@ -57,10 +57,10 @@ discard block |
||
57 | 57 | * |
58 | 58 | * @return bool |
59 | 59 | */ |
60 | -function wp_session_regenerate_id( $delete_old_session = false ) { |
|
60 | +function wp_session_regenerate_id($delete_old_session = false) { |
|
61 | 61 | $wp_session = WP_Session::get_instance(); |
62 | 62 | |
63 | - $wp_session->regenerate_id( $delete_old_session ); |
|
63 | + $wp_session->regenerate_id($delete_old_session); |
|
64 | 64 | |
65 | 65 | return true; |
66 | 66 | } |
@@ -74,12 +74,12 @@ discard block |
||
74 | 74 | */ |
75 | 75 | function wp_session_start() { |
76 | 76 | $wp_session = WP_Session::get_instance(); |
77 | - do_action( 'wp_session_start' ); |
|
77 | + do_action('wp_session_start'); |
|
78 | 78 | |
79 | 79 | return $wp_session->session_started(); |
80 | 80 | } |
81 | -if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
|
82 | - add_action( 'plugins_loaded', 'wp_session_start' ); |
|
81 | +if (!defined('WP_CLI') || false === WP_CLI) { |
|
82 | + add_action('plugins_loaded', 'wp_session_start'); |
|
83 | 83 | } |
84 | 84 | |
85 | 85 | /** |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | function wp_session_status() { |
91 | 91 | $wp_session = WP_Session::get_instance(); |
92 | 92 | |
93 | - if ( $wp_session->session_started() ) { |
|
93 | + if ($wp_session->session_started()) { |
|
94 | 94 | return PHP_SESSION_ACTIVE; |
95 | 95 | } |
96 | 96 | |
@@ -113,10 +113,10 @@ discard block |
||
113 | 113 | $wp_session = WP_Session::get_instance(); |
114 | 114 | |
115 | 115 | $wp_session->write_data(); |
116 | - do_action( 'wp_session_commit' ); |
|
116 | + do_action('wp_session_commit'); |
|
117 | 117 | } |
118 | -if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
|
119 | - add_action( 'shutdown', 'wp_session_write_close' ); |
|
118 | +if (!defined('WP_CLI') || false === WP_CLI) { |
|
119 | + add_action('shutdown', 'wp_session_write_close'); |
|
120 | 120 | } |
121 | 121 | |
122 | 122 | /** |
@@ -127,33 +127,33 @@ discard block |
||
127 | 127 | * of a scheduled task or cron job. |
128 | 128 | */ |
129 | 129 | function wp_session_cleanup() { |
130 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
130 | + if (defined('WP_SETUP_CONFIG')) { |
|
131 | 131 | return; |
132 | 132 | } |
133 | 133 | |
134 | - if ( ! defined( 'WP_INSTALLING' ) ) { |
|
134 | + if (!defined('WP_INSTALLING')) { |
|
135 | 135 | /** |
136 | 136 | * Determine the size of each batch for deletion. |
137 | 137 | * |
138 | 138 | * @param int |
139 | 139 | */ |
140 | - $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
140 | + $batch_size = apply_filters('wp_session_delete_batch_size', 1000); |
|
141 | 141 | |
142 | 142 | // Delete a batch of old sessions |
143 | - WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
143 | + WP_Session_Utils::delete_old_sessions($batch_size); |
|
144 | 144 | } |
145 | 145 | |
146 | 146 | // Allow other plugins to hook in to the garbage collection process. |
147 | - do_action( 'wp_session_cleanup' ); |
|
147 | + do_action('wp_session_cleanup'); |
|
148 | 148 | } |
149 | -add_action( 'wp_session_garbage_collection', 'wp_session_cleanup' ); |
|
149 | +add_action('wp_session_garbage_collection', 'wp_session_cleanup'); |
|
150 | 150 | |
151 | 151 | /** |
152 | 152 | * Register the garbage collector as a twice daily event. |
153 | 153 | */ |
154 | 154 | function wp_session_register_garbage_collection() { |
155 | - if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
156 | - wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
155 | + if (!wp_next_scheduled('wp_session_garbage_collection')) { |
|
156 | + wp_schedule_event(time(), 'hourly', 'wp_session_garbage_collection'); |
|
157 | 157 | } |
158 | 158 | } |
159 | -add_action( 'wp', 'wp_session_register_garbage_collection' ); |
|
159 | +add_action('wp', 'wp_session_register_garbage_collection'); |