Quittio
extends Facade
in package
FinalYes
Tags
Table of Contents
Methods
- accountStatement() : RenderableDocumentBuilder
- assertDocumentQueued() : void
- assertDocumentRendered() : void
- assertNothingQueued() : void
- assertNothingRendered() : void
- assertQueued() : void
- assertRendered() : void
- assertRenderedCount() : void
- cancellation() : InvoiceBuilder
- check() : ValidationResult
- core() : Quittio
- coreWithLevels() : Quittio
- countries() : CountryRegistry
- defaultVat() : TaxPreset|null
- deliveryNote() : RenderableDocumentBuilder
- document() : PendingDocument
- documents() : array<int, RenderedDocument>
- edit() : RenderableInvoiceBuilder
- extend() : QuittioManager
- fake() : QuittioFake
- Replaces rendering with a fast fake that records every call.
- flush() : QuittioManager
- flushMacros() : void
- formats() : FormatRegistry
- hasMacro() : bool
- invoice() : RenderableInvoiceBuilder
- macro() : void
- make() : PendingInvoice
- mixin() : void
- orderConfirmation() : RenderableDocumentBuilder
- paymentReminder() : RenderableDocumentBuilder
- prepare() : PreparedInvoice
- profiles() : ProfileRegistry
- proforma() : RenderableDocumentBuilder
- queued() : array<int, RenderInvoice>
- queuedDocuments() : array<int, RenderDocument>
- queueDocument() : RenderDocument
- queueInvoice() : RenderInvoice
- quote() : RenderableDocumentBuilder
- read() : ReadResult
- readFile() : ReadResult
- registerCountry() : QuittioManager
- renderDocument() : RenderedDocument
- rendered() : array<int, RenderedInvoice>
- renderInvoice() : RenderedInvoice
- settings() : Settings
- validateFile() : ValidationResult
- validatePath() : ValidationResult
- getFacadeAccessor() : string
Methods
accountStatement()
public
static accountStatement() : RenderableDocumentBuilder
Return values
RenderableDocumentBuilderassertDocumentQueued()
public
static assertDocumentQueued([callable|null $callback = = 'null' ]) : void
Parameters
- $callback : callable|null = = 'null'
assertDocumentRendered()
public
static assertDocumentRendered([callable|null $callback = = 'null' ]) : void
Parameters
- $callback : callable|null = = 'null'
assertNothingQueued()
public
static assertNothingQueued() : void
assertNothingRendered()
public
static assertNothingRendered() : void
assertQueued()
public
static assertQueued([callable|null $callback = = 'null' ]) : void
Parameters
- $callback : callable|null = = 'null'
assertRendered()
public
static assertRendered([callable|null $callback = = 'null' ]) : void
Parameters
- $callback : callable|null = = 'null'
assertRenderedCount()
public
static assertRenderedCount(int $count) : void
Parameters
- $count : int
cancellation()
public
static cancellation(InvoiceData $original, string $number[, string|null $reason = = 'null' ][, string|null $strategy = = 'null' ][, Date|null $issueDate = = 'null' ][, array<int, BigDecimal|int|string, amount?: string}>|null $lines = = 'null' ][, CancellationHistory|null $history = = 'null' ][, string|null $title = = 'null' ]) : InvoiceBuilder
Parameters
- $original : InvoiceData
- $number : string
- $reason : string|null = = 'null'
- $strategy : string|null = = 'null'
- $issueDate : Date|null = = 'null'
- $lines : array<int, BigDecimal|int|string, amount?: string}>|null = = 'null'
- $history : CancellationHistory|null = = 'null'
- $title : string|null = = 'null'
Return values
InvoiceBuildercheck()
public
static check(InvoiceData $invoice, RenderOptions $options) : ValidationResult
Parameters
- $invoice : InvoiceData
- $options : RenderOptions
Return values
ValidationResultcore()
public
static core() : Quittio
Return values
QuittiocoreWithLevels()
public
static coreWithLevels(array<int, string> $levels) : Quittio
a new core with the configured validation levels plus $levels (e.g. kosit, verapdf)
Parameters
- $levels : array<int, string>
Return values
Quittiocountries()
public
static countries() : CountryRegistry
Return values
CountryRegistrydefaultVat()
public
static defaultVat(string|null $sellerCountry, bool $smallBusiness) : TaxPreset|null
Parameters
- $sellerCountry : string|null
- $smallBusiness : bool
Return values
TaxPreset|nulldeliveryNote()
public
static deliveryNote() : RenderableDocumentBuilder
Return values
RenderableDocumentBuilderdocument()
public
static document(DocumentData|DocumentBuilder $document) : PendingDocument
Parameters
- $document : DocumentData|DocumentBuilder
Return values
PendingDocumentdocuments()
public
static documents() : array<int, RenderedDocument>
Return values
array<int, RenderedDocument>edit()
public
static edit(InvoiceData $data) : RenderableInvoiceBuilder
continues existing invoice data with the configured calculator
Parameters
- $data : InvoiceData
Return values
RenderableInvoiceBuilderextend()
public
static extend(string $type, string $name, Closure $factory) : QuittioManager
type renderer, validator, serializer or format_resolver; the factory receives the container and the driver configuration
Parameters
- $type : string
- $name : string
- $factory : Closure
Return values
QuittioManagerfake()
Replaces rendering with a fast fake that records every call.
public
static fake() : QuittioFake
Return values
QuittioFakeflush()
public
static flush() : QuittioManager
forgets the built core, e.g. after configuration changes
Return values
QuittioManagerflushMacros()
public
static flushMacros() : void
formats()
public
static formats() : FormatRegistry
Return values
FormatRegistryhasMacro()
public
static hasMacro(string $name) : bool
Parameters
- $name : string
Return values
boolinvoice()
public
static invoice() : RenderableInvoiceBuilder
a new invoice with the seller of config/quittio.php (or the current issuer of quittio/managed)
Return values
RenderableInvoiceBuildermacro()
public
static macro(string $name, object|callable $macro) : void
Parameters
- $name : string
- $macro : object|callable
make()
public
static make(InvoiceData|ProvidesInvoiceData|InvoiceBuilder $data) : PendingInvoice
Parameters
Return values
PendingInvoicemixin()
public
static mixin(object $mixin[, bool $replace = = 'true' ]) : void
Parameters
- $mixin : object
- $replace : bool = = 'true'
orderConfirmation()
public
static orderConfirmation() : RenderableDocumentBuilder
Return values
RenderableDocumentBuilderpaymentReminder()
public
static paymentReminder([int $level = = '0' ]) : RenderableDocumentBuilder
Parameters
- $level : int = = '0'
Return values
RenderableDocumentBuilderprepare()
public
static prepare(InvoiceData $invoice, RenderOptions $options) : PreparedInvoice
Parameters
- $invoice : InvoiceData
- $options : RenderOptions
Return values
PreparedInvoiceprofiles()
public
static profiles() : ProfileRegistry
Return values
ProfileRegistryproforma()
public
static proforma() : RenderableDocumentBuilder
Return values
RenderableDocumentBuilderqueued()
public
static queued() : array<int, RenderInvoice>
Return values
array<int, RenderInvoice>queuedDocuments()
public
static queuedDocuments() : array<int, RenderDocument>
Return values
array<int, RenderDocument>queueDocument()
public
static queueDocument(RenderDocument $job) : RenderDocument
Parameters
- $job : RenderDocument
Return values
RenderDocumentqueueInvoice()
public
static queueInvoice(RenderInvoice $job) : RenderInvoice
dispatches the job of PendingInvoice::queue()->save()
Parameters
- $job : RenderInvoice
Return values
RenderInvoicequote()
public
static quote() : RenderableDocumentBuilder
Return values
RenderableDocumentBuilderread()
public
static read(string $content) : ReadResult
content (bytes) of an XML or PDF e-invoice, never a path
Parameters
- $content : string
Return values
ReadResultreadFile()
public
static readFile(string $path) : ReadResult
path of an XML or PDF e-invoice
Parameters
- $path : string
Return values
ReadResultregisterCountry()
public
static registerCountry(CountryPack $pack) : QuittioManager
Parameters
- $pack : CountryPack
Return values
QuittioManagerrenderDocument()
public
static renderDocument(DocumentData $document, RenderOptions $options) : RenderedDocument
the render run behind PendingDocument::render()
Parameters
- $document : DocumentData
- $options : RenderOptions
Return values
RenderedDocumentrendered()
public
static rendered() : array<int, RenderedInvoice>
Return values
array<int, RenderedInvoice>renderInvoice()
public
static renderInvoice(InvoiceData $invoice, RenderOptions $options) : RenderedInvoice
the render run behind PendingInvoice::render(), with events
Parameters
- $invoice : InvoiceData
- $options : RenderOptions
Return values
RenderedInvoicesettings()
public
static settings() : Settings
Return values
SettingsvalidateFile()
public
static validateFile(string $content) : ValidationResult
content (bytes) of an XML or PDF e-invoice, never a path
Parameters
- $content : string
Return values
ValidationResultvalidatePath()
public
static validatePath(string $path) : ValidationResult
path of an XML or PDF e-invoice
Parameters
- $path : string
Return values
ValidationResultgetFacadeAccessor()
protected
static getFacadeAccessor() : string