PendingInvoice
in package
uses
Macroable
Fluent render call: Quittio::make($order)->profile('en16931')->format('zugferd')->locale('de')->render().
Table of Contents
Properties
Methods
- __construct() : mixed
- check() : ValidationResult
- Validates like a render run without rendering. An explicit validation request: it validates whatever validation.mode or withoutValidation() say and never throws a ValidationException.
- country() : static
- Leading country pack of this call (ISO 3166-1 alpha-2), instead of the seller's country.
- data() : InvoiceData
- The invoice data of this call, as passed (not calculated).
- format() : static
- Output format of this call, e.g. "zugferd", "xrechnung-cii", "pdf"; replaces earlier formats.
- formats() : static
- locale() : static
- Locale of this call; wins over the invoice locale and the configuration.
- option() : static
- Output option of this call, e.g. option('fold_marks', false); see the output configuration.
- options() : RenderOptions
- The options collected so far, as passed to the render run.
- prepare() : PreparedInvoice
- Calculates and validates without rendering, whatever validation.mode or withoutValidation() say; see {@see PreparedInvoice}.
- presentation() : static
- Presentation defaults (design, texts) for this call; the invoice's own values win.
- profile() : static
- Profile of the XML for this call, as key, alias or Profile object, e.g. "xrechnung"; the format must support it. Wins over the configured profile.
- queue() : QueuedInvoice
- Renders in a queued job: Quittio::make($order)->queue()->save('invoices', $path).
- render() : RenderedInvoice
- Renders the formats of this call with the events of the run (InvoiceRendering, InvoiceValidated or InvoiceValidationFailed, InvoiceRendered); see Quittio::render().
- template() : static
- Template of this call (a shipped or a configured template); wins over the invoice presentation and the configuration.
- validate() : static
- Switches validation on (errors throw) or to warnings only.
- withoutValidation() : static
- Validation mode "off" for this call: nothing is validated, no ValidationException.
Properties
$data read-only
protected
InvoiceData
$data
$manager read-only
protected
QuittioManager
$manager
Methods
__construct()
public
final __construct(QuittioManager $manager, InvoiceData $data) : mixed
Parameters
- $manager : QuittioManager
- $data : InvoiceData
check()
Validates like a render run without rendering. An explicit validation request: it validates whatever validation.mode or withoutValidation() say and never throws a ValidationException.
public
check() : ValidationResult
Return values
ValidationResultcountry()
Leading country pack of this call (ISO 3166-1 alpha-2), instead of the seller's country.
public
country(string $country) : static
Parameters
- $country : string
Return values
staticdata()
The invoice data of this call, as passed (not calculated).
public
data() : InvoiceData
Return values
InvoiceDataformat()
Output format of this call, e.g. "zugferd", "xrechnung-cii", "pdf"; replaces earlier formats.
public
format(string $format) : static
Parameters
- $format : string
Return values
staticformats()
public
formats(array<int, string> $formats) : static
Parameters
- $formats : array<int, string>
Return values
staticlocale()
Locale of this call; wins over the invoice locale and the configuration.
public
locale(string $locale) : static
Parameters
- $locale : string
Return values
staticoption()
Output option of this call, e.g. option('fold_marks', false); see the output configuration.
public
option(string $key, mixed $value) : static
Parameters
- $key : string
- $value : mixed
Return values
staticoptions()
The options collected so far, as passed to the render run.
public
options() : RenderOptions
Return values
RenderOptionsprepare()
Calculates and validates without rendering, whatever validation.mode or withoutValidation() say; see {@see PreparedInvoice}.
public
prepare() : PreparedInvoice
Return values
PreparedInvoicepresentation()
Presentation defaults (design, texts) for this call; the invoice's own values win.
public
presentation(Presentation $presentation) : static
Parameters
- $presentation : Presentation
Return values
staticprofile()
Profile of the XML for this call, as key, alias or Profile object, e.g. "xrechnung"; the format must support it. Wins over the configured profile.
public
profile(Profile|string $profile) : static
Parameters
- $profile : Profile|string
Return values
staticqueue()
Renders in a queued job: Quittio::make($order)->queue()->save('invoices', $path).
public
queue([string|null $connection = null ][, string|null $queue = null ]) : QueuedInvoice
Parameters
- $connection : string|null = null
- $queue : string|null = null
Return values
QueuedInvoicerender()
Renders the formats of this call with the events of the run (InvoiceRendering, InvoiceValidated or InvoiceValidationFailed, InvoiceRendered); see Quittio::render().
public
render() : RenderedInvoice
Tags
Return values
RenderedInvoicetemplate()
Template of this call (a shipped or a configured template); wins over the invoice presentation and the configuration.
public
template(string $template) : static
Parameters
- $template : string
Return values
staticvalidate()
Switches validation on (errors throw) or to warnings only.
public
validate([bool $throwOnError = true ]) : static
Parameters
- $throwOnError : bool = true
Return values
staticwithoutValidation()
Validation mode "off" for this call: nothing is validated, no ValidationException.
public
withoutValidation() : static