API reference / Quittio \ Core \ View
LetterLayout
final readonly class in quittio/core
Quittio\Core\View\LetterLayout · Source
Position of the address field and marks on the first page, in millimetres from the top left corner (e.g. DIN 5008 form A/B in the German country pack).
Properties#
| Property | Type | Description |
|---|---|---|
$addressHeight readonly | float | |
$addressLeft readonly | float | |
$addressTop readonly | float | |
$addressWidth readonly | float | |
$addressZoneTop readonly | float | start of the recipient address within the address field (DIN 5008: below the 17.7 mm "Zusatz- und Vermerkzone", whose last line holds the sender line) |
$foldMarks readonly | list<float> | distances of fold marks from the top edge |
$name readonly | string | |
$punchMark readonly | ?float | |
$senderLineHeight readonly | float |
Methods#
| Method | Description |
|---|---|
->__construct() | |
::free() | Layout without norm: address field where the default template places it. |
->letterheadHeight() | Height of the letterhead above the address field for a given top page margin. |
__construct()#
public function __construct(
string $name,
float $addressTop = 45.0,
float $addressLeft = 20.0,
float $addressWidth = 85.0,
float $addressHeight = 45.0,
float $senderLineHeight = 5.0,
list<float> $foldMarks = [],
?float $punchMark = null,
float $addressZoneTop = 17.7,
)| Parameter | Type | Description |
|---|---|---|
$name | string | |
$addressTop | float = 45.0 | |
$addressLeft | float = 20.0 | |
$addressWidth | float = 85.0 | |
$addressHeight | float = 45.0 | |
$senderLineHeight | float = 5.0 | |
$foldMarks | list<float> = [] | distances of fold marks from the top edge |
$punchMark | ?float = null | |
$addressZoneTop | float = 17.7 | start of the recipient address within the address field (DIN 5008: below the 17.7 mm "Zusatz- und Vermerkzone", whose last line holds the sender line) |
free()#
public static function free(): selfLayout without norm: address field where the default template places it.
- Returns
self
letterheadHeight()#
public function letterheadHeight(float $pageMarginTop): floatHeight of the letterhead above the address field for a given top page margin.
| Parameter | Type | Description |
|---|---|---|
$pageMarginTop | float |
- Returns
float