Table of contents
Namespace: Com\Tecnick\Pdf
enum HybridProfile: string
Source: src/HybridProfile.php:41
Backed enum for the standard followed by a hybrid electronic document: a PDF/A-3 file carrying a structured XML payload as an embedded file, as produced by MetaInfo::setFacturX().
Each case supplies the payload file name, the XMP namespace URI, prefix, extension schema name, version and document type required by that standard.
Cases
FacturX = 'facturx': Factur-X 1.0.x, equivalent to ZUGFeRD 2.1 and later.ZugferdV1 = 'zugferdv1': ZUGFeRD 1.0.ZugferdV2 = 'zugferdv2': ZUGFeRD 2.0.OrderX = 'orderx': Order-X 1.0.
Methods
description()
Default description of the embedded file.
public description(): string
Returns: string
Source: src/HybridProfile.php:126
documentType()
Default value of the DocumentType XMP property.
public documentType(): string
Returns: string
Source: src/HybridProfile.php:118
fileName()
Name the XML payload must be embedded with.
public fileName(): string
Returns: string
Source: src/HybridProfile.php:58
fromLoose()
Resolve a loose profile value to the matching enum case.
Accepts the profile identifier (case-insensitive, surrounding whitespace trimmed) or an enum instance (returned unchanged). Unknown values throw.
public static fromLoose(string|self $value): self
Parameters:
$value(string|self): Profile identifier or enum case.
Returns: self
Throws:
- Exception: if the value is not a known profile.
Source: src/HybridProfile.php:145
namespaceUri()
XMP namespace URI of the profile properties.
public namespaceUri(): string
Returns: string
Source: src/HybridProfile.php:71
prefix()
XMP namespace prefix of the profile properties.
public prefix(): string
Returns: string
Source: src/HybridProfile.php:84
schemaName()
Name of the PDF/A extension schema describing the profile properties.
public schemaName(): string
Returns: string
Source: src/HybridProfile.php:106
version()
Value of the Version XMP property.
public version(): string
Returns: string
Source: src/HybridProfile.php:95