New: adds support for multiple UBL formats (#927)

wpovernight · Dec 13, 2024 · 18d85ca · 18d85ca
1 parent 0b73234
commit 18d85ca
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 10 deletions.
diff --git a/assets/js/admin-script.js b/assets/js/admin-script.js
@@ -55,6 +55,17 @@ jQuery( function( $ ) {
 			$( this ).closest( 'tr' ).nextAll( 'tr' ).has( 'input#next_invoice_number' ).first().show();
 		}
 	} ).trigger( 'change' );
+
+	// disable encrypted pdf option for non UBL 2.1 formats
+	$( "[name='wpo_wcpdf_documents_settings_invoice_ubl[ubl_format]']" ).on( 'change', function( event ) {
+		let $encryptedPdfCheckbox = $( this ).closest( 'form' ).find( "[name='wpo_wcpdf_documents_settings_invoice_ubl[include_encrypted_pdf]']" );
+
+		if ( $( this ).val() !== 'ubl_2_1' ) {
+			$encryptedPdfCheckbox.prop( 'checked', false ).prop( 'disabled', true );
+		} else {
+			$encryptedPdfCheckbox.prop( 'disabled', false );
+		}
+	} ).trigger( 'change' );
 
 	// enable settings document switch
 	$( '.wcpdf_document_settings_sections > h2' ).on( 'click', function() {

diff --git a/assets/js/admin-script.min.js b/assets/js/admin-script.min.js
diff --git a/includes/Documents/Invoice.php b/includes/Documents/Invoice.php
@@ -579,7 +579,7 @@ public function get_ubl_settings_fields( $option_name ) {
 		$settings_fields = array(
 			array(
 				'type'     => 'section',
-				'id'       => $this->type.'_ubl',
+				'id'       => $this->type . '_ubl',
 				'title'    => '',
 				'callback' => 'section',
 			),
@@ -588,18 +588,32 @@ public function get_ubl_settings_fields( $option_name ) {
 				'id'       => 'enabled',
 				'title'    => __( 'Enable', 'woocommerce-pdf-invoices-packing-slips' ),
 				'callback' => 'checkbox',
-				'section'  => $this->type.'_ubl',
+				'section'  => $this->type . '_ubl',
 				'args'     => array(
 					'option_name' => $option_name,
 					'id'          => 'enabled',
 				)
 			),
+			array(
+				'type'     => 'setting',
+				'id'       => 'ubl_format',
+				'title'    => __( 'Format', 'woocommerce-pdf-invoices-packing-slips' ),
+				'callback' => 'select',
+				'section'  => $this->type . '_ubl',
+				'args'     => array(
+					'option_name' => $option_name,
+					'id'          => 'ubl_format',
+					'options'     => apply_filters( 'wpo_wcpdf_document_ubl_settings_formats', array(
+						'ubl_2_1' => __( 'UBL 2.1' , 'woocommerce-pdf-invoices-packing-slips' ),
+					), $this ),
+				)
+			),
 			array(
 				'type'     => 'setting',
 				'id'       => 'attach_to_email_ids',
 				'title'    => __( 'Attach to:', 'woocommerce-pdf-invoices-packing-slips' ),
 				'callback' => 'multiple_checkboxes',
-				'section'  => $this->type.'_ubl',
+				'section'  => $this->type . '_ubl',
 				'args'     => array(
 					'option_name'     => $option_name,
 					'id'              => 'attach_to_email_ids',
@@ -613,11 +627,11 @@ public function get_ubl_settings_fields( $option_name ) {
 				'id'       => 'include_encrypted_pdf',
 				'title'    => __( 'Include encrypted PDF:', 'woocommerce-pdf-invoices-packing-slips' ),
 				'callback' => 'checkbox',
-				'section'  => $this->type.'_ubl',
+				'section'  => $this->type . '_ubl',
 				'args'     => array(
 					'option_name' => $option_name,
 					'id'          => 'include_encrypted_pdf',
-					'description' => __( 'Include the PDF Invoice file encrypted in the UBL file.', 'woocommerce-pdf-invoices-packing-slips' ),
+					'description' => __( 'Embed the encrypted PDF invoice file within the UBL document. Note that this option may not be supported by all UBL formats.', 'woocommerce-pdf-invoices-packing-slips' ),
 				)
 			),
 		);
@@ -687,6 +701,7 @@ public function get_settings_categories( string $output_format ): array {
 					'title'   => __( 'General', 'woocommerce-pdf-invoices-packing-slips' ),
 					'members' => array(
 						'enabled',
+						'ubl_format',
 						'attach_to_email_ids',
 						'include_encrypted_pdf',
 					),

diff --git a/includes/Documents/OrderDocument.php b/includes/Documents/OrderDocument.php
@@ -342,6 +342,17 @@ public function is_enabled( $output_format = 'pdf' ) {
 
 		return apply_filters( 'wpo_wcpdf_document_is_enabled', $is_enabled, $this->type, $output_format );
 	}
+
+	/**
+	 * Get the UBL format
+	 *
+	 * @return string|false
+	 */
+	public function get_ubl_format() {
+		$ubl_format = $this->get_setting( 'ubl_format', false, 'ubl' );
+
+		return apply_filters( 'wpo_wcpdf_document_ubl_format', $ubl_format, $this );
+	}
 
 	public function get_hook_prefix() {
 		return 'wpo_wcpdf_' . $this->slug . '_get_';

diff --git a/includes/Settings/SettingsGeneral.php b/includes/Settings/SettingsGeneral.php
@@ -207,7 +207,7 @@ public function init_settings() {
 					'option_name'  => $option_name,
 					'id'           => 'shop_phone_number',
 					'translatable' => true,
-//					'description'  => __( 'Required for e-Invoice.', 'woocommerce-pdf-invoices-packing-slips' ),
+					'description'  => __( 'Mandatory for certain UBL formats.', 'woocommerce-pdf-invoices-packing-slips' ),
 				)
 			),
 			array(

diff --git a/ubl/Builders/SabreBuilder.php b/ubl/Builders/SabreBuilder.php
@@ -23,7 +23,7 @@ public function build( Document $document ) {
 		$namespaces                  = array_flip( $document->get_namespaces() );
 		$this->service->namespaceMap = $namespaces;
 
-		return $this->service->write( 'Invoice', $document->get_data() );
+		return $this->service->write( $document->get_root_element(), $document->get_data() );
 	}
 
 }
diff --git a/ubl/Documents/Document.php b/ubl/Documents/Document.php
@@ -31,6 +31,7 @@ public function set_order_document( OrderDocument $order_document ) {
 		$this->order_document = $order_document;
 	}
 
+	abstract public function get_root_element();
 	abstract public function get_format();
 	abstract public function get_namespaces();
 	abstract public function get_data();

diff --git a/ubl/Documents/UblDocument.php b/ubl/Documents/UblDocument.php
@@ -9,6 +9,10 @@
 }
 
 class UblDocument extends Document {
+
+	public function get_root_element() {
+		return apply_filters( 'wpo_wc_ubl_document_root_element', 'Invoice', $this );
+	}
 
 	public function get_format() {
 		$format = apply_filters( 'wpo_wc_ubl_document_format' , array(
@@ -82,7 +86,7 @@ public function get_format() {
 				'enabled' => true,
 				'handler' => \WPO\IPS\UBL\Handlers\Invoice\InvoiceLineHandler::class,
 			),
-		) );
+		), $this );
 
 		foreach ( $format as $key => $element ) {
 			if ( false === $element['enabled'] ) {
@@ -98,7 +102,7 @@ public function get_namespaces() {
 			'cac' => 'urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2',
 			'cbc' => 'urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2',
 			''    => 'urn:oasis:names:specification:ubl:schema:xsd:Invoice-2',
-		) );
+		), $this );
 	}
 
 	public function get_data() {