API reference / Quittio \ Laravel \ Rendering
PendingDocument
final class in quittio/laravel · uses Illuminate\Support\Traits\Macroable
Quittio\Laravel\Rendering\PendingDocument · Source
Fluent render call for documents: Quittio::document($quote)->locale('de')->render().
Methods#
| Method | Description |
|---|---|
->__construct() | |
->country() | Leading country pack of this call (ISO 3166-1 alpha-2), instead of the seller's country. |
->data() | The document of this call, as passed (not calculated). |
->htmlOnly() | Renders the template only, without PDF (format "html"). |
->locale() | Locale of this call; wins over the document locale and the configuration. |
->option() | Output option of this call, e.g. option('fold_marks', false); see the output configuration. |
->options() | The options collected so far, as passed to the render run. |
->presentation() | Design defaults of this call; the document's own presentation wins. |
->queue() | Renders in a queued job: Quittio::document($quote)->queue()->save('documents', $path). |
->render() | Calculates and renders the document with the events DocumentRendering and DocumentRendered, see Quittio::renderDocument(). |
->template() | Template of this call; the same selection rules as for invoices. |
__construct()#
public function __construct(QuittioManager $manager, DocumentData $data)| Parameter | Type | Description |
|---|---|---|
$manager | QuittioManager | |
$data | DocumentData |
country()#
public function country(string $country): staticLeading country pack of this call (ISO 3166-1 alpha-2), instead of the seller's country.
| Parameter | Type | Description |
|---|---|---|
$country | string |
- Returns
static
data()#
public function data(): DocumentDataThe document of this call, as passed (not calculated).
- Returns
DocumentData
htmlOnly()#
public function htmlOnly(): staticRenders the template only, without PDF (format "html").
- Returns
static
locale()#
public function locale(string $locale): staticLocale of this call; wins over the document locale and the configuration.
| Parameter | Type | Description |
|---|---|---|
$locale | string |
- Returns
static
option()#
public function option(string $key, mixed $value): staticOutput option of this call, e.g. option('fold_marks', false); see the output configuration.
| Parameter | Type | Description |
|---|---|---|
$key | string | |
$value | mixed |
- Returns
static
options()#
public function options(): RenderOptionsThe options collected so far, as passed to the render run.
- Returns
RenderOptions
presentation()#
public function presentation(Presentation $presentation): staticDesign defaults of this call; the document's own presentation wins.
| Parameter | Type | Description |
|---|---|---|
$presentation | Presentation |
- Returns
static
queue()#
public function queue(?string $connection = null, ?string $queue = null): QueuedDocumentRenders in a queued job: Quittio::document($quote)->queue()->save('documents', $path).
| Parameter | Type | Description |
|---|---|---|
$connection | ?string = null | |
$queue | ?string = null |
- Returns
QueuedDocument
render()#
public function render(): RenderedDocumentCalculates and renders the document with the events DocumentRendering and DocumentRendered, see Quittio::renderDocument().
- Returns
RenderedDocument- Throws
CalculationException– when the document cannot be calculated- Throws
PdfException– when the PDF cannot be rendered
template()#
public function template(string $template): staticTemplate of this call; the same selection rules as for invoices.
| Parameter | Type | Description |
|---|---|---|
$template | string |
- Returns
static