WooCommerce PDF Invoices & Packing Slips - Version 1.5.30

Version Description

  • Feature: Enable currency font for extended currency support
  • Fix: Font sync on plugin update
Download this release

Release Info

Developer pomegranate
Plugin Icon 128x128 WooCommerce PDF Invoices & Packing Slips
Version 1.5.30
Comparing to
See all releases

Code changes from version 1.5.29 to 1.5.30

Files changed (7) hide show
  1. includes/class-wcpdf-export.php +1221 -1197
  2. includes/class-wcpdf-settings.php +13 -0
  3. lib/dompdf/lib/fonts/01847c3483fce00998f5049154250e7f.ttf +0 -0
  4. lib/dompdf/lib/fonts/01847c3483fce00998f5049154250e7f.ufm +75 -0
  5. lib/dompdf/lib/fonts/dompdf_font_family_cache.php +7 -0
  6. readme.txt +606 -602
  7. woocommerce-pdf-invoices-packingslips.php +989 -982
includes/class-wcpdf-export.php CHANGED
@@ -1,1197 +1,1221 @@
1
- <?php
2
- /**
3
- * PDF Export class
4
- */
5
- if ( ! class_exists( 'WooCommerce_PDF_Invoices_Export' ) ) {
6
-
7
- class WooCommerce_PDF_Invoices_Export {
8
-
9
- public $template_directory_name;
10
- public $template_base_path;
11
- public $template_default_base_path;
12
- public $template_default_base_uri;
13
- public $template_path;
14
-
15
- public $order;
16
- public $template_type;
17
- public $order_id;
18
- public $output_body;
19
-
20
- /**
21
- * Constructor
22
- */
23
- public function __construct() {
24
- global $woocommerce;
25
- $this->order = new WC_Order('');
26
- $this->general_settings = get_option('wpo_wcpdf_general_settings');
27
- $this->template_settings = get_option('wpo_wcpdf_template_settings');
28
- $this->debug_settings = get_option('wpo_wcpdf_debug_settings');
29
-
30
- $this->template_directory_name = 'pdf';
31
- $this->template_base_path = (defined('WC_TEMPLATE_PATH')?WC_TEMPLATE_PATH:$woocommerce->template_url) . $this->template_directory_name . '/';
32
- $this->template_default_base_path = WooCommerce_PDF_Invoices::$plugin_path . 'templates/' . $this->template_directory_name . '/';
33
- $this->template_default_base_uri = WooCommerce_PDF_Invoices::$plugin_url . 'templates/' . $this->template_directory_name . '/';
34
-
35
- $this->template_path = isset( $this->template_settings['template_path'] )?$this->template_settings['template_path']:'';
36
-
37
- // backwards compatible template path (1.4.4+ uses relative paths instead of absolute)
38
- $backslash_abspath = str_replace('/', '\\', ABSPATH);
39
- if (strpos($this->template_path, ABSPATH) === false && strpos($this->template_path, $backslash_abspath) === false) {
40
- // add site base path, double check it exists!
41
- if ( file_exists( ABSPATH . $this->template_path ) ) {
42
- $this->template_path = ABSPATH . $this->template_path;
43
- }
44
- }
45
-
46
- if ( file_exists( $this->template_path . '/template-functions.php' ) ) {
47
- require_once( $this->template_path . '/template-functions.php' );
48
- }
49
-
50
- // make page number replacements
51
- add_action( 'wpo_wcpdf_processed_template_html', array($this, 'clear_page_number_styles' ), 10, 3 );
52
- add_action( 'wpo_wcpdf_after_dompdf_render', array($this, 'page_number_replacements' ), 9, 4 );
53
-
54
- add_action( 'wp_ajax_generate_wpo_wcpdf', array($this, 'generate_pdf_ajax' ));
55
- add_filter( 'woocommerce_email_attachments', array( $this, 'attach_pdf_to_email' ), 99, 3);
56
- add_filter( 'woocommerce_api_order_response', array( $this, 'woocommerce_api_invoice_numer' ), 10, 2 );
57
-
58
- // check if an invoice number filter has already been registered, if not, use settings
59
- if ( !has_filter( 'wpo_wcpdf_invoice_number' ) ) {
60
- add_filter( 'wpo_wcpdf_invoice_number', array( $this, 'format_invoice_number' ), 20, 4 );
61
- }
62
-
63
- if ( isset($this->debug_settings['enable_debug'])) {
64
- $this->enable_debug();
65
- }
66
-
67
- if ( isset($this->debug_settings['html_output'])) {
68
- add_filter( 'wpo_wcpdf_output_html', '__return_true' );
69
- add_filter( 'wpo_wcpdf_use_path', '__return_false' );
70
- }
71
-
72
- // WooCommerce Subscriptions compatibility
73
- if ( class_exists('WC_Subscriptions') ) {
74
- if ( version_compare( WC_Subscriptions::$version, '2.0', '<' ) ) {
75
- add_action( 'woocommerce_subscriptions_renewal_order_created', array( $this, 'woocommerce_subscriptions_renewal_order_created' ), 10, 4 );
76
- } else {
77
- add_action( 'wcs_renewal_order_created', array( $this, 'wcs_renewal_order_created' ), 10, 2 );
78
- }
79
- }
80
-
81
- // WooCommerce Product Bundles compatibility (add row classes)
82
- if ( class_exists('WC_Bundles') ) {
83
- add_filter( 'wpo_wcpdf_item_row_class', array( $this, 'add_product_bundles_classes' ), 10, 4 );
84
- }
85
-
86
- // WooCommerce Chained Products compatibility (add row classes)
87
- if ( class_exists('SA_WC_Chained_Products') ) {
88
- add_filter( 'wpo_wcpdf_item_row_class', array( $this, 'add_chained_product_class' ), 10, 4 );
89
- }
90
-
91
- // qTranslate-X compatibility
92
- if ( function_exists('qtranxf_useCurrentLanguageIfNotFoundUseDefaultLanguage')) {
93
- $this->qtranslatex_filters();
94
- }
95
- }
96
-
97
- /**
98
- * Install/create plugin tmp folders
99
- */
100
- public function init_tmp ( $tmp_base ) {
101
- // create plugin base temp folder
102
- @mkdir( $tmp_base );
103
-
104
- // create subfolders & protect
105
- $subfolders = array( 'attachments', 'fonts', 'dompdf' );
106
- foreach ( $subfolders as $subfolder ) {
107
- $path = $tmp_base . $subfolder . '/';
108
- @mkdir( $path );
109
-
110
- // copy font files
111
- if ( $subfolder == 'fonts' ) {
112
- $this->copy_fonts( $path );
113
- }
114
-
115
- // create .htaccess file and empty index.php to protect in case an open webfolder is used!
116
- @file_put_contents( $path . '.htaccess', 'deny from all' );
117
- @touch( $path . 'index.php' );
118
- }
119
-
120
- }
121
-
122
- /**
123
- * Copy DOMPDF fonts to wordpress tmp folder
124
- */
125
- public function copy_fonts ( $path ) {
126
- $dompdf_font_dir = WooCommerce_PDF_Invoices::$plugin_path . "lib/dompdf/lib/fonts/";
127
-
128
- // first try the easy way with glob!
129
- if ( function_exists('glob') ) {
130
- $files = glob($dompdf_font_dir."*.*");
131
- foreach($files as $file){
132
- if(!is_dir($file) && is_readable($file)) {
133
- $dest = $path . basename($file);
134
- copy($file, $dest);
135
- }
136
- }
137
- } else {
138
- // fallback method using font cache file (glob is disabled on some servers with disable_functions)
139
- $font_cache_file = $dompdf_font_dir . "dompdf_font_family_cache.php";
140
- $font_cache_dist_file = $dompdf_font_dir . "dompdf_font_family_cache.dist.php";
141
- $fonts = @require_once( $font_cache_file );
142
- $extensions = array( '.ttf', '.ufm', '.ufm.php', '.afm' );
143
-
144
- foreach ($fonts as $font_family => $filenames) {
145
- foreach ($filenames as $filename) {
146
- foreach ($extensions as $extension) {
147
- $file = $filename.$extension;
148
- if (file_exists($file)) {
149
- $dest = $path . basename($file);
150
- copy($file, $dest);
151
- }
152
- }
153
- }
154
- }
155
-
156
- // copy cache files separately
157
- copy($font_cache_file, $path.basename($font_cache_file));
158
- copy($font_cache_dist_file, $path.basename($font_cache_dist_file));
159
- }
160
-
161
- }
162
-
163
- /**
164
- * Return tmp path for different plugin processes
165
- */
166
- public function tmp_path ( $type = '' ) {
167
- // get temp setting
168
- $old_tmp = isset($this->debug_settings['old_tmp']);
169
-
170
- $tmp_base = $this->get_tmp_base();
171
- if (!$old_tmp) {
172
- // check if tmp folder exists => if not, initialize
173
- if ( !@is_dir( $tmp_base ) ) {
174
- $this->init_tmp( $tmp_base );
175
- }
176
- }
177
-
178
- if ( empty( $type ) ) {
179
- return $tmp_base;
180
- }
181
-
182
- switch ( $type ) {
183
- case 'DOMPDF_TEMP_DIR':
184
- // original value : sys_get_temp_dir()
185
- // 1.5+ : $tmp_base . 'dompdf'
186
- $tmp_path = $old_tmp ? sys_get_temp_dir() : $tmp_base . 'dompdf';
187
- break;
188
- case 'DOMPDF_FONT_DIR': // NEEDS TRAILING SLASH!
189
- // original value : DOMPDF_DIR."/lib/fonts/"
190
- // 1.5+ : $tmp_base . 'fonts/'
191
- $tmp_path = $old_tmp ? DOMPDF_DIR."/lib/fonts/" : $tmp_base . 'fonts/';
192
- break;
193
- case 'DOMPDF_FONT_CACHE':
194
- // original value : DOMPDF_FONT_DIR
195
- // 1.5+ : $tmp_base . 'fonts'
196
- $tmp_path = $old_tmp ? DOMPDF_FONT_DIR : $tmp_base . 'fonts';
197
- break;
198
- case 'attachments':
199
- // original value : WooCommerce_PDF_Invoices::$plugin_path . 'tmp/'
200
- // 1.5+ : $tmp_base . 'attachments/'
201
- $tmp_path = $old_tmp ? WooCommerce_PDF_Invoices::$plugin_path . 'tmp/' : $tmp_base . 'attachments/';
202
- break;
203
- default:
204
- $tmp_path = $tmp_base . $type;
205
- break;
206
- }
207
-
208
- // double check for existence, in case tmp_base was installed, but subfolder not created
209
- if ( !@is_dir( $tmp_path ) ) {
210
- @mkdir( $tmp_path );
211
- }
212
-
213
- return $tmp_path;
214
- }
215
-
216
- /**
217
- * return the base tmp folder (usually uploads)
218
- */
219
- public function get_tmp_base () {
220
- // wp_upload_dir() is used to set the base temp folder, under which a
221
- // 'wpo_wcpdf' folder and several subfolders are created
222
- //
223
- // wp_upload_dir() will:
224
- // * default to WP_CONTENT_DIR/uploads
225
- // * UNLESS the ‘UPLOADS’ constant is defined in wp-config (http://codex.wordpress.org/Editing_wp-config.php#Moving_uploads_folder)
226
- //
227
- // May also be overridden by the wpo_wcpdf_tmp_path filter
228
-
229
- $upload_dir = wp_upload_dir();
230
- $upload_base = trailingslashit( $upload_dir['basedir'] );
231
- $tmp_base = trailingslashit( apply_filters( 'wpo_wcpdf_tmp_path', $upload_base . 'wpo_wcpdf/' ) );
232
- return $tmp_base;
233
- }
234
-
235
- /**
236
- * Generate the template output
237
- */
238
- public function process_template( $template_type, $order_ids ) {
239
- $this->template_type = $template_type;
240
- $order_ids = apply_filters( 'wpo_wcpdf_process_order_ids', $order_ids, $template_type );
241
-
242
- // custom function fix
243
- if (function_exists('wpo_wcpdf_payment_form')) {
244
- return false;
245
- }
246
-
247
- // filter out trashed orders
248
- foreach ($order_ids as $key => $order_id) {
249
- $order_status = get_post_status( $order_id );
250
- if ( $order_status == 'trash' ) {
251
- unset( $order_ids[ $key ] );
252
- }
253
- }
254
- // sharing is caring!
255
- $this->order_ids = $order_ids;
256
-
257
- // throw error when no order ids
258
- if ( empty( $order_ids ) ) {
259
- throw new Exception('No orders to export!');
260
- }
261
-
262
- do_action( 'wpo_wcpdf_process_template', $template_type );
263
-
264
- $output_html = array();
265
- foreach ($order_ids as $order_id) {
266
- $this->order = new WC_Order( $order_id );
267
- do_action( 'wpo_wcpdf_process_template_order', $template_type, $order_id );
268
-
269
- $template = $this->template_path . '/' . $template_type . '.php';
270
- $template = apply_filters( 'wpo_wcpdf_template_file', $template, $template_type, $this->order );
271
-
272
- if (!file_exists($template)) {
273
- throw new Exception('Template not found! Check if the following file exists: <pre>'.$template.'</pre><br/>');
274
- }
275
-
276
- // Set the invoice number
277
- if ( $template_type == 'invoice' ) {
278
- $this->set_invoice_number( $order_id );
279
- }
280
-
281
- $output_html[$order_id] = $this->get_template($template);
282
-
283
- // store meta to be able to check if an invoice for an order has been created already
284
- if ( $template_type == 'invoice' ) {
285
- update_post_meta( $order_id, '_wcpdf_invoice_exists', 1 );
286
- }
287
-
288
-
289
- // Wipe post from cache
290
- wp_cache_delete( $order_id, 'posts' );
291
- wp_cache_delete( $order_id, 'post_meta' );
292
- }
293
-
294
- $print_script = "<script language=javascript>window.onload = function(){ window.print(); };</script>";
295
- // <div style="page-break-before: always;"></div>
296
- $page_break = "\n<div style=\"page-break-before: always;\"></div>\n";
297
-
298
-
299
- if (apply_filters('wpo_wcpdf_output_html', false, $template_type) && apply_filters('wpo_wcpdf_print_html', false, $template_type)) {
300
- $this->output_body = $print_script . implode($page_break, $output_html);
301
- } else {
302
- $this->output_body = implode($page_break, $output_html);
303
- }
304
-
305
- // Try to clean up a bit of memory
306
- unset($output_html);
307
-
308
- $template_wrapper = $this->template_path . '/html-document-wrapper.php';
309
-
310
- if (!file_exists($template_wrapper)) {
311
- throw new Exception('Template wrapper not found! Check if the following file exists: <pre>'.$template_wrapper.'</pre><br/>');
312
- }
313
-
314
- $complete_document = $this->get_template($template_wrapper);
315
-
316
- // Try to clean up a bit of memory
317
- unset($this->output_body);
318
-
319
- // clean up special characters
320
- $complete_document = utf8_decode(mb_convert_encoding($complete_document, 'HTML-ENTITIES', 'UTF-8'));
321
-
322
-
323
- return $complete_document;
324
- }
325
-
326
- /**
327
- * Adds spans around placeholders to be able to make replacement (page count) and css (page number)
328
- */
329
- public function clear_page_number_styles ( $html, $template_type, $order_ids ) {
330
- $html = str_replace('{{PAGE_COUNT}}', '<span class="pagecount">{{PAGE_COUNT}}</span>', $html);
331
- $html = str_replace('{{PAGE_NUM}}', '<span class="pagenum"></span>', $html );
332
- return $html;
333
- }
334
-
335
- /**
336
- * Replace {{PAGE_COUNT}} placeholder with total page count
337
- */
338
- public function page_number_replacements ( $dompdf, $html, $template_type, $order_ids ) {
339
- $placeholder = '{{PAGE_COUNT}}';
340
-
341
- // check if placeholder is used
342
- if (strpos($html, $placeholder) !== false ) {
343
- foreach ($dompdf->get_canvas()->get_cpdf()->objects as &$object) {
344
- if (array_key_exists("c", $object) && strpos($object["c"], $placeholder) !== false) {
345
- $object["c"] = str_replace( $placeholder , $dompdf->get_canvas()->get_page_count() , $object["c"] );
346
- }
347
- }
348
- }
349
-
350
- return $dompdf;
351
- }
352
-
353
- /**
354
- * Create & render DOMPDF object
355
- */
356
- public function generate_pdf( $template_type, $order_ids ) {
357
- $paper_size = apply_filters( 'wpo_wcpdf_paper_format', $this->template_settings['paper_size'], $template_type );
358
- $paper_orientation = apply_filters( 'wpo_wcpdf_paper_orientation', 'portrait', $template_type);
359
-
360
- do_action( 'wpo_wcpdf_before_pdf', $template_type );
361
- if ( !class_exists('DOMPDF') ) {
362
- // extra check to avoid clashes with other plugins using DOMPDF
363
- // This could have unwanted side-effects when the version that's already
364
- // loaded is different, and it could also miss fonts etc, but it's better
365
- // than not checking...
366
- require_once( WooCommerce_PDF_Invoices::$plugin_path . "lib/dompdf/dompdf_config.inc.php" );
367
- }
368
-
369
- $dompdf = new DOMPDF();
370
- $html = apply_filters( 'wpo_wcpdf_processed_template_html', $this->process_template( $template_type, $order_ids ), $template_type, $order_ids );
371
- $dompdf->load_html( $html );
372
- $dompdf->set_paper( $paper_size, $paper_orientation );
373
- $dompdf = apply_filters( 'wpo_wcpdf_before_dompdf_render', $dompdf, $html, $template_type, $order_ids );
374
- $dompdf->render();
375
- $dompdf = apply_filters( 'wpo_wcpdf_after_dompdf_render', $dompdf, $html, $template_type, $order_ids );
376
- do_action( 'wpo_wcpdf_after_pdf', $template_type );
377
-
378
- // Try to clean up a bit of memory
379
- unset($complete_pdf);
380
-
381
- return $dompdf;
382
- }
383
-
384
- /**
385
- * Stream PDF
386
- */
387
- public function stream_pdf( $template_type, $order_ids, $filename ) {
388
- $dompdf = $this->generate_pdf( $template_type, $order_ids );
389
- $dompdf->stream($filename);
390
- }
391
-
392
- /**
393
- * Get PDF
394
- */
395
- public function get_pdf( $template_type, $order_ids ) {
396
- try {
397
- $dompdf = $this->generate_pdf( $template_type, $order_ids );
398
- return $dompdf->output();
399
- } catch (Exception $e) {
400
- echo $e->getMessage();
401
- return false;
402
- }
403
-
404
- }
405
-
406
- /**
407
- * Load and generate the template output with ajax
408
- */
409
- public function generate_pdf_ajax() {
410
- // Check the nonce
411
- if( empty( $_GET['action'] ) || ! is_user_logged_in() || !check_admin_referer( $_GET['action'] ) ) {
412
- wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
413
- }
414
-
415
- // Check if all parameters are set
416
- if( empty( $_GET['template_type'] ) || empty( $_GET['order_ids'] ) ) {
417
- wp_die( __( 'Some of the export parameters are missing.', 'wpo_wcpdf' ) );
418
- }
419
-
420
- $order_ids = (array) explode('x',$_GET['order_ids']);
421
- // Process oldest first: reverse $order_ids array
422
- $order_ids = array_reverse($order_ids);
423
-
424
- // Check the user privileges
425
- if( apply_filters( 'wpo_wcpdf_check_privs', !current_user_can( 'manage_woocommerce_orders' ) && !current_user_can( 'edit_shop_orders' ) && !isset( $_GET['my-account'] ), $order_ids ) ) {
426
- wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
427
- }
428
-
429
- // User call from my-account page
430
- if ( isset( $_GET['my-account'] ) ) {
431
- // Only for single orders!
432
- if ( count( $order_ids ) > 1 ) {
433
- wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
434
- }
435
-
436
- // Get user_id of order
437
- $this->order = new WC_Order ( $order_ids[0] );
438
-
439
- // Check if current user is owner of order IMPORTANT!!!
440
- if ( $this->order->user_id != get_current_user_id() ) {
441
- wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
442
- }
443
-
444
- // if we got here, we're safe to go!
445
- }
446
-
447
- // Generate the output
448
- $template_type = $_GET['template_type'];
449
- // die($this->process_template( $template_type, $order_ids )); // or use the filter switch below!
450
-
451
- if (apply_filters('wpo_wcpdf_output_html', false, $template_type)) {
452
- // Output html to browser for debug
453
- // NOTE! images will be loaded with the server path by default
454
- // use the wpo_wcpdf_use_path filter (return false) to change this to http urls
455
- die($this->process_template( $template_type, $order_ids ));
456
- }
457
-
458
- if ( !($pdf = $this->get_pdf( $template_type, $order_ids )) ) {
459
- exit;
460
- }
461
-
462
- $filename = $this->build_filename( $template_type, $order_ids, 'download' );
463
-
464
- do_action( 'wpo_wcpdf_created_manually', $pdf, $filename );
465
-
466
- // Get output setting
467
- $output_mode = isset($this->general_settings['download_display'])?$this->general_settings['download_display']:'';
468
-
469
- // Switch headers according to output setting
470
- if ( $output_mode == 'display' || empty($output_mode) ) {
471
- header('Content-type: application/pdf');
472
- header('Content-Disposition: inline; filename="'.$filename.'"');
473
- } else {
474
- header('Content-Description: File Transfer');
475
- header('Content-Type: application/octet-stream');
476
- header('Content-Disposition: attachment; filename="'.$filename.'"');
477
- header('Content-Transfer-Encoding: binary');
478
- header('Connection: Keep-Alive');
479
- header('Expires: 0');
480
- header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
481
- header('Pragma: public');
482
- }
483
-
484
- // output PDF data
485
- echo($pdf);
486
-
487
- exit;
488
- }
489
-
490
- /**
491
- * Build filename
492
- */
493
- public function build_filename( $template_type, $order_ids, $context ) {
494
- $count = count($order_ids);
495
-
496
- switch ($template_type) {
497
- case 'invoice':
498
- $name = _n( 'invoice', 'invoices', $count, 'wpo_wcpdf' );
499
- $number = $this->get_display_number( $order_ids[0] );
500
- break;
501
- case 'packing-slip':
502
- $name = _n( 'packing-slip', 'packing-slips', $count, 'wpo_wcpdf' );
503
- $number = $this->order->get_order_number();
504
- break;
505
- default:
506
- $name = $template_type;
507
- $number = $this->order->get_order_number();
508
- break;
509
- }
510
-
511
- if ( $count == 1 ) {
512
- $suffix = $number;
513
- } else {
514
- $suffix = date('Y-m-d'); // 2020-11-11
515
- }
516
-
517
- $filename = $name . '-' . $suffix . '.pdf';
518
-
519
- // Filter depending on context (for legacy filter support)
520
- if ( $context == 'download' ) {
521
- $filename = apply_filters( 'wpo_wcpdf_bulk_filename', $filename, $order_ids, $name, $template_type );
522
- } elseif ( $context == 'attachment' ) {
523
- $filename = apply_filters( 'wpo_wcpdf_attachment_filename', $filename, $number, $order_ids[0] );
524
- }
525
-
526
- // Filter filename (use this filter instead of the above legacy filters!)
527
- $filename = apply_filters( 'wpo_wcpdf_filename', $filename, $template_type, $order_ids, $context );
528
-
529
- // sanitize filename (after filters to prevent human errors)!
530
- return sanitize_file_name( $filename );
531
- }
532
-
533
- /**
534
- * Attach invoice to completed order or customer invoice email
535
- */
536
- public function attach_pdf_to_email ( $attachments, $status, $order ) {
537
- // check if all variables properly set
538
- if ( !is_object( $order ) || !isset( $status ) ) {
539
- return $attachments;
540
- }
541
-
542
- // Skip User emails
543
- if ( get_class( $order ) == 'WP_User' ) {
544
- return $attachments;
545
- }
546
-
547
- // WooCommerce Booking compatibility
548
- if ( get_post_type( $order->id ) == 'wc_booking' && isset($order->order) ) {
549
- // $order is actually a WC_Booking object!
550
- $order = $order->order;
551
- }
552
-
553
- // do not process low stock notifications, user emails etc!
554
- if ( in_array( $status, array( 'no_stock', 'low_stock', 'backorder', 'customer_new_account', 'customer_reset_password' ) ) || get_post_type( $order->id ) != 'shop_order' ) {
555
- return $attachments;
556
- }
557
-
558
- // Disable free setting check
559
- $order_total = $order->get_total();
560
- if ( $order_total == 0 && isset($this->general_settings['disable_free']) ) {
561
- return $attachments;
562
- }
563
-
564
- $this->order = $order;
565
-
566
- $tmp_path = $this->tmp_path('attachments');
567
-
568
- // clear pdf files from temp folder (from http://stackoverflow.com/a/13468943/1446634)
569
- array_map('unlink', ( glob( $tmp_path.'*.pdf' ) ? glob( $tmp_path.'*.pdf' ) : array() ) );
570
-
571
- // set allowed statuses for invoices
572
- $invoice_allowed = isset($this->general_settings['email_pdf']) ? array_keys( $this->general_settings['email_pdf'] ) : array();
573
- $documents = array(
574
- 'invoice' => apply_filters( 'wpo_wcpdf_email_allowed_statuses', $invoice_allowed ), // Relevant (default) statuses: new_order, customer_invoice, customer_processing_order, customer_completed_order
575
- );
576
- $documents = apply_filters('wpo_wcpdf_attach_documents', $documents );
577
-
578
- foreach ($documents as $template_type => $allowed_statuses ) {
579
- // convert 'lazy' status name
580
- foreach ($allowed_statuses as $key => $order_status) {
581
- if ($order_status == 'completed' || $order_status == 'processing') {
582
- $allowed_statuses[$key] = "customer_" . $order_status . "_order";
583
- }
584
- }
585
-
586
- // legacy filter, use wpo_wcpdf_custom_attachment_condition instead!
587
- $attach_invoice = apply_filters('wpo_wcpdf_custom_email_condition', true, $order, $status );
588
- if ( $template_type == 'invoice' && !$attach_invoice ) {
589
- // don't attach invoice, continue with other documents
590
- continue;
591
- }
592
-
593
- // use this filter to add an extra condition - return false to disable the PDF attachment
594
- $attach_document = apply_filters('wpo_wcpdf_custom_attachment_condition', true, $order, $status, $template_type );
595
- if( in_array( $status, $allowed_statuses ) && $attach_document ) {
596
- // create pdf data
597
- $pdf_data = $this->get_pdf( $template_type, (array) $order->id );
598
-
599
- if ( !$pdf_data ) {
600
- // something went wrong, continue trying with other documents
601
- continue;
602
- }
603
-
604
- // compose filename
605
- $pdf_filename = $this->build_filename( $template_type, (array) $order->id, 'attachment' );
606
-
607
- $pdf_path = $tmp_path . $pdf_filename;
608
- file_put_contents ( $pdf_path, $pdf_data );
609
- $attachments[] = $pdf_path;
610
-
611
- do_action( 'wpo_wcpdf_email_attachment', $pdf_path, $template_type );
612
- }
613
- }
614
-
615
- return $attachments;
616
- }
617
-
618
- public function set_invoice_number( $order_id ) {
619
- // first check: get invoice number from post meta
620
- $invoice_number = get_post_meta( $order_id, '_wcpdf_invoice_number', true );
621
-
622
- // add invoice number if it doesn't exist
623
- if ( empty($invoice_number) || !isset($invoice_number) ) {
624
- global $wpdb;
625
- // making direct DB call to avoid caching issues
626
- $next_invoice_number = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", 'wpo_wcpdf_next_invoice_number' ) );
627
- $next_invoice_number = apply_filters( 'wpo_wcpdf_next_invoice_number', $next_invoice_number, $order_id );
628
-
629
- if ( empty($next_invoice_number) ) {
630
- // First time! We start numbering from order_number or order_id
631
-
632
- // Check if $order_number is an integer
633
- $order_number = ltrim($this->order->get_order_number(), '#');
634
- if ( ctype_digit( (string)$order_number ) ) {
635
- // order_number == integer: use as starting point.
636
- $invoice_number = $order_number;
637
- } else {
638
- // fallback: use order_id as starting point.
639
- $invoice_number = $order_id;
640
- }
641
-
642
- } else {
643
- $invoice_number = $next_invoice_number;
644
- }
645
-
646
- // reset invoice number yearly
647
- if ( isset( $this->template_settings['yearly_reset_invoice_number'] ) ) {
648
- $current_year = date("Y");
649
- $last_invoice_year = get_option( 'wpo_wcpdf_last_invoice_year' );
650
- // check first time use
651
- if ( empty( $last_invoice_year ) ) {
652
- $last_invoice_year = $current_year;
653
- update_option( 'wpo_wcpdf_last_invoice_year', $current_year );
654
- }
655
- // check if we need to reset
656
- if ( $current_year != $last_invoice_year ) {
657
- $invoice_number = 1;
658
- update_option( 'wpo_wcpdf_last_invoice_year', $current_year );
659
- }
660
- }
661
- // die($invoice_number);
662
-
663
- // invoice number logging
664
- // $order_number = ltrim($this->order->get_order_number(), '#');
665
- // $this->log( $order_id, "Invoice number {$invoice_number} set for order {$order_number} (id {$order_id})" );
666
-
667
- update_post_meta($order_id, '_wcpdf_invoice_number', $invoice_number);
668
- update_post_meta($order_id, '_wcpdf_formatted_invoice_number', $this->get_invoice_number( $order_id ) );
669
-
670
- // increase next_order_number
671
- $update_args = array(
672
- 'option_value' => $invoice_number + 1,
673
- 'autoload' => 'yes',
674
- );
675
- $result = $wpdb->update( $wpdb->options, $update_args, array( 'option_name' => 'wpo_wcpdf_next_invoice_number' ) );
676
- }
677
-
678
- // store invoice_number in class object
679
- $this->invoice_number = $invoice_number;
680
-
681
- // store invoice number in _POST superglobal to prevent the number from being cleared in a save action
682
- // (http://wordpress.org/support/topic/customer-invoice-selection-from-order-detail-page-doesnt-record-invoice-id?replies=1)
683
- $_POST['_wcpdf_invoice_number'] = $invoice_number;
684
-
685
- return $invoice_number;
686
- }
687
-
688
- public function get_invoice_number( $order_id ) {
689
- // get invoice number from post meta
690
- if ( $invoice_number = get_post_meta( $order_id, '_wcpdf_invoice_number', true ) ) {
691
- // check if we have already loaded this order
692
- if ( $this->order->id == $order_id ) {
693
- $order_number = $this->order->get_order_number();
694
- $order_date = $this->order->order_date;
695
- } else {
696
- $order = new WC_Order( $order_id );
697
- $order_number = $order->get_order_number();
698
- $order_date = $order->order_date;
699
- }
700
-
701
- return apply_filters( 'wpo_wcpdf_invoice_number', $invoice_number, $order_number, $order_id, $order_date );
702
- } else {
703
- // no invoice number for this order
704
- return false;
705
- }
706
- }
707
-
708
- /**
709
- * Add invoice number to WC REST API
710
- */
711
- public function woocommerce_api_invoice_numer ( $data, $order ) {
712
- if ( $invoice_number = $this->get_invoice_number( $order->id ) ) {
713
- $data['wpo_wcpdf_invoice_number'] = $invoice_number;
714
- } else {
715
- $data['wpo_wcpdf_invoice_number'] = '';
716
- }
717
- return $data;
718
- }
719
-
720
- /**
721
- * Reset invoice data for WooCommerce subscription renewal orders
722
- * https://wordpress.org/support/topic/subscription-renewal-duplicate-invoice-number?replies=6#post-6138110
723
- */
724
- public function woocommerce_subscriptions_renewal_order_created ( $renewal_order, $original_order, $product_id, $new_order_role ) {
725
- $this->reset_invoice_data( $renewal_order->id );
726
- return $renewal_order;
727
- }
728
-
729
- public function wcs_renewal_order_created ( $renewal_order, $subscription ) {
730
- $this->reset_invoice_data( $renewal_order->id );
731
- return $renewal_order;
732
- }
733
-
734
- public function reset_invoice_data ( $order_id ) {
735
- // delete invoice number, invoice date & invoice exists meta
736
- delete_post_meta( $order_id, '_wcpdf_invoice_number' );
737
- delete_post_meta( $order_id, '_wcpdf_formatted_invoice_number' );
738
- delete_post_meta( $order_id, '_wcpdf_invoice_date' );
739
- delete_post_meta( $order_id, '_wcpdf_invoice_exists' );
740
- }
741
-
742
- public function format_invoice_number( $invoice_number, $order_number, $order_id, $order_date ) {
743
- // get format settings
744
- $formats['prefix'] = isset($this->template_settings['invoice_number_formatting_prefix'])?$this->template_settings['invoice_number_formatting_prefix']:'';
745
- $formats['suffix'] = isset($this->template_settings['invoice_number_formatting_suffix'])?$this->template_settings['invoice_number_formatting_suffix']:'';
746
- $formats['padding'] = isset($this->template_settings['invoice_number_formatting_padding'])?$this->template_settings['invoice_number_formatting_padding']:'';
747
-
748
- // Replacements
749
- $order_year = date_i18n( 'Y', strtotime( $order_date ) );
750
- $order_month = date_i18n( 'm', strtotime( $order_date ) );
751
- $invoice_date = get_post_meta($order_id,'_wcpdf_invoice_date',true);
752
- $invoice_date = empty($invoice_date) ? current_time('mysql') : $invoice_date;
753
- $invoice_year = date_i18n( 'Y', strtotime( $invoice_date ) );
754
- $invoice_month = date_i18n( 'm', strtotime( $invoice_date ) );
755
-
756
- foreach ($formats as $key => $value) {
757
- $value = str_replace('[order_year]', $order_year, $value);
758
- $value = str_replace('[order_month]', $order_month, $value);
759
- $value = str_replace('[invoice_year]', $invoice_year, $value);
760
- $value = str_replace('[invoice_month]', $invoice_month, $value);
761
- $formats[$key] = $value;
762
- }
763
-
764
- // Padding
765
- if ( ctype_digit( (string)$formats['padding'] ) ) {
766
- $invoice_number = sprintf('%0'.$formats['padding'].'d', $invoice_number);
767
- }
768
-
769
- $formatted_invoice_number = $formats['prefix'] . $invoice_number . $formats['suffix'] ;
770
-
771
- return $formatted_invoice_number;
772
- }
773
-
774
- public function get_display_number( $order_id ) {
775
- if ( !isset($this->order->id) ) {
776
- $this->order = new WC_Order ( $order_id );
777
- }
778
-
779
- if ( isset($this->template_settings['display_number']) && $this->template_settings['display_number'] == 'invoice_number' ) {
780
- // use invoice number
781
- $display_number = $this->get_invoice_number( $order_id );
782
- // die($display_number);
783
- } else {
784
- // use order number
785
- $display_number = ltrim($this->order->get_order_number(), '#');
786
- }
787
-
788
- return $display_number;
789
- }
790
-
791
- /**
792
- * Return evaluated template contents
793
- */
794
- public function get_template( $file ) {
795
- ob_start();
796
- if (file_exists($file)) {
797
- include($file);
798
- }
799
- return ob_get_clean();
800
- }
801
-
802
- /**
803
- * Get the current order
804
- */
805
- public function get_order() {
806
- return $this->order;
807
- }
808
-
809
- /**
810
- * Get the current order items
811
- */
812
- public function get_order_items() {
813
- global $woocommerce;
814
- global $_product;
815
-
816
- $items = $this->order->get_items();
817
- $data_list = array();
818
-
819
- if( sizeof( $items ) > 0 ) {
820
- foreach ( $items as $item_id => $item ) {
821
- // Array with data for the pdf template
822
- $data = array();
823
-
824
- // Set the item_id
825
- $data['item_id'] = $item_id;
826
-
827
- // Set the id
828
- $data['product_id'] = $item['product_id'];
829
- $data['variation_id'] = $item['variation_id'];
830
-
831
- // Set item name
832
- $data['name'] = $item['name'];
833
-
834
- // Set item quantity
835
- $data['quantity'] = $item['qty'];
836
-
837
- // Set the line total (=after discount)
838
- $data['line_total'] = $this->wc_price( $item['line_total'] );
839
- $data['single_line_total'] = $this->wc_price( $item['line_total'] / max( 1, $item['qty'] ) );
840
- $data['line_tax'] = $this->wc_price( $item['line_tax'] );
841
- $data['single_line_tax'] = $this->wc_price( $item['line_tax'] / max( 1, $item['qty'] ) );
842
-
843
- $line_tax_data = maybe_unserialize( isset( $item['line_tax_data'] ) ? $item['line_tax_data'] : '' );
844
- $data['tax_rates'] = $this->get_tax_rate( $item['tax_class'], $item['line_total'], $item['line_tax'], $line_tax_data );
845
-
846
- // Set the line subtotal (=before discount)
847
- $data['line_subtotal'] = $this->wc_price( $item['line_subtotal'] );
848
- $data['line_subtotal_tax'] = $this->wc_price( $item['line_subtotal_tax'] );
849
- $data['ex_price'] = $this->get_formatted_item_price ( $item, 'total', 'excl' );
850
- $data['price'] = $this->get_formatted_item_price ( $item, 'total' );
851
- $data['order_price'] = $this->order->get_formatted_line_subtotal( $item ); // formatted according to WC settings
852
-
853
- // Calculate the single price with the same rules as the formatted line subtotal (!)
854
- // = before discount
855
- $data['ex_single_price'] = $this->get_formatted_item_price ( $item, 'single', 'excl' );
856
- $data['single_price'] = $this->get_formatted_item_price ( $item, 'single' );
857
-
858
- // Pass complete item array
859
- $data['item'] = $item;
860
-
861
- // Create the product to display more info
862
- $data['product'] = null;
863
-
864
- $product = $this->order->get_product_from_item( $item );
865
-
866
- // Checking fo existance, thanks to MDesigner0
867
- if(!empty($product)) {
868
- // Set the thumbnail id DEPRICATED (does not support thumbnail sizes), use thumbnail_path or thumbnail instead
869
- $data['thumbnail_id'] = $this->get_thumbnail_id( $product );
870
-
871
- // Thumbnail (full img tag)
872
- $data['thumbnail'] = $this->get_thumbnail ( $product );
873
-
874
- // Set the single price (turned off to use more consistent calculated price)
875
- // $data['single_price'] = woocommerce_price ( $product->get_price() );
876
-
877
- // Set item SKU
878
- $data['sku'] = $product->get_sku();
879
-
880
- // Set item weight
881
- $data['weight'] = $product->get_weight();
882
-
883
- // Set item dimensions
884
- $data['dimensions'] = $product->get_dimensions();
885
-
886
- // Pass complete product object
887
- $data['product'] = $product;
888
-
889
- }
890
-
891
- // Set item meta
892
- if ( version_compare( WOOCOMMERCE_VERSION, '2.4', '<' ) ) {
893
- $meta = new WC_Order_Item_Meta( $item['item_meta'], $product );
894
- } else {
895
- // pass complete item for WC2.4+
896
- $meta = new WC_Order_Item_Meta( $item, $product );
897
- }
898
-
899
- $data['meta'] = $meta->display( false, true );
900
-
901
- $data_list[$item_id] = apply_filters( 'wpo_wcpdf_order_item_data', $data, $this->order );
902
- }
903
- }
904
-
905
- return apply_filters( 'wpo_wcpdf_order_items_data', $data_list, $this->order );
906
- }
907
-
908
- /**
909
- * Gets price - formatted for display.
910
- *
911
- * @access public
912
- * @param mixed $item
913
- * @return string
914
- */
915
- public function get_formatted_item_price ( $item, $type, $tax_display = '' ) {
916
- $item_price = 0;
917
- $divider = ($type == 'single' && $item['qty'] != 0 )?$item['qty']:1; //divide by 1 if $type is not 'single' (thus 'total')
918
-
919
- if ( ! isset( $item['line_subtotal'] ) || ! isset( $item['line_subtotal_tax'] ) )
920
- return;
921
-
922
- if ( $tax_display == 'excl' ) {
923
- $item_price = $this->wc_price( ($this->order->get_line_subtotal( $item )) / $divider );
924
- } else {
925
- $item_price = $this->wc_price( ($this->order->get_line_subtotal( $item, true )) / $divider );
926
- }
927
-
928
- return $item_price;
929
- }
930
-
931
- /**
932
- * wrapper for wc2.1 depricated price function
933
- */
934
- public function wc_price( $price, $args = array() ) {
935
- if ( version_compare( WOOCOMMERCE_VERSION, '2.1' ) >= 0 ) {
936
- // WC 2.1 or newer is used
937
- $args['currency'] = $this->order->get_order_currency();
938
- $formatted_price = wc_price( $price, $args );
939
- } else {
940
- $formatted_price = woocommerce_price( $price );
941
- }
942
-
943
- return $formatted_price;
944
- }
945
-
946
- /**
947
- * Get the tax rates/percentages for a given tax class
948
- * @param string $tax_class tax class slug
949
- * @return string $tax_rates imploded list of tax rates
950
- */
951
- public function get_tax_rate( $tax_class, $line_total, $line_tax, $line_tax_data = '' ) {
952
- if ( $line_tax == 0 ) {
953
- return '-'; // no need to determine tax rate...
954
- }
955
-
956
- // first try the easy wc2.2 way, using line_tax_data
957
- if ( !empty( $line_tax_data ) && isset($line_tax_data['total']) ) {
958
- $tax_rates = array();
959
-
960
- $line_taxes = $line_tax_data['total'];
961
- foreach ( $line_taxes as $tax_id => $tax ) {
962
- if ( !empty($tax) && $tax != 0 ) {
963
- $tax_rates[] = $this->get_tax_rate_by_id( $tax_id ) . ' %';
964
- }
965
- }
966
-
967
- $tax_rates = implode(' ,', $tax_rates );
968
- return $tax_rates;
969
- }
970
-
971
- if ( version_compare( WOOCOMMERCE_VERSION, '2.1' ) >= 0 && !apply_filters( 'wpo_wcpdf_calculate_tax_rate', false ) ) {
972
- // WC 2.1 or newer is used
973
-
974
- // if (empty($tax_class))
975
- // $tax_class = 'standard';// does not appear to work anymore - get_rates does accept an empty tax_class though!
976
-
977
- $tax = new WC_Tax();
978
- $taxes = $tax->get_rates( $tax_class );
979
-
980
- $tax_rates = array();
981
-
982
- foreach ($taxes as $tax) {
983
- $tax_rates[$tax['label']] = round( $tax['rate'], 2 ).' %';
984
- }
985
-
986
- if (empty($tax_rates)) {
987
- // one last try: manually calculate
988
- if ( $line_total != 0) {
989
- $tax_rates[] = round( ($line_tax / $line_total)*100, 1 ).' %';
990
- } else {
991
- $tax_rates[] = '-';
992
- }
993
- }
994
-
995
- $tax_rates = implode(' ,', $tax_rates );
996
- } else {
997
- // Backwards compatibility/fallback: calculate tax from line items
998
- if ( $line_total != 0) {
999
- $tax_rates = round( ($line_tax / $line_total)*100, 1 ).' %';
1000
- } else {
1001
- $tax_rates = '-';
1002
- }
1003
- }
1004
-
1005
- return $tax_rates;
1006
- }
1007
-
1008
- /**
1009
- * Returns the percentage rate (float) for a given tax rate ID.
1010
- * @param int $rate_id woocommerce tax rate id
1011
- * @return float $rate percentage rate
1012
- */
1013
- public function get_tax_rate_by_id( $rate_id ) {
1014
- global $wpdb;
1015
- $rate = $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %d;", $rate_id ) );
1016
- return (float) $rate;
1017
- }
1018
-
1019
- /**
1020
- * Returns a an array with rate_id => tax rate data (array) of all tax rates in woocommerce
1021
- * @return array $tax_rate_ids keyed by id
1022
- */
1023
- public function get_tax_rate_ids() {
1024
- global $wpdb;
1025
- $rates = $wpdb->get_results( "SELECT * FROM {$wpdb->prefix}woocommerce_tax_rates" );
1026
-
1027
- $tax_rate_ids = array();
1028
- foreach ($rates as $rate) {
1029
- // var_dump($rate->tax_rate_id);
1030
- // die($rate);
1031
- $rate_id = $rate->tax_rate_id;
1032
- unset($rate->tax_rate_id);
1033
- $tax_rate_ids[$rate_id] = (array) $rate;
1034
- }
1035
-
1036
- return $tax_rate_ids;
1037
- }
1038
-
1039
- /**
1040
- * Get order custom field
1041
- */
1042
- public function get_order_field( $field ) {
1043
- if( isset( $this->get_order()->order_custom_fields[$field] ) ) {
1044
- return $this->get_order()->order_custom_fields[$field][0];
1045
- }
1046
- return;
1047
- }
1048
-
1049
- /**
1050
- * Returns the main product image ID
1051
- * Adapted from the WC_Product class
1052
- *
1053
- * @access public
1054
- * @return string
1055
- */
1056
- public function get_thumbnail_id ( $product ) {
1057
- // DEPRICATED (does not support thumbnail sizes)
1058
- global $woocommerce;
1059
-
1060
- if ( $product->variation_id && has_post_thumbnail( $product->variation_id ) ) {
1061
- $thumbnail_id = get_post_thumbnail_id ( $product->variation_id );
1062
- } elseif ( has_post_thumbnail( $product->id ) ) {
1063
- $thumbnail_id = get_post_thumbnail_id ( $product->id );
1064
- } elseif ( ( $parent_id = wp_get_post_parent_id( $product->id ) ) && has_post_thumbnail( $parent_id ) ) {
1065
- $thumbnail_id = get_post_thumbnail_id ( $parent_id );
1066
- } else {
1067
- $thumbnail_id = $woocommerce->plugin_url() . '/assets/images/placeholder.png';
1068
- }
1069
-
1070
- return $thumbnail_id;
1071
- }
1072
-
1073
- public function get_thumbnail ( $product ) {
1074
- // Get default WooCommerce img tag (url/http)
1075
- $size = apply_filters( 'wpo_wcpdf_thumbnail_size', 'shop_thumbnail' );
1076
- $thumbnail_img_tag_url = $product->get_image( $size, array( 'title' => '' ) );
1077
-
1078
- // Extract the url from img
1079
- preg_match('/<img(.*)src(.*)=(.*)"(.*)"/U', $thumbnail_img_tag_url, $thumbnail_url );
1080
- // convert url to path
1081
- $thumbnail_path = str_replace( get_site_url() . '/', ABSPATH, array_pop($thumbnail_url));
1082
-
1083
- // Thumbnail (full img tag)
1084
- if (apply_filters('wpo_wcpdf_use_path', true) && file_exists($thumbnail_path)) {
1085
- // load img with server path by default
1086
- $thumbnail = sprintf('<img width="90" height="90" src="%s" class="attachment-shop_thumbnail wp-post-image">', $thumbnail_path );
1087
- } else {
1088
- // load img with http url when filtered
1089
- $thumbnail = $thumbnail_img_tag_url;
1090
- }
1091
-
1092
- // die($thumbnail);
1093
-
1094
- return $thumbnail;
1095
- }
1096
-
1097
- public function add_product_bundles_classes ( $classes, $template_type, $order, $item_id = '' ) {
1098
- if ( empty($item_id) ) {
1099
- // get item id from classes (backwards compatibility fix)
1100
- $class_array = explode(' ', $classes);
1101
- foreach ($class_array as $class) {
1102
- if (is_numeric($class)) {
1103
- $item_id = $class;
1104
- break;
1105
- }
1106
- }
1107
-
1108
- // if still empty, we lost the item id somewhere :(
1109
- if (empty($item_id)) {
1110
- return $classes;
1111
- }
1112
- }
1113
-
1114
- $item_meta = $order->get_item_meta( $item_id );
1115
-
1116
- if (isset($item_meta['_bundled_by'])) {
1117
- $classes = $classes . ' bundled-item';
1118
-
1119
- // check bundled item visibility
1120
- if ( ! empty( $item_meta[ '_bundled_item_hidden' ] ) ) {
1121
- $classes = $classes . ' hidden';
1122
- }
1123
-
1124
- return $classes;
1125
- } elseif (isset($item_meta['_bundled_items'])) {
1126
- return $classes . ' product-bundle';
1127
- }
1128
-
1129
- return $classes;
1130
- }
1131
-
1132
- public function add_chained_product_class ( $classes, $template_type, $order, $item_id = '' ) {
1133
- if ( empty($item_id) ) {
1134
- // get item id from classes (backwards compatibility fix)
1135
- $class_array = explode(' ', $classes);
1136
- foreach ($class_array as $class) {
1137
- if (is_numeric($class)) {
1138
- $item_id = $class;
1139
- break;
1140
- }
1141
- }
1142
-
1143
- // if still empty, we lost the item id somewhere :(
1144
- if (empty($item_id)) {
1145
- return $classes;
1146
- }
1147
- }
1148
-
1149
- $item_meta = $order->get_item_meta( $item_id );
1150
-
1151
- if (isset($item_meta['_chained_product_of'])) {
1152
- return $classes . ' chained-product';
1153
- }
1154
-
1155
- return $classes;
1156
- }
1157
-
1158
- /**
1159
- * Filter plugin strings with qTranslate-X
1160
- */
1161
- public function qtranslatex_filters() {
1162
- $use_filters = array(
1163
- 'wpo_wcpdf_shop_name' => 20,
1164
- 'wpo_wcpdf_shop_address' => 20,
1165
- 'wpo_wcpdf_footer' => 20,
1166
- 'wpo_wcpdf_order_items' => 20,
1167
- 'wpo_wcpdf_payment_method' => 20,
1168
- 'wpo_wcpdf_shipping_method' => 20,
1169
- 'wpo_wcpdf_extra_1' => 20,
1170
- 'wpo_wcpdf_extra_2' => 20,
1171
- 'wpo_wcpdf_extra_3' => 20,
1172
- );
1173
-
1174
- foreach ( $use_filters as $name => $priority ) {
1175
- add_filter( $name, 'qtranxf_useCurrentLanguageIfNotFoundUseDefaultLanguage', $priority );
1176
- }
1177
- }
1178
-
1179
- public function enable_debug () {
1180
- error_reporting( E_ALL );
1181
- ini_set( 'display_errors', 1 );
1182
- }
1183
-
1184
- /**
1185
- * Log messages
1186
- */
1187
-
1188
- public function log( $order_id, $message ) {
1189
- $current_date_time = date("Y-m-d H:i:s");
1190
- $message = $order_id . ' ' . $current_date_time .' ' .$message ."\n";
1191
- $file = $this->tmp_path() . 'log.txt';
1192
-
1193
- file_put_contents($file, $message, FILE_APPEND);
1194
- }
1195
- }
1196
-
1197
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <?php
2
+ /**
3
+ * PDF Export class
4
+ */
5
+ if ( ! class_exists( 'WooCommerce_PDF_Invoices_Export' ) ) {
6
+
7
+ class WooCommerce_PDF_Invoices_Export {
8
+
9
+ public $template_directory_name;
10
+ public $template_base_path;
11
+ public $template_default_base_path;
12
+ public $template_default_base_uri;
13
+ public $template_path;
14
+
15
+ public $order;
16
+ public $template_type;
17
+ public $order_id;
18
+ public $output_body;
19
+
20
+ /**
21
+ * Constructor
22
+ */
23
+ public function __construct() {
24
+ global $woocommerce;
25
+ $this->order = new WC_Order('');
26
+ $this->general_settings = get_option('wpo_wcpdf_general_settings');
27
+ $this->template_settings = get_option('wpo_wcpdf_template_settings');
28
+ $this->debug_settings = get_option('wpo_wcpdf_debug_settings');
29
+
30
+ $this->template_directory_name = 'pdf';
31
+ $this->template_base_path = (defined('WC_TEMPLATE_PATH')?WC_TEMPLATE_PATH:$woocommerce->template_url) . $this->template_directory_name . '/';
32
+ $this->template_default_base_path = WooCommerce_PDF_Invoices::$plugin_path . 'templates/' . $this->template_directory_name . '/';
33
+ $this->template_default_base_uri = WooCommerce_PDF_Invoices::$plugin_url . 'templates/' . $this->template_directory_name . '/';
34
+
35
+ $this->template_path = isset( $this->template_settings['template_path'] )?$this->template_settings['template_path']:'';
36
+
37
+ // backwards compatible template path (1.4.4+ uses relative paths instead of absolute)
38
+ $backslash_abspath = str_replace('/', '\\', ABSPATH);
39
+ if (strpos($this->template_path, ABSPATH) === false && strpos($this->template_path, $backslash_abspath) === false) {
40
+ // add site base path, double check it exists!
41
+ if ( file_exists( ABSPATH . $this->template_path ) ) {
42
+ $this->template_path = ABSPATH . $this->template_path;
43
+ }
44
+ }
45
+
46
+ if ( file_exists( $this->template_path . '/template-functions.php' ) ) {
47
+ require_once( $this->template_path . '/template-functions.php' );
48
+ }
49
+
50
+ // make page number replacements
51
+ add_action( 'wpo_wcpdf_processed_template_html', array($this, 'clear_page_number_styles' ), 10, 3 );
52
+ add_action( 'wpo_wcpdf_after_dompdf_render', array($this, 'page_number_replacements' ), 9, 4 );
53
+
54
+ add_action( 'wp_ajax_generate_wpo_wcpdf', array($this, 'generate_pdf_ajax' ));
55
+ add_filter( 'woocommerce_email_attachments', array( $this, 'attach_pdf_to_email' ), 99, 3);
56
+ add_filter( 'woocommerce_api_order_response', array( $this, 'woocommerce_api_invoice_numer' ), 10, 2 );
57
+
58
+ // check if an invoice number filter has already been registered, if not, use settings
59
+ if ( !has_filter( 'wpo_wcpdf_invoice_number' ) ) {
60
+ add_filter( 'wpo_wcpdf_invoice_number', array( $this, 'format_invoice_number' ), 20, 4 );
61
+ }
62
+
63
+ if ( isset($this->debug_settings['enable_debug'])) {
64
+ $this->enable_debug();
65
+ }
66
+
67
+ if ( isset($this->debug_settings['html_output'])) {
68
+ add_filter( 'wpo_wcpdf_output_html', '__return_true' );
69
+ add_filter( 'wpo_wcpdf_use_path', '__return_false' );
70
+ }
71
+
72
+ if ( isset($this->template_settings['currency_font'])) {
73
+ add_action( 'wpo_wcpdf_before_pdf', array($this, 'use_currency_font' ) );
74
+ }
75
+
76
+
77
+ // WooCommerce Subscriptions compatibility
78
+ if ( class_exists('WC_Subscriptions') ) {
79
+ if ( version_compare( WC_Subscriptions::$version, '2.0', '<' ) ) {
80
+ add_action( 'woocommerce_subscriptions_renewal_order_created', array( $this, 'woocommerce_subscriptions_renewal_order_created' ), 10, 4 );
81
+ } else {
82
+ add_action( 'wcs_renewal_order_created', array( $this, 'wcs_renewal_order_created' ), 10, 2 );
83
+ }
84
+ }
85
+
86
+ // WooCommerce Product Bundles compatibility (add row classes)
87
+ if ( class_exists('WC_Bundles') ) {
88
+ add_filter( 'wpo_wcpdf_item_row_class', array( $this, 'add_product_bundles_classes' ), 10, 4 );
89
+ }
90
+
91
+ // WooCommerce Chained Products compatibility (add row classes)
92
+ if ( class_exists('SA_WC_Chained_Products') ) {
93
+ add_filter( 'wpo_wcpdf_item_row_class', array( $this, 'add_chained_product_class' ), 10, 4 );
94
+ }
95
+
96
+ // qTranslate-X compatibility
97
+ if ( function_exists('qtranxf_useCurrentLanguageIfNotFoundUseDefaultLanguage')) {
98
+ $this->qtranslatex_filters();
99
+ }
100
+ }
101
+
102
+ /**
103
+ * Install/create plugin tmp folders
104
+ */
105
+ public function init_tmp ( $tmp_base ) {
106
+ // create plugin base temp folder
107
+ @mkdir( $tmp_base );
108
+
109
+ // create subfolders & protect
110
+ $subfolders = array( 'attachments', 'fonts', 'dompdf' );
111
+ foreach ( $subfolders as $subfolder ) {
112
+ $path = $tmp_base . $subfolder . '/';
113
+ @mkdir( $path );
114
+
115
+ // copy font files
116
+ if ( $subfolder == 'fonts' ) {
117
+ $this->copy_fonts( $path );
118
+ }
119
+
120
+ // create .htaccess file and empty index.php to protect in case an open webfolder is used!
121
+ @file_put_contents( $path . '.htaccess', 'deny from all' );
122
+ @touch( $path . 'index.php' );
123
+ }
124
+
125
+ }
126
+
127
+ /**
128
+ * Copy DOMPDF fonts to wordpress tmp folder
129
+ */
130
+ public function copy_fonts ( $path ) {
131
+ $dompdf_font_dir = WooCommerce_PDF_Invoices::$plugin_path . "lib/dompdf/lib/fonts/";
132
+
133
+ // first try the easy way with glob!
134
+ if ( function_exists('glob') ) {
135
+ $files = glob($dompdf_font_dir."*.*");
136
+ foreach($files as $file){
137
+ if(!is_dir($file) && is_readable($file)) {
138
+ $dest = $path . basename($file);
139
+ copy($file, $dest);
140
+ }
141
+ }
142
+ } else {
143
+ // fallback method using font cache file (glob is disabled on some servers with disable_functions)
144
+ $font_cache_file = $dompdf_font_dir . "dompdf_font_family_cache.php";
145
+ $font_cache_dist_file = $dompdf_font_dir . "dompdf_font_family_cache.dist.php";
146
+ $fonts = @require_once( $font_cache_file );
147
+ $extensions = array( '.ttf', '.ufm', '.ufm.php', '.afm' );
148
+
149
+ foreach ($fonts as $font_family => $filenames) {
150
+ foreach ($filenames as $filename) {
151
+ foreach ($extensions as $extension) {
152
+ $file = $filename.$extension;
153
+ if (file_exists($file)) {
154
+ $dest = $path . basename($file);
155
+ copy($file, $dest);
156
+ }
157
+ }
158
+ }
159
+ }
160
+
161
+ // copy cache files separately
162
+ copy($font_cache_file, $path.basename($font_cache_file));
163
+ copy($font_cache_dist_file, $path.basename($font_cache_dist_file));
164
+ }
165
+
166
+ }
167
+
168
+ /**
169
+ * Return tmp path for different plugin processes
170
+ */
171
+ public function tmp_path ( $type = '' ) {
172
+ // get temp setting
173
+ $old_tmp = isset($this->debug_settings['old_tmp']);
174
+
175
+ $tmp_base = $this->get_tmp_base();
176
+ if (!$old_tmp) {
177
+ // check if tmp folder exists => if not, initialize
178
+ if ( !@is_dir( $tmp_base ) ) {
179
+ $this->init_tmp( $tmp_base );
180
+ }
181
+ }
182
+
183
+ if ( empty( $type ) ) {
184
+ return $tmp_base;
185
+ }
186
+
187
+ switch ( $type ) {
188
+ case 'DOMPDF_TEMP_DIR':
189
+ // original value : sys_get_temp_dir()
190
+ // 1.5+ : $tmp_base . 'dompdf'
191
+ $tmp_path = $old_tmp ? sys_get_temp_dir() : $tmp_base . 'dompdf';
192
+ break;
193
+ case 'DOMPDF_FONT_DIR': // NEEDS TRAILING SLASH!
194
+ // original value : DOMPDF_DIR."/lib/fonts/"
195
+ // 1.5+ : $tmp_base . 'fonts/'
196
+ $tmp_path = $old_tmp ? DOMPDF_DIR."/lib/fonts/" : $tmp_base . 'fonts/';
197
+ break;
198
+ case 'DOMPDF_FONT_CACHE':
199
+ // original value : DOMPDF_FONT_DIR
200
+ // 1.5+ : $tmp_base . 'fonts'
201
+ $tmp_path = $old_tmp ? DOMPDF_FONT_DIR : $tmp_base . 'fonts';
202
+ break;
203
+ case 'attachments':
204
+ // original value : WooCommerce_PDF_Invoices::$plugin_path . 'tmp/'
205
+ // 1.5+ : $tmp_base . 'attachments/'
206
+ $tmp_path = $old_tmp ? WooCommerce_PDF_Invoices::$plugin_path . 'tmp/' : $tmp_base . 'attachments/';
207
+ break;
208
+ default:
209
+ $tmp_path = $tmp_base . $type;
210
+ break;
211
+ }
212
+
213
+ // double check for existence, in case tmp_base was installed, but subfolder not created
214
+ if ( !@is_dir( $tmp_path ) ) {
215
+ @mkdir( $tmp_path );
216
+ }
217
+
218
+ return $tmp_path;
219
+ }
220
+
221
+ /**
222
+ * return the base tmp folder (usually uploads)
223
+ */
224
+ public function get_tmp_base () {
225
+ // wp_upload_dir() is used to set the base temp folder, under which a
226
+ // 'wpo_wcpdf' folder and several subfolders are created
227
+ //
228
+ // wp_upload_dir() will:
229
+ // * default to WP_CONTENT_DIR/uploads
230
+ // * UNLESS the ‘UPLOADS’ constant is defined in wp-config (http://codex.wordpress.org/Editing_wp-config.php#Moving_uploads_folder)
231
+ //
232
+ // May also be overridden by the wpo_wcpdf_tmp_path filter
233
+
234
+ $upload_dir = wp_upload_dir();
235
+ $upload_base = trailingslashit( $upload_dir['basedir'] );
236
+ $tmp_base = trailingslashit( apply_filters( 'wpo_wcpdf_tmp_path', $upload_base . 'wpo_wcpdf/' ) );
237
+ return $tmp_base;
238
+ }
239
+
240
+ /**
241
+ * Generate the template output
242
+ */
243
+ public function process_template( $template_type, $order_ids ) {
244
+ $this->template_type = $template_type;
245
+ $order_ids = apply_filters( 'wpo_wcpdf_process_order_ids', $order_ids, $template_type );
246
+
247
+ // custom function fix
248
+ if (function_exists('wpo_wcpdf_payment_form')) {
249
+ return false;
250
+ }
251
+
252
+ // filter out trashed orders
253
+ foreach ($order_ids as $key => $order_id) {
254
+ $order_status = get_post_status( $order_id );
255
+ if ( $order_status == 'trash' ) {
256
+ unset( $order_ids[ $key ] );
257
+ }
258
+ }
259
+ // sharing is caring!
260
+ $this->order_ids = $order_ids;
261
+
262
+ // throw error when no order ids
263
+ if ( empty( $order_ids ) ) {
264
+ throw new Exception('No orders to export!');
265
+ }
266
+
267
+ do_action( 'wpo_wcpdf_process_template', $template_type );
268
+
269
+ $output_html = array();
270
+ foreach ($order_ids as $order_id) {
271
+ $this->order = new WC_Order( $order_id );
272
+ do_action( 'wpo_wcpdf_process_template_order', $template_type, $order_id );
273
+
274
+ $template = $this->template_path . '/' . $template_type . '.php';
275
+ $template = apply_filters( 'wpo_wcpdf_template_file', $template, $template_type, $this->order );
276
+
277
+ if (!file_exists($template)) {
278
+ throw new Exception('Template not found! Check if the following file exists: <pre>'.$template.'</pre><br/>');
279
+ }
280
+
281
+ // Set the invoice number
282
+ if ( $template_type == 'invoice' ) {
283
+ $this->set_invoice_number( $order_id );
284
+ }
285
+
286
+ $output_html[$order_id] = $this->get_template($template);
287
+
288
+ // store meta to be able to check if an invoice for an order has been created already
289
+ if ( $template_type == 'invoice' ) {
290
+ update_post_meta( $order_id, '_wcpdf_invoice_exists', 1 );
291
+ }
292
+
293
+
294
+ // Wipe post from cache
295
+ wp_cache_delete( $order_id, 'posts' );
296
+ wp_cache_delete( $order_id, 'post_meta' );
297
+ }
298
+
299
+ $print_script = "<script language=javascript>window.onload = function(){ window.print(); };</script>";
300
+ // <div style="page-break-before: always;"></div>
301
+ $page_break = "\n<div style=\"page-break-before: always;\"></div>\n";
302
+
303
+
304
+ if (apply_filters('wpo_wcpdf_output_html', false, $template_type) && apply_filters('wpo_wcpdf_print_html', false, $template_type)) {
305
+ $this->output_body = $print_script . implode($page_break, $output_html);
306
+ } else {
307
+ $this->output_body = implode($page_break, $output_html);
308
+ }
309
+
310
+ // Try to clean up a bit of memory
311
+ unset($output_html);
312
+
313
+ $template_wrapper = $this->template_path . '/html-document-wrapper.php';
314
+
315
+ if (!file_exists($template_wrapper)) {
316
+ throw new Exception('Template wrapper not found! Check if the following file exists: <pre>'.$template_wrapper.'</pre><br/>');
317
+ }
318
+
319
+ $complete_document = $this->get_template($template_wrapper);
320
+
321
+ // Try to clean up a bit of memory
322
+ unset($this->output_body);
323
+
324
+ // clean up special characters
325
+ $complete_document = utf8_decode(mb_convert_encoding($complete_document, 'HTML-ENTITIES', 'UTF-8'));
326
+
327
+
328
+ return $complete_document;
329
+ }
330
+
331
+ /**
332
+ * Adds spans around placeholders to be able to make replacement (page count) and css (page number)
333
+ */
334
+ public function clear_page_number_styles ( $html, $template_type, $order_ids ) {
335
+ $html = str_replace('{{PAGE_COUNT}}', '<span class="pagecount">{{PAGE_COUNT}}</span>', $html);
336
+ $html = str_replace('{{PAGE_NUM}}', '<span class="pagenum"></span>', $html );
337
+ return $html;
338
+ }
339
+
340
+ /**
341
+ * Replace {{PAGE_COUNT}} placeholder with total page count
342
+ */
343
+ public function page_number_replacements ( $dompdf, $html, $template_type, $order_ids ) {
344
+ $placeholder = '{{PAGE_COUNT}}';
345
+
346
+ // check if placeholder is used
347
+ if (strpos($html, $placeholder) !== false ) {
348
+ foreach ($dompdf->get_canvas()->get_cpdf()->objects as &$object) {
349
+ if (array_key_exists("c", $object) && strpos($object["c"], $placeholder) !== false) {
350
+ $object["c"] = str_replace( $placeholder , $dompdf->get_canvas()->get_page_count() , $object["c"] );
351
+ }
352
+ }
353
+ }
354
+
355
+ return $dompdf;
356
+ }
357
+
358
+ /**
359
+ * Create & render DOMPDF object
360
+ */
361
+ public function generate_pdf( $template_type, $order_ids ) {
362
+ $paper_size = apply_filters( 'wpo_wcpdf_paper_format', $this->template_settings['paper_size'], $template_type );
363
+ $paper_orientation = apply_filters( 'wpo_wcpdf_paper_orientation', 'portrait', $template_type);
364
+
365
+ do_action( 'wpo_wcpdf_before_pdf', $template_type );
366
+ if ( !class_exists('DOMPDF') ) {
367
+ // extra check to avoid clashes with other plugins using DOMPDF
368
+ // This could have unwanted side-effects when the version that's already
369
+ // loaded is different, and it could also miss fonts etc, but it's better
370
+ // than not checking...
371
+ require_once( WooCommerce_PDF_Invoices::$plugin_path . "lib/dompdf/dompdf_config.inc.php" );
372
+ }
373
+
374
+ $dompdf = new DOMPDF();
375
+ $html = apply_filters( 'wpo_wcpdf_processed_template_html', $this->process_template( $template_type, $order_ids ), $template_type, $order_ids );
376
+ $dompdf->load_html( $html );
377
+ $dompdf->set_paper( $paper_size, $paper_orientation );
378
+ $dompdf = apply_filters( 'wpo_wcpdf_before_dompdf_render', $dompdf, $html, $template_type, $order_ids );
379
+ $dompdf->render();
380
+ $dompdf = apply_filters( 'wpo_wcpdf_after_dompdf_render', $dompdf, $html, $template_type, $order_ids );
381
+ do_action( 'wpo_wcpdf_after_pdf', $template_type );
382
+
383
+ // Try to clean up a bit of memory
384
+ unset($complete_pdf);
385
+
386
+ return $dompdf;
387
+ }
388
+
389
+ /**
390
+ * Stream PDF
391
+ */
392
+ public function stream_pdf( $template_type, $order_ids, $filename ) {
393
+ $dompdf = $this->generate_pdf( $template_type, $order_ids );
394
+ $dompdf->stream($filename);
395
+ }
396
+
397
+ /**
398
+ * Get PDF
399
+ */
400
+ public function get_pdf( $template_type, $order_ids ) {
401
+ try {
402
+ $dompdf = $this->generate_pdf( $template_type, $order_ids );
403
+ return $dompdf->output();
404
+ } catch (Exception $e) {
405
+ echo $e->getMessage();
406
+ return false;
407
+ }
408
+
409
+ }
410
+
411
+ /**
412
+ * Load and generate the template output with ajax
413
+ */
414
+ public function generate_pdf_ajax() {
415
+ // Check the nonce
416
+ if( empty( $_GET['action'] ) || ! is_user_logged_in() || !check_admin_referer( $_GET['action'] ) ) {
417
+ wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
418
+ }
419
+
420
+ // Check if all parameters are set
421
+ if( empty( $_GET['template_type'] ) || empty( $_GET['order_ids'] ) ) {
422
+ wp_die( __( 'Some of the export parameters are missing.', 'wpo_wcpdf' ) );
423
+ }
424
+
425
+ $order_ids = (array) explode('x',$_GET['order_ids']);
426
+ // Process oldest first: reverse $order_ids array
427
+ $order_ids = array_reverse($order_ids);
428
+
429
+ // Check the user privileges
430
+ if( apply_filters( 'wpo_wcpdf_check_privs', !current_user_can( 'manage_woocommerce_orders' ) && !current_user_can( 'edit_shop_orders' ) && !isset( $_GET['my-account'] ), $order_ids ) ) {
431
+ wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
432
+ }
433
+
434
+ // User call from my-account page
435
+ if ( isset( $_GET['my-account'] ) ) {
436
+ // Only for single orders!
437
+ if ( count( $order_ids ) > 1 ) {
438
+ wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
439
+ }
440
+
441
+ // Get user_id of order
442
+ $this->order = new WC_Order ( $order_ids[0] );
443
+
444
+ // Check if current user is owner of order IMPORTANT!!!
445
+ if ( $this->order->user_id != get_current_user_id() ) {
446
+ wp_die( __( 'You do not have sufficient permissions to access this page.', 'wpo_wcpdf' ) );
447
+ }
448
+
449
+ // if we got here, we're safe to go!
450
+ }
451
+
452
+ // Generate the output
453
+ $template_type = $_GET['template_type'];
454
+ // die($this->process_template( $template_type, $order_ids )); // or use the filter switch below!
455
+
456
+ if (apply_filters('wpo_wcpdf_output_html', false, $template_type)) {
457
+ // Output html to browser for debug
458
+ // NOTE! images will be loaded with the server path by default
459
+ // use the wpo_wcpdf_use_path filter (return false) to change this to http urls
460
+ die($this->process_template( $template_type, $order_ids ));
461
+ }
462
+
463
+ if ( !($pdf = $this->get_pdf( $template_type, $order_ids )) ) {
464
+ exit;
465
+ }
466
+
467
+ $filename = $this->build_filename( $template_type, $order_ids, 'download' );
468
+
469
+ do_action( 'wpo_wcpdf_created_manually', $pdf, $filename );
470
+
471
+ // Get output setting
472
+ $output_mode = isset($this->general_settings['download_display'])?$this->general_settings['download_display']:'';
473
+
474
+ // Switch headers according to output setting
475
+ if ( $output_mode == 'display' || empty($output_mode) ) {
476
+ header('Content-type: application/pdf');
477
+ header('Content-Disposition: inline; filename="'.$filename.'"');
478
+ } else {
479
+ header('Content-Description: File Transfer');
480
+ header('Content-Type: application/octet-stream');
481
+ header('Content-Disposition: attachment; filename="'.$filename.'"');
482
+ header('Content-Transfer-Encoding: binary');
483
+ header('Connection: Keep-Alive');
484
+ header('Expires: 0');
485
+ header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
486
+ header('Pragma: public');
487
+ }
488
+
489
+ // output PDF data
490
+ echo($pdf);
491
+
492
+ exit;
493
+ }
494
+
495
+ /**
496
+ * Build filename
497
+ */
498
+ public function build_filename( $template_type, $order_ids, $context ) {
499
+ $count = count($order_ids);
500
+
501
+ switch ($template_type) {
502
+ case 'invoice':
503
+ $name = _n( 'invoice', 'invoices', $count, 'wpo_wcpdf' );
504
+ $number = $this->get_display_number( $order_ids[0] );
505
+ break;
506
+ case 'packing-slip':
507
+ $name = _n( 'packing-slip', 'packing-slips', $count, 'wpo_wcpdf' );
508
+ $number = $this->order->get_order_number();
509
+ break;
510
+ default:
511
+ $name = $template_type;
512
+ $number = $this->order->get_order_number();
513
+ break;
514
+ }
515
+
516
+ if ( $count == 1 ) {
517
+ $suffix = $number;
518
+ } else {
519
+ $suffix = date('Y-m-d'); // 2020-11-11
520
+ }
521
+
522
+ $filename = $name . '-' . $suffix . '.pdf';
523
+
524
+ // Filter depending on context (for legacy filter support)
525
+ if ( $context == 'download' ) {
526
+ $filename = apply_filters( 'wpo_wcpdf_bulk_filename', $filename, $order_ids, $name, $template_type );
527
+ } elseif ( $context == 'attachment' ) {
528
+ $filename = apply_filters( 'wpo_wcpdf_attachment_filename', $filename, $number, $order_ids[0] );
529
+ }
530
+
531
+ // Filter filename (use this filter instead of the above legacy filters!)
532
+ $filename = apply_filters( 'wpo_wcpdf_filename', $filename, $template_type, $order_ids, $context );
533
+
534
+ // sanitize filename (after filters to prevent human errors)!
535
+ return sanitize_file_name( $filename );
536
+ }
537
+
538
+ /**
539
+ * Attach invoice to completed order or customer invoice email
540
+ */
541
+ public function attach_pdf_to_email ( $attachments, $status, $order ) {
542
+ // check if all variables properly set
543
+ if ( !is_object( $order ) || !isset( $status ) ) {
544
+ return $attachments;
545
+ }
546
+
547
+ // Skip User emails
548
+ if ( get_class( $order ) == 'WP_User' ) {
549
+ return $attachments;
550
+ }
551
+
552
+ // WooCommerce Booking compatibility
553
+ if ( get_post_type( $order->id ) == 'wc_booking' && isset($order->order) ) {
554
+ // $order is actually a WC_Booking object!
555
+ $order = $order->order;
556
+ }
557
+
558
+ // do not process low stock notifications, user emails etc!
559
+ if ( in_array( $status, array( 'no_stock', 'low_stock', 'backorder', 'customer_new_account', 'customer_reset_password' ) ) || get_post_type( $order->id ) != 'shop_order' ) {
560
+ return $attachments;
561
+ }
562
+
563
+ // Disable free setting check
564
+ $order_total = $order->get_total();
565
+ if ( $order_total == 0 && isset($this->general_settings['disable_free']) ) {
566
+ return $attachments;
567
+ }
568
+
569
+ $this->order = $order;
570
+
571
+ $tmp_path = $this->tmp_path('attachments');
572
+
573
+ // clear pdf files from temp folder (from http://stackoverflow.com/a/13468943/1446634)
574
+ array_map('unlink', ( glob( $tmp_path.'*.pdf' ) ? glob( $tmp_path.'*.pdf' ) : array() ) );
575
+
576
+ // set allowed statuses for invoices
577
+ $invoice_allowed = isset($this->general_settings['email_pdf']) ? array_keys( $this->general_settings['email_pdf'] ) : array();
578
+ $documents = array(
579
+ 'invoice' => apply_filters( 'wpo_wcpdf_email_allowed_statuses', $invoice_allowed ), // Relevant (default) statuses: new_order, customer_invoice, customer_processing_order, customer_completed_order
580
+ );
581
+ $documents = apply_filters('wpo_wcpdf_attach_documents', $documents );
582
+
583
+ foreach ($documents as $template_type => $allowed_statuses ) {
584
+ // convert 'lazy' status name
585
+ foreach ($allowed_statuses as $key => $order_status) {
586
+ if ($order_status == 'completed' || $order_status == 'processing') {
587
+ $allowed_statuses[$key] = "customer_" . $order_status . "_order";
588
+ }
589
+ }
590
+
591
+ // legacy filter, use wpo_wcpdf_custom_attachment_condition instead!
592
+ $attach_invoice = apply_filters('wpo_wcpdf_custom_email_condition', true, $order, $status );
593
+ if ( $template_type == 'invoice' && !$attach_invoice ) {
594
+ // don't attach invoice, continue with other documents
595
+ continue;
596
+ }
597
+
598
+ // use this filter to add an extra condition - return false to disable the PDF attachment
599
+ $attach_document = apply_filters('wpo_wcpdf_custom_attachment_condition', true, $order, $status, $template_type );
600
+ if( in_array( $status, $allowed_statuses ) && $attach_document ) {
601
+ // create pdf data
602
+ $pdf_data = $this->get_pdf( $template_type, (array) $order->id );
603
+
604
+ if ( !$pdf_data ) {
605
+ // something went wrong, continue trying with other documents
606
+ continue;
607
+ }
608
+
609
+ // compose filename
610
+ $pdf_filename = $this->build_filename( $template_type, (array) $order->id, 'attachment' );
611
+
612
+ $pdf_path = $tmp_path . $pdf_filename;
613
+ file_put_contents ( $pdf_path, $pdf_data );
614
+ $attachments[] = $pdf_path;
615
+
616
+ do_action( 'wpo_wcpdf_email_attachment', $pdf_path, $template_type );
617
+ }
618
+ }
619
+
620
+ return $attachments;
621
+ }
622
+
623
+ public function set_invoice_number( $order_id ) {
624
+ // first check: get invoice number from post meta
625
+ $invoice_number = get_post_meta( $order_id, '_wcpdf_invoice_number', true );
626
+
627
+ // add invoice number if it doesn't exist
628
+ if ( empty($invoice_number) || !isset($invoice_number) ) {
629
+ global $wpdb;
630
+ // making direct DB call to avoid caching issues
631
+ $next_invoice_number = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", 'wpo_wcpdf_next_invoice_number' ) );
632
+ $next_invoice_number = apply_filters( 'wpo_wcpdf_next_invoice_number', $next_invoice_number, $order_id );
633
+
634
+ if ( empty($next_invoice_number) ) {
635
+ // First time! We start numbering from order_number or order_id
636
+
637
+ // Check if $order_number is an integer
638
+ $order_number = ltrim($this->order->get_order_number(), '#');
639
+ if ( ctype_digit( (string)$order_number ) ) {
640
+ // order_number == integer: use as starting point.
641
+ $invoice_number = $order_number;
642
+ } else {
643
+ // fallback: use order_id as starting point.
644
+ $invoice_number = $order_id;
645
+ }
646
+
647
+ } else {
648
+ $invoice_number = $next_invoice_number;
649
+ }
650
+
651
+ // reset invoice number yearly
652
+ if ( isset( $this->template_settings['yearly_reset_invoice_number'] ) ) {
653
+ $current_year = date("Y");
654
+ $last_invoice_year = get_option( 'wpo_wcpdf_last_invoice_year' );
655
+ // check first time use
656
+ if ( empty( $last_invoice_year ) ) {
657
+ $last_invoice_year = $current_year;
658
+ update_option( 'wpo_wcpdf_last_invoice_year', $current_year );
659
+ }
660
+ // check if we need to reset
661
+ if ( $current_year != $last_invoice_year ) {
662
+ $invoice_number = 1;
663
+ update_option( 'wpo_wcpdf_last_invoice_year', $current_year );
664
+ }
665
+ }
666
+ // die($invoice_number);
667
+
668
+ // invoice number logging
669
+ // $order_number = ltrim($this->order->get_order_number(), '#');
670
+ // $this->log( $order_id, "Invoice number {$invoice_number} set for order {$order_number} (id {$order_id})" );
671
+
672
+ update_post_meta($order_id, '_wcpdf_invoice_number', $invoice_number);
673
+ update_post_meta($order_id, '_wcpdf_formatted_invoice_number', $this->get_invoice_number( $order_id ) );
674
+
675
+ // increase next_order_number
676
+ $update_args = array(
677
+ 'option_value' => $invoice_number + 1,
678
+ 'autoload' => 'yes',
679
+ );
680
+ $result = $wpdb->update( $wpdb->options, $update_args, array( 'option_name' => 'wpo_wcpdf_next_invoice_number' ) );
681
+ }
682
+
683
+ // store invoice_number in class object
684
+ $this->invoice_number = $invoice_number;
685
+
686
+ // store invoice number in _POST superglobal to prevent the number from being cleared in a save action
687
+ // (http://wordpress.org/support/topic/customer-invoice-selection-from-order-detail-page-doesnt-record-invoice-id?replies=1)
688
+ $_POST['_wcpdf_invoice_number'] = $invoice_number;
689
+
690
+ return $invoice_number;
691
+ }
692
+
693
+ public function get_invoice_number( $order_id ) {
694
+ // get invoice number from post meta
695
+ if ( $invoice_number = get_post_meta( $order_id, '_wcpdf_invoice_number', true ) ) {
696
+ // check if we have already loaded this order
697
+ if ( $this->order->id == $order_id ) {
698
+ $order_number = $this->order->get_order_number();
699
+ $order_date = $this->order->order_date;
700
+ } else {
701
+ $order = new WC_Order( $order_id );
702
+ $order_number = $order->get_order_number();
703
+ $order_date = $order->order_date;
704
+ }
705
+
706
+ return apply_filters( 'wpo_wcpdf_invoice_number', $invoice_number, $order_number, $order_id, $order_date );
707
+ } else {
708
+ // no invoice number for this order
709
+ return false;
710
+ }
711
+ }
712
+
713
+ /**
714
+ * Add invoice number to WC REST API
715
+ */
716
+ public function woocommerce_api_invoice_numer ( $data, $order ) {
717
+ if ( $invoice_number = $this->get_invoice_number( $order->id ) ) {
718
+ $data['wpo_wcpdf_invoice_number'] = $invoice_number;
719
+ } else {
720
+ $data['wpo_wcpdf_invoice_number'] = '';
721
+ }
722
+ return $data;
723
+ }
724
+
725
+ /**
726
+ * Reset invoice data for WooCommerce subscription renewal orders
727
+ * https://wordpress.org/support/topic/subscription-renewal-duplicate-invoice-number?replies=6#post-6138110
728
+ */
729
+ public function woocommerce_subscriptions_renewal_order_created ( $renewal_order, $original_order, $product_id, $new_order_role ) {
730
+ $this->reset_invoice_data( $renewal_order->id );
731
+ return $renewal_order;
732
+ }
733
+
734
+ public function wcs_renewal_order_created ( $renewal_order, $subscription ) {
735
+ $this->reset_invoice_data( $renewal_order->id );
736
+ return $renewal_order;
737
+ }
738
+
739
+ public function reset_invoice_data ( $order_id ) {
740
+ // delete invoice number, invoice date & invoice exists meta
741
+ delete_post_meta( $order_id, '_wcpdf_invoice_number' );
742
+ delete_post_meta( $order_id, '_wcpdf_formatted_invoice_number' );
743
+ delete_post_meta( $order_id, '_wcpdf_invoice_date' );
744
+ delete_post_meta( $order_id, '_wcpdf_invoice_exists' );
745
+ }
746
+
747
+ public function format_invoice_number( $invoice_number, $order_number, $order_id, $order_date ) {
748
+ // get format settings
749
+ $formats['prefix'] = isset($this->template_settings['invoice_number_formatting_prefix'])?$this->template_settings['invoice_number_formatting_prefix']:'';
750
+ $formats['suffix'] = isset($this->template_settings['invoice_number_formatting_suffix'])?$this->template_settings['invoice_number_formatting_suffix']:'';
751
+ $formats['padding'] = isset($this->template_settings['invoice_number_formatting_padding'])?$this->template_settings['invoice_number_formatting_padding']:'';
752
+
753
+ // Replacements
754
+ $order_year = date_i18n( 'Y', strtotime( $order_date ) );
755
+ $order_month = date_i18n( 'm', strtotime( $order_date ) );
756
+ $invoice_date = get_post_meta($order_id,'_wcpdf_invoice_date',true);
757
+ $invoice_date = empty($invoice_date) ? current_time('mysql') : $invoice_date;
758
+ $invoice_year = date_i18n( 'Y', strtotime( $invoice_date ) );
759
+ $invoice_month = date_i18n( 'm', strtotime( $invoice_date ) );
760
+
761
+ foreach ($formats as $key => $value) {
762
+ $value = str_replace('[order_year]', $order_year, $value);
763
+ $value = str_replace('[order_month]', $order_month, $value);
764
+ $value = str_replace('[invoice_year]', $invoice_year, $value);
765
+ $value = str_replace('[invoice_month]', $invoice_month, $value);
766
+ $formats[$key] = $value;
767
+ }
768
+
769
+ // Padding
770
+ if ( ctype_digit( (string)$formats['padding'] ) ) {
771
+ $invoice_number = sprintf('%0'.$formats['padding'].'d', $invoice_number);
772
+ }
773
+
774
+ $formatted_invoice_number = $formats['prefix'] . $invoice_number . $formats['suffix'] ;
775
+
776
+ return $formatted_invoice_number;
777
+ }
778
+
779
+ public function get_display_number( $order_id ) {
780
+ if ( !isset($this->order->id) ) {
781
+ $this->order = new WC_Order ( $order_id );
782
+ }
783
+
784
+ if ( isset($this->template_settings['display_number']) && $this->template_settings['display_number'] == 'invoice_number' ) {
785
+ // use invoice number
786
+ $display_number = $this->get_invoice_number( $order_id );
787
+ // die($display_number);
788
+ } else {
789
+ // use order number
790
+ $display_number = ltrim($this->order->get_order_number(), '#');
791
+ }
792
+
793
+ return $display_number;
794
+ }
795
+
796
+ /**
797
+ * Return evaluated template contents
798
+ */
799
+ public function get_template( $file ) {
800
+ ob_start();
801
+ if (file_exists($file)) {
802
+ include($file);
803
+ }
804
+ return ob_get_clean();
805
+ }
806
+
807
+ /**
808
+ * Get the current order
809
+ */
810
+ public function get_order() {
811
+ return $this->order;
812
+ }
813
+
814
+ /**
815
+ * Get the current order items
816
+ */
817
+ public function get_order_items() {
818
+ global $woocommerce;
819
+ global $_product;
820
+
821
+ $items = $this->order->get_items();
822
+ $data_list = array();
823
+
824
+ if( sizeof( $items ) > 0 ) {
825
+ foreach ( $items as $item_id => $item ) {
826
+ // Array with data for the pdf template
827
+ $data = array();
828
+
829
+ // Set the item_id
830
+ $data['item_id'] = $item_id;
831
+
832
+ // Set the id
833
+ $data['product_id'] = $item['product_id'];
834
+ $data['variation_id'] = $item['variation_id'];
835
+
836
+ // Set item name
837
+ $data['name'] = $item['name'];
838
+
839
+ // Set item quantity
840
+ $data['quantity'] = $item['qty'];
841
+
842
+ // Set the line total (=after discount)
843
+ $data['line_total'] = $this->wc_price( $item['line_total'] );
844
+ $data['single_line_total'] = $this->wc_price( $item['line_total'] / max( 1, $item['qty'] ) );
845
+ $data['line_tax'] = $this->wc_price( $item['line_tax'] );
846
+ $data['single_line_tax'] = $this->wc_price( $item['line_tax'] / max( 1, $item['qty'] ) );
847
+
848
+ $line_tax_data = maybe_unserialize( isset( $item['line_tax_data'] ) ? $item['line_tax_data'] : '' );
849
+ $data['tax_rates'] = $this->get_tax_rate( $item['tax_class'], $item['line_total'], $item['line_tax'], $line_tax_data );
850
+
851
+ // Set the line subtotal (=before discount)
852
+ $data['line_subtotal'] = $this->wc_price( $item['line_subtotal'] );
853
+ $data['line_subtotal_tax'] = $this->wc_price( $item['line_subtotal_tax'] );
854
+ $data['ex_price'] = $this->get_formatted_item_price ( $item, 'total', 'excl' );
855
+ $data['price'] = $this->get_formatted_item_price ( $item, 'total' );
856
+ $data['order_price'] = $this->order->get_formatted_line_subtotal( $item ); // formatted according to WC settings
857
+
858
+ // Calculate the single price with the same rules as the formatted line subtotal (!)
859
+ // = before discount
860
+ $data['ex_single_price'] = $this->get_formatted_item_price ( $item, 'single', 'excl' );
861
+ $data['single_price'] = $this->get_formatted_item_price ( $item, 'single' );
862
+
863
+ // Pass complete item array
864
+ $data['item'] = $item;
865
+
866
+ // Create the product to display more info
867
+ $data['product'] = null;
868
+
869
+ $product = $this->order->get_product_from_item( $item );
870
+
871
+ // Checking fo existance, thanks to MDesigner0
872
+ if(!empty($product)) {
873
+ // Set the thumbnail id DEPRICATED (does not support thumbnail sizes), use thumbnail_path or thumbnail instead
874
+ $data['thumbnail_id'] = $this->get_thumbnail_id( $product );
875
+
876
+ // Thumbnail (full img tag)
877
+ $data['thumbnail'] = $this->get_thumbnail ( $product );
878
+
879
+ // Set the single price (turned off to use more consistent calculated price)
880
+ // $data['single_price'] = woocommerce_price ( $product->get_price() );
881
+
882
+ // Set item SKU
883
+ $data['sku'] = $product->get_sku();
884
+
885
+ // Set item weight
886
+ $data['weight'] = $product->get_weight();
887
+
888
+ // Set item dimensions
889
+ $data['dimensions'] = $product->get_dimensions();
890
+
891
+ // Pass complete product object
892
+ $data['product'] = $product;
893
+
894
+ }
895
+
896
+ // Set item meta
897
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.4', '<' ) ) {
898
+ $meta = new WC_Order_Item_Meta( $item['item_meta'], $product );
899
+ } else {
900
+ // pass complete item for WC2.4+
901
+ $meta = new WC_Order_Item_Meta( $item, $product );
902
+ }
903
+
904
+ $data['meta'] = $meta->display( false, true );
905
+
906
+ $data_list[$item_id] = apply_filters( 'wpo_wcpdf_order_item_data', $data, $this->order );
907
+ }
908
+ }
909
+
910
+ return apply_filters( 'wpo_wcpdf_order_items_data', $data_list, $this->order );
911
+ }
912
+
913
+ /**
914
+ * Gets price - formatted for display.
915
+ *
916
+ * @access public
917
+ * @param mixed $item
918
+ * @return string
919
+ */
920
+ public function get_formatted_item_price ( $item, $type, $tax_display = '' ) {
921
+ $item_price = 0;
922
+ $divider = ($type == 'single' && $item['qty'] != 0 )?$item['qty']:1; //divide by 1 if $type is not 'single' (thus 'total')
923
+
924
+ if ( ! isset( $item['line_subtotal'] ) || ! isset( $item['line_subtotal_tax'] ) )
925
+ return;
926
+
927
+ if ( $tax_display == 'excl' ) {
928
+ $item_price = $this->wc_price( ($this->order->get_line_subtotal( $item )) / $divider );
929
+ } else {
930
+ $item_price = $this->wc_price( ($this->order->get_line_subtotal( $item, true )) / $divider );
931
+ }
932
+
933
+ return $item_price;
934
+ }
935
+
936
+ /**
937
+ * wrapper for wc2.1 depricated price function
938
+ */
939
+ public function wc_price( $price, $args = array() ) {
940
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.1' ) >= 0 ) {
941
+ // WC 2.1 or newer is used
942
+ $args['currency'] = $this->order->get_order_currency();
943
+ $formatted_price = wc_price( $price, $args );
944
+ } else {
945
+ $formatted_price = woocommerce_price( $price );
946
+ }
947
+
948
+ return $formatted_price;
949
+ }
950
+
951
+ /**
952
+ * Get the tax rates/percentages for a given tax class
953
+ * @param string $tax_class tax class slug
954
+ * @return string $tax_rates imploded list of tax rates
955
+ */
956
+ public function get_tax_rate( $tax_class, $line_total, $line_tax, $line_tax_data = '' ) {
957
+ if ( $line_tax == 0 ) {
958
+ return '-'; // no need to determine tax rate...
959
+ }
960
+
961
+ // first try the easy wc2.2 way, using line_tax_data
962
+ if ( !empty( $line_tax_data ) && isset($line_tax_data['total']) ) {
963
+ $tax_rates = array();
964
+
965
+ $line_taxes = $line_tax_data['total'];
966
+ foreach ( $line_taxes as $tax_id => $tax ) {
967
+ if ( !empty($tax) && $tax != 0 ) {
968
+ $tax_rates[] = $this->get_tax_rate_by_id( $tax_id ) . ' %';
969
+ }
970
+ }
971
+
972
+ $tax_rates = implode(' ,', $tax_rates );
973
+ return $tax_rates;
974
+ }
975
+
976
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.1' ) >= 0 && !apply_filters( 'wpo_wcpdf_calculate_tax_rate', false ) ) {
977
+ // WC 2.1 or newer is used
978
+
979
+ // if (empty($tax_class))
980
+ // $tax_class = 'standard';// does not appear to work anymore - get_rates does accept an empty tax_class though!
981
+
982
+ $tax = new WC_Tax();
983
+ $taxes = $tax->get_rates( $tax_class );
984
+
985
+ $tax_rates = array();
986
+
987
+ foreach ($taxes as $tax) {
988
+ $tax_rates[$tax['label']] = round( $tax['rate'], 2 ).' %';
989
+ }
990
+
991
+ if (empty($tax_rates)) {
992
+ // one last try: manually calculate
993
+ if ( $line_total != 0) {
994
+ $tax_rates[] = round( ($line_tax / $line_total)*100, 1 ).' %';
995
+ } else {
996
+ $tax_rates[] = '-';
997
+ }
998
+ }
999
+
1000
+ $tax_rates = implode(' ,', $tax_rates );
1001
+ } else {
1002
+ // Backwards compatibility/fallback: calculate tax from line items
1003
+ if ( $line_total != 0) {
1004
+ $tax_rates = round( ($line_tax / $line_total)*100, 1 ).' %';
1005
+ } else {
1006
+ $tax_rates = '-';
1007
+ }
1008
+ }
1009
+
1010
+ return $tax_rates;
1011
+ }
1012
+
1013
+ /**
1014
+ * Returns the percentage rate (float) for a given tax rate ID.
1015
+ * @param int $rate_id woocommerce tax rate id
1016
+ * @return float $rate percentage rate
1017
+ */
1018
+ public function get_tax_rate_by_id( $rate_id ) {
1019
+ global $wpdb;
1020
+ $rate = $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %d;", $rate_id ) );
1021
+ return (float) $rate;
1022
+ }
1023
+
1024
+ /**
1025
+ * Returns a an array with rate_id => tax rate data (array) of all tax rates in woocommerce
1026
+ * @return array $tax_rate_ids keyed by id
1027
+ */
1028
+ public function get_tax_rate_ids() {
1029
+ global $wpdb;
1030
+ $rates = $wpdb->get_results( "SELECT * FROM {$wpdb->prefix}woocommerce_tax_rates" );
1031
+
1032
+ $tax_rate_ids = array();
1033
+ foreach ($rates as $rate) {
1034
+ // var_dump($rate->tax_rate_id);
1035
+ // die($rate);
1036
+ $rate_id = $rate->tax_rate_id;
1037
+ unset($rate->tax_rate_id);
1038
+ $tax_rate_ids[$rate_id] = (array) $rate;
1039
+ }
1040
+
1041
+ return $tax_rate_ids;
1042
+ }
1043
+
1044
+ /**
1045
+ * Get order custom field
1046
+ */
1047
+ public function get_order_field( $field ) {
1048
+ if( isset( $this->get_order()->order_custom_fields[$field] ) ) {
1049
+ return $this->get_order()->order_custom_fields[$field][0];
1050
+ }
1051
+ return;
1052
+ }
1053
+
1054
+ /**
1055
+ * Returns the main product image ID
1056
+ * Adapted from the WC_Product class
1057
+ *
1058
+ * @access public
1059
+ * @return string
1060
+ */
1061
+ public function get_thumbnail_id ( $product ) {
1062
+ // DEPRICATED (does not support thumbnail sizes)
1063
+ global $woocommerce;
1064
+
1065
+ if ( $product->variation_id && has_post_thumbnail( $product->variation_id ) ) {
1066
+ $thumbnail_id = get_post_thumbnail_id ( $product->variation_id );
1067
+ } elseif ( has_post_thumbnail( $product->id ) ) {
1068
+ $thumbnail_id = get_post_thumbnail_id ( $product->id );
1069
+ } elseif ( ( $parent_id = wp_get_post_parent_id( $product->id ) ) && has_post_thumbnail( $parent_id ) ) {
1070
+ $thumbnail_id = get_post_thumbnail_id ( $parent_id );
1071
+ } else {
1072
+ $thumbnail_id = $woocommerce->plugin_url() . '/assets/images/placeholder.png';
1073
+ }
1074
+
1075
+ return $thumbnail_id;
1076
+ }
1077
+
1078
+ public function get_thumbnail ( $product ) {
1079
+ // Get default WooCommerce img tag (url/http)
1080
+ $size = apply_filters( 'wpo_wcpdf_thumbnail_size', 'shop_thumbnail' );
1081
+ $thumbnail_img_tag_url = $product->get_image( $size, array( 'title' => '' ) );
1082
+
1083
+ // Extract the url from img
1084
+ preg_match('/<img(.*)src(.*)=(.*)"(.*)"/U', $thumbnail_img_tag_url, $thumbnail_url );
1085
+ // convert url to path
1086
+ $thumbnail_path = str_replace( get_site_url() . '/', ABSPATH, array_pop($thumbnail_url));
1087
+
1088
+ // Thumbnail (full img tag)
1089
+ if (apply_filters('wpo_wcpdf_use_path', true) && file_exists($thumbnail_path)) {
1090
+ // load img with server path by default
1091
+ $thumbnail = sprintf('<img width="90" height="90" src="%s" class="attachment-shop_thumbnail wp-post-image">', $thumbnail_path );
1092
+ } else {
1093
+ // load img with http url when filtered
1094
+ $thumbnail = $thumbnail_img_tag_url;
1095
+ }
1096
+
1097
+ // die($thumbnail);
1098
+
1099
+ return $thumbnail;
1100
+ }
1101
+
1102
+ public function add_product_bundles_classes ( $classes, $template_type, $order, $item_id = '' ) {
1103
+ if ( empty($item_id) ) {
1104
+ // get item id from classes (backwards compatibility fix)
1105
+ $class_array = explode(' ', $classes);
1106
+ foreach ($class_array as $class) {
1107
+ if (is_numeric($class)) {
1108
+ $item_id = $class;
1109
+ break;
1110
+ }
1111
+ }
1112
+
1113
+ // if still empty, we lost the item id somewhere :(
1114
+ if (empty($item_id)) {
1115
+ return $classes;
1116
+ }
1117
+ }
1118
+
1119
+ $item_meta = $order->get_item_meta( $item_id );
1120
+
1121
+ if (isset($item_meta['_bundled_by'])) {
1122
+ $classes = $classes . ' bundled-item';
1123
+
1124
+ // check bundled item visibility
1125
+ if ( ! empty( $item_meta[ '_bundled_item_hidden' ] ) ) {
1126
+ $classes = $classes . ' hidden';
1127
+ }
1128
+
1129
+ return $classes;
1130
+ } elseif (isset($item_meta['_bundled_items'])) {
1131
+ return $classes . ' product-bundle';
1132
+ }
1133
+
1134
+ return $classes;
1135
+ }
1136
+
1137
+ public function add_chained_product_class ( $classes, $template_type, $order, $item_id = '' ) {
1138
+ if ( empty($item_id) ) {
1139
+ // get item id from classes (backwards compatibility fix)
1140
+ $class_array = explode(' ', $classes);
1141
+ foreach ($class_array as $class) {
1142
+ if (is_numeric($class)) {
1143
+ $item_id = $class;
1144
+ break;
1145
+ }
1146
+ }
1147
+
1148
+ // if still empty, we lost the item id somewhere :(
1149
+ if (empty($item_id)) {
1150
+ return $classes;
1151
+ }
1152
+ }
1153
+
1154
+ $item_meta = $order->get_item_meta( $item_id );
1155
+
1156
+ if (isset($item_meta['_chained_product_of'])) {
1157
+ return $classes . ' chained-product';
1158
+ }
1159
+
1160
+ return $classes;
1161
+ }
1162
+
1163
+ /**
1164
+ * Filter plugin strings with qTranslate-X
1165
+ */
1166
+ public function qtranslatex_filters() {
1167
+ $use_filters = array(
1168
+ 'wpo_wcpdf_shop_name' => 20,
1169
+ 'wpo_wcpdf_shop_address' => 20,
1170
+ 'wpo_wcpdf_footer' => 20,
1171
+ 'wpo_wcpdf_order_items' => 20,
1172
+ 'wpo_wcpdf_payment_method' => 20,
1173
+ 'wpo_wcpdf_shipping_method' => 20,
1174
+ 'wpo_wcpdf_extra_1' => 20,
1175
+ 'wpo_wcpdf_extra_2' => 20,
1176
+ 'wpo_wcpdf_extra_3' => 20,
1177
+ );
1178
+
1179
+ foreach ( $use_filters as $name => $priority ) {
1180
+ add_filter( $name, 'qtranxf_useCurrentLanguageIfNotFoundUseDefaultLanguage', $priority );
1181
+ }
1182
+ }
1183
+
1184
+ /**
1185
+ * Use currency symbol font (when enabled in options)
1186
+ */
1187
+ public function use_currency_font ( $template_type ) {
1188
+ add_filter( 'woocommerce_currency_symbol', array( $this, 'wrap_currency_symbol' ), 10, 2);
1189
+ add_action( 'wpo_wcpdf_custom_styles', array($this, 'currency_symbol_font_styles' ) );
1190
+ }
1191
+
1192
+ public function wrap_currency_symbol( $currency_symbol, $currency ) {
1193
+ $currency_symbol = sprintf( '<span class="wcpdf-currency-symbol">%s</span>', $currency_symbol );
1194
+ return $currency_symbol;
1195
+ }
1196
+
1197
+ public function currency_symbol_font_styles () {
1198
+ ?>
1199
+ .wcpdf-currency-symbol { font-family: 'Currencies'; }
1200
+ <?php
1201
+ }
1202
+
1203
+ public function enable_debug () {
1204
+ error_reporting( E_ALL );
1205
+ ini_set( 'display_errors', 1 );
1206
+ }
1207
+
1208
+ /**
1209
+ * Log messages
1210
+ */
1211
+
1212
+ public function log( $order_id, $message ) {
1213
+ $current_date_time = date("Y-m-d H:i:s");
1214
+ $message = $order_id . ' ' . $current_date_time .' ' .$message ."\n";
1215
+ $file = $this->tmp_path() . 'log.txt';
1216
+
1217
+ file_put_contents($file, $message, FILE_APPEND);
1218
+ }
1219
+ }
1220
+
1221
+ }
includes/class-wcpdf-settings.php CHANGED
@@ -611,6 +611,19 @@ if ( ! class_exists( 'WooCommerce_PDF_Invoices_Settings' ) ) {
611
  )
