SetaPDF_Core_XmpHelper_Zugferd A helper class to handle ZUGFeRD >= 2.3 metadata

File: /SetaPDF v2/Core/XmpHelper/Zugferd.php

Class hierarchy

Summary

Static Properties

$invoiceStandards

static public array<string, array{conformanceLevel: string, version: string, documentFileName: string, documentType: string}> SetaPDF_Core_XmpHelper_Zugferd::$invoiceStandards = array(...)

Standards based on ZF23


Static Methods

extractMetadataInformation()

public static SetaPDF_Core_XmpHelper_Zugferd::extractMetadataInformation (
string $zugferdXml
): array{conformanceLevel: string, version: string, documentFileName: string, documentType: string}

Extracts the GuidelineSpecifiedDocumentContextParameter/ID and matches it to predefined invoice standards.

Parameters
$zugferdXml : string
 
Exceptions

Throws Exception

See
  • self::$invoiceStandards

get()

public static SetaPDF_Core_XmpHelper_Zugferd::get (): false|array{conformanceLevel: string, version: string, documentFileName: string, documentType: string}

Get the ZUGFeRD metadata (>= 2.3) values stored in the documents metadata package.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

update()

public static SetaPDF_Core_XmpHelper_Zugferd::update (
SetaPDF_Core_Document $document, string $conformanceLevel, string $version, string $documentFileName [, string $documentType = 'INVOICE' ]
): void

Updates the documents metadata package to ZUGFeRD (>= 2.3).

Parameters
$document : SetaPDF_Core_Document
 
$conformanceLevel : string
 
$version : string
 
$documentFileName : string
 
$documentType : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception