API reference

Quittio\Core\View

quittio/core#

Quittio\Core\View

• AccessLogRecords which view model fields a template read (for the mandatory field guard).
• AddressFormatter interfaceFormats postal addresses according to the conventions of a country.
• CountryNamesCountry names from ext-intl with the ISO code as fallback.
• FormattedValueA value for templates: formatted for display and available in raw form. Casting to string returns the formatted value, so {{ $value }} prints it.
• Formatter interfaceFormats values for display according to a locale.
• InternationalAddressFormatterFallback address format: street lines, "postcode city", subdivision and, for foreign recipients, the country name in upper case as the last line.
• IntlFormatterLocale aware formatting with ext-intl and a fallback for German and English conventions.
• InvoiceTitleLabel key of the document title for a type code (BT-3).
• InvoiceViewModelThe only object templates receive. Every value is available formatted ($value->formatted or {{ $value }}) and raw ($value->raw).
• LetterLayoutPosition 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).
• MandatoryFieldGuardChecks after rendering that the template printed all mandatory values.
• MandatoryFieldMissingA template omitted mandatory invoice information.
• MarkdownSafe Markdown subset for texts: paragraphs, lists, bold and italic. HTML in the input is shown as text, links keep only their text.
• ResolvedLogoA logo of the presentation as the renderer gets it: a local file or a checked data URI (Pdf\LogoCache), resolved before the view model is built, so that the view layer does no I/O.
• ViewContextEverything the view model factory needs besides the invoice data.
• ViewModelFactoryBuilds the template view model from calculated invoice data.
• ViewNodeRead-only node of the invoice view model with recorded property access.

Quittio\Core\View\Model

• AccountViewA credit transfer account (BG-17).
• AddressViewA postal address.
• AllowanceChargeViewAn allowance or charge on document level (BG-20, BG-21).
• AttachmentViewAn attached document (BG-24).
• AttributeViewAn item attribute (BG-32).
• CardViewA payment card (BG-18).
• ContactViewContact details of a party.
• DeliveryViewDelivery information (BG-13).
• DescribedAmountViewAn amount with its description: a third party payment or a reminder fee.
• DescriptionViewThe item description of a line.
• DesignViewThe design values: colours, font, logo, letter layout, sender line and footer.
• DirectDebitViewA direct debit (BG-19).
• DiscountViewA cash discount of the payment terms.
• DocumentInfoViewInformation of documents (quotes, delivery notes, reminders, statements …).
• DocumentViewThe "document" node: type and kind of the invoice or document.
• DunningViewA payment reminder.
• InterestViewAn interest charge of a reminder.
• LineAllowanceChargeViewAn allowance or charge of a line (BG-27, BG-28).
• LineGroupViewA group of lines for display.
• LineOptionsViewThe options of a document line.
• LineViewAn invoice line (BG-25), also a sub line.
• MetaViewLocale, custom values and source of the invoice.
• NoteViewA note (BG-1) other than the legal notes.
• OpenItemViewAn open invoice of a reminder or statement.
• PackageViewA package of a delivery note.
• PartyViewA party: "seller" and "buyer", and "issuer" and "recipient", which stand for one of them.
• PayeeViewThe payee (BG-10).
• PaymentSlipSectionViewOne heading of a payment slip with its lines; without lines an empty field to fill in by hand.
• PaymentSlipViewThe payment slip of a payment QR code, e.g. the payment part and receipt of the Swiss QR bill.
• PaymentTermsViewThe payment terms (BT-20) with due date and cash discounts.
• PaymentViewThe payment instructions (BG-16).
• PrecedingInvoiceViewA preceding invoice reference (BG-3).
• QrCodeViewThe payment QR code.
• ReferenceViewA filled document reference, e.g. the purchase order.
• StatementViewAn account statement.
• TaxRepresentativeViewThe seller tax representative (BG-11).
• TextsViewThe texts of the presentation.
• TotalsViewThe document totals (BG-22).
• UnitViewThe unit of measure of a line.
• VatRowViewA row of the VAT breakdown (BG-23).
• ViewListA list (or a map, such as "labels") of the view model whose entries have one type, e.g. ViewList<LineView> for "lines" or ViewList<string> for "legalNotes".