PendingDocument
in package
uses
Macroable
Fluent render call for documents: Quittio::document($quote)->locale('de')->render().
Table of Contents
Methods
- __construct() : mixed
- country() : static
- Leading country pack of this call (ISO 3166-1 alpha-2), instead of the seller's country.
- data() : DocumentData
- The document of this call, as passed (not calculated).
- htmlOnly() : static
- Renders the template only, without PDF (format "html").
- locale() : static
- Locale of this call; wins over the document 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.
- presentation() : static
- Design defaults of this call; the document's own presentation wins.
- queue() : QueuedDocument
- Renders in a queued job: Quittio::document($quote)->queue()->save('documents', $path).
- render() : RenderedDocument
- Calculates and renders the document with the events DocumentRendering and DocumentRendered, see Quittio::renderDocument().
- template() : static
- Template of this call; the same selection rules as for invoices.
Methods
__construct()
public
__construct(QuittioManager $manager, DocumentData $data) : mixed
Parameters
- $manager : QuittioManager
- $data : DocumentData
country()
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 document of this call, as passed (not calculated).
public
data() : DocumentData
Return values
DocumentDatahtmlOnly()
Renders the template only, without PDF (format "html").
public
htmlOnly() : static
Return values
staticlocale()
Locale of this call; wins over the document 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
RenderOptionspresentation()
Design defaults of this call; the document's own presentation wins.
public
presentation(Presentation $presentation) : static
Parameters
- $presentation : Presentation
Return values
staticqueue()
Renders in a queued job: Quittio::document($quote)->queue()->save('documents', $path).
public
queue([string|null $connection = null ][, string|null $queue = null ]) : QueuedDocument
Parameters
- $connection : string|null = null
- $queue : string|null = null
Return values
QueuedDocumentrender()
Calculates and renders the document with the events DocumentRendering and DocumentRendered, see Quittio::renderDocument().
public
render() : RenderedDocument
Tags
Return values
RenderedDocumenttemplate()
Template of this call; the same selection rules as for invoices.
public
template(string $template) : static
Parameters
- $template : string