612
  );
613
 
 
 
 
 
 
 
 
 
 
 
 
 
 
614
  // Section.
615
  add_settings_section(
616
  'packing_slip',
611
  )
612
  );
613
 
614
+ add_settings_field(
615
+ 'currency_font',
616
+ __( 'Extended currency symbol support', 'wpo_wcpdf' ),
617
+ array( &$this, 'checkbox_element_callback' ),
618
+ $option,
619
+ 'invoice',
620
+ array(
621
+ 'menu' => $option,
622
+ 'id' => 'currency_font',
623
+ 'description' => __( 'Enable this if your currency symbol is not displaying properly' , 'wpo_wcpdf' ),
624
+ )
625
+ );
626
+
627
  // Section.
628
  add_settings_section(
629
  'packing_slip',
lib/dompdf/lib/fonts/01847c3483fce00998f5049154250e7f.ttf ADDED
Binary file
lib/dompdf/lib/fonts/01847c3483fce00998f5049154250e7f.ufm ADDED
@@ -0,0 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ StartFontMetrics 4.1
2
+ Notice Converted by PHP-font-lib
3
+ Comment https://github.com/PhenX/php-font-lib
4
+ EncodingScheme FontSpecific
5
+ Copyright Typeface © James Kass 1998-2008. Data © James Kass 1998-2008. All Rights Reserved.
6
+ FontName Code2000
7
+ FontSubfamily Normal
8
+ UniqueID Code2000
9
+ FullName Code2000
10
+ Version Version 1.171
11
+ PostScriptName Code2000
12
+ Trademark Notice: Code2000 is shareware, users are required to register. US$5.00 (James Kass, 2807 Erskine Creek Road Space 93,Lake Isabella, California 93240 U.S.A.)[e-mail: jameskass@code2000.net]<Web site: http://www.code2000.net/index.htm>
13
+ Manufacturer James Kass
14
+ Designer James Kass
15
+ FontVendorURL http://www.code2000.net/index.htm
16
+ FontDesignerURL http://www.code2000.net/index.htm
17
+ LicenseURL http://www.code2000.net/code2000_page.htm
18
+ SampleText Hễ cố là phải được.
19
+ Weight Bold
20
+ ItalicAngle 0
21
+ IsFixedPitch false
22
+ UnderlineThickness 50
23
+ UnderlinePosition -200
24
+ FontHeightOffset 0
25
+ Ascender 977
26
+ Descender -293
27
+ FontBBox -20 -293 1047 977
28
+ StartCharMetrics 48
29
+ U 32 ; WX 391 ; N space ; G 3
30
+ U 36 ; WX 514 ; N uni0024 ; G 4
31
+ U 160 ; WX 391 ; N uni00A0 ; G 5
32
+ U 162 ; WX 475 ; N uni00A2 ; G 6
33
+ U 163 ; WX 693 ; N uni00A3 ; G 7
34
+ U 164 ; WX 703 ; N uni00A4 ; G 8
35
+ U 165 ; WX 604 ; N uni00A5 ; G 9
36
+ U 402 ; WX 563 ; N uni0192 ; G 10
37
+ U 2546 ; WX 537 ; N uni09F2 ; G 11
38
+ U 2547 ; WX 611 ; N uni09F3 ; G 12
39
+ U 2801 ; WX 779 ; N uni0AF1 ; G 13
40
+ U 3065 ; WX 1047 ; N uni0BF9 ; G 14
41
+ U 3647 ; WX 703 ; N uni0E3F ; G 15
42
+ U 6107 ; WX 377 ; N uni17DB ; G 16
43
+ U 8199 ; WX 391 ; N uni2007 ; G 17
44
+ U 8239 ; WX 391 ; N uni202F ; G 18
45
+ U 8288 ; WX 391 ; N uni2060 ; G 19
46
+ U 8352 ; WX 703 ; N uni20A0 ; G 20
47
+ U 8353 ; WX 650 ; N uni20A1 ; G 21
48
+ U 8354 ; WX 670 ; N uni20A2 ; G 22
49
+ U 8355 ; WX 586 ; N uni20A3 ; G 23
50
+ U 8356 ; WX 693 ; N uni20A4 ; G 24
51
+ U 8357 ; WX 967 ; N uni20A5 ; G 25
52
+ U 8358 ; WX 895 ; N uni20A6 ; G 26
53
+ U 8359 ; WX 764 ; N uni20A7 ; G 27
54
+ U 8360 ; WX 961 ; N uni20A8 ; G 28
55
+ U 8361 ; WX 1025 ; N uni20A9 ; G 29
56
+ U 8362 ; WX 736 ; N uni20AA ; G 30
57
+ U 8363 ; WX 676 ; N uni20AB ; G 31
58
+ U 8364 ; WX 746 ; N uni20AC ; G 32
59
+ U 8365 ; WX 965 ; N uni20AD ; G 33
60
+ U 8366 ; WX 633 ; N uni20AE ; G 34
61
+ U 8367 ; WX 1049 ; N uni20AF ; G 35
62
+ U 8368 ; WX 709 ; N uni20B0 ; G 36
63
+ U 8369 ; WX 881 ; N uni20B1 ; G 37
64
+ U 8370 ; WX 650 ; N uni20B2 ; G 38
65
+ U 8371 ; WX 760 ; N uni20B3 ; G 39
66
+ U 8372 ; WX 643 ; N uni20B4 ; G 40
67
+ U 8373 ; WX 650 ; N uni20B5 ; G 41
68
+ U 8499 ; WX 824 ; N uni2133 ; G 42
69
+ U 20803 ; WX 1000 ; N uni5143 ; G 43
70
+ U 20870 ; WX 1000 ; N uni5186 ; G 44
71
+ U 22278 ; WX 1000 ; N uni5706 ; G 45
72
+ U 22291 ; WX 1000 ; N uni5713 ; G 46
73
+ U 65020 ; WX 1086 ; N uniFDFC ; G 47
74
+ EndCharMetrics
75
+ EndFontMetrics
lib/dompdf/lib/fonts/dompdf_font_family_cache.php CHANGED
@@ -85,4 +85,11 @@
85
  'italic' => DOMPDF_FONT_DIR . 'e1ed1c78d201fe6255daee12e8820a6d',
86
  'bold_italic' => DOMPDF_FONT_DIR . 'c1583238aa915ad7e56d544a3a5f8f4e',
87
  ),
 
 
 
 
 
 
 
