setasign\SetaPDF2\Core\Xmp
Zugferd A helper class to handle ZUGFeRD >= 2.3 metadata
File: /SetaPDF v2/Core/Xmp/Zugferd.php
Old class name (alias):
\SetaPDF_Core_XmpHelper_Zugferd
Class hierarchy
Summary
Static Properties
$invoiceStandards
static public array<string, array{conformanceLevel: string, version: string, documentFileName: string, documentType: string}> Zugferd::$invoiceStandards = array(...)
Predefined standards based on ZF23
Static Methods
_extendSchema()
Parameters
- $info : \SetaPDF_Core_Document_Info
Exceptions
Throws \DOMException
extractMetadataInformation()
public static 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
get()
public static Zugferd::get (
\SetaPDF_Core_Document $document
): 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
update()
public static Zugferd::update (
\SetaPDF_Core_Document $document,
string $conformanceLevel,
string $version,
string $documentFileName,
string $documentType = 'INVOICE'
): voidstring $conformanceLevel,
string $version,
string $documentFileName,
string $documentType = 'INVOICE'
Updates the documents metadata package to ZUGFeRD (>= 2.3).
Parameters
- $document : \SetaPDF_Core_Document
- $conformanceLevel : string
- $version : string
- $documentFileName : string
- $documentType : string