Presentation
in package
uses
Immutable
Read onlyYes
FinalYes
Data used only for the PDF. Never written to XML.
Table of Contents
Constants
- PAYMENT_QR_AUTO : string = 'auto'
- PAYMENT_QR_GIROCODE : string = 'girocode'
- PAYMENT_QR_NONE : string = 'none'
- PAYMENT_QR_SWISS : string = 'swiss-qr-bill'
Properties
- $closingText : string|null
- $colors : Colors|null
- $explicit : array<string|int, mixed>
- $font : string|null
- $footerColumns : array<string|int, mixed>
- $introText : string|null
- $labels : array<string|int, mixed>
- $letterLayout : string|null
- $lineGroups : array<string|int, mixed>
- $logo : string|null
- $paper : string
- $paymentQr : string
- $salutation : string|null
- $senderLine : string|null
- $showGrossPrices : bool
- $showItemNumbers : bool
- $template : string|null
- $title : string|null
- $watermark : string|null
Methods
- __construct() : mixed
- isExplicit() : bool
- Whether $property is set explicitly (see $explicit), also to its default value.
- with() : static
- Returns a copy with the given properties replaced.
Constants
PAYMENT_QR_AUTO
public
string
PAYMENT_QR_AUTO
= 'auto'
PAYMENT_QR_GIROCODE
public
string
PAYMENT_QR_GIROCODE
= 'girocode'
PAYMENT_QR_NONE
public
string
PAYMENT_QR_NONE
= 'none'
PAYMENT_QR_SWISS
public
string
PAYMENT_QR_SWISS
= 'swiss-qr-bill'
Properties
$closingText
public
string|null
$closingText
= null
Attributes
- #[PdfOnly]
$colors
public
Colors|null
$colors
= null
Attributes
- #[PdfOnly]
$explicit
public
array<string|int, mixed>
$explicit
= []
Attributes
- #[ListOf]
- 'string'
- #[PdfOnly]
$font
public
string|null
$font
= null
Attributes
- #[PdfOnly]
$footerColumns
public
array<string|int, mixed>
$footerColumns
= []
Attributes
- #[PdfOnly]
$introText
public
string|null
$introText
= null
Attributes
- #[PdfOnly]
$labels
public
array<string|int, mixed>
$labels
= []
Attributes
- #[PdfOnly]
$letterLayout
public
string|null
$letterLayout
= null
Attributes
- #[PdfOnly]
$lineGroups
public
array<string|int, mixed>
$lineGroups
= []
Attributes
- #[ListOf]
- LineGroup::class
- #[PdfOnly]
$logo
public
string|null
$logo
= null
Attributes
- #[PdfOnly]
$paper
public
string
$paper
= 'A4'
Attributes
- #[PdfOnly]
$paymentQr
public
string
$paymentQr
= self::PAYMENT_QR_AUTO
Attributes
- #[PdfOnly]
$salutation
public
string|null
$salutation
= null
Attributes
- #[PdfOnly]
$senderLine
public
string|null
$senderLine
= null
Attributes
- #[PdfOnly]
$showGrossPrices
public
bool
$showGrossPrices
= false
Attributes
- #[PdfOnly]
$showItemNumbers
public
bool
$showItemNumbers
= false
Attributes
- #[PdfOnly]
$template
public
string|null
$template
= null
Attributes
- #[PdfOnly]
$title
public
string|null
$title
= null
Attributes
- #[PdfOnly]
$watermark
public
string|null
$watermark
= null
Attributes
- #[PdfOnly]
Methods
__construct()
public
__construct([string|null $template = null ][, string|null $logo = null ][, Colors|null $colors = null ][, string|null $font = null ][, string|null $senderLine = null ][, string|null $letterLayout = null ][, string|null $salutation = null ][, string|null $introText = null ][, string|null $closingText = null ][, array<int, array<int, string>> $footerColumns = [] ][, array<int, LineGroup> $lineGroups = [] ][, bool $showGrossPrices = false ][, bool $showItemNumbers = false ][, string $paymentQr = self::PAYMENT_QR_AUTO ][, string|null $watermark = null ][, string $paper = 'A4' ][, array<string, string> $labels = [] ][, string|null $title = null ][, array<int, string> $explicit = [] ]) : mixed
Parameters
- $template : string|null = null
- $logo : string|null = null
- $colors : Colors|null = null
- $font : string|null = null
- $senderLine : string|null = null
- $letterLayout : string|null = null
- $salutation : string|null = null
- $introText : string|null = null
- $closingText : string|null = null
- $footerColumns : array<int, array<int, string>> = []
- $lineGroups : array<int, LineGroup> = []
- $showGrossPrices : bool = false
- $showItemNumbers : bool = false
- $paymentQr : string = self::PAYMENT_QR_AUTO
- $watermark : string|null = null
- $paper : string = 'A4'
- $labels : array<string, string> = []
- $title : string|null = null
- $explicit : array<int, string> = []
-
properties whose value wins even when it equals the default, e.g. ['showGrossPrices', 'paper', 'footerColumns'] to switch off, set A4 or clear a configured value for this invoice
isExplicit()
Whether $property is set explicitly (see $explicit), also to its default value.
public
isExplicit(string $property) : bool
Parameters
- $property : string
Return values
boolwith()
Returns a copy with the given properties replaced.
public
with(array<string, mixed> $changes) : static
Parameters
- $changes : array<string, mixed>