88
  ) ?>
85
  'italic' => DOMPDF_FONT_DIR . 'e1ed1c78d201fe6255daee12e8820a6d',
86
  'bold_italic' => DOMPDF_FONT_DIR . 'c1583238aa915ad7e56d544a3a5f8f4e',
87
  ),
88
+ 'currencies' =>
89
+ array (
90
+ 'normal' => DOMPDF_FONT_DIR . '01847c3483fce00998f5049154250e7f',
91
+ 'bold' => DOMPDF_FONT_DIR . '01847c3483fce00998f5049154250e7f',
92
+ 'italic' => DOMPDF_FONT_DIR . '01847c3483fce00998f5049154250e7f',
93
+ 'bold_italic' => DOMPDF_FONT_DIR . '01847c3483fce00998f5049154250e7f',
94
+ ),
95
  ) ?>
readme.txt CHANGED
@@ -1,602 +1,606 @@
1
- === Plugin Name ===
2
- Contributors: pomegranate
3
- Tags: woocommerce, pdf, invoices, packing slips, print, delivery notes, invoice, packing slip, export, email, bulk, automatic
4
- Requires at least: 3.5
5
- Tested up to: 4.4.2
6
- Stable tag: 1.5.29
7
- License: GPLv2 or later
8
- License URI: http://www.gnu.org/licenses/gpl-2.0.html
9
-
10
- Create, print & automatically email PDF invoices & packing slips for WooCommerce orders.
11
-
12
- == Description ==
13
-
14
- This WooCommerce extension automatically adds a PDF invoice to the order confirmation emails sent out to your customers. Includes a basic template (additional templates are available from [WP Overnight](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-premium-templates/)) as well as the possibility to modify/create your own templates. In addition, you can choose to download or print invoices and packing slips from the WooCommerce order admin.
15
-
16
- = Main features =
17
- * Automatically attach invoice PDF to WooCommerce emails of your choice
18
- * Download the PDF invoice / packing slip from the order admin page
19
- * Generate PDF invoices / packings slips in bulk
20
- * **Fully customizable** HTML/CSS invoice templates
21
- * Download invoices from the My Account page
22
- * Sequential invoice numbers - with custom formatting
23
- * **Available in: Czech, Dutch, English, Finnish, French, German, Hungarian, Italian, Japanese (see FAQ for adding custom fonts!), Norwegian, Polish, Romanian, Russian, Slovak, Slovenian, Spanish, Swedish & Ukrainian**
24
-
25
- In addition to this, we offer several premium extensions:
26
-
27
- * Create/email PDF Proforma Invoices, Credit Notes (for Refunds), email Packing Slips & more with [WooCommerce PDF Invoices & Packing Slips Professional](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-professional/)
28
- * Upload all invoices automatically to Dropbox with [WooCommerce PDF Invoices & Packing Slips to Dropbox](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-dropbox/)
29
- * Automatically send new orders or packing slips to your printer, as soon as the customer orders! [WooCommerce Automatic Order Printing](https://www.simbahosting.co.uk/s3/product/woocommerce-automatic-order-printing/?affiliates=2) (from our partners at Simba Hosting)
30
- * More advanced & stylish templates with [WooCommerce PDF Invoices & Packing Slips Premium Templates](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-premium-templates/)
31
-
32
- = Fully customizable =
33
- In addition to a number of default settings (including a custom header/logo) and several layout fields that you can use out of the box, the plugin contains HTML/CSS based templates that allow for customization & full control over the PDF output. Copy the templates to your theme folder and you don't have to worry that your customizations will be overwritten when you update the plugin.
34
-
35
- * Insert customer header image/logo
36
- * Modify shop data / footer / disclaimer etc. on the invoices & packing slips
37
- * Select paper size (Letter or A4)
38
- * Translation ready
39
-
40
- == Installation ==
41
-
42
- = Minimum Requirements =
43
-
44
- * WooCommerce 2.0 or later
45
- * WordPress 3.5 or later
46
-
47
- = Automatic installation =
48
- Automatic installation is the easiest option as WordPress handles the file transfers itself and you don't even need to leave your web browser. To do an automatic install of WooCommerce PDF Invoices & Packing Slips, log in to your WordPress admin panel, navigate to the Plugins menu and click Add New.
49
-
50
- In the search field type "WooCommerce PDF Invoices & Packing Slips" and click Search Plugins. You can install it by simply clicking Install Now. After clicking that link you will be asked if you're sure you want to install the plugin. Click yes and WordPress will automatically complete the installation. After installation has finished, click the 'activate plugin' link.
51
-
52
- = Manual installation via the WordPress interface =
53
- 1. Download the plugin zip file to your computer
54
- 2. Go to the WordPress admin panel menu Plugins > Add New
55
- 3. Choose upload
56
- 4. Upload the plugin zip file, the plugin will now be installed
57
- 5. After installation has finished, click the 'activate plugin' link
58
-
59
- = Manual installation via FTP =
60
- 1. Download the plugin file to your computer and unzip it
61
- 2. Using an FTP program, or your hosting control panel, upload the unzipped plugin folder to your WordPress installation's wp-content/plugins/ directory.
62
- 3. Activate the plugin from the Plugins menu within the WordPress admin.
63
-
64
- == Frequently Asked Questions ==
65
-
66
- Make sure to check out [WooCommerce PDF Invoices & Packing Slips documentation](http://docs.wpovernight.com/woocommerce-pdf-invoices-packing-slips/) on our site - it covers most of the questions below (and more!) in more detail!
67
-
68
- = How do I create my own custom template? =
69
-
70
- Copy the files from `wp-content/plugins/woocommerce-pdf-invoices-packing-slips/templates/pdf/Simple/` to your (child) theme in `wp-content/themes/yourtheme/woocommerce/pdf/yourtemplate` and customize them there. The new template will show up as 'yourtemplate' (the folder name) in the settings panel.
71
-
72
- = Where can I find more templates? =
73
-
74
- Go to [wpovernight.com](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-premium-templates/) to checkout more templates! These include templates with more tax details and product thumbnails. Need a custom templates? Contact us at support@wpovernight.com for more information.
75
-
76
- = Can I create/send a proforma invoice or a credit note? =
77
- This is a feature of our Professional extension, which can be found at [wpovernight.com](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-professional/)
78
-
79
- = Can I contribute to the code? =
80
- You're more than welcome! This plugin is hosted on github, where you can post issues or make pull requests.
81
- https://github.com/wpovernight/woocommerce-pdf-invoices-packing-slips
82
-
83
- = My language is not included, how can I contribute? =
84
-
85
- This plugin is translation ready, which means that you can translate it using standard WordPress methods.
86
-
87
- 1. Download POEdit at (http://www.poedit.net/download.php)
88
- 2. Open POEdit
89
- 3. File > New from POT
90
- 4. Open wpo_wcpdf.pot (from `woocommerce-pdf-invoices-packing-slips/languages/`)
91
- 5. A popup will ask you for your language
92
- 6. This step is a bit tricky, configuring the plurals. Somehow the settings can't be copied from the pot. Go to Catalogue > Preferences. Then enter nplurals=2; plural=n != 1; in the custom expression field
93
- 7. Enter the translations. invoice and packing-slip now have two translation fields, single & plural. Note that this is a filename, so replace spaces with a - just to be sure!
94
- 8. Save as `wpo_wcpdf-xx_XX.po`, where you replace xx_XX with your language code & country code suffix (da_DK, pl_PL, de_DE etc.)
95
-
96
- = How can I use my own font? =
97
- Although the plugin supports webfonts, this is somewhat limited and has a lot of caveats, read [this thread](https://wordpress.org/support/topic/webfonts-within-a-custom-template-not-rendering-in-pdf?replies=4#post-5395442) on the forum.
98
- Some languages (Japanese, Chinese, etc.) are not supported by the default font included with the plugin, in this case a custom font is required.
99
- The best method is to create a custom template first (see above), then add a `fonts/` folder to that template and use the following code (replace the font names/filenames) to load the font in the style.css from the pdf template:
100
- `
101
- <?php global $wpo_wcpdf;?>
102
- /* Load font */
103
- @font-face {
104
- font-family: 'MyFont';
105
- font-style: normal;
106
- font-weight: normal;
107
- src: local('MyFont'), local('MyFont'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont.ttf) format('truetype');
108
- }
109
- @font-face {
110
- font-family: 'MyFont';
111
- font-style: normal;
112
- font-weight: bold;
113
- src: local('MyFont Bold'), local('MyFont-Bold'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont-bold.ttf) format('truetype');
114
- }
115
- @font-face {
116
- font-family: 'MyFont';
117
- font-style: italic;
118
- font-weight: normal;
119
- src: local('MyFont Italic'), local('MyFont-Italic'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont-italic.ttf) format('truetype');
120
- }
121
- @font-face {
122
- font-family: 'MyFont';
123
- font-style: italic;
124
- font-weight: bold;
125
- src: local('MyFont Bold Italic'), local('MyFont-BoldItalic'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont-bolditalic.ttf) format('truetype');
126
- }
127
- `
128
- then make sure you assign that font family to the body or other elements of the template:
129
- `
130
- font-family: 'MyFont';
131
- `
132
-
133
- Some notes:
134
-
135
- * Only TTF fonts are supported.
136
- * You can't use numeric font weights (like 700 instead of bold)!
137
- * Avoid spaces or special characters in the font filenames.
138
- * I have found that not all servers cope well with the font paths. If this is the case with your font, try to put the font in the root of your site and put that in the font url (i.e. `url(http://yoursite.com/fonts/myfont-italic.ttf)` )
139
-
140
- Some font links:
141
-
142
- * Japanese - http://ipafont.ipa.go.jp/index.html
143
- * Chinese - http://www.study-area.org/apt/firefly-font/
144
-
145
- = How can I display the HTML/CSS source for debugging/developing templates? =
146
- There's a setting on the Status tab of the settings page that allows you to toggle HTML output. Don't forget to turn if off after you're done testing!
147
-
148
- = How can I display custom fields in the invoice or packing slip? =
149
- First, you need to create a custom template following instructions from the first item in this FAQ.
150
- Then place the following snippet where you would like the custom field to appear:
151
-
152
- `
153
- <?php $wpo_wcpdf->custom_field('custom_fieldname', 'Custom field:'); ?>
154
- `
155
-
156
- Where you replace 'custom_fieldname' with the name of the field you want to display, and 'Custom field' with the label. The plugin only displays the field when it contains data. If you also want to display the label when the field is empty, you can pass a third parameter (true), like this:
157
-
158
- `
159
- <?php $wpo_wcpdf->custom_field('custom_fieldname', 'Custom field:', true); ?>
160
- `
161
-
162
- = How can I display order notes in the invoice or packing slip? =
163
- First, you need to create a custom template following instructions from the first item in this FAQ.
164
- Then place the following snippet where you would like the order notes to appear:
165
-
166
- `
167
- <?php $wpo_wcpdf->order_notes(); ?>
168
- `
169
-
170
- if you want to display all order notes, including the (private) admin notes, use:
171
- `
172
- <?php $wpo_wcpdf->order_notes('all'); ?>
173
- `
174
-
175
- = How do can I modify the pdf filename? =
176
- You can do this via a filter in your theme's `functions.php` (Some themes have a "custom functions" area in the settings).
177
-
178
- Here's a simple example for putting your shop name in front of the filname.
179
- `
180
- add_filter( 'wpo_wcpdf_filename', 'wpo_wcpdf_custom_filename', 10, 4 );
181
- function wpo_wcpdf_custom_filename( $filename, $template_type, $order_ids, $context ) {
182
- // prepend your shopname to the file
183
- $new_filename = 'myshopname_' . $filename;
184
-
185
- return $new_filename;
186
- }
187
- `
188
- You can also use the $template_type ('invoice' or 'packing-slip'), $order_ids (single array) or $context ('download' or 'attachment') variables to make more complex rules for the filename.
189
-
190
- = How can I add a download link to the invoice on the Thank you page? =
191
- You can do this with an action in your theme's `functions.php` (Some themes have a "custom functions" area in the settings). Note that due to security restrictions, this will only work for registered/logged in users!
192
-
193
- `
194
- add_filter('woocommerce_thankyou_order_received_text', 'wpo_wcpdf_thank_you_link', 10, 2);
195
- function wpo_wcpdf_thank_you_link( $text, $order ) {
196
- if ( is_user_logged_in() ) {
197
- $pdf_url = wp_nonce_url( admin_url( 'admin-ajax.php?action=generate_wpo_wcpdf&template_type=invoice&order_ids=' . $order->id . '&my-account'), 'generate_wpo_wcpdf' );
198
- $text .= '<p><a href="'.esc_attr($pdf_url).'">Download a printable invoice / payment confirmation (PDF format)</a></p>';
199
- }
200
- return $text;
201
- }
202
- `
203
-
204
- alternatively, you can hook this text to the `woocommerce_thankyou` action, see [this thread](https://wordpress.org/support/topic/suggestion-for-the-faq?replies=5#post-6298810) on the support forum.
205
-
206
- = How can I get a copy of the invoice emailed to the shop manager? =
207
- The easiest way to do this is to just tick the 'new order' box. However, this also means that an invoice will be created for all new orders, also the ones that are never completed.
208
-
209
- Alternatively you can get a (BCC) copy of the completed order email by placing the following filter in your theme's `functions.php` (Some themes have a "custom functions" area in the settings)
210
- Modify the name & email address to your own preferences,
211
-
212
- `
213
- add_filter( 'woocommerce_email_headers', 'mycustom_headers_filter_function', 10, 2);
214
-
215
- function mycustom_headers_filter_function( $headers, $object ) {
216
- if ($object == 'customer_completed_order') {
217
- $headers .= 'BCC: Your name <your@email.com>' . "\r\n"; //just repeat this line again to insert another email address in BCC
218
- }
219
-
220
- return $headers;
221
- }
222
- `
223
-
224
-
225
- = Fatal error: Allowed memory size of ######## bytes exhausted (tried to allocate ### bytes) =
226
-
227
- This usually only happens on batch actions. PDF creation is a memory intensive job, especially if it includes several pages with images. Go to WooCommerce > System Status to check your WP Memory Limit. We recommend setting it to 128mb or more.
228
-
229
- == Screenshots ==
230
-
231
- 1. General settings page
232
- 2. Template settings page
233
- 3. Simple invoice PDF
234
- 4. Simple packing slip PDF
235
-
236
- == Changelog ==
237
-
238
- = 1.5.29 =
239
- * Translations: Added Croation (Thanks Neven/Spine ICT!), updated French (Thanks Sabra!)
240
- * Tweak: filter shop address before checking if it's empty
241
- * Dev: added $order to `wpo_wcpdf_template_file` filter
242
-
243
- = 1.5.28 =
244
- * Tweak: the 'Next invoice number' is now stored separately in the database for faster and more reliable retrieval. Circumventing any caching, this should prevent duplicate invoice numbers.
245
- * Fix: Bulk actions plugin conflicts
246
- * Experimental: page numbers (use {{PAGE_NUM}} / {{PAGE_COUNT}} in your template)
247
-
248
- = 1.5.27 =
249
- * Feature: Use [invoice_year] and [invoice_month] placeholders in invoice number prefix/suffix
250
- * Feature: WooCommerce Order Status & Actions Manager emails compatibility
251
- * Feature: Add invoice number to WC REST API
252
- * Fix: Allow positive 'discounts' (price corrections)
253
- * Fix: Discounts rounding
254
- * Translations: Updated Finnish & Portugese & POT
255
-
256
- = 1.5.26 =
257
- * Feature: Automatically list all emails registered in WooCommerce
258
- * Feature: Reset invoice number yearly
259
- * Feature: WooCommerce Chained Products compatibility
260
- * Feature: WooCommerce Product Bundles visibility settings taken into account in invoice
261
- * Fix: Disable PDF creation from trashed order_ids
262
- * Tweak: Alert when no orders selected for bulk export (Props to Dartui!)
263
- * Tweak: PDF invoice settings always under WooCommerce menu (also for premium users)
264
- * Tweak: extra $item_id passed in row class filter
265
- * Translations: Updated Slovenian, Spanish, Dutch & POT file
266
-
267
- = 1.5.24 =
268
- * Hotfix: Subscriptions renewal filter arguments
269
-
270
- = 1.5.23 =
271
- * Fix: WooCommerce Subscriptons 2.0 deprecation notice.
272
- * Tweak: better qTranslate-X support
273
- * Tweak: filter for user privileges check (wpo_wcpdf_check_privs)
274
- * Translations: French translations fix
275
-
276
- = 1.5.22 =
277
- * Fix: Workaround for bug in WPML (which cleared all settings)
278
- * Translation: fixed Polish translation for invoice
279
-
280
- = 1.5.21 =
281
- * Translations: Added Estionan (thanks Tanel!)
282
- * Tweak: WC2.4 compatibility
283
-
284
- = 1.5.20 =
285
- * Feature: Option to 'never' display My Account invoice link
286
- * Fix: Order total for refunds in WC2.4
287
- * Fix: notice when no custom statuses selected for My Account display
288
- * Tweak: Product bundles styles
289
-
290
- = 1.5.19 =
291
- * Fix: Invoice number search (broke other custom searches)
292
-
293
- = 1.5.18 =
294
- * Fix: wpo_wcpdf_item_row_class packing slip filter arguments
295
-
296
- = 1.5.17 =
297
- * Feature: WooCommerce Product Bundles compatibility styles
298
- * Tweak: wpo_wcpdf_item_row_class as filter instead of action
299
-
300
- = 1.5.16 =
301
- * Feature: Search orders by invoice number (note: search on formatted invoice number only works for new orders)
302
- * Feature: Formatted invoice number stored in order
303
- * Tweak: Function parameters added to some of the filters
304
- * Tweak: WooCommerce 2.4 compatibility
305
- * Dev feature: action to add class to items table row (wpo_wcpdf_item_row_class)
306
- * Translations: Swedish updated (thanks Conney!)
307
- * Translations: Norwegian updated
308
-
309
- = 1.5.15 =
310
- * Fix: invoice number padding didn't work for values lower than 3
311
- * Tweak: WPML compatibility filter
312
- * Translations: Updated French (Thanks Nicolas!)
313
-
314
- = 1.5.14 =
315
- * Tweak: Invoice number & date edit fields moved to separate box on order edit page
316
- * Translations: Updated POT & Dutch
317
-
318
- = 1.5.13 =
319
- * Fix: Better address comparison to determine when to display alternate address
320
- * Tweak: Filter N/A addresses
321
- * Tweak: Use WooCommerce function for 2.3 discounts
322
- * Translations: Czech Updated (Thanks Ivo!)
323
- * Translations: French (minor fixes)
324
-
325
- = 1.5.12 =
326
- * Translations: added Danish, Updated POT & Italian
327
-
328
- = 1.5.11 =
329
- * Fix: Product text attributes (now checks key too)
330
- * Fix: Status page upload explanation typos
331
-
332
- = 1.5.10 =
333
- * Fix: Double check to make sure plugin doesn't attach to user emails
334
-
335
- = 1.5.9 =
336
- * Feature: Shorthand function to display product attributes: `$wpo_wcpdf->get_product_attribute( $attribute_name, $product )`
337
-
338
- = 1.5.8 =
339
- * Feature: disable invoice for free orders
340
- * Feature: action to insert data before & after item meta
341
- * Tweak: Added classes to sku & weight
342
- * Tweak: Hide payment method from totals (already shown in template)
343
- * Translations: Updated POT & Dutch
344
-
345
- = 1.5.7 =
346
- * Feature: Setting to show email address & phone number on invoice or packing slip (does not work on custom templates based on previous versions!)
347
-
348
- = 1.5.6 =
349
- * Feature: Setting to show shipping address on invoice (does not work on custom templates based on previous versions!)
350
- * Feature: My Account invoice download setting
351
- * Feature: several new template actions
352
- * Tweak: WooCommerce Bookings compatibility
353
- * Tweak: Gerenal stylesheet cleanup
354
- * Fix: temp path check/error on settings page
355
- * Fix: Document titles for credit notes and proforma (Pro)
356
- * Fix: Discount including tax
357
- * Fix: Special characters on item meta (requires WooCommerce 2.3.6)
358
- * Translations: Missing text domain on several strings
359
- * Translations: Updated POT & Dutch
360
-
361
- = 1.5.5 =
362
- * Fix: Check for incomplete line tax data (Subscriptions compatibility)
363
- * Fix: More precise template path instructions
364
- * Fix: duplicate stylesheet filter
365
- * Fix: Always prefer original order's billing address for refunds (WooCommerce EU VAT Number compatibility)
366
- * Translations: Updated German (MwSt. instead of formal Ust.)
367
- * Translations: Updated Dutch
368
-
369
- = 1.5.4 =
370
- * Tweak: include plugin version in style/script includes
371
- * Tweak: upload code cleanup
372
- * Fix: Parent invoice number (for Credit Notes in professional extension)
373
-
374
- = 1.5.3 =
375
- * Feature: add original order date value to order date filter
376
- * Feature: Work with line_tax_data when available
377
- * Feature: pass item_id to items
378
- * Tweak: later check for woocommerce active
379
- * Fix: do not try to validate empty settings (Status page settings)
380
- * Translations: Fixed Dutch typo
381
-
382
- = 1.5.2 =
383
- * Fix: fatal error when trying to activate with WooCommerce not installed yet.
384
- * Tweak: indentation fix on the Simple template
385
-
386
- = 1.5.1 =
387
- * Fix: prevent errors when upgrading
388
-
389
- = 1.5.0 =
390
- * Feature: All temporary files are now stored centrally in the WP uploads folder.
391
- * Feature: Debug settings in status panel (output errors & output to HTML)
392
- * Feature: Compatibility filter for WooCommerce Subscriptions (prevents duplicate invoice numbers)
393
- * Tweak: Pass order to totals filters
394
- * Translations: Updated POT
395
- * Translations: Updated Italian (Thanks Astrid!)
396
- * Translations: Updated Dutch
397
- * FAQ: instructions for placing a link on the thank you page
398
-
399
- = 1.4.14 =
400
- * Fix: fatal error when user registers at checkout (applies to credit notes only)
401
- * Translations: Updated German (Thanks Dietmar!)
402
- * Translations: Place your custom translations in wp-content/languages/woocommerce-pdf-invoices-packing-slips/wpo_wcpdf-LOCALE.mo to protect them from being overwritten by plugin updates.
403
-
404
- = 1.4.13 =
405
- * Feature: use separate file for all your template specific functions (template-functions.php)
406
- * Translations: Added Slovenian (thanks gregy1403!)
407
- * Translations: Updated Norwegian & Dutch.
408
- * Translations: Added Japanese - needs custom font!
409
- * FAQ: instructions on how to use custom fonts
410
-
411
- = 1.4.12 =
412
- * Fix: issues with post parent objects (WC2.1 and older)
413
-
414
- = 1.4.11 =
415
- * Small fix: bulk actions for specific i18n configurations
416
- * Tweak: total row key used as class in Simple template
417
-
418
- = 1.4.10 =
419
- * Fix: Invoice not attaching
420
- * Translations: Updated POT file
421
- * Translations: Updated Dutch, Norwegian, Polish, Brazilian Portugese, Romanian, Russian, Slovak, Spanish & Ukrainian (Many thanks to all the translators!)
422
- * Templates: added action hooks for easier customizations (`wpo_wcpdf_before_order_details`, `wpo_wcpdf_after_order_details`, `wpo_wcpdf_invoice_title` & `wpo_wcpdf_packing_slip_title`)
423
-
424
- = 1.4.9 =
425
- * Feature: Order number and date are now displayed by default in the Simple template (invoice number and date still optional)
426
- * Feature: Display Customer/Order notes with a simple shorthand (see FAQ)
427
- * Translations: Added Brazilian Portugese (thanks Victor Debone!)
428
- * Tweak: Fail more gracefully when there are errors during PDF generation
429
- * Tweak: added template type class to template output body
430
- * Tweak: cleaned up Simple template style.css
431
-
432
- = 1.4.8 =
433
- * Translations: Added Finnish (Thanks Sami Mäkelä/Contrast.fi!)
434
-
435
- = 1.4.7 =
436
- * Fix: check if image file exists locally, fallback to url if not (CDN compatibility)
437
- * Fix: make deleting invoice date possible
438
- * Fix: correct tmp folder check on status page
439
- * Translations: updated po/mo files
440
- * Tweak: changed settings capability requirement to `manage_woocommerce` (was: `manage_options`)
441
- * Tweak: better email attachment function
442
- * Tweak: prevent footer overlap (Simple template)
443
- * Tweak: fallback if `glob()` is not allowed on the server
444
- * Tweak: better custom template instructions (reflects path to actual (child-)theme)
445
-
446
- = 1.4.6 =
447
- * HOTFIX: WooCommerce 2.2 compatibility fix
448
- * Filter for PDF temp folder (wpo_wcpdf_tmp_path)
449
-
450
- = 1.4.5 =
451
- * Fix: Double date conversion for order date on invoice number filter (to avoid i18n date issues)
452
- * Fix: Template selector reset after update
453
- * Translations: added Norwegian (Thanks Aleksander!)
454
-
455
- = 1.4.4 =
456
- * Feature: Editable invoice date per order/invoice.
457
- * Feature: HTML is now allowed in footer and other settings fields.
458
- * Translations: Updated German (Thanks Nadine!)
459
- * Fix: template paths are now saved relative to the site base path (ABSPATH) to prevent errors when moving to another server
460
- * Tweak: Changed bulk action hook for better theme compatibility
461
- * Tweak: Newlines in custom checkout fields
462
-
463
- = 1.4.3 =
464
- * Feature: Added function to call custom fields more easily (see FAQ)
465
- * Feature: Change the my account button text via a filter (wpo_wcpdf_myaccount_button_text)
466
- * Translations: Added Danish (Thanks Mads!)
467
- * Tweak: only load PDF engine if it's not already loaded by another plugin
468
-
469
- = 1.4.2 =
470
- * Fix: Don't create invoice number when exporting packing slips
471
- * Fix: Division by zero for 0 quantity items
472
-
473
- = 1.4.1 =
474
- * Translations: Added Polish (Thanks Mike!)
475
- * Fix: Invoice number formatting notices in debug mode
476
-
477
- = 1.4.0 =
478
- * Feature: Invoice numbers can now be given a prefix, suffix or padding on the settings page!
479
- * Filter: `wpo_wcpdf_email_allowed_statuses` to attach pdf to custom order status emails
480
- * Tweak: Sequential Order Numbers Pro compatibility
481
- * Tweak: Filenames are now automatically sanitized to prevent issues with illegal characters
482
-
483
- = 1.3.2 =
484
- * Fix: error on wpo_wcpdf_email_attachment filter when $pdf_path not set
485
-
486
- = 1.3.1 =
487
- * Fix: invoice number was cleared when Order Actions were being used when an invoice number was not set
488
- * Translations: Updated Slovak (Thanks Jozef!)
489
- * Translations: Added Czech (Thanks CubiQ!)
490
-
491
- = 1.3.0 =
492
- * Feature: Added 'status' panel for better problem diagnosis
493
- * Tweak: split create & get invoice number calls to prevent slow database calls from causing number skipping
494
- * Translations: Added Romanian (Thanks Leonardo!)
495
- * Translations: Added Slovak (Thanks Oleg!)
496
-
497
- = 1.2.13 =
498
- * Feature: added filter for custom email attachment condition (wpo_wcpdf_custom_email_condition)
499
- * Fix: warning for tax implode
500
-
501
- = 1.2.12 =
502
- * Fix: hyperlink underline (was more like a strikethrough)
503
-
504
- = 1.2.11 =
505
- * Translations: Fixed German spelling error
506
- * Translations: Updated Swedish (Thanks Fredrik!)
507
-
508
- = 1.2.10 =
509
- * Translations: Added Swedish (Thanks Jonathan!)
510
- * Fix: Line-height issue (on some systems, the space between lines was very high)
511
-
512
- = 1.2.9 =
513
- * Fix: bug where 'standard' tax class would not display in some cases
514
- * Fix: bug that caused the totals to jump for some font sizes
515
- * Fix: WC2.1 deprecated totals function
516
- * Fix: If multiple taxes were set up with the same name, only one would display (Simple template was not affected)
517
-
518
- = 1.2.8 =
519
- * Template: Body line-height defined to prevent character jumping with italic texts
520
- * Fix: Open Sans now included in plugin package (fixes font issues for servers with allow_url_fopen disabled)
521
-
522
- = 1.2.7 =
523
- * Translations: POT, DE & NL updated
524
- * Fix: Removed stray span tag in totals table
525
-
526
- = 1.2.6 =
527
- * Translations: Spanish update (thanks prepu!)
528
- * Fix: More advanced checks to determine if a customer can download the invoice (including a status filter)
529
-
530
- = 1.2.5 =
531
- * Feature: Optional Invoice Number column for the orders listing
532
- * Feature: Better support for international characters
533
- * Translations: Added Russian & Ukrainian translation (thanks Oleg!)
534
- * Translations: Updated Spanish (Thanks Manuel!) and Dutch translations & POT file
535
- * Tweak: Memory limit notice
536
- * Tweak: Filename name now includes invoice number (when configured in the settings)
537
-
538
- = 1.2.4 =
539
- * Feature: Set which type of emails you want to attach the invoice to
540
-
541
- = 1.2.3 =
542
- * Feature: Manually edit invoice number on the edit order screen
543
- * Feature: Set the first (/next) invoice number on the settings screen
544
- * Fix: Bug where invoice number would be generated twice due to slow database calls
545
- * Fix: php strict warnings
546
-
547
- = 1.2.2 =
548
- * Feature: Simple template now uses Open Sans to include more international special characters
549
- * Feature: Implemented filters for paper size & orientation ([read here](http://wordpress.org/support/topic/select-a5-paper-size-for-packing-slips?replies=5#post-5211129))
550
- * Tweak: PDF engine updated (dompdf 0.6.0)
551
- * Tweak: Download PDF link on the my account page is now only shown when an invoice is already created by the admin or automatically, to prevent unwanted invoice created (creating problems with european laws).
552
-
553
- = 1.2.1 =
554
- * Fix: shipping & fees functions didn't output correctly with the tax set to 'incl'
555
-
556
- = 1.2.0 =
557
- * Feature: Sequential invoice numbers (set upon invoice creation).
558
- * Feature: Invoice date (set upon invoice creation).
559
-
560
- = 1.1.6 =
561
- * Feature: Hungarian translations added - thanks Joseph!
562
- * Tweak: Better debug code.
563
- * Tweak: Error reporting when templates not found.
564
- * Fix: tax rate calculation for free items.
565
-
566
- = 1.1.5 =
567
- * Feature: German translations added - thanks Christian!
568
- * Fix: dompdf 0.6.0 proved to be less stable, so switching back to beta3 for now.
569
-
570
- = 1.1.4 =
571
- * Fix: Template paths on windows servers were not properly saved (stripslashes), resulting in an empty output.
572
-
573
- = 1.1.3 =
574
- * Feature: PDF engine (dompdf) updated to 0.6.0 for better stability and utf-8 support.
575
- * Tweak: Local server path is used for header image for better compatibility with server settings.
576
- * Fix: several small bugs.
577
-
578
- = 1.1.2 =
579
- * Feature: Totals can now be called with simpler template functions
580
- * Feature: Italian translations - thanks max66max!
581
- * Tweak: improved memory performance
582
-
583
- = 1.1.1 =
584
- * Feature: French translations - thanks Guillaume!
585
-
586
- = 1.1.0 =
587
- * Feature: Fees can now also be called ex. VAT
588
- * Feature: Invoices can now be downloaded from the My Account page
589
- * Feature: Spanish translation & POT file included
590
- * Fix: ternary statements that caused an error
591
-
592
- = 1.0.1 =
593
- * Tweak: Packing slip now displays shipping address instead of billing address
594
- * Tweak: Variation data is now displayed by default
595
-
596
- = 1.0.0 =
597
- * First release
598
-
599
- == Upgrade Notice ==
600
-
601
- = 1.5 =
602
- Version 1.5 changes where temporary files are stored - everything is now stored centrally in the WP uploads folder. For backwards compatibility, this feature is turned off by default, but we recommend to use the new folders. Check the plugin Status panel for more information!
 
 
 
 
1
+ === Plugin Name ===
2
+ Contributors: pomegranate
3
+ Tags: woocommerce, pdf, invoices, packing slips, print, delivery notes, invoice, packing slip, export, email, bulk, automatic
4
+ Requires at least: 3.5
5
+ Tested up to: 4.5
6
+ Stable tag: 1.5.30
7
+ License: GPLv2 or later
8
+ License URI: http://www.gnu.org/licenses/gpl-2.0.html
9
+
10
+ Create, print & automatically email PDF invoices & packing slips for WooCommerce orders.
11
+
12
+ == Description ==
13
+
14
+ This WooCommerce extension automatically adds a PDF invoice to the order confirmation emails sent out to your customers. Includes a basic template (additional templates are available from [WP Overnight](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-premium-templates/)) as well as the possibility to modify/create your own templates. In addition, you can choose to download or print invoices and packing slips from the WooCommerce order admin.
15
+
16
+ = Main features =
17
+ * Automatically attach invoice PDF to WooCommerce emails of your choice
18
+ * Download the PDF invoice / packing slip from the order admin page
19
+ * Generate PDF invoices / packings slips in bulk
20
+ * **Fully customizable** HTML/CSS invoice templates
21
+ * Download invoices from the My Account page
22
+ * Sequential invoice numbers - with custom formatting
23
+ * **Available in: Czech, Dutch, English, Finnish, French, German, Hungarian, Italian, Japanese (see FAQ for adding custom fonts!), Norwegian, Polish, Romanian, Russian, Slovak, Slovenian, Spanish, Swedish & Ukrainian**
24
+
25
+ In addition to this, we offer several premium extensions:
26
+
27
+ * Create/email PDF Proforma Invoices, Credit Notes (for Refunds), email Packing Slips & more with [WooCommerce PDF Invoices & Packing Slips Professional](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-professional/)
28
+ * Upload all invoices automatically to Dropbox with [WooCommerce PDF Invoices & Packing Slips to Dropbox](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-dropbox/)
29
+ * Automatically send new orders or packing slips to your printer, as soon as the customer orders! [WooCommerce Automatic Order Printing](https://www.simbahosting.co.uk/s3/product/woocommerce-automatic-order-printing/?affiliates=2) (from our partners at Simba Hosting)
30
+ * More advanced & stylish templates with [WooCommerce PDF Invoices & Packing Slips Premium Templates](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-premium-templates/)
31
+
32
+ = Fully customizable =
33
+ In addition to a number of default settings (including a custom header/logo) and several layout fields that you can use out of the box, the plugin contains HTML/CSS based templates that allow for customization & full control over the PDF output. Copy the templates to your theme folder and you don't have to worry that your customizations will be overwritten when you update the plugin.
34
+
35
+ * Insert customer header image/logo
36
+ * Modify shop data / footer / disclaimer etc. on the invoices & packing slips
37
+ * Select paper size (Letter or A4)
38
+ * Translation ready
39
+
40
+ == Installation ==
41
+
42
+ = Minimum Requirements =
43
+
44
+ * WooCommerce 2.0 or later
45
+ * WordPress 3.5 or later
46
+
47
+ = Automatic installation =
48
+ Automatic installation is the easiest option as WordPress handles the file transfers itself and you don't even need to leave your web browser. To do an automatic install of WooCommerce PDF Invoices & Packing Slips, log in to your WordPress admin panel, navigate to the Plugins menu and click Add New.
49
+
50
+ In the search field type "WooCommerce PDF Invoices & Packing Slips" and click Search Plugins. You can install it by simply clicking Install Now. After clicking that link you will be asked if you're sure you want to install the plugin. Click yes and WordPress will automatically complete the installation. After installation has finished, click the 'activate plugin' link.
51
+
52
+ = Manual installation via the WordPress interface =
53
+ 1. Download the plugin zip file to your computer
54
+ 2. Go to the WordPress admin panel menu Plugins > Add New
55
+ 3. Choose upload
56
+ 4. Upload the plugin zip file, the plugin will now be installed
57
+ 5. After installation has finished, click the 'activate plugin' link
58
+
59
+ = Manual installation via FTP =
60
+ 1. Download the plugin file to your computer and unzip it
61
+ 2. Using an FTP program, or your hosting control panel, upload the unzipped plugin folder to your WordPress installation's wp-content/plugins/ directory.
62
+ 3. Activate the plugin from the Plugins menu within the WordPress admin.
63
+
64
+ == Frequently Asked Questions ==
65
+
66
+ Make sure to check out [WooCommerce PDF Invoices & Packing Slips documentation](http://docs.wpovernight.com/woocommerce-pdf-invoices-packing-slips/) on our site - it covers most of the questions below (and more!) in more detail!
67
+
68
+ = How do I create my own custom template? =
69
+
70
+ Copy the files from `wp-content/plugins/woocommerce-pdf-invoices-packing-slips/templates/pdf/Simple/` to your (child) theme in `wp-content/themes/yourtheme/woocommerce/pdf/yourtemplate` and customize them there. The new template will show up as 'yourtemplate' (the folder name) in the settings panel.
71
+
72
+ = Where can I find more templates? =
73
+
74
+ Go to [wpovernight.com](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-premium-templates/) to checkout more templates! These include templates with more tax details and product thumbnails. Need a custom templates? Contact us at support@wpovernight.com for more information.
75
+
76
+ = Can I create/send a proforma invoice or a credit note? =
77
+ This is a feature of our Professional extension, which can be found at [wpovernight.com](https://wpovernight.com/downloads/woocommerce-pdf-invoices-packing-slips-professional/)
78
+
79
+ = Can I contribute to the code? =
80
+ You're more than welcome! This plugin is hosted on github, where you can post issues or make pull requests.
81
+ https://github.com/wpovernight/woocommerce-pdf-invoices-packing-slips
82
+
83
+ = My language is not included, how can I contribute? =
84
+
85
+ This plugin is translation ready, which means that you can translate it using standard WordPress methods.
86
+
87
+ 1. Download POEdit at (http://www.poedit.net/download.php)
88
+ 2. Open POEdit
89
+ 3. File > New from POT
90
+ 4. Open wpo_wcpdf.pot (from `woocommerce-pdf-invoices-packing-slips/languages/`)
91
+ 5. A popup will ask you for your language
92
+ 6. This step is a bit tricky, configuring the plurals. Somehow the settings can't be copied from the pot. Go to Catalogue > Preferences. Then enter nplurals=2; plural=n != 1; in the custom expression field
93
+ 7. Enter the translations. invoice and packing-slip now have two translation fields, single & plural. Note that this is a filename, so replace spaces with a - just to be sure!
94
+ 8. Save as `wpo_wcpdf-xx_XX.po`, where you replace xx_XX with your language code & country code suffix (da_DK, pl_PL, de_DE etc.)
95
+
96
+ = How can I use my own font? =
97
+ Although the plugin supports webfonts, this is somewhat limited and has a lot of caveats, read [this thread](https://wordpress.org/support/topic/webfonts-within-a-custom-template-not-rendering-in-pdf?replies=4#post-5395442) on the forum.
98
+ Some languages (Japanese, Chinese, etc.) are not supported by the default font included with the plugin, in this case a custom font is required.
99
+ The best method is to create a custom template first (see above), then add a `fonts/` folder to that template and use the following code (replace the font names/filenames) to load the font in the style.css from the pdf template:
100
+ `
101
+ <?php global $wpo_wcpdf;?>
102
+ /* Load font */
103
+ @font-face {
104
+ font-family: 'MyFont';
105
+ font-style: normal;
106
+ font-weight: normal;
107
+ src: local('MyFont'), local('MyFont'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont.ttf) format('truetype');
108
+ }
109
+ @font-face {
110
+ font-family: 'MyFont';
111
+ font-style: normal;
112
+ font-weight: bold;
113
+ src: local('MyFont Bold'), local('MyFont-Bold'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont-bold.ttf) format('truetype');
114
+ }
115
+ @font-face {
116
+ font-family: 'MyFont';
117
+ font-style: italic;
118
+ font-weight: normal;
119
+ src: local('MyFont Italic'), local('MyFont-Italic'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont-italic.ttf) format('truetype');
120
+ }
121
+ @font-face {
122
+ font-family: 'MyFont';
123
+ font-style: italic;
124
+ font-weight: bold;
125
+ src: local('MyFont Bold Italic'), local('MyFont-BoldItalic'), url(<?php echo $wpo_wcpdf->export->template_path; ?>/fonts/myfont-bolditalic.ttf) format('truetype');
126
+ }
127
+ `
128
+ then make sure you assign that font family to the body or other elements of the template:
129
+ `
130
+ font-family: 'MyFont';
131
+ `
132
+
133
+ Some notes:
134
+
135
+ * Only TTF fonts are supported.
136
+ * You can't use numeric font weights (like 700 instead of bold)!
137
+ * Avoid spaces or special characters in the font filenames.
138
+ * I have found that not all servers cope well with the font paths. If this is the case with your font, try to put the font in the root of your site and put that in the font url (i.e. `url(http://yoursite.com/fonts/myfont-italic.ttf)` )
139
+
140
+ Some font links:
141
+
142
+ * Japanese - http://ipafont.ipa.go.jp/index.html
143
+ * Chinese - http://www.study-area.org/apt/firefly-font/
144
+
145
+ = How can I display the HTML/CSS source for debugging/developing templates? =
146
+ There's a setting on the Status tab of the settings page that allows you to toggle HTML output. Don't forget to turn if off after you're done testing!
147
+
148
+ = How can I display custom fields in the invoice or packing slip? =
149
+ First, you need to create a custom template following instructions from the first item in this FAQ.
150
+ Then place the following snippet where you would like the custom field to appear:
151
+
152
+ `
153
+ <?php $wpo_wcpdf->custom_field('custom_fieldname', 'Custom field:'); ?>
154
+ `
155
+
156
+ Where you replace 'custom_fieldname' with the name of the field you want to display, and 'Custom field' with the label. The plugin only displays the field when it contains data. If you also want to display the label when the field is empty, you can pass a third parameter (true), like this:
157
+
158
+ `
159
+ <?php $wpo_wcpdf->custom_field('custom_fieldname', 'Custom field:', true); ?>
160
+ `
161
+
162
+ = How can I display order notes in the invoice or packing slip? =
163
+ First, you need to create a custom template following instructions from the first item in this FAQ.
164
+ Then place the following snippet where you would like the order notes to appear:
165
+
166
+ `
167
+ <?php $wpo_wcpdf->order_notes(); ?>
168
+ `
169
+
170
+ if you want to display all order notes, including the (private) admin notes, use:
171
+ `
172
+ <?php $wpo_wcpdf->order_notes('all'); ?>
173
+ `
174
+
175
+ = How do can I modify the pdf filename? =
176
+ You can do this via a filter in your theme's `functions.php` (Some themes have a "custom functions" area in the settings).
177
+
178
+ Here's a simple example for putting your shop name in front of the filname.
179
+ `
180
+ add_filter( 'wpo_wcpdf_filename', 'wpo_wcpdf_custom_filename', 10, 4 );
181
+ function wpo_wcpdf_custom_filename( $filename, $template_type, $order_ids, $context ) {
182
+ // prepend your shopname to the file
183
+ $new_filename = 'myshopname_' . $filename;
184
+
185
+ return $new_filename;
186
+ }
187
+ `
188
+ You can also use the $template_type ('invoice' or 'packing-slip'), $order_ids (single array) or $context ('download' or 'attachment') variables to make more complex rules for the filename.
189
+
190
+ = How can I add a download link to the invoice on the Thank you page? =
191
+ You can do this with an action in your theme's `functions.php` (Some themes have a "custom functions" area in the settings). Note that due to security restrictions, this will only work for registered/logged in users!
192
+
193
+ `
194
+ add_filter('woocommerce_thankyou_order_received_text', 'wpo_wcpdf_thank_you_link', 10, 2);
195
+ function wpo_wcpdf_thank_you_link( $text, $order ) {
196
+ if ( is_user_logged_in() ) {
197
+ $pdf_url = wp_nonce_url( admin_url( 'admin-ajax.php?action=generate_wpo_wcpdf&template_type=invoice&order_ids=' . $order->id . '&my-account'), 'generate_wpo_wcpdf' );
198
+ $text .= '<p><a href="'.esc_attr($pdf_url).'">Download a printable invoice / payment confirmation (PDF format)</a></p>';
199
+ }
200
+ return $text;
201
+ }
202
+ `
203
+
204
+ alternatively, you can hook this text to the `woocommerce_thankyou` action, see [this thread](https://wordpress.org/support/topic/suggestion-for-the-faq?replies=5#post-6298810) on the support forum.
205
+
206
+ = How can I get a copy of the invoice emailed to the shop manager? =
207
+ The easiest way to do this is to just tick the 'new order' box. However, this also means that an invoice will be created for all new orders, also the ones that are never completed.
208
+
209
+ Alternatively you can get a (BCC) copy of the completed order email by placing the following filter in your theme's `functions.php` (Some themes have a "custom functions" area in the settings)
210
+ Modify the name & email address to your own preferences,
211
+
212
+ `
213
+ add_filter( 'woocommerce_email_headers', 'mycustom_headers_filter_function', 10, 2);
214
+
215
+ function mycustom_headers_filter_function( $headers, $object ) {
216
+ if ($object == 'customer_completed_order') {
217
+ $headers .= 'BCC: Your name <your@email.com>' . "\r\n"; //just repeat this line again to insert another email address in BCC
218
+ }
219
+
220
+ return $headers;
221
+ }
222
+ `
223
+
224
+
225
+ = Fatal error: Allowed memory size of ######## bytes exhausted (tried to allocate ### bytes) =
226
+
227
+ This usually only happens on batch actions. PDF creation is a memory intensive job, especially if it includes several pages with images. Go to WooCommerce > System Status to check your WP Memory Limit. We recommend setting it to 128mb or more.
228
+
229
+ == Screenshots ==
230
+
231
+ 1. General settings page
232
+ 2. Template settings page
233
+ 3. Simple invoice PDF
234
+ 4. Simple packing slip PDF
235
+
236
+ == Changelog ==
237
+
238
+ = 1.5.30 =
239
+ * Feature: Enable currency font for extended currency support
240
+ * Fix: Font sync on plugin update
241
+
242
+ = 1.5.29 =
243
+ * Translations: Added Croation (Thanks Neven/Spine ICT!), updated French (Thanks Sabra!)
244
+ * Tweak: filter shop address before checking if it's empty
245
+ * Dev: added $order to `wpo_wcpdf_template_file` filter
246
+
247
+ = 1.5.28 =
248
+ * Tweak: the 'Next invoice number' is now stored separately in the database for faster and more reliable retrieval. Circumventing any caching, this should prevent duplicate invoice numbers.
249
+ * Fix: Bulk actions plugin conflicts
250
+ * Experimental: page numbers (use {{PAGE_NUM}} / {{PAGE_COUNT}} in your template)
251
+
252
+ = 1.5.27 =
253
+ * Feature: Use [invoice_year] and [invoice_month] placeholders in invoice number prefix/suffix
254
+ * Feature: WooCommerce Order Status & Actions Manager emails compatibility
255
+ * Feature: Add invoice number to WC REST API
256
+ * Fix: Allow positive 'discounts' (price corrections)
257
+ * Fix: Discounts rounding
258
+ * Translations: Updated Finnish & Portugese & POT
259
+
260
+ = 1.5.26 =
261
+ * Feature: Automatically list all emails registered in WooCommerce
262
+ * Feature: Reset invoice number yearly
263
+ * Feature: WooCommerce Chained Products compatibility
264
+ * Feature: WooCommerce Product Bundles visibility settings taken into account in invoice
265
+ * Fix: Disable PDF creation from trashed order_ids
266
+ * Tweak: Alert when no orders selected for bulk export (Props to Dartui!)
267
+ * Tweak: PDF invoice settings always under WooCommerce menu (also for premium users)
268
+ * Tweak: extra $item_id passed in row class filter
269
+ * Translations: Updated Slovenian, Spanish, Dutch & POT file
270
+
271
+ = 1.5.24 =
272
+ * Hotfix: Subscriptions renewal filter arguments
273
+
274
+ = 1.5.23 =
275
+ * Fix: WooCommerce Subscriptons 2.0 deprecation notice.
276
+ * Tweak: better qTranslate-X support
277
+ * Tweak: filter for user privileges check (wpo_wcpdf_check_privs)
278
+ * Translations: French translations fix
279
+
280
+ = 1.5.22 =
281
+ * Fix: Workaround for bug in WPML (which cleared all settings)
282
+ * Translation: fixed Polish translation for invoice
283
+
284
+ = 1.5.21 =
285
+ * Translations: Added Estionan (thanks Tanel!)
286
+ * Tweak: WC2.4 compatibility
287
+
288
+ = 1.5.20 =
289
+ * Feature: Option to 'never' display My Account invoice link
290
+ * Fix: Order total for refunds in WC2.4
291
+ * Fix: notice when no custom statuses selected for My Account display
292
+ * Tweak: Product bundles styles
293
+
294
+ = 1.5.19 =
295
+ * Fix: Invoice number search (broke other custom searches)
296
+
297
+ = 1.5.18 =
298
+ * Fix: wpo_wcpdf_item_row_class packing slip filter arguments
299
+
300
+ = 1.5.17 =
301
+ * Feature: WooCommerce Product Bundles compatibility styles
302
+ * Tweak: wpo_wcpdf_item_row_class as filter instead of action
303
+
304
+ = 1.5.16 =
305
+ * Feature: Search orders by invoice number (note: search on formatted invoice number only works for new orders)
306
+ * Feature: Formatted invoice number stored in order
307
+ * Tweak: Function parameters added to some of the filters
308
+ * Tweak: WooCommerce 2.4 compatibility
309
+ * Dev feature: action to add class to items table row (wpo_wcpdf_item_row_class)
310
+ * Translations: Swedish updated (thanks Conney!)
311
+ * Translations: Norwegian updated
312
+
313
+ = 1.5.15 =
314
+ * Fix: invoice number padding didn't work for values lower than 3
315
+ * Tweak: WPML compatibility filter
316
+ * Translations: Updated French (Thanks Nicolas!)
317
+
318
+ = 1.5.14 =
319
+ * Tweak: Invoice number & date edit fields moved to separate box on order edit page
320
+ * Translations: Updated POT & Dutch
321
+
322
+ = 1.5.13 =
323
+ * Fix: Better address comparison to determine when to display alternate address
324
+ * Tweak: Filter N/A addresses
325
+ * Tweak: Use WooCommerce function for 2.3 discounts
326
+ * Translations: Czech Updated (Thanks Ivo!)
327
+ * Translations: French (minor fixes)
328
+
329
+ = 1.5.12 =
330
+ * Translations: added Danish, Updated POT & Italian
331
+
332
+ = 1.5.11 =
333
+ * Fix: Product text attributes (now checks key too)
334
+ * Fix: Status page upload explanation typos
335
+
336
+ = 1.5.10 =
337
+ * Fix: Double check to make sure plugin doesn't attach to user emails
338
+
339
+ = 1.5.9 =
340
+ * Feature: Shorthand function to display product attributes: `$wpo_wcpdf->get_product_attribute( $attribute_name, $product )`
341
+
342
+ = 1.5.8 =
343
+ * Feature: disable invoice for free orders
344
+ * Feature: action to insert data before & after item meta
345
+ * Tweak: Added classes to sku & weight
346
+ * Tweak: Hide payment method from totals (already shown in template)
347
+ * Translations: Updated POT & Dutch
348
+
349
+ = 1.5.7 =
350
+ * Feature: Setting to show email address & phone number on invoice or packing slip (does not work on custom templates based on previous versions!)
351
+
352
+ = 1.5.6 =
353
+ * Feature: Setting to show shipping address on invoice (does not work on custom templates based on previous versions!)
354
+ * Feature: My Account invoice download setting
355
+ * Feature: several new template actions
356
+ * Tweak: WooCommerce Bookings compatibility
357
+ * Tweak: Gerenal stylesheet cleanup
358
+ * Fix: temp path check/error on settings page
359
+ * Fix: Document titles for credit notes and proforma (Pro)
360
+ * Fix: Discount including tax
361
+ * Fix: Special characters on item meta (requires WooCommerce 2.3.6)
362
+ * Translations: Missing text domain on several strings
363
+ * Translations: Updated POT & Dutch
364
+
365
+ = 1.5.5 =
366
+ * Fix: Check for incomplete line tax data (Subscriptions compatibility)
367
+ * Fix: More precise template path instructions
368
+ * Fix: duplicate stylesheet filter
369
+ * Fix: Always prefer original order's billing address for refunds (WooCommerce EU VAT Number compatibility)
370
+ * Translations: Updated German (MwSt. instead of formal Ust.)
371
+ * Translations: Updated Dutch
372
+
373
+ = 1.5.4 =
374
+ * Tweak: include plugin version in style/script includes
375
+ * Tweak: upload code cleanup
376
+ * Fix: Parent invoice number (for Credit Notes in professional extension)
377
+
378
+ = 1.5.3 =
379
+ * Feature: add original order date value to order date filter
380
+ * Feature: Work with line_tax_data when available
381
+ * Feature: pass item_id to items
382
+ * Tweak: later check for woocommerce active
383
+ * Fix: do not try to validate empty settings (Status page settings)
384
+ * Translations: Fixed Dutch typo
385
+
386
+ = 1.5.2 =
387
+ * Fix: fatal error when trying to activate with WooCommerce not installed yet.
388
+ * Tweak: indentation fix on the Simple template
389
+
390
+ = 1.5.1 =
391
+ * Fix: prevent errors when upgrading
392
+
393
+ = 1.5.0 =
394
+ * Feature: All temporary files are now stored centrally in the WP uploads folder.
395
+ * Feature: Debug settings in status panel (output errors & output to HTML)
396
+ * Feature: Compatibility filter for WooCommerce Subscriptions (prevents duplicate invoice numbers)
397
+ * Tweak: Pass order to totals filters
398
+ * Translations: Updated POT
399
+ * Translations: Updated Italian (Thanks Astrid!)
400
+ * Translations: Updated Dutch
401
+ * FAQ: instructions for placing a link on the thank you page
402
+
403
+ = 1.4.14 =
404
+ * Fix: fatal error when user registers at checkout (applies to credit notes only)
405
+ * Translations: Updated German (Thanks Dietmar!)
406
+ * Translations: Place your custom translations in wp-content/languages/woocommerce-pdf-invoices-packing-slips/wpo_wcpdf-LOCALE.mo to protect them from being overwritten by plugin updates.
407
+
408
+ = 1.4.13 =
409
+ * Feature: use separate file for all your template specific functions (template-functions.php)
410
+ * Translations: Added Slovenian (thanks gregy1403!)
411
+ * Translations: Updated Norwegian & Dutch.
412
+ * Translations: Added Japanese - needs custom font!
413
+ * FAQ: instructions on how to use custom fonts
414
+
415
+ = 1.4.12 =
416
+ * Fix: issues with post parent objects (WC2.1 and older)
417
+
418
+ = 1.4.11 =
419
+ * Small fix: bulk actions for specific i18n configurations
420
+ * Tweak: total row key used as class in Simple template
421
+
422
+ = 1.4.10 =
423
+ * Fix: Invoice not attaching
424
+ * Translations: Updated POT file
425
+ * Translations: Updated Dutch, Norwegian, Polish, Brazilian Portugese, Romanian, Russian, Slovak, Spanish & Ukrainian (Many thanks to all the translators!)
426
+ * Templates: added action hooks for easier customizations (`wpo_wcpdf_before_order_details`, `wpo_wcpdf_after_order_details`, `wpo_wcpdf_invoice_title` & `wpo_wcpdf_packing_slip_title`)
427
+
428
+ = 1.4.9 =
429
+ * Feature: Order number and date are now displayed by default in the Simple template (invoice number and date still optional)
430
+ * Feature: Display Customer/Order notes with a simple shorthand (see FAQ)
431
+ * Translations: Added Brazilian Portugese (thanks Victor Debone!)
432
+ * Tweak: Fail more gracefully when there are errors during PDF generation
433
+ * Tweak: added template type class to template output body
434
+ * Tweak: cleaned up Simple template style.css
435
+
436
+ = 1.4.8 =
437
+ * Translations: Added Finnish (Thanks Sami Mäkelä/Contrast.fi!)
438
+
439
+ = 1.4.7 =
440
+ * Fix: check if image file exists locally, fallback to url if not (CDN compatibility)
441
+ * Fix: make deleting invoice date possible
442
+ * Fix: correct tmp folder check on status page
443
+ * Translations: updated po/mo files
444
+ * Tweak: changed settings capability requirement to `manage_woocommerce` (was: `manage_options`)
445
+ * Tweak: better email attachment function
446
+ * Tweak: prevent footer overlap (Simple template)
447
+ * Tweak: fallback if `glob()` is not allowed on the server
448
+ * Tweak: better custom template instructions (reflects path to actual (child-)theme)
449
+
450
+ = 1.4.6 =
451
+ * HOTFIX: WooCommerce 2.2 compatibility fix
452
+ * Filter for PDF temp folder (wpo_wcpdf_tmp_path)
453
+
454
+ = 1.4.5 =
455
+ * Fix: Double date conversion for order date on invoice number filter (to avoid i18n date issues)
456
+ * Fix: Template selector reset after update
457
+ * Translations: added Norwegian (Thanks Aleksander!)
458
+
459
+ = 1.4.4 =
460
+ * Feature: Editable invoice date per order/invoice.
461
+ * Feature: HTML is now allowed in footer and other settings fields.
462
+ * Translations: Updated German (Thanks Nadine!)
463
+ * Fix: template paths are now saved relative to the site base path (ABSPATH) to prevent errors when moving to another server
464
+ * Tweak: Changed bulk action hook for better theme compatibility
465
+ * Tweak: Newlines in custom checkout fields
466
+
467
+ = 1.4.3 =
468
+ * Feature: Added function to call custom fields more easily (see FAQ)
469
+ * Feature: Change the my account button text via a filter (wpo_wcpdf_myaccount_button_text)
470
+ * Translations: Added Danish (Thanks Mads!)
471
+ * Tweak: only load PDF engine if it's not already loaded by another plugin
472
+
473
+ = 1.4.2 =
474
+ * Fix: Don't create invoice number when exporting packing slips
475
+ * Fix: Division by zero for 0 quantity items
476
+
477
+ = 1.4.1 =
478
+ * Translations: Added Polish (Thanks Mike!)
479
+ * Fix: Invoice number formatting notices in debug mode
480
+
481
+ = 1.4.0 =
482
+ * Feature: Invoice numbers can now be given a prefix, suffix or padding on the settings page!
483
+ * Filter: `wpo_wcpdf_email_allowed_statuses` to attach pdf to custom order status emails
484
+ * Tweak: Sequential Order Numbers Pro compatibility
485
+ * Tweak: Filenames are now automatically sanitized to prevent issues with illegal characters
486
+
487
+ = 1.3.2 =
488
+ * Fix: error on wpo_wcpdf_email_attachment filter when $pdf_path not set
489
+
490
+ = 1.3.1 =
491
+ * Fix: invoice number was cleared when Order Actions were being used when an invoice number was not set
492
+ * Translations: Updated Slovak (Thanks Jozef!)
493
+ * Translations: Added Czech (Thanks CubiQ!)
494
+
495
+ = 1.3.0 =
496
+ * Feature: Added 'status' panel for better problem diagnosis
497
+ * Tweak: split create & get invoice number calls to prevent slow database calls from causing number skipping
498
+ * Translations: Added Romanian (Thanks Leonardo!)
499
+ * Translations: Added Slovak (Thanks Oleg!)
500
+
501
+ = 1.2.13 =
502
+ * Feature: added filter for custom email attachment condition (wpo_wcpdf_custom_email_condition)
503
+ * Fix: warning for tax implode
504
+
505
+ = 1.2.12 =
506
+ * Fix: hyperlink underline (was more like a strikethrough)
507
+
508
+ = 1.2.11 =
509
+ * Translations: Fixed German spelling error
510
+ * Translations: Updated Swedish (Thanks Fredrik!)
511
+
512
+ = 1.2.10 =
513
+ * Translations: Added Swedish (Thanks Jonathan!)
514
+ * Fix: Line-height issue (on some systems, the space between lines was very high)
515
+
516
+ = 1.2.9 =
517
+ * Fix: bug where 'standard' tax class would not display in some cases
518
+ * Fix: bug that caused the totals to jump for some font sizes
519
+ * Fix: WC2.1 deprecated totals function
520
+ * Fix: If multiple taxes were set up with the same name, only one would display (Simple template was not affected)
521
+
522
+ = 1.2.8 =
523
+ * Template: Body line-height defined to prevent character jumping with italic texts
524
+ * Fix: Open Sans now included in plugin package (fixes font issues for servers with allow_url_fopen disabled)
525
+
526
+ = 1.2.7 =
527
+ * Translations: POT, DE & NL updated
528
+ * Fix: Removed stray span tag in totals table
529
+
530
+ = 1.2.6 =
531
+ * Translations: Spanish update (thanks prepu!)
532
+ * Fix: More advanced checks to determine if a customer can download the invoice (including a status filter)
533
+
534
+ = 1.2.5 =
535
+ * Feature: Optional Invoice Number column for the orders listing
536
+ * Feature: Better support for international characters
537
+ * Translations: Added Russian & Ukrainian translation (thanks Oleg!)
538
+ * Translations: Updated Spanish (Thanks Manuel!) and Dutch translations & POT file
539
+ * Tweak: Memory limit notice
540
+ * Tweak: Filename name now includes invoice number (when configured in the settings)
541
+
542
+ = 1.2.4 =
543
+ * Feature: Set which type of emails you want to attach the invoice to
544
+
545
+ = 1.2.3 =
546
+ * Feature: Manually edit invoice number on the edit order screen
547
+ * Feature: Set the first (/next) invoice number on the settings screen
548
+ * Fix: Bug where invoice number would be generated twice due to slow database calls
549
+ * Fix: php strict warnings
550
+
551
+ = 1.2.2 =
552
+ * Feature: Simple template now uses Open Sans to include more international special characters
553
+ * Feature: Implemented filters for paper size & orientation ([read here](http://wordpress.org/support/topic/select-a5-paper-size-for-packing-slips?replies=5#post-5211129))
554
+ * Tweak: PDF engine updated (dompdf 0.6.0)
555
+ * Tweak: Download PDF link on the my account page is now only shown when an invoice is already created by the admin or automatically, to prevent unwanted invoice created (creating problems with european laws).
556
+
557
+ = 1.2.1 =
558
+ * Fix: shipping & fees functions didn't output correctly with the tax set to 'incl'
559
+
560
+ = 1.2.0 =
561
+ * Feature: Sequential invoice numbers (set upon invoice creation).
562
+ * Feature: Invoice date (set upon invoice creation).
563
+
564
+ = 1.1.6 =
565
+ * Feature: Hungarian translations added - thanks Joseph!
566
+ * Tweak: Better debug code.
567
+ * Tweak: Error reporting when templates not found.
568
+ * Fix: tax rate calculation for free items.
569
+
570
+ = 1.1.5 =
571
+ * Feature: German translations added - thanks Christian!
572
+ * Fix: dompdf 0.6.0 proved to be less stable, so switching back to beta3 for now.
573
+
574
+ = 1.1.4 =
575
+ * Fix: Template paths on windows servers were not properly saved (stripslashes), resulting in an empty output.
576
+
577
+ = 1.1.3 =
578
+ * Feature: PDF engine (dompdf) updated to 0.6.0 for better stability and utf-8 support.
579
+ * Tweak: Local server path is used for header image for better compatibility with server settings.
580
+ * Fix: several small bugs.
581
+
582
+ = 1.1.2 =
583
+ * Feature: Totals can now be called with simpler template functions
584
+ * Feature: Italian translations - thanks max66max!
585
+ * Tweak: improved memory performance
586
+
587
+ = 1.1.1 =
588
+ * Feature: French translations - thanks Guillaume!
589
+
590
+ = 1.1.0 =
591
+ * Feature: Fees can now also be called ex. VAT
592
+ * Feature: Invoices can now be downloaded from the My Account page
593
+ * Feature: Spanish translation & POT file included
594
+ * Fix: ternary statements that caused an error
595
+
596
+ = 1.0.1 =
597
+ * Tweak: Packing slip now displays shipping address instead of billing address
598
+ * Tweak: Variation data is now displayed by default
599
+
600
+ = 1.0.0 =
601
+ * First release
602
+
603
+ == Upgrade Notice ==
604
+
605
+ = 1.5 =
606
+ Version 1.5 changes where temporary files are stored - everything is now stored centrally in the WP uploads folder. For backwards compatibility, this feature is turned off by default, but we recommend to use the new folders. Check the plugin Status panel for more information!
woocommerce-pdf-invoices-packingslips.php CHANGED
@@ -1,982 +1,989 @@
1
- <?php
2
- /**
3
- * Plugin Name: WooCommerce PDF Invoices & Packing Slips
4
- * Plugin URI: http://www.wpovernight.com
5
- * Description: Create, print & email PDF invoices & packing slips for WooCommerce orders.
6
- * Version: 1.5.29
7
- * Author: Ewout Fernhout
8
- * Author URI: http://www.wpovernight.com
9
- * License: GPLv2 or later
10
- * License URI: http://www.opensource.org/licenses/gpl-license.php
11
- * Text Domain: wpo_wcpdf
12
- */
13
-
14
- if ( !class_exists( 'WooCommerce_PDF_Invoices' ) ) {
15
-
16
- class WooCommerce_PDF_Invoices {
17
-
18
- public static $plugin_prefix;
19
- public static $plugin_url;
20
- public static $plugin_path;
21
- public static $plugin_basename;
22
- public static $version;
23
-
24
- public $writepanels;
25
- public $settings;
26
- public $export;
27
-
28
- /**
29
- * Constructor
30
- */
31
- public function __construct() {
32
- self::$plugin_prefix = 'wpo_wcpdf_';
33
- self::$plugin_basename = plugin_basename(__FILE__);
34
- self::$plugin_url = plugin_dir_url(self::$plugin_basename);
35
- self::$plugin_path = trailingslashit(dirname(__FILE__));
36
- self::$version = '1.5.29';
37
-
38
- // load the localisation & classes
39
- add_action( 'plugins_loaded', array( $this, 'translations' ) ); // or use init?
40
- add_action( 'init', array( $this, 'load_classes' ) );
41
-
42
- // run lifecycle methods
43
- if ( is_admin() && ! defined( 'DOING_AJAX' ) ) {
44
- // check if upgrading from versionless (1.4.14 and older)
45
- if ( get_option('wpo_wcpdf_general_settings') && get_option('wpo_wcpdf_version') === false ) {
46
- // tag 'versionless', so that we can apply necessary upgrade settings
47
- add_option( 'wpo_wcpdf_version', 'versionless' );
48
- }
49
-
50
- add_action( 'wp_loaded', array( $this, 'do_install' ) );
51
- }
52
- }
53
-
54
- /**
55
- * Load the translation / textdomain files
56
- *
57
- * Note: the first-loaded translation file overrides any following ones if the same translation is present
58
- */
59
- public function translations() {
60
- $locale = apply_filters( 'plugin_locale', get_locale(), 'wpo_wcpdf' );
61
- $dir = trailingslashit( WP_LANG_DIR );
62
-
63
- /**
64
- * Frontend/global Locale. Looks in:
65
- *
66
- * - WP_LANG_DIR/woocommerce-pdf-invoices-packing-slips/wpo_wcpdf-LOCALE.mo
67
- * - WP_LANG_DIR/plugins/wpo_wcpdf-LOCALE.mo
68
- * - woocommerce-pdf-invoices-packing-slips/languages/wpo_wcpdf-LOCALE.mo (which if not found falls back to:)
69
- * - WP_LANG_DIR/plugins/wpo_wcpdf-LOCALE.mo
70
- */
71
- load_textdomain( 'wpo_wcpdf', $dir . 'woocommerce-pdf-invoices-packing-slips/wpo_wcpdf-' . $locale . '.mo' );
72
- load_textdomain( 'wpo_wcpdf', $dir . 'plugins/wpo_wcpdf-' . $locale . '.mo' );
73
- load_plugin_textdomain( 'wpo_wcpdf', false, dirname( self::$plugin_basename ) . '/languages' );
74
- }
75
-
76
- /**
77
- * Load the main plugin classes and functions
78
- */
79
- public function includes() {
80
- include_once( 'includes/class-wcpdf-settings.php' );
81
- include_once( 'includes/class-wcpdf-writepanels.php' );
82
- include_once( 'includes/class-wcpdf-export.php' );
83
- }
84
-
85
-
86
- /**
87
- * Instantiate classes when woocommerce is activated
88
- */
89
- public function load_classes() {
90
- if ( $this->is_woocommerce_activated() ) {
91
- $this->includes();
92
- $this->settings = new WooCommerce_PDF_Invoices_Settings();
93
- $this->writepanels = new WooCommerce_PDF_Invoices_Writepanels();
94
- $this->export = new WooCommerce_PDF_Invoices_Export();
95
- } else {
96
- // display notice instead
97
- add_action( 'admin_notices', array ( $this, 'need_woocommerce' ) );
98
- }
99
-
100
- }
101
-
102
- /**
103
- * Check if woocommerce is activated
104
- */
105
- public function is_woocommerce_activated() {
106
- $blog_plugins = get_option( 'active_plugins', array() );
107
- $site_plugins = get_site_option( 'active_sitewide_plugins', array() );
108
-
109
- if ( in_array( 'woocommerce/woocommerce.php', $blog_plugins ) || isset( $site_plugins['woocommerce/woocommerce.php'] ) ) {
110
- return true;
111
- } else {
112
- return false;
113
- }
114
- }
115
-
116
- /**
117
- * WooCommerce not active notice.
118
- *
119
- * @return string Fallack notice.
120
- */
121
-
122
- public function need_woocommerce() {
123
- $error = sprintf( __( 'WooCommerce PDF Invoices & Packing Slips requires %sWooCommerce%s to be installed & activated!' , 'wpo_wcpdf' ), '<a href="http://wordpress.org/extend/plugins/woocommerce/">', '</a>' );
124
-
125
- $message = '<div class="error"><p>' . $error . '</p></div>';
126
-
127
- echo $message;
128
- }
129
-
130
- /** Lifecycle methods *******************************************************
131
- * Because register_activation_hook only runs when the plugin is manually
132
- * activated by the user, we're checking the current version against the
133
- * version stored in the database
134
- ****************************************************************************/
135
-
136
- /**
137
- * Handles version checking
138
- */
139
- public function do_install() {
140
- // only install when woocommerce is active
141
- if ( !$this->is_woocommerce_activated() ) {
142
- return;
143
- }
144
-
145
- $version_setting = 'wpo_wcpdf_version';
146
- $installed_version = get_option( $version_setting );
147
-
148
- // installed version lower than plugin version?
149
- if ( version_compare( $installed_version, self::$version, '<' ) ) {
150
-
151
- if ( ! $installed_version ) {
152
- $this->install();
153
- } else {
154
- $this->upgrade( $installed_version );
155
- }
156
-
157
- // new version number
158
- update_option( $version_setting, self::$version );
159
- }
160
- }
161
-
162
-
163
- /**
164
- * Plugin install method. Perform any installation tasks here
165
- */
166
- protected function install() {
167
- // Create temp folders
168
- $tmp_base = $this->export->get_tmp_base();
169
-
170
- // check if tmp folder exists => if not, initialize
171
- if ( !@is_dir( $tmp_base ) ) {
172
- $this->export->init_tmp( $tmp_base );
173
- }
174
-
175
- }
176
-
177
-
178
- /**
179
- * Plugin upgrade method. Perform any required upgrades here
180
- *
181
- * @param string $installed_version the currently installed version
182
- */
183
- protected function upgrade( $installed_version ) {
184
- if ( $installed_version == 'versionless') { // versionless = 1.4.14 and older
185
- // We're upgrading from an old version, so we're enabling the option to use the plugin tmp folder.
186
- // This is not per se the 'best' solution, but the good thing is that nothing is changed
187
- // and nothing will be broken (that wasn't broken before)
188
- $default = array( 'old_tmp' => 1 );
189
- update_option( 'wpo_wcpdf_debug_settings', $default );
190
- }
191
-
192
- // sync fonts on every upgrade!
193
- $debug_settings = get_option( 'wpo_wcpdf_debug_settings' ); // get temp setting
194
-
195
- // do not copy if old_tmp function active! (double check for slow databases)
196
- if ( !( isset($this->debug_settings['old_tmp']) || $installed_version == 'versionless' ) ) {
197
- $tmp_base = $this->export->get_tmp_base();
198
-
199
- // check if tmp folder exists => if not, initialize
200
- if ( !@is_dir( $tmp_base ) ) {
201
- $this->export->init_tmp( $tmp_base );
202
- }
203
-
204
- $font_path = $tmp_base . 'fonts/';
205
- $this->export->copy_fonts( $font_path );
206
- }
207
-
208
- // 1.5.28 update: copy next invoice number to separate setting
209
- if ( $installed_version == 'versionless' || version_compare( $installed_version, '1.5.28', '<' ) ) {
210
- $template_settings = get_option( 'wpo_wcpdf_template_settings' );
211
- $next_invoice_number = isset($template_settings['next_invoice_number'])?$template_settings['next_invoice_number']:'';
212
- update_option( 'wpo_wcpdf_next_invoice_number', $next_invoice_number );
213
- }
214
- }
215
-
216
- /***********************************************************************/
217
- /********************** GENERAL TEMPLATE FUNCTIONS *********************/
218
- /***********************************************************************/
219
-
220
- /**
221
- * Get template name from slug
222
- */
223
- public function get_template_name ( $template_type ) {
224
- switch ( $template_type ) {
225
- case 'invoice':
226
- $template_name = apply_filters( 'wpo_wcpdf_invoice_title', __( 'Invoice', 'wpo_wcpdf' ) );
227
- break;
228
- case 'packing-slip':
229
- $template_name = apply_filters( 'wpo_wcpdf_packing_slip_title', __( 'Packing Slip', 'wpo_wcpdf' ) );
230
- break;
231
- default:
232
- // try to 'unslug' the name
233
- $template_name = ucwords( str_replace( array( '_', '-' ), ' ', $template_type ) );
234
- break;
235
- }
236
-
237
- return apply_filters( 'wpo_wcpdf_template_name', $template_name, $template_type );
238
- }
239
-
240
- /**
241
- * Output template styles
242
- */
243
- public function template_styles() {
244
- $css = apply_filters( 'wpo_wcpdf_template_styles_file', $this->export->template_path. '/' .'style.css' );
245
-
246
- ob_start();
247
- if (file_exists($css)) {
248
- include($css);
249
- }
250
- $html = ob_get_clean();
251
- $html = apply_filters( 'wpo_wcpdf_template_styles', $html );
252
-
253
- echo $html;
254
- }
255
-
256
- /**
257
- * Return logo id
258
- */
259
- public function get_header_logo_id() {
260
- if (isset($this->settings->template_settings['header_logo'])) {
261
- return apply_filters( 'wpo_wcpdf_header_logo_id', $this->settings->template_settings['header_logo'] );
262
- }
263
- }
264
-
265
- /**
266
- * Show logo html
267
- */
268
- public function header_logo() {
269
- if ($this->get_header_logo_id()) {
270
- $attachment_id = $this->get_header_logo_id();
271
- $company = isset($this->settings->template_settings['shop_name'])? $this->settings->template_settings['shop_name'] : '';
272
- if( $attachment_id ) {
273
- $attachment = wp_get_attachment_image_src( $attachment_id, 'full', false );
274
-
275
- $attachment_src = $attachment[0];
276
- $attachment_width = $attachment[1];
277
- $attachment_height = $attachment[2];
278
-
279
- $attachment_path = get_attached_file( $attachment_id );
280
-
281
- if ( apply_filters('wpo_wcpdf_use_path', true) && file_exists($attachment_path) ) {
282
- $src = $attachment_path;
283
- } else {
284
- $src = $attachment_src;
285
- }
286
-
287
- printf('<img src="%1$s" width="%2$d" height="%3$d" alt="%4$s" />', $src, $attachment_width, $attachment_height, esc_attr( $company ) );
288
- }
289
- }
290
- }
291
-
292
- /**
293
- * Return/Show custom company name or default to blog name
294
- */
295
- public function get_shop_name() {
296
- if (!empty($this->settings->template_settings['shop_name'])) {
297
- $name = trim( $this->settings->template_settings['shop_name'] );
298
- return apply_filters( 'wpo_wcpdf_shop_name', wptexturize( $name ) );
299
- } else {
300
- return apply_filters( 'wpo_wcpdf_shop_name', get_bloginfo( 'name' ) );
301
- }
302
- }
303
- public function shop_name() {
304
- echo $this->get_shop_name();
305
- }
306
-
307
- /**
308
- * Return/Show shop/company address if provided
309
- */
310
- public function get_shop_address() {
311
- $shop_address = apply_filters( 'wpo_wcpdf_shop_address', wpautop( wptexturize( $this->settings->template_settings['shop_address'] ) ) );
312
- if (!empty($shop_address)) {
313
- return $shop_address;
314
- } else {
315
- return false;
316
- }
317
- }
318
- public function shop_address() {
319
- echo $this->get_shop_address();
320
- }
321
-
322
- /**
323
- * Check if billing address and shipping address are equal
324
- */
325
- public function ships_to_different_address() {
326
- // always prefer parent address for refunds
327
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
328
- // temporarily switch order to make all filters / order calls work correctly
329
- $order_meta = get_post_meta( $parent_order_id );
330
- } else {
331
- $order_meta = get_post_meta( $this->export->order->id );
332
- }
333
-
334
- $address_comparison_fields = apply_filters( 'wpo_wcpdf_address_comparison_fields', array(
335
- 'first_name',
336
- 'last_name',
337
- 'company',
338
- 'address_1',
339
- 'address_2',
340
- 'city',
341
- 'state',
342
- 'postcode',
343
- 'country'
344
- ) );
345
-
346
- foreach ($address_comparison_fields as $address_field) {
347
- $billing_field = isset( $order_meta['_billing_'.$address_field] ) ? $order_meta['_billing_'.$address_field] : '';
348
- $shipping_field = isset( $order_meta['_shipping_'.$address_field] ) ? $order_meta['_shipping_'.$address_field] : '';
349
- if ( $shipping_field != $billing_field ) {
350
- // this address field is different -> ships to different address!
351
- return true;
352
- }
353
- }
354
-
355
- //if we got here, it means the addresses are equal -> doesn't ship to different address!
356
- return apply_filters( 'wpo_wcpdf_ships_to_different_address', false, $order_meta );
357
- }
358
-
359
- /**
360
- * Return/Show billing address
361
- */
362
- public function get_billing_address() {
363
- // always prefer parent billing address for refunds
364
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
365
- // temporarily switch order to make all filters / order calls work correctly
366
- $current_order = $this->export->order;
367
- $this->export->order = new WC_Order( $parent_order_id );
368
- $address = apply_filters( 'wpo_wcpdf_billing_address', $this->export->order->get_formatted_billing_address() );
369
- // switch back & unset
370
- $this->export->order = $current_order;
371
- unset($current_order);
372
- } elseif ( $address = $this->export->order->get_formatted_billing_address() ) {
373
- // regular shop_order
374
- $address = apply_filters( 'wpo_wcpdf_billing_address', $address );
375
- } else {
376
- // no address
377
- $address = apply_filters( 'wpo_wcpdf_billing_address', __('N/A', 'wpo_wcpdf') );
378
- }
379
-
380
- return $address;
381
- }
382
- public function billing_address() {
383
- echo $this->get_billing_address();
384
- }
385
-
386
- /**
387
- * Return/Show billing email
388
- */
389
- public function get_billing_email() {
390
- $billing_email = $this->export->order->billing_email;
391
-
392
- if ( !$billing_email && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
393
- // try parent
394
- $billing_email = get_post_meta( $parent_order_id, '_billing_email', true );
395
- }
396
-
397
- return apply_filters( 'wpo_wcpdf_billing_email', $billing_email );
398
- }
399
- public function billing_email() {
400
- echo $this->get_billing_email();
401
- }
402
-
403
- /**
404
- * Return/Show billing phone
405
- */
406
- public function get_billing_phone() {
407
- $billing_phone = $this->export->order->billing_phone;
408
-
409
- if ( !$billing_phone && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
410
- // try parent
411
- $billing_phone = get_post_meta( $parent_order_id, '_billing_phone', true );
412
- }
413
-
414
- return apply_filters( 'wpo_wcpdf_billing_phone', $billing_phone );
415
- }
416
- public function billing_phone() {
417
- echo $this->get_billing_phone();
418
- }
419
-
420
- /**
421
- * Return/Show shipping address
422
- */
423
- public function get_shipping_address() {
424
- // always prefer parent shipping address for refunds
425
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
426
- // temporarily switch order to make all filters / order calls work correctly
427
- $current_order = $this->export->order;
428
- $this->export->order = new WC_Order( $parent_order_id );
429
- $address = apply_filters( 'wpo_wcpdf_shipping_address', $this->export->order->get_formatted_shipping_address() );
430
- // switch back & unset
431
- $this->export->order = $current_order;
432
- unset($current_order);
433
- } elseif ( $address = $this->export->order->get_formatted_shipping_address() ) {
434
- // regular shop_order
435
- $address = apply_filters( 'wpo_wcpdf_shipping_address', $address );
436
- } else {
437
- // no address
438
- $address = apply_filters( 'wpo_wcpdf_shipping_address', __('N/A', 'wpo_wcpdf') );
439
- }
440
-
441
- return $address;
442
- }
443
- public function shipping_address() {
444
- echo $this->get_shipping_address();
445
- }
446
-
447
- /**
448
- * Return/Show a custom field
449
- */
450
- public function get_custom_field( $field_name ) {
451
- $custom_field = get_post_meta($this->export->order->id,$field_name,true);
452
-
453
- if ( !$custom_field && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
454
- // try parent
455
- $custom_field = get_post_meta( $parent_order_id, $field_name, true );
456
- }
457
-
458
- return apply_filters( 'wpo_wcpdf_billing_custom_field', $custom_field );
459
- }
460
- public function custom_field( $field_name, $field_label = '', $display_empty = false ) {
461
- $custom_field = $this->get_custom_field( $field_name );
462
- if (!empty($field_label)){
463
- // add a a trailing space to the label
464
- $field_label .= ' ';
465
- }
466
-
467
- if (!empty($custom_field) || $display_empty) {
468
- echo $field_label . nl2br ($custom_field);
469
- }
470
- }
471
-
472
- /**
473
- * Return/Show order notes
474
- */
475
- public function get_order_notes( $filter = 'customer' ) {
476
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
477
- $post_id = $parent_order_id;
478
- } else {
479
- $post_id = $this->export->order->id;
480
- }
481
-
482
- $args = array(
483
- 'post_id' => $post_id,
484
- 'approve' => 'approve',
485
- 'type' => 'order_note'
486
- );
487
-
488
- remove_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 );
489
-
490
- $notes = get_comments( $args );
491
-
492
- add_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 );
493
-
494
- if ( $notes ) {
495
- foreach( $notes as $key => $note ) {
496
- if ( $filter == 'customer' && !get_comment_meta( $note->comment_ID, 'is_customer_note', true ) ) {
497
- unset($notes[$key]);
498
- }
499
- if ( $filter == 'private' && get_comment_meta( $note->comment_ID, 'is_customer_note', true ) ) {
500
- unset($notes[$key]);
501
- }
502
- }
503
- return $notes;
504
- }
505
- }
506
- public function order_notes( $filter = 'customer' ) {
507
- $notes = $this->get_order_notes( $filter );
508
- if ( $notes ) {
509
- foreach( $notes as $note ) {
510
- ?>
511
- <div class="note_content">
512
- <?php echo wpautop( wptexturize( wp_kses_post( $note->comment_content ) ) ); ?>
513
- </div>
514
- <?php
515
- }
516
- }
517
- }
518
-
519
- /**
520
- * Return/Show the current date
521
- */
522
- public function get_current_date() {
523
- return apply_filters( 'wpo_wcpdf_date', date_i18n( get_option( 'date_format' ) ) );
524
- }
525
- public function current_date() {
526
- echo $this->get_current_date();
527
- }
528
-
529
- /**
530
- * Return/Show payment method
531
- */
532
- public function get_payment_method() {
533
- $payment_method_label = __( 'Payment method', 'wpo_wcpdf' );
534
-
535
- $payment_method = __( $this->export->order->payment_method_title, 'woocommerce' );
536
- if ( !$payment_method && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
537
- // try parent
538
- $payment_method = get_post_meta( $parent_order_id, '_payment_method_title', true );
539
- $payment_method = __( $payment_method, 'woocommerce' );
540
- }
541
-
542
- return apply_filters( 'wpo_wcpdf_payment_method', $payment_method );
543
- }
544
- public function payment_method() {
545
- echo $this->get_payment_method();
546
- }
547
-
548
- /**
549
- * Return/Show shipping method
550
- */
551
- public function get_shipping_method() {
552
- $shipping_method_label = __( 'Shipping method', 'wpo_wcpdf' );
553
- return apply_filters( 'wpo_wcpdf_shipping_method', __( $this->export->order->get_shipping_method(), 'woocommerce' ) );
554
- }
555
- public function shipping_method() {
556
- echo $this->get_shipping_method();
557
- }
558
-
559
- /**
560
- * Return/Show order number
561
- */
562
- public function get_order_number() {
563
- // try parent first
564
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
565
- $parent_order = new WC_Order( $parent_order_id );
566
- $order_number = $parent_order->get_order_number();
567
- } else {
568
- $order_number = $this->export->order->get_order_number();
569
- }
570
-
571
- // Trim the hash to have a clean number but still
572
- // support any filters that were applied before.
573
- $order_number = ltrim($order_number, '#');
574
- return apply_filters( 'wpo_wcpdf_order_number', $order_number);
575
- }
576
- public function order_number() {
577
- echo $this->get_order_number();
578
- }
579
-
580
- /**
581
- * Return/Show invoice number
582
- */
583
- public function get_invoice_number() {
584
- // try parent first
585
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
586
- $invoice_number = $this->export->get_invoice_number( $parent_order_id );
587
- } else {
588
- $invoice_number = $this->export->get_invoice_number( $this->export->order->id );
589
- }
590
-
591
- return $invoice_number;
592
- }
593
- public function invoice_number() {
594
- echo $this->get_invoice_number();
595
- }
596
-
597
- /**
598
- * Return/Show the order date
599
- */
600
- public function get_order_date() {
601
- if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
602
- $parent_order = new WC_Order( $parent_order_id );
603
- $order_date = $parent_order->order_date;
604
- } else {
605
- $order_date = $this->export->order->order_date;
606
- }
607
-
608
- $date = date_i18n( get_option( 'date_format' ), strtotime( $order_date ) );
609
- return apply_filters( 'wpo_wcpdf_order_date', $date, $order_date );
610
- }
611
- public function order_date() {
612
- echo $this->get_order_date();
613
- }
614
-
615
- /**
616
- * Return/Show the invoice date
617
- */
618
- public function get_invoice_date() {
619
- $invoice_date = get_post_meta($this->export->order->id,'_wcpdf_invoice_date',true);
620
-
621
- // add invoice date if it doesn't exist
622
- if ( empty($invoice_date) || !isset($invoice_date) ) {
623
- $invoice_date = current_time('mysql');
624
- update_post_meta( $this->export->order->id, '_wcpdf_invoice_date', $invoice_date );
625
- }
626
-
627
- $formatted_invoice_date = date_i18n( get_option( 'date_format' ), strtotime( $invoice_date ) );
628
-
629
- return apply_filters( 'wpo_wcpdf_invoice_date', $formatted_invoice_date, $invoice_date );
630
- }
631
- public function invoice_date() {
632
- echo $this->get_invoice_date();
633
- }
634
-
635
- /**
636
- * Return the order items
637
- */
638
- public function get_order_items() {
639
- return apply_filters( 'wpo_wcpdf_order_items', $this->export->get_order_items() );
640
- }
641
-
642
- /**
643
- * Return/show product attribute
644
- */
645
- public function get_product_attribute( $attribute_name, $product ) {
646
- // first, check the text attributes
647
- $attributes = $product->get_attributes();
648
- $attribute_key = @wc_attribute_taxonomy_name( $attribute_name );
649
- if (array_key_exists( sanitize_title( $attribute_name ), $attributes) ) {
650
- $attribute = $product->get_attribute ( $attribute_name );
651
- return $attribute;
652
- } elseif (array_key_exists( sanitize_title( $attribute_key ), $attributes) ) {
653
- $attribute = $product->get_attribute ( $attribute_key );
654
- return $attribute;
655
- }
656
-
657
- // not a text attribute, try attribute taxonomy
658
- $attribute_key = @wc_attribute_taxonomy_name( $attribute_name );
659
- $product_terms = @wc_get_product_terms( $product->id, $attribute_key, array( 'fields' => 'names' ) );
660
- // check if not empty, then display
661
- if ( !empty($product_terms) ) {
662
- $attribute = array_shift( $product_terms );
663
- return $attribute;
664
- } else {
665
- // no attribute under this name
666
- return false;
667
- }
668
- }
669
- public function product_attribute( $attribute_name, $product ) {
670
- echo $this->get_product_attribute( $attribute_name, $product );
671
- }
672
-
673
-
674
- /**
675
- * Return the order totals listing
676
- */
677
- public function get_woocommerce_totals() {
678
- // get totals and remove the semicolon
679
- $totals = apply_filters( 'wpo_wcpdf_raw_order_totals', $this->export->order->get_order_item_totals(), $this->export->order );
680
-
681
- // remove the colon for every label
682
- foreach ( $totals as $key => $total ) {
683
- $label = $total['label'];
684
- $colon = strrpos( $label, ':' );
685
- if( $colon !== false ) {
686
- $label = substr_replace( $label, '', $colon, 1 );
687
- }
688
- $totals[$key]['label'] = $label;
689
- }
690
-
691
- // WC2.4 fix order_total for refunded orders
692
- if ( version_compare( WOOCOMMERCE_VERSION, '2.4', '>=' ) && isset($totals['order_total']) ) {
693
- $tax_display = $this->export->order->tax_display_cart;
694
- $totals['order_total']['value'] = wc_price( $this->export->order->get_total(), array( 'currency' => $this->export->order->get_order_currency() ) );
695
- $order_total = $this->export->order->get_total();
696
- $tax_string = '';
697
-
698
- // Tax for inclusive prices
699
- if ( wc_tax_enabled() && 'incl' == $tax_display ) {
700
- $tax_string_array = array();
701
-
702
- if ( 'itemized' == get_option( 'woocommerce_tax_total_display' ) ) {
703
- foreach ( $this->export->order->get_tax_totals() as $code => $tax ) {
704
- $tax_amount = $tax->formatted_amount;
705
- $tax_string_array[] = sprintf( '%s %s', $tax_amount, $tax->label );
706
- }
707
- } else {
708
- $tax_string_array[] = sprintf( '%s %s', wc_price( $this->export->order->get_total_tax() - $this->export->order->get_total_tax_refunded(), array( 'currency' => $this->export->order->get_order_currency() ) ), WC()->countries->tax_or_vat() );
709
- }
710
- if ( ! empty( $tax_string_array ) ) {
711
- $tax_string = ' ' . sprintf( __( '(Includes %s)', 'woocommerce' ), implode( ', ', $tax_string_array ) );
712
- }
713
- }
714
-
715
- $totals['order_total']['value'] .= $tax_string;
716
- }
717
-
718
- return apply_filters( 'wpo_wcpdf_woocommerce_totals', $totals, $this->export->order );
719
- }
720
-
721
- /**
722
- * Return/show the order subtotal
723
- */
724
- public function get_order_subtotal( $tax = 'excl', $discount = 'incl' ) { // set $tax to 'incl' to include tax, same for $discount
725
- //$compound = ($discount == 'incl')?true:false;
726
-
727
- $subtotal = $this->export->order->get_subtotal_to_display( false, $tax );
728
-
729
- $subtotal = ($pos = strpos($subtotal, ' <small>')) ? substr($subtotal, 0, $pos) : $subtotal; //removing the 'excluding tax' text
730
-
731
- $subtotal = array (
732
- 'label' => __('Subtotal', 'wpo_wcpdf'),
733
- 'value' => $subtotal,
734
- );
735
-
736
- return apply_filters( 'wpo_wcpdf_order_subtotal', $subtotal, $tax, $discount );
737
- }
738
- public function order_subtotal( $tax = 'excl', $discount = 'incl' ) {
739
- $subtotal = $this->get_order_subtotal( $tax, $discount );
740
- echo $subtotal['value'];
741
- }
742
-
743
- /**
744
- * Return/show the order shipping costs
745
- */
746
- public function get_order_shipping( $tax = 'excl' ) { // set $tax to 'incl' to include tax
747
- if ($tax == 'excl' ) {
748
- $shipping_costs = $this->export->wc_price( $this->export->order->order_shipping );
749
- } else {
750
- $shipping_costs = $this->export->wc_price( $this->export->order->order_shipping + $this->export->order->order_shipping_tax );
751
- }
752
-
753
- $shipping = array (
754
- 'label' => __('Shipping', 'wpo_wcpdf'),
755
- 'value' => $shipping_costs,
756
- 'tax' => $this->export->wc_price( $this->export->order->order_shipping_tax ),
757
- );
758
- return apply_filters( 'wpo_wcpdf_order_shipping', $shipping, $tax );
759
- }
760
- public function order_shipping( $tax = 'excl' ) {
761
- $shipping = $this->get_order_shipping( $tax );
762
- echo $shipping['value'];
763
- }
764
-
765
- /**
766
- * Return/show the total discount
767
- */
768
- public function get_order_discount( $type = 'total', $tax = 'incl' ) {
769
- if ( $tax == 'incl' ) {
770
- switch ($type) {
771
- case 'cart':
772
- // Cart Discount - pre-tax discounts. (deprecated in WC2.3)
773
- $discount_value = $this->export->order->get_cart_discount();
774
- break;
775
- case 'order':
776
- // Order Discount - post-tax discounts. (deprecated in WC2.3)
777
- $discount_value = $this->export->order->get_order_discount();
778
- break;
779
- case 'total':
780
- // Total Discount
781
- if ( version_compare( WOOCOMMERCE_VERSION, '2.3' ) >= 0 ) {
782
- $discount_value = $this->export->order->get_total_discount( false ); // $ex_tax = false
783
- } else {
784
- // WC2.2 and older: recalculate to include tax
785
- $discount_value = 0;
786
- $items = $this->export->order->get_items();;
787
- if( sizeof( $items ) > 0 ) {
788
- foreach( $items as $item ) {
789
- $discount_value += ($item['line_subtotal'] + $item['line_subtotal_tax']) - ($item['line_total'] + $item['line_tax']);
790
- }
791
- }
792
- }
793
-
794
- break;
795
- default:
796
- // Total Discount - Cart & Order Discounts combined
797
- $discount_value = $this->export->order->get_total_discount();
798
- break;
799
- }
800
- } else { // calculate discount excluding tax
801
- if ( version_compare( WOOCOMMERCE_VERSION, '2.3' ) >= 0 ) {
802
- $discount_value = $this->export->order->get_total_discount( true ); // $ex_tax = true
803
- } else {
804
- // WC2.2 and older: recalculate to exclude tax
805
- $discount_value = 0;
806
-
807
- $items = $this->export->order->get_items();;
808
- if( sizeof( $items ) > 0 ) {
809
- foreach( $items as $item ) {
810
- $discount_value += ($item['line_subtotal'] - $item['line_total']);
811
- }
812
- }
813
- }
814
- }
815
-
816
- $discount = array (
817
- 'label' => __('Discount', 'wpo_wcpdf'),
818
- 'value' => $this->export->wc_price($discount_value),
819
- 'raw_value' => $discount_value,
820
- );
821
-
822
- if ( round( $discount_value, 3 ) != 0 ) {
823
- return apply_filters( 'wpo_wcpdf_order_discount', $discount, $type, $tax );
824
- }
825
- }
826
- public function order_discount( $type = 'total', $tax = 'incl' ) {
827
- $discount = $this->get_order_discount( $type, $tax );
828
- echo $discount['value'];
829
- }
830
-
831
- /**
832
- * Return the order fees
833
- */
834
- public function get_order_fees( $tax = 'excl' ) {
835
- if ( $wcfees = $this->export->order->get_fees() ) {
836
- foreach( $wcfees as $id => $fee ) {
837
- if ($tax == 'excl' ) {
838
- $fee_price = $this->export->wc_price( $fee['line_total'] );
839
- } else {
840
- $fee_price = $this->export->wc_price( $fee['line_total'] + $fee['line_tax'] );
841
- }
842
-
843
- $fees[ $id ] = array(
844
- 'label' => $fee['name'],
845
- 'value' => $fee_price,
846
- 'line_total' => $this->export->wc_price($fee['line_total']),
847
- 'line_tax' => $this->export->wc_price($fee['line_tax'])
848
- );
849
- }
850
- return $fees;
851
- }
852
- }
853
-
854
- /**
855
- * Return the order taxes
856
- */
857
- public function get_order_taxes() {
858
- $tax_label = __( 'VAT', 'wpo_wcpdf' ); // register alternate label translation
859
- $tax_label = __( 'Tax rate', 'wpo_wcpdf' );
860
- $tax_rate_ids = $this->export->get_tax_rate_ids();
861
- if ($this->export->order->get_taxes()) {
862
- foreach ( $this->export->order->get_taxes() as $key => $tax ) {
863
- $taxes[ $key ] = array(
864
- 'label' => isset( $tax[ 'label' ] ) ? $tax[ 'label' ] : $tax[ 'name' ],
865
- 'value' => $this->export->wc_price( ( $tax[ 'tax_amount' ] + $tax[ 'shipping_tax_amount' ] ) ),
866
- 'rate_id' => $tax['rate_id'],
867
- 'tax_amount' => $tax['tax_amount'],
868
- 'shipping_tax_amount' => $tax['shipping_tax_amount'],
869
- 'rate' => isset( $tax_rate_ids[ $tax['rate_id'] ] ) ? ( (float) $tax_rate_ids[$tax['rate_id']]['tax_rate'] ) . ' %': '',
870
- );
871
- }
872
-
873
- return apply_filters( 'wpo_wcpdf_order_taxes', $taxes );
874
- }
875
- }
876
-
877
- /**
878
- * Return/show the order grand total
879
- */
880
- public function get_order_grand_total( $tax = 'incl' ) {
881
- if ( version_compare( WOOCOMMERCE_VERSION, '2.1' ) >= 0 ) {
882
- // WC 2.1 or newer is used
883
- $total_unformatted = $this->export->order->get_total();
884
- } else {
885
- // Backwards compatibility
886
- $total_unformatted = $this->export->order->get_order_total();
887
- }
888
-
889
- if ($tax == 'excl' ) {
890
- $total_tax = 0;
891
- foreach ( $this->export->order->get_taxes() as $tax ) {
892
- $total_tax += ( $tax[ 'tax_amount' ] + $tax[ 'shipping_tax_amount' ] );
893
- }
894
-
895
- $total = $this->export->wc_price( ( $total_unformatted - $total_tax ) );
896
- $label = __( 'Total ex. VAT', 'wpo_wcpdf' );
897
- } else {
898
- $total = $this->export->wc_price( ( $total_unformatted ) );
899
- $label = __( 'Total', 'wpo_wcpdf' );
900
- }
901
-
902
- $grand_total = array(
903
- 'label' => $label,
904
- 'value' => $total,
905
- );
906
-
907
- return apply_filters( 'wpo_wcpdf_order_grand_total', $grand_total, $tax );
908
- }
909
- public function order_grand_total( $tax = 'incl' ) {
910
- $grand_total = $this->get_order_grand_total( $tax );
911
- echo $grand_total['value'];
912
- }
913
-
914
-
915
- /**
916
- * Return/Show shipping notes
917
- */
918
- public function get_shipping_notes() {
919
- $shipping_notes = wpautop( wptexturize( $this->export->order->customer_note ) );
920
- return apply_filters( 'wpo_wcpdf_shipping_notes', $shipping_notes );
921
- }
922
- public function shipping_notes() {
923
- echo $this->get_shipping_notes();
924
- }
925
-
926
-
927
- /**
928
- * Return/Show shop/company footer imprint, copyright etc.
929
- */
930
- public function get_footer() {
931
- if (isset($this->settings->template_settings['footer'])) {
932
- $footer = wpautop( wptexturize( $this->settings->template_settings[ 'footer' ] ) );
933
- return apply_filters( 'wpo_wcpdf_footer', $footer );
934
- }
935
- }
936
- public function footer() {
937
- echo $this->get_footer();
938
- }
939
-
940
- /**
941
- * Return/Show Extra field 1
942
- */
943
- public function get_extra_1() {
944
- if (isset($this->settings->template_settings['extra_1'])) {
945
- $extra_1 = nl2br( wptexturize( $this->settings->template_settings[ 'extra_1' ] ) );
946
- return apply_filters( 'wpo_wcpdf_extra_1', $extra_1 );
947
- }
948
- }
949
- public function extra_1() {
950
- echo $this->get_extra_1();
951
- }
952
-
953
- /**
954
- * Return/Show Extra field 2
955
- */
956
- public function get_extra_2() {
957
- if (isset($this->settings->template_settings['extra_2'])) {
958
- $extra_2 = nl2br( wptexturize( $this->settings->template_settings[ 'extra_2' ] ) );
959
- return apply_filters( 'wpo_wcpdf_extra_2', $extra_2 );
960
- }
961
- }
962
- public function extra_2() {
963
- echo $this->get_extra_2();
964
- }
965
-
966
- /**
967
- * Return/Show Extra field 3
968
- */
969
- public function get_extra_3() {
970
- if (isset($this->settings->template_settings['extra_3'])) {
971
- $extra_3 = nl2br( wptexturize( $this->settings->template_settings[ 'extra_3' ] ) );
972
- return apply_filters( 'wpo_wcpdf_extra_3', $extra_3 );
973
- }
974
- }
975
- public function extra_3() {
976
- echo $this->get_extra_3();
977
- }
978
- }
979
- }
980
-
981
- // Load main plugin class
982
- $wpo_wcpdf = new WooCommerce_PDF_Invoices();
 
 
 
 
 
 
 
1
+ <?php
2
+ /**
3
+ * Plugin Name: WooCommerce PDF Invoices & Packing Slips
4
+ * Plugin URI: http://www.wpovernight.com
5
+ * Description: Create, print & email PDF invoices & packing slips for WooCommerce orders.
6
+ * Version: 1.5.30
7
+ * Author: Ewout Fernhout
8
+ * Author URI: http://www.wpovernight.com
9
+ * License: GPLv2 or later
10
+ * License URI: http://www.opensource.org/licenses/gpl-license.php
11
+ * Text Domain: wpo_wcpdf
12
+ */
13
+
14
+ if ( !class_exists( 'WooCommerce_PDF_Invoices' ) ) {
15
+
16
+ class WooCommerce_PDF_Invoices {
17
+
18
+ public static $plugin_prefix;
19
+ public static $plugin_url;
20
+ public static $plugin_path;
21
+ public static $plugin_basename;
22
+ public static $version;
23
+
24
+ public $writepanels;
25
+ public $settings;
26
+ public $export;
27
+
28
+ /**
29
+ * Constructor
30
+ */
31
+ public function __construct() {
32
+ self::$plugin_prefix = 'wpo_wcpdf_';
33
+ self::$plugin_basename = plugin_basename(__FILE__);
34
+ self::$plugin_url = plugin_dir_url(self::$plugin_basename);
35
+ self::$plugin_path = trailingslashit(dirname(__FILE__));
36
+ self::$version = '1.5.30';
37
+
38
+ // load the localisation & classes
39
+ add_action( 'plugins_loaded', array( $this, 'translations' ) ); // or use init?
40
+ add_action( 'init', array( $this, 'load_classes' ) );
41
+
42
+ // run lifecycle methods
43
+ if ( is_admin() && ! defined( 'DOING_AJAX' ) ) {
44
+ // check if upgrading from versionless (1.4.14 and older)
45
+ if ( get_option('wpo_wcpdf_general_settings') && get_option('wpo_wcpdf_version') === false ) {
46
+ // tag 'versionless', so that we can apply necessary upgrade settings
47
+ add_option( 'wpo_wcpdf_version', 'versionless' );
48
+ }
49
+
50
+ add_action( 'wp_loaded', array( $this, 'do_install' ) );
51
+ }
52
+ }
53
+
54
+ /**
55
+ * Load the translation / textdomain files
56
+ *
57
+ * Note: the first-loaded translation file overrides any following ones if the same translation is present
58
+ */
59
+ public function translations() {
60
+ $locale = apply_filters( 'plugin_locale', get_locale(), 'wpo_wcpdf' );
61
+ $dir = trailingslashit( WP_LANG_DIR );
62
+
63
+ /**
64
+ * Frontend/global Locale. Looks in:
65
+ *
66
+ * - WP_LANG_DIR/woocommerce-pdf-invoices-packing-slips/wpo_wcpdf-LOCALE.mo
67
+ * - WP_LANG_DIR/plugins/wpo_wcpdf-LOCALE.mo
68
+ * - woocommerce-pdf-invoices-packing-slips/languages/wpo_wcpdf-LOCALE.mo (which if not found falls back to:)
69
+ * - WP_LANG_DIR/plugins/wpo_wcpdf-LOCALE.mo
70
+ */
71
+ load_textdomain( 'wpo_wcpdf', $dir . 'woocommerce-pdf-invoices-packing-slips/wpo_wcpdf-' . $locale . '.mo' );
72
+ load_textdomain( 'wpo_wcpdf', $dir . 'plugins/wpo_wcpdf-' . $locale . '.mo' );
73
+ load_plugin_textdomain( 'wpo_wcpdf', false, dirname( self::$plugin_basename ) . '/languages' );
74
+ }
75
+
76
+ /**
77
+ * Load the main plugin classes and functions
78
+ */
79
+ public function includes() {
80
+ include_once( 'includes/class-wcpdf-settings.php' );
81
+ include_once( 'includes/class-wcpdf-writepanels.php' );
82
+ include_once( 'includes/class-wcpdf-export.php' );
83
+ }
84
+
85
+
86
+ /**
87
+ * Instantiate classes when woocommerce is activated
88
+ */
89
+ public function load_classes() {
90
+ if ( $this->is_woocommerce_activated() ) {
91
+ $this->includes();
92
+ $this->settings = new WooCommerce_PDF_Invoices_Settings();
93
+ $this->writepanels = new WooCommerce_PDF_Invoices_Writepanels();
94
+ $this->export = new WooCommerce_PDF_Invoices_Export();
95
+ } else {
96
+ // display notice instead
97
+ add_action( 'admin_notices', array ( $this, 'need_woocommerce' ) );
98
+ }
99
+
100
+ }
101
+
102
+ /**
103
+ * Check if woocommerce is activated
104
+ */
105
+ public function is_woocommerce_activated() {
106
+ $blog_plugins = get_option( 'active_plugins', array() );
107
+ $site_plugins = get_site_option( 'active_sitewide_plugins', array() );
108
+
109
+ if ( in_array( 'woocommerce/woocommerce.php', $blog_plugins ) || isset( $site_plugins['woocommerce/woocommerce.php'] ) ) {
110
+ return true;
111
+ } else {
112
+ return false;
113
+ }
114
+ }
115
+
116
+ /**
117
+ * WooCommerce not active notice.
118
+ *
119
+ * @return string Fallack notice.
120
+ */
121
+
122
+ public function need_woocommerce() {
123
+ $error = sprintf( __( 'WooCommerce PDF Invoices & Packing Slips requires %sWooCommerce%s to be installed & activated!' , 'wpo_wcpdf' ), '<a href="http://wordpress.org/extend/plugins/woocommerce/">', '</a>' );
124
+
125
+ $message = '<div class="error"><p>' . $error . '</p></div>';
126
+
127
+ echo $message;
128
+ }
129
+
130
+ /** Lifecycle methods *******************************************************
131
+ * Because register_activation_hook only runs when the plugin is manually
132
+ * activated by the user, we're checking the current version against the
133
+ * version stored in the database
134
+ ****************************************************************************/
135
+
136
+ /**
137
+ * Handles version checking
138
+ */
139
+ public function do_install() {
140
+ // only install when woocommerce is active
141
+ if ( !$this->is_woocommerce_activated() ) {
142
+ return;
143
+ }
144
+
145
+ $version_setting = 'wpo_wcpdf_version';
146
+ $installed_version = get_option( $version_setting );
147
+
148
+ // installed version lower than plugin version?
149
+ if ( version_compare( $installed_version, self::$version, '<' ) ) {
150
+
151
+ if ( ! $installed_version ) {
152
+ $this->install();
153
+ } else {
154
+ $this->upgrade( $installed_version );
155
+ }
156
+
157
+ // new version number
158
+ update_option( $version_setting, self::$version );
159
+ }
160
+ }
161
+
162
+
163
+ /**
164
+ * Plugin install method. Perform any installation tasks here
165
+ */
166
+ protected function install() {
167
+ // Create temp folders
168
+ $tmp_base = $this->export->get_tmp_base();
169
+
170
+ // check if tmp folder exists => if not, initialize
171
+ if ( !@is_dir( $tmp_base ) ) {
172
+ $this->export->init_tmp( $tmp_base );
173
+ }
174
+
175
+ }
176
+
177
+
178
+ /**
179
+ * Plugin upgrade method. Perform any required upgrades here
180
+ *
181
+ * @param string $installed_version the currently installed version
182
+ */
183
+ protected function upgrade( $installed_version ) {
184
+ if ( $installed_version == 'versionless') { // versionless = 1.4.14 and older
185
+ // We're upgrading from an old version, so we're enabling the option to use the plugin tmp folder.
186
+ // This is not per se the 'best' solution, but the good thing is that nothing is changed
187
+ // and nothing will be broken (that wasn't broken before)
188
+ $default = array( 'old_tmp' => 1 );
189
+ update_option( 'wpo_wcpdf_debug_settings', $default );
190
+ }
191
+
192
+ // sync fonts on every upgrade!
193
+ $debug_settings = get_option( 'wpo_wcpdf_debug_settings' ); // get temp setting
194
+
195
+ // do not copy if old_tmp function active! (double check for slow databases)
196
+ if ( !( isset($debug_settings['old_tmp']) || $installed_version == 'versionless' ) ) {
197
+ $tmp_base = $this->export->get_tmp_base();
198
+
199
+ // check if tmp folder exists => if not, initialize
200
+ if ( !@is_dir( $tmp_base ) ) {
201
+ $this->export->init_tmp( $tmp_base );
202
+ }
203
+
204
+ $font_path = $tmp_base . 'fonts/';
205
+ $this->export->copy_fonts( $font_path );
206
+ }
207
+
208
+ // 1.5.28 update: copy next invoice number to separate setting
209
+ if ( $installed_version == 'versionless' || version_compare( $installed_version, '1.5.28', '<' ) ) {
210
+ $template_settings = get_option( 'wpo_wcpdf_template_settings' );
211
+ $next_invoice_number = isset($template_settings['next_invoice_number'])?$template_settings['next_invoice_number']:'';
212
+ update_option( 'wpo_wcpdf_next_invoice_number', $next_invoice_number );
213
+ }
214
+ }
215
+
216
+ /***********************************************************************/
217
+ /********************** GENERAL TEMPLATE FUNCTIONS *********************/
218
+ /***********************************************************************/
219
+
220
+ /**
221
+ * Get template name from slug
222
+ */
223
+ public function get_template_name ( $template_type ) {
224
+ switch ( $template_type ) {
225
+ case 'invoice':
226
+ $template_name = apply_filters( 'wpo_wcpdf_invoice_title', __( 'Invoice', 'wpo_wcpdf' ) );
227
+ break;
228
+ case 'packing-slip':
229
+ $template_name = apply_filters( 'wpo_wcpdf_packing_slip_title', __( 'Packing Slip', 'wpo_wcpdf' ) );
230
+ break;
231
+ default:
232
+ // try to 'unslug' the name
233
+ $template_name = ucwords( str_replace( array( '_', '-' ), ' ', $template_type ) );
234
+ break;
235
+ }
236
+
237
+ return apply_filters( 'wpo_wcpdf_template_name', $template_name, $template_type );
238
+ }
239
+
240
+ /**
241
+ * Output template styles
242
+ */
243
+ public function template_styles() {
244
+ $css = apply_filters( 'wpo_wcpdf_template_styles_file', $this->export->template_path. '/' .'style.css' );
245
+
246
+ ob_start();
247
+ if (file_exists($css)) {
248
+ include($css);
249
+ }
250
+ $html = ob_get_clean();
251
+ $html = apply_filters( 'wpo_wcpdf_template_styles', $html );
252
+
253
+ echo $html;
254
+ }
255
+
256
+ /**
257
+ * Return logo id
258
+ */
259
+ public function get_header_logo_id() {
260
+ if (isset($this->settings->template_settings['header_logo'])) {
261
+ return apply_filters( 'wpo_wcpdf_header_logo_id', $this->settings->template_settings['header_logo'] );
262
+ }
263
+ }
264
+
265
+ /**
266
+ * Show logo html
267
+ */
268
+ public function header_logo() {
269
+ if ($this->get_header_logo_id()) {
270
+ $attachment_id = $this->get_header_logo_id();
271
+ $company = isset($this->settings->template_settings['shop_name'])? $this->settings->template_settings['shop_name'] : '';
272
+ if( $attachment_id ) {
273
+ $attachment = wp_get_attachment_image_src( $attachment_id, 'full', false );
274
+
275
+ $attachment_src = $attachment[0];
276
+ $attachment_width = $attachment[1];
277
+ $attachment_height = $attachment[2];
278
+
279
+ $attachment_path = get_attached_file( $attachment_id );
280
+
281
+ if ( apply_filters('wpo_wcpdf_use_path', true) && file_exists($attachment_path) ) {
282
+ $src = $attachment_path;
283
+ } else {
284
+ $src = $attachment_src;
285
+ }
286
+
287
+ printf('<img src="%1$s" width="%2$d" height="%3$d" alt="%4$s" />', $src, $attachment_width, $attachment_height, esc_attr( $company ) );
288
+ }
289
+ }
290
+ }
291
+
292
+ /**
293
+ * Return/Show custom company name or default to blog name
294
+ */
295
+ public function get_shop_name() {
296
+ if (!empty($this->settings->template_settings['shop_name'])) {
297
+ $name = trim( $this->settings->template_settings['shop_name'] );
298
+ return apply_filters( 'wpo_wcpdf_shop_name', wptexturize( $name ) );
299
+ } else {
300
+ return apply_filters( 'wpo_wcpdf_shop_name', get_bloginfo( 'name' ) );
301
+ }
302
+ }
303
+ public function shop_name() {
304
+ echo $this->get_shop_name();
305
+ }
306
+
307
+ /**
308
+ * Return/Show shop/company address if provided
309
+ */
310
+ public function get_shop_address() {
311
+ $shop_address = apply_filters( 'wpo_wcpdf_shop_address', wpautop( wptexturize( $this->settings->template_settings['shop_address'] ) ) );
312
+ if (!empty($shop_address)) {
313
+ return $shop_address;
314
+ } else {
315
+ return false;
316
+ }
317
+ }
318
+ public function shop_address() {
319
+ echo $this->get_shop_address();
320
+ }
321
+
322
+ /**
323
+ * Check if billing address and shipping address are equal
324
+ */
325
+ public function ships_to_different_address() {
326
+ // always prefer parent address for refunds
327
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
328
+ // temporarily switch order to make all filters / order calls work correctly
329
+ $order_meta = get_post_meta( $parent_order_id );
330
+ } else {
331
+ $order_meta = get_post_meta( $this->export->order->id );
332
+ }
333
+
334
+ $address_comparison_fields = apply_filters( 'wpo_wcpdf_address_comparison_fields', array(
335
+ 'first_name',
336
+ 'last_name',
337
+ 'company',
338
+ 'address_1',
339
+ 'address_2',
340
+ 'city',
341
+ 'state',
342
+ 'postcode',
343
+ 'country'
344
+ ) );
345
+
346
+ foreach ($address_comparison_fields as $address_field) {
347
+ $billing_field = isset( $order_meta['_billing_'.$address_field] ) ? $order_meta['_billing_'.$address_field] : '';
348
+ $shipping_field = isset( $order_meta['_shipping_'.$address_field] ) ? $order_meta['_shipping_'.$address_field] : '';
349
+ if ( $shipping_field != $billing_field ) {
350
+ // this address field is different -> ships to different address!
351
+ return true;
352
+ }
353
+ }
354
+
355
+ //if we got here, it means the addresses are equal -> doesn't ship to different address!
356
+ return apply_filters( 'wpo_wcpdf_ships_to_different_address', false, $order_meta );
357
+ }
358
+
359
+ /**
360
+ * Return/Show billing address
361
+ */
362
+ public function get_billing_address() {
363
+ // always prefer parent billing address for refunds
364
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
365
+ // temporarily switch order to make all filters / order calls work correctly
366
+ $current_order = $this->export->order;
367
+ $this->export->order = new WC_Order( $parent_order_id );
368
+ $address = apply_filters( 'wpo_wcpdf_billing_address', $this->export->order->get_formatted_billing_address() );
369
+ // switch back & unset
370
+ $this->export->order = $current_order;
371
+ unset($current_order);
372
+ } elseif ( $address = $this->export->order->get_formatted_billing_address() ) {
373
+ // regular shop_order
374
+ $address = apply_filters( 'wpo_wcpdf_billing_address', $address );
375
+ } else {
376
+ // no address
377
+ $address = apply_filters( 'wpo_wcpdf_billing_address', __('N/A', 'wpo_wcpdf') );
378
+ }
379
+
380
+ return $address;
381
+ }
382
+ public function billing_address() {
383
+ echo $this->get_billing_address();
384
+ }
385
+
386
+ /**
387
+ * Return/Show billing email
388
+ */
389
+ public function get_billing_email() {
390
+ $billing_email = $this->export->order->billing_email;
391
+
392
+ if ( !$billing_email && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
393
+ // try parent
394
+ $billing_email = get_post_meta( $parent_order_id, '_billing_email', true );
395
+ }
396
+
397
+ return apply_filters( 'wpo_wcpdf_billing_email', $billing_email );
398
+ }
399
+ public function billing_email() {
400
+ echo $this->get_billing_email();
401
+ }
402
+
403
+ /**
404
+ * Return/Show billing phone
405
+ */
406
+ public function get_billing_phone() {
407
+ $billing_phone = $this->export->order->billing_phone;
408
+
409
+ if ( !$billing_phone && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
410
+ // try parent
411
+ $billing_phone = get_post_meta( $parent_order_id, '_billing_phone', true );
412
+ }
413
+
414
+ return apply_filters( 'wpo_wcpdf_billing_phone', $billing_phone );
415
+ }
416
+ public function billing_phone() {
417
+ echo $this->get_billing_phone();
418
+ }
419
+
420
+ /**
421
+ * Return/Show shipping address
422
+ */
423
+ public function get_shipping_address() {
424
+ // always prefer parent shipping address for refunds
425
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
426
+ // temporarily switch order to make all filters / order calls work correctly
427
+ $current_order = $this->export->order;
428
+ $this->export->order = new WC_Order( $parent_order_id );
429
+ $address = apply_filters( 'wpo_wcpdf_shipping_address', $this->export->order->get_formatted_shipping_address() );
430
+ // switch back & unset
431
+ $this->export->order = $current_order;
432
+ unset($current_order);
433
+ } elseif ( $address = $this->export->order->get_formatted_shipping_address() ) {
434
+ // regular shop_order
435
+ $address = apply_filters( 'wpo_wcpdf_shipping_address', $address );
436
+ } else {
437
+ // no address
438
+ $address = apply_filters( 'wpo_wcpdf_shipping_address', __('N/A', 'wpo_wcpdf') );
439
+ }
440
+
441
+ return $address;
442
+ }
443
+ public function shipping_address() {
444
+ echo $this->get_shipping_address();
445
+ }
446
+
447
+ /**
448
+ * Return/Show a custom field
449
+ */
450
+ public function get_custom_field( $field_name ) {
451
+ $custom_field = get_post_meta($this->export->order->id,$field_name,true);
452
+
453
+ if ( !$custom_field && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
454
+ // try parent
455
+ $custom_field = get_post_meta( $parent_order_id, $field_name, true );
456
+ }
457
+
458
+ return apply_filters( 'wpo_wcpdf_billing_custom_field', $custom_field );
459
+ }
460
+ public function custom_field( $field_name, $field_label = '', $display_empty = false ) {
461
+ $custom_field = $this->get_custom_field( $field_name );
462
+ if (!empty($field_label)){
463
+ // add a a trailing space to the label
464
+ $field_label .= ' ';
465
+ }
466
+
467
+ if (!empty($custom_field) || $display_empty) {
468
+ echo $field_label . nl2br ($custom_field);
469
+ }
470
+ }
471
+
472
+ /**
473
+ * Return/Show order notes
474
+ */
475
+ public function get_order_notes( $filter = 'customer' ) {
476
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
477
+ $post_id = $parent_order_id;
478
+ } else {
479
+ $post_id = $this->export->order->id;
480
+ }
481
+
482
+ $args = array(
483
+ 'post_id' => $post_id,
484
+ 'approve' => 'approve',
485
+ 'type' => 'order_note'
486
+ );
487
+
488
+ remove_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 );
489
+
490
+ $notes = get_comments( $args );
491
+
492
+ add_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 );
493
+
494
+ if ( $notes ) {
495
+ foreach( $notes as $key => $note ) {
496
+ if ( $filter == 'customer' && !get_comment_meta( $note->comment_ID, 'is_customer_note', true ) ) {
497
+ unset($notes[$key]);
498
+ }
499
+ if ( $filter == 'private' && get_comment_meta( $note->comment_ID, 'is_customer_note', true ) ) {
500
+ unset($notes[$key]);
501
+ }
502
+ }
503
+ return $notes;
504
+ }
505
+ }
506
+ public function order_notes( $filter = 'customer' ) {
507
+ $notes = $this->get_order_notes( $filter );
508
+ if ( $notes ) {
509
+ foreach( $notes as $note ) {
510
+ ?>
511
+ <div class="note_content">
512
+ <?php echo wpautop( wptexturize( wp_kses_post( $note->comment_content ) ) ); ?>
513
+ </div>
514
+ <?php
515
+ }
516
+ }
517
+ }
518
+
519
+ /**
520
+ * Return/Show the current date
521
+ */
522
+ public function get_current_date() {
523
+ return apply_filters( 'wpo_wcpdf_date', date_i18n( get_option( 'date_format' ) ) );
524
+ }
525
+ public function current_date() {
526
+ echo $this->get_current_date();
527
+ }
528
+
529
+ /**
530
+ * Return/Show payment method
531
+ */
532
+ public function get_payment_method() {
533
+ $payment_method_label = __( 'Payment method', 'wpo_wcpdf' );
534
+
535
+ $payment_method = __( $this->export->order->payment_method_title, 'woocommerce' );
536
+ if ( !$payment_method && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
537
+ // try parent
538
+ $payment_method = get_post_meta( $parent_order_id, '_payment_method_title', true );
539
+ $payment_method = __( $payment_method, 'woocommerce' );
540
+ }
541
+
542
+ return apply_filters( 'wpo_wcpdf_payment_method', $payment_method );
543
+ }
544
+ public function payment_method() {
545
+ echo $this->get_payment_method();
546
+ }
547
+
548
+ /**
549
+ * Return/Show shipping method
550
+ */
551
+ public function get_shipping_method() {
552
+ $shipping_method_label = __( 'Shipping method', 'wpo_wcpdf' );
553
+ return apply_filters( 'wpo_wcpdf_shipping_method', __( $this->export->order->get_shipping_method(), 'woocommerce' ) );
554
+ }
555
+ public function shipping_method() {
556
+ echo $this->get_shipping_method();
557
+ }
558
+
559
+ /**
560
+ * Return/Show order number
561
+ */
562
+ public function get_order_number() {
563
+ // try parent first
564
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
565
+ $parent_order = new WC_Order( $parent_order_id );
566
+ $order_number = $parent_order->get_order_number();
567
+ } else {
568
+ $order_number = $this->export->order->get_order_number();
569
+ }
570
+
571
+ // Trim the hash to have a clean number but still
572
+ // support any filters that were applied before.
573
+ $order_number = ltrim($order_number, '#');
574
+ return apply_filters( 'wpo_wcpdf_order_number', $order_number);
575
+ }
576
+ public function order_number() {
577
+ echo $this->get_order_number();
578
+ }
579
+
580
+ /**
581
+ * Return/Show invoice number
582
+ */
583
+ public function get_invoice_number() {
584
+ // try parent first
585
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
586
+ $invoice_number = $this->export->get_invoice_number( $parent_order_id );
587
+ } else {
588
+ $invoice_number = $this->export->get_invoice_number( $this->export->order->id );
589
+ }
590
+
591
+ return $invoice_number;
592
+ }
593
+ public function invoice_number() {
594
+ echo $this->get_invoice_number();
595
+ }
596
+
597
+ /**
598
+ * Return/Show the order date
599
+ */
600
+ public function get_order_date() {
601
+ if ( get_post_type( $this->export->order->id ) == 'shop_order_refund' && $parent_order_id = wp_get_post_parent_id( $this->export->order->id ) ) {
602
+ $parent_order = new WC_Order( $parent_order_id );
603
+ $order_date = $parent_order->order_date;
604
+ } else {
605
+ $order_date = $this->export->order->order_date;
606
+ }
607
+
608
+ $date = date_i18n( get_option( 'date_format' ), strtotime( $order_date ) );
609
+ return apply_filters( 'wpo_wcpdf_order_date', $date, $order_date );
610
+ }
611
+ public function order_date() {
612
+ echo $this->get_order_date();
613
+ }
614
+
615
+ /**
616
+ * Return/Show the invoice date
617
+ */
618
+ public function get_invoice_date() {
619
+ $invoice_date = get_post_meta($this->export->order->id,'_wcpdf_invoice_date',true);
620
+
621
+ // add invoice date if it doesn't exist
622
+ if ( empty($invoice_date) || !isset($invoice_date) ) {
623
+ $invoice_date = current_time('mysql');
624
+ update_post_meta( $this->export->order->id, '_wcpdf_invoice_date', $invoice_date );
625
+ }
626
+
627
+ $formatted_invoice_date = date_i18n( get_option( 'date_format' ), strtotime( $invoice_date ) );
628
+
629
+ return apply_filters( 'wpo_wcpdf_invoice_date', $formatted_invoice_date, $invoice_date );
630
+ }
631
+ public function invoice_date() {
632
+ echo $this->get_invoice_date();
633
+ }
634
+
635
+ /**
636
+ * Return the order items
637
+ */
638
+ public function get_order_items() {
639
+ return apply_filters( 'wpo_wcpdf_order_items', $this->export->get_order_items() );
640
+ }
641
+
642
+ /**
643
+ * Return/show product attribute
644
+ */
645
+ public function get_product_attribute( $attribute_name, $product ) {
646
+ // first, check the text attributes
647
+ $attributes = $product->get_attributes();
648
+ $attribute_key = @wc_attribute_taxonomy_name( $attribute_name );
649
+ if (array_key_exists( sanitize_title( $attribute_name ), $attributes) ) {
650
+ $attribute = $product->get_attribute ( $attribute_name );
651
+ return $attribute;
652
+ } elseif (array_key_exists( sanitize_title( $attribute_key ), $attributes) ) {
653
+ $attribute = $product->get_attribute ( $attribute_key );
654
+ return $attribute;
655
+ }
656
+
657
+ // not a text attribute, try attribute taxonomy
658
+ $attribute_key = @wc_attribute_taxonomy_name( $attribute_name );
659
+ $product_terms = @wc_get_product_terms( $product->id, $attribute_key, array( 'fields' => 'names' ) );
660
+ // check if not empty, then display
661
+ if ( !empty($product_terms) ) {
662
+ $attribute = array_shift( $product_terms );
663
+ return $attribute;
664
+ } else {
665
+ // no attribute under this name
666
+ return false;
667
+ }
668
+ }
669
+ public function product_attribute( $attribute_name, $product ) {
670
+ echo $this->get_product_attribute( $attribute_name, $product );
671
+ }
672
+
673
+
674
+ /**
675
+ * Return the order totals listing
676
+ */
677
+ public function get_woocommerce_totals() {
678
+ // get totals and remove the semicolon
679
+ $totals = apply_filters( 'wpo_wcpdf_raw_order_totals', $this->export->order->get_order_item_totals(), $this->export->order );
680
+
681
+ // remove the colon for every label
682
+ foreach ( $totals as $key => $total ) {
683
+ $label = $total['label'];
684
+ $colon = strrpos( $label, ':' );
685
+ if( $colon !== false ) {
686
+ $label = substr_replace( $label, '', $colon, 1 );
687
+ }
688
+ $totals[$key]['label'] = $label;
689
+ }
690
+
691
+ // WC2.4 fix order_total for refunded orders
692
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.4', '>=' ) && isset($totals['order_total']) ) {
693
+ $tax_display = $this->export->order->tax_display_cart;
694
+ $totals['order_total']['value'] = wc_price( $this->export->order->get_total(), array( 'currency' => $this->export->order->get_order_currency() ) );
695
+ $order_total = $this->export->order->get_total();
696
+ $tax_string = '';
697
+
698
+ // Tax for inclusive prices
699
+ if ( wc_tax_enabled() && 'incl' == $tax_display ) {
700
+ $tax_string_array = array();
701
+
702
+ if ( 'itemized' == get_option( 'woocommerce_tax_total_display' ) ) {
703
+ foreach ( $this->export->order->get_tax_totals() as $code => $tax ) {
704
+ $tax_amount = $tax->formatted_amount;
705
+ $tax_string_array[] = sprintf( '%s %s', $tax_amount, $tax->label );
706
+ }
707
+ } else {
708
+ $tax_string_array[] = sprintf( '%s %s', wc_price( $this->export->order->get_total_tax() - $this->export->order->get_total_tax_refunded(), array( 'currency' => $this->export->order->get_order_currency() ) ), WC()->countries->tax_or_vat() );
709
+ }
710
+ if ( ! empty( $tax_string_array ) ) {
711
+ $tax_string = ' ' . sprintf( __( '(Includes %s)', 'woocommerce' ), implode( ', ', $tax_string_array ) );
712
+ }
713
+ }
714
+
715
+ $totals['order_total']['value'] .= $tax_string;
716
+ }
717
+
718
+ // remove refund lines (shouldn't be in invoice)
719
+ foreach ( $totals as $key => $total ) {
720
+ if ( strpos($key, 'refund_') !== false ) {
721
+ unset( $totals[$key] );
722
+ }
723
+ }
724
+
725
+ return apply_filters( 'wpo_wcpdf_woocommerce_totals', $totals, $this->export->order );
726
+ }
727
+
728
+ /**
729
+ * Return/show the order subtotal
730
+ */
731
+ public function get_order_subtotal( $tax = 'excl', $discount = 'incl' ) { // set $tax to 'incl' to include tax, same for $discount
732
+ //$compound = ($discount == 'incl')?true:false;
733
+
734
+ $subtotal = $this->export->order->get_subtotal_to_display( false, $tax );
735
+
736
+ $subtotal = ($pos = strpos($subtotal, ' <small>')) ? substr($subtotal, 0, $pos) : $subtotal; //removing the 'excluding tax' text
737
+
738
+ $subtotal = array (
739
+ 'label' => __('Subtotal', 'wpo_wcpdf'),
740
+ 'value' => $subtotal,
741
+ );
742
+
743
+ return apply_filters( 'wpo_wcpdf_order_subtotal', $subtotal, $tax, $discount );
744
+ }
745
+ public function order_subtotal( $tax = 'excl', $discount = 'incl' ) {
746
+ $subtotal = $this->get_order_subtotal( $tax, $discount );
747
+ echo $subtotal['value'];
748
+ }
749
+
750
+ /**
751
+ * Return/show the order shipping costs
752
+ */
753
+ public function get_order_shipping( $tax = 'excl' ) { // set $tax to 'incl' to include tax
754
+ if ($tax == 'excl' ) {
755
+ $shipping_costs = $this->export->wc_price( $this->export->order->order_shipping );
756
+ } else {
757
+ $shipping_costs = $this->export->wc_price( $this->export->order->order_shipping + $this->export->order->order_shipping_tax );
758
+ }
759
+
760
+ $shipping = array (
761
+ 'label' => __('Shipping', 'wpo_wcpdf'),
762
+ 'value' => $shipping_costs,
763
+ 'tax' => $this->export->wc_price( $this->export->order->order_shipping_tax ),
764
+ );
765
+ return apply_filters( 'wpo_wcpdf_order_shipping', $shipping, $tax );
766
+ }
767
+ public function order_shipping( $tax = 'excl' ) {
768
+ $shipping = $this->get_order_shipping( $tax );
769
+ echo $shipping['value'];
770
+ }
771
+
772
+ /**
773
+ * Return/show the total discount
774
+ */
775
+ public function get_order_discount( $type = 'total', $tax = 'incl' ) {
776
+ if ( $tax == 'incl' ) {
777
+ switch ($type) {
778
+ case 'cart':
779
+ // Cart Discount - pre-tax discounts. (deprecated in WC2.3)
780
+ $discount_value = $this->export->order->get_cart_discount();
781
+ break;
782
+ case 'order':
783
+ // Order Discount - post-tax discounts. (deprecated in WC2.3)
784
+ $discount_value = $this->export->order->get_order_discount();
785
+ break;
786
+ case 'total':
787
+ // Total Discount
788
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.3' ) >= 0 ) {
789
+ $discount_value = $this->export->order->get_total_discount( false ); // $ex_tax = false
790
+ } else {
791
+ // WC2.2 and older: recalculate to include tax
792
+ $discount_value = 0;
793
+ $items = $this->export->order->get_items();;
794
+ if( sizeof( $items ) > 0 ) {
795
+ foreach( $items as $item ) {
796
+ $discount_value += ($item['line_subtotal'] + $item['line_subtotal_tax']) - ($item['line_total'] + $item['line_tax']);
797
+ }
798
+ }
799
+ }
800
+
801
+ break;
802
+ default:
803
+ // Total Discount - Cart & Order Discounts combined
804
+ $discount_value = $this->export->order->get_total_discount();
805
+ break;
806
+ }
807
+ } else { // calculate discount excluding tax
808
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.3' ) >= 0 ) {
809
+ $discount_value = $this->export->order->get_total_discount( true ); // $ex_tax = true
810
+ } else {
811
+ // WC2.2 and older: recalculate to exclude tax
812
+ $discount_value = 0;
813
+
814
+ $items = $this->export->order->get_items();;
815
+ if( sizeof( $items ) > 0 ) {
816
+ foreach( $items as $item ) {
817
+ $discount_value += ($item['line_subtotal'] - $item['line_total']);
818
+ }
819
+ }
820
+ }
821
+ }
822
+
823
+ $discount = array (
824
+ 'label' => __('Discount', 'wpo_wcpdf'),
825
+ 'value' => $this->export->wc_price($discount_value),
826
+ 'raw_value' => $discount_value,
827
+ );
828
+
829
+ if ( round( $discount_value, 3 ) != 0 ) {
830
+ return apply_filters( 'wpo_wcpdf_order_discount', $discount, $type, $tax );
831
+ }
832
+ }
833
+ public function order_discount( $type = 'total', $tax = 'incl' ) {
834
+ $discount = $this->get_order_discount( $type, $tax );
835
+ echo $discount['value'];
836
+ }
837
+
838
+ /**
839
+ * Return the order fees
840
+ */
841
+ public function get_order_fees( $tax = 'excl' ) {
842
+ if ( $wcfees = $this->export->order->get_fees() ) {
843
+ foreach( $wcfees as $id => $fee ) {
844
+ if ($tax == 'excl' ) {
845
+ $fee_price = $this->export->wc_price( $fee['line_total'] );
846
+ } else {
847
+ $fee_price = $this->export->wc_price( $fee['line_total'] + $fee['line_tax'] );
848
+ }
849
+
850
+ $fees[ $id ] = array(
851
+ 'label' => $fee['name'],
852
+ 'value' => $fee_price,
853
+ 'line_total' => $this->export->wc_price($fee['line_total']),
854
+ 'line_tax' => $this->export->wc_price($fee['line_tax'])
855
+ );
856
+ }
857
+ return $fees;
858
+ }
859
+ }
860
+
861
+ /**
862
+ * Return the order taxes
863
+ */
864
+ public function get_order_taxes() {
865
+ $tax_label = __( 'VAT', 'wpo_wcpdf' ); // register alternate label translation
866
+ $tax_label = __( 'Tax rate', 'wpo_wcpdf' );
867
+ $tax_rate_ids = $this->export->get_tax_rate_ids();
868
+ if ($this->export->order->get_taxes()) {
869
+ foreach ( $this->export->order->get_taxes() as $key => $tax ) {
870
+ $taxes[ $key ] = array(
871
+ 'label' => isset( $tax[ 'label' ] ) ? $tax[ 'label' ] : $tax[ 'name' ],
872
+ 'value' => $this->export->wc_price( ( $tax[ 'tax_amount' ] + $tax[ 'shipping_tax_amount' ] ) ),
873
+ 'rate_id' => $tax['rate_id'],
874
+ 'tax_amount' => $tax['tax_amount'],
875
+ 'shipping_tax_amount' => $tax['shipping_tax_amount'],
876
+ 'rate' => isset( $tax_rate_ids[ $tax['rate_id'] ] ) ? ( (float) $tax_rate_ids[$tax['rate_id']]['tax_rate'] ) . ' %': '',
877
+ );
878
+ }
879
+
880
+ return apply_filters( 'wpo_wcpdf_order_taxes', $taxes );
881
+ }
882
+ }
883
+
884
+ /**
885
+ * Return/show the order grand total
886
+ */
887
+ public function get_order_grand_total( $tax = 'incl' ) {
888
+ if ( version_compare( WOOCOMMERCE_VERSION, '2.1' ) >= 0 ) {
889
+ // WC 2.1 or newer is used
890
+ $total_unformatted = $this->export->order->get_total();
891
+ } else {
892
+ // Backwards compatibility
893
+ $total_unformatted = $this->export->order->get_order_total();
894
+ }
895
+
896
+ if ($tax == 'excl' ) {
897
+ $total_tax = 0;
898
+ foreach ( $this->export->order->get_taxes() as $tax ) {
899
+ $total_tax += ( $tax[ 'tax_amount' ] + $tax[ 'shipping_tax_amount' ] );
900
+ }
901
+
902
+ $total = $this->export->wc_price( ( $total_unformatted - $total_tax ) );
903
+ $label = __( 'Total ex. VAT', 'wpo_wcpdf' );
904
+ } else {
905
+ $total = $this->export->wc_price( ( $total_unformatted ) );
906
+ $label = __( 'Total', 'wpo_wcpdf' );
907
+ }
908
+
909
+ $grand_total = array(
910
+ 'label' => $label,
911
+ 'value' => $total,
912
+ );
913
+
914
+ return apply_filters( 'wpo_wcpdf_order_grand_total', $grand_total, $tax );
915
+ }
916
+ public function order_grand_total( $tax = 'incl' ) {
917
+ $grand_total = $this->get_order_grand_total( $tax );
918
+ echo $grand_total['value'];
919
+ }
920
+
921
+
922
+ /**
923
+ * Return/Show shipping notes
924
+ */
925
+ public function get_shipping_notes() {
926
+ $shipping_notes = wpautop( wptexturize( $this->export->order->customer_note ) );
927
+ return apply_filters( 'wpo_wcpdf_shipping_notes', $shipping_notes );
928
+ }
929
+ public function shipping_notes() {
930
+ echo $this->get_shipping_notes();
931
+ }
932
+
933
+
934
+ /**
935
+ * Return/Show shop/company footer imprint, copyright etc.
936
+ */
937
+ public function get_footer() {
938
+ if (isset($this->settings->template_settings['footer'])) {
939
+ $footer = wpautop( wptexturize( $this->settings->template_settings[ 'footer' ] ) );
940
+ return apply_filters( 'wpo_wcpdf_footer', $footer );
941
+ }
942
+ }
943
+ public function footer() {
944
+ echo $this->get_footer();
945
+ }
946
+
947
+ /**
948
+ * Return/Show Extra field 1
949
+ */
950
+ public function get_extra_1() {
951
+ if (isset($this->settings->template_settings['extra_1'])) {
952
+ $extra_1 = nl2br( wptexturize( $this->settings->template_settings[ 'extra_1' ] ) );
953
+ return apply_filters( 'wpo_wcpdf_extra_1', $extra_1 );
954
+ }
955
+ }
956
+ public function extra_1() {
957
+ echo $this->get_extra_1();
958
+ }
959
+
960
+ /**
961
+ * Return/Show Extra field 2
962
+ */
963
+ public function get_extra_2() {
964
+ if (isset($this->settings->template_settings['extra_2'])) {
965
+ $extra_2 = nl2br( wptexturize( $this->settings->template_settings[ 'extra_2' ] ) );
966
+ return apply_filters( 'wpo_wcpdf_extra_2', $extra_2 );
967
+ }
968
+ }
969
+ public function extra_2() {
970
+ echo $this->get_extra_2();
971
+ }
972
+
973
+ /**
974
+ * Return/Show Extra field 3
975
+ */
976
+ public function get_extra_3() {
977
+ if (isset($this->settings->template_settings['extra_3'])) {
978
+ $extra_3 = nl2br( wptexturize( $this->settings->template_settings[ 'extra_3' ] ) );
979
+ return apply_filters( 'wpo_wcpdf_extra_3', $extra_3 );
980
+ }
981
+ }
982
+ public function extra_3() {
983
+ echo $this->get_extra_3();
984
+ }
985
+ }
986
+ }
987
+
988
+ // Load main plugin class
989
+ $wpo_wcpdf = new WooCommerce_PDF_Invoices();