OutputFormat
in package
Read onlyYes
FinalYes
Definition of an output format.
Table of Contents
Properties
- $defaultProfile : string|null
- $embedsXml : bool
- $html : bool
- $json : bool
- $key : string
- $pdf : bool
- $profiles : array<string|int, mixed>
- $syntax : Syntax|null
Methods
- __construct() : mixed
- allowsProfile() : bool
- hasXml() : bool
- isEInvoice() : bool
- Whether the format is an e-invoice in the sense of EN 16931 (structured XML).
Properties
$defaultProfile
public
string|null
$defaultProfile
= null
$embedsXml
public
bool
$embedsXml
= false
$html
public
bool
$html
= false
$json
public
bool
$json
= false
$key
public
string
$key
public
bool
$pdf
= false
$profiles
public
array<string|int, mixed>
$profiles
= []
$syntax
public
Syntax|null
$syntax
= null
Methods
__construct()
public
__construct(string $key[, Syntax|null $syntax = null ][, bool $pdf = false ][, bool $embedsXml = false ][, string|null $defaultProfile = null ][, array<int, string> $profiles = [] ][, bool $html = false ][, bool $json = false ]) : mixed
Parameters
- $key : string
- $syntax : Syntax|null = null
-
XML syntax, null for formats without XML
- $pdf : bool = false
-
whether a PDF is produced
- $embedsXml : bool = false
-
whether the XML is embedded in the PDF (ZUGFeRD/Factur-X)
- $defaultProfile : string|null = null
-
profile used when none is given
- $profiles : array<int, string> = []
-
allowed profile keys; empty = every profile that supports the syntax
- $html : bool = false
- $json : bool = false
allowsProfile()
public
allowsProfile(string $key) : bool
Parameters
- $key : string
Return values
boolhasXml()
public
hasXml() : bool
Return values
boolisEInvoice()
Whether the format is an e-invoice in the sense of EN 16931 (structured XML).
public
isEInvoice() : bool