mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-11-03 19:37:32 -05:00
524 lines
23 KiB
PHP
524 lines
23 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://opensource.org/licenses/AAL
|
|
*/
|
|
|
|
namespace App\Services\PdfMaker;
|
|
|
|
use App\Models\Quote;
|
|
use App\Services\PdfMaker\Designs\Utilities\BaseDesign;
|
|
use App\Services\PdfMaker\Designs\Utilities\DesignHelpers;
|
|
use App\Utils\Number;
|
|
use App\Utils\Traits\MakesInvoiceValues;
|
|
use DOMDocument;
|
|
use Illuminate\Support\Str;
|
|
|
|
class Design extends BaseDesign
|
|
{
|
|
use MakesInvoiceValues, DesignHelpers;
|
|
|
|
/** @var App\Models\Invoice || @var App\Models\Quote */
|
|
public $entity;
|
|
|
|
/** @var App\Models\Client */
|
|
public $client;
|
|
|
|
/** Global state of the design, @var array */
|
|
public $context;
|
|
|
|
/** Type of entity => product||task */
|
|
public $type;
|
|
|
|
/** Design string */
|
|
public $design;
|
|
|
|
/** Construct options */
|
|
public $options;
|
|
|
|
const BOLD = 'bold';
|
|
const BUSINESS = 'business';
|
|
const CLEAN = 'clean';
|
|
const CREATIVE = 'creative';
|
|
const ELEGANT = 'elegant';
|
|
const HIPSTER = 'hipster';
|
|
const MODERN = 'modern';
|
|
const PLAIN = 'plain';
|
|
const PLAYFUL = 'playful';
|
|
const CUSTOM = 'custom';
|
|
|
|
public function __construct(string $design = null, array $options = [])
|
|
{
|
|
Str::endsWith('.html', $design) ? $this->design = $design : $this->design = "{$design}.html";
|
|
|
|
$this->options = $options;
|
|
}
|
|
|
|
public function html(): ?string
|
|
{
|
|
if ($this->design == 'custom.html') {
|
|
return $this->composeFromPartials(
|
|
$this->options['custom_partials']
|
|
);
|
|
}
|
|
|
|
$path = isset($this->options['custom_path'])
|
|
? $this->options['custom_path']
|
|
: config('ninja.designs.base_path');
|
|
|
|
return file_get_contents(
|
|
$path . $this->design
|
|
);
|
|
}
|
|
|
|
public function elements(array $context, string $type = 'product'): array
|
|
{
|
|
$this->context = $context;
|
|
|
|
$this->type = $type;
|
|
|
|
$this->setup();
|
|
|
|
return [
|
|
'company-details' => [
|
|
'id' => 'company-details',
|
|
'elements' => $this->companyDetails(),
|
|
],
|
|
'company-address' => [
|
|
'id' => 'company-address',
|
|
'elements' => $this->companyAddress(),
|
|
],
|
|
'client-details' => [
|
|
'id' => 'client-details',
|
|
'elements' => $this->clientDetails(),
|
|
],
|
|
'entity-details' => [
|
|
'id' => 'entity-details',
|
|
'elements' => $this->entityDetails(),
|
|
],
|
|
'delivery-note-table' => [
|
|
'id' => 'delivery-note-table',
|
|
'elements' => $this->deliveryNoteTable(),
|
|
],
|
|
'product-table' => [
|
|
'id' => 'product-table',
|
|
'elements' => $this->productTable(),
|
|
],
|
|
'task-table' => [
|
|
'id' => 'task-table',
|
|
'elements' => $this->taskTable(),
|
|
],
|
|
'table-totals' => [
|
|
'id' => 'table-totals',
|
|
'elements' => $this->tableTotals(),
|
|
],
|
|
'footer-elements' => [
|
|
'id' => 'footer',
|
|
'elements' => [
|
|
$this->sharedFooterElements(),
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
public function companyDetails(): array
|
|
{
|
|
$variables = $this->context['pdf_variables']['company_details'];
|
|
|
|
$elements = [];
|
|
|
|
foreach ($variables as $variable) {
|
|
$elements[] = ['element' => 'p', 'content' => $variable, 'show_empty' => false, 'properties' => ['data-ref' => 'company_details-' . substr($variable, 1)]];
|
|
}
|
|
|
|
foreach (['company1', 'company2', 'company3', 'company4'] as $field) {
|
|
$elements[] = ['element' => 'p', 'content' => $this->getCustomFieldValue($field), 'show_empty' => false, 'properties' => ['data-ref' => 'company_details-' . $field]];
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
public function companyAddress(): array
|
|
{
|
|
$variables = $this->context['pdf_variables']['company_address'];
|
|
|
|
$elements = [];
|
|
|
|
foreach ($variables as $variable) {
|
|
$elements[] = ['element' => 'p', 'content' => $variable, 'show_empty' => false, 'properties' => ['data-ref' => 'company_address-' . substr($variable, 1)]];
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
public function clientDetails(): array
|
|
{
|
|
$elements = [];
|
|
|
|
if ($this->type == 'delivery_note') {
|
|
$elements = [
|
|
['element' => 'p', 'content' => $this->entity->client->name, 'show_empty' => false, 'properties' => ['data-ref' => 'delivery_note-client.name']],
|
|
['element' => 'p', 'content' => $this->entity->client->shipping_address1, 'show_empty' => false, 'properties' => ['data-ref' => 'delivery_note-client.shipping_address1']],
|
|
['element' => 'p', 'content' => $this->entity->client->shipping_address2, 'show_empty' => false, 'properties' => ['data-ref' => 'delivery_note-client.shipping_address2']],
|
|
['element' => 'p', 'show_empty' => false, 'elements' => [
|
|
['element' => 'span', 'content' => "{$this->entity->client->shipping_city} ", 'properties' => ['ref' => 'delivery_note-client.shipping_city']],
|
|
['element' => 'span', 'content' => "{$this->entity->client->shipping_state} ", 'properties' => ['ref' => 'delivery_note-client.shipping_state']],
|
|
['element' => 'span', 'content' => "{$this->entity->client->shipping_postal_code} ", 'properties' => ['ref' => 'delivery_note-client.shipping_postal_code']],
|
|
]],
|
|
['element' => 'p', 'content' => optional($this->entity->client->shipping_country)->name, 'show_empty' => false],
|
|
];
|
|
|
|
if (!is_null($this->context['contact'])) {
|
|
$elements[] = ['element' => 'p', 'content' => $this->context['contact']->email, 'show_empty' => false, 'properties' => ['data-ref' => 'delivery_note-contact.email']];
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
$variables = $this->context['pdf_variables']['client_details'];
|
|
|
|
foreach ($variables as $variable) {
|
|
$elements[] = ['element' => 'p', 'content' => $variable, 'show_empty' => false, 'properties' => ['data-ref' => 'client_details-' . substr($variable, 1)]];
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
public function entityDetails(): array
|
|
{
|
|
$variables = $this->context['pdf_variables']['invoice_details'];
|
|
|
|
if ($this->entity instanceof Quote) {
|
|
$variables = $this->context['pdf_variables']['quote_details'];
|
|
}
|
|
|
|
$elements = [];
|
|
|
|
// We don't want to show account balance or invoice total on PDF.. or any amount with currency.
|
|
if ($this->type == 'delivery_note') {
|
|
$variables = array_filter($variables, function ($m) {
|
|
return !in_array($m, ['$invoice.balance_due', '$invoice.total']);
|
|
});
|
|
}
|
|
|
|
foreach ($variables as $variable) {
|
|
$_variable = explode('.', $variable)[1];
|
|
$_customs = ['custom1', 'custom2', 'custom3', 'custom4'];
|
|
|
|
if (in_array($_variable, $_customs)) {
|
|
$elements[] = ['element' => 'tr', 'elements' => [
|
|
['element' => 'th', 'content' => $variable . '_label', 'properties' => ['data-ref' => 'entity_details-' . substr($variable, 1) . '_label']],
|
|
['element' => 'th', 'content' => $variable, 'properties' => ['data-ref' => 'entity_details-' . substr($variable, 1)]],
|
|
]];
|
|
} else {
|
|
$elements[] = ['element' => 'tr', 'properties' => ['hidden' => $this->entityVariableCheck($variable)], 'elements' => [
|
|
['element' => 'th', 'content' => $variable . '_label', 'properties' => ['data-ref' => 'entity_details-' . substr($variable, 1) . '_label']],
|
|
['element' => 'th', 'content' => $variable, 'properties' => ['data-ref' => 'entity_details-' . substr($variable, 1)]],
|
|
]];
|
|
}
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
public function deliveryNoteTable(): array
|
|
{
|
|
if ($this->type !== 'delivery_note') {
|
|
return [];
|
|
}
|
|
|
|
return [
|
|
['element' => 'thead', 'elements' => [
|
|
['element' => 'th', 'content' => '$item_label', 'properties' => ['data-ref' => 'delivery_note-item_label']],
|
|
['element' => 'th', 'content' => '$description_label', 'properties' => ['data-ref' => 'delivery_note-description_label']],
|
|
['element' => 'th', 'content' => '$product.quantity_label', 'properties' => ['data-ref' => 'delivery_note-product.quantity_label']],
|
|
]],
|
|
['element' => 'tbody', 'elements' => $this->buildTableBody('delivery_note')],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Parent method for building products table.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function productTable(): array
|
|
{
|
|
$product_items = collect($this->entity->line_items)->filter(function ($item) {
|
|
return $item->type_id == 1;
|
|
});
|
|
|
|
if (count($product_items) == 0) {
|
|
return [];
|
|
}
|
|
|
|
if ($this->type == 'delivery_note') {
|
|
return [];
|
|
}
|
|
|
|
return [
|
|
['element' => 'thead', 'elements' => $this->buildTableHeader('product')],
|
|
['element' => 'tbody', 'elements' => $this->buildTableBody('$product')],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Parent method for building tasks table.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function taskTable(): array
|
|
{
|
|
$task_items = collect($this->entity->line_items)->filter(function ($item) {
|
|
return $item->type_id == 2;
|
|
});
|
|
|
|
if (count($task_items) == 0) {
|
|
return [];
|
|
}
|
|
|
|
if ($this->type == 'delivery_note') {
|
|
return [];
|
|
}
|
|
|
|
return [
|
|
['element' => 'thead', 'elements' => $this->buildTableHeader('task')],
|
|
['element' => 'tbody', 'elements' => $this->buildTableBody('$task')],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Generate the structure of table headers. (<thead/>)
|
|
*
|
|
* @param string $type "product" or "task"
|
|
* @return array
|
|
*/
|
|
public function buildTableHeader(string $type): array
|
|
{
|
|
$this->processTaxColumns($type);
|
|
// $this->processCustomColumns($type);
|
|
|
|
$elements = [];
|
|
|
|
// Some of column can be aliased. This is simple workaround for these.
|
|
$aliases = [
|
|
'$product.product_key' => '$product.item',
|
|
'$task.product_key' => '$task.service',
|
|
];
|
|
|
|
foreach ($this->context['pdf_variables']["{$type}_columns"] as $column) {
|
|
if (array_key_exists($column, $aliases)) {
|
|
$elements[] = ['element' => 'th', 'content' => $aliases[$column] . '_label', 'properties' => ['hidden' => $this->client->getSetting('hide_empty_columns_on_pdf')]];
|
|
} elseif ($column == '$product.discount' && !$this->client->company->enable_product_discount) {
|
|
$elements[] = ['element' => 'th', 'content' => $column . '_label', 'properties' => ['data-ref' => "{$type}_table-" . substr($column, 1) . '-th', 'style' => 'display: none;']];
|
|
} elseif ($column == '$product.quantity' && !$this->client->company->enable_product_quantity) {
|
|
$elements[] = ['element' => 'th', 'content' => $column . '_label', 'properties' => ['data-ref' => "{$type}_table-" . substr($column, 1) . '-th', 'style' => 'display: none;']];
|
|
} elseif ($column == '$product.tax_rate1') {
|
|
$elements[] = ['element' => 'th', 'content' => $column . '_label', 'properties' => ['data-ref' => "{$type}_table-product.tax1-th", 'hidden' => $this->client->getSetting('hide_empty_columns_on_pdf')]];
|
|
} elseif ($column == '$product.tax_rate2') {
|
|
$elements[] = ['element' => 'th', 'content' => $column . '_label', 'properties' => ['data-ref' => "{$type}_table-product.tax2-th", 'hidden' => $this->client->getSetting('hide_empty_columns_on_pdf')]];
|
|
} elseif ($column == '$product.tax_rate3') {
|
|
$elements[] = ['element' => 'th', 'content' => $column . '_label', 'properties' => ['data-ref' => "{$type}_table-product.tax3-th", 'hidden' => $this->client->getSetting('hide_empty_columns_on_pdf')]];
|
|
} else {
|
|
$elements[] = ['element' => 'th', 'content' => $column . '_label', 'properties' => ['data-ref' => "{$type}_table-" . substr($column, 1) . '-th', 'hidden' => $this->client->getSetting('hide_empty_columns_on_pdf')]];
|
|
}
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
/**
|
|
* Generate the structure of table body. (<tbody/>)
|
|
*
|
|
* @param string $type "$product" or "$task"
|
|
* @return array
|
|
*/
|
|
public function buildTableBody(string $type): array
|
|
{
|
|
$elements = [];
|
|
|
|
$items = $this->transformLineItems($this->entity->line_items, $type);
|
|
|
|
if (count($items) == 0) {
|
|
return [];
|
|
}
|
|
|
|
if ($type == 'delivery_note') {
|
|
foreach ($items as $row) {
|
|
$element = ['element' => 'tr', 'elements' => []];
|
|
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['delivery_note.product_key'], 'properties' => ['data-ref' => 'delivery_note_table.product_key-td']];
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['delivery_note.notes'], 'properties' => ['data-ref' => 'delivery_note_table.notes-td']];
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['delivery_note.quantity'], 'properties' => ['data-ref' => 'delivery_note_table.quantity-td']];
|
|
|
|
$elements[] = $element;
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
foreach ($items as $row) {
|
|
$element = ['element' => 'tr', 'elements' => []];
|
|
|
|
if (
|
|
array_key_exists($type, $this->context) &&
|
|
!empty($this->context[$type]) &&
|
|
!is_null($this->context[$type])
|
|
) {
|
|
$document = new DOMDocument();
|
|
$document->loadHTML($this->context[$type], LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
|
|
|
|
$td = $document->getElementsByTagName('tr')->item(0);
|
|
|
|
if ($td) {
|
|
foreach ($td->childNodes as $child) {
|
|
if ($child->nodeType !== 1) {
|
|
continue;
|
|
}
|
|
|
|
if ($child->tagName !== 'td') {
|
|
continue;
|
|
}
|
|
|
|
$element['elements'][] = ['element' => 'td', 'content' => strtr($child->nodeValue, $row)];
|
|
}
|
|
}
|
|
} else {
|
|
$_type = Str::startsWith($type, '$') ? ltrim($type, '$') : $type;
|
|
|
|
foreach ($this->context['pdf_variables']["{$_type}_columns"] as $key => $cell) {
|
|
// We want to keep aliases like these:
|
|
// $task.cost => $task.rate
|
|
// $task.quantity => $task.hours
|
|
|
|
if ($cell == '$task.rate') {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['$task.cost'], 'properties' => ['data-ref' => 'task_table-task.cost-td']];
|
|
} elseif ($cell == '$product.discount' && !$this->client->company->enable_product_discount) {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['$product.discount'], 'properties' => ['data-ref' => 'product_table-product.discount-td', 'style' => 'display: none;']];
|
|
} elseif ($cell == '$product.quantity' && !$this->client->company->enable_product_quantity) {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['$product.quantity'], 'properties' => ['data-ref' => 'product_table-product.quantity-td', 'style' => 'display: none;']];
|
|
} elseif ($cell == '$task.hours') {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row['$task.quantity'], 'properties' => ['data-ref' => 'task_table-task.hours-td']];
|
|
} elseif ($cell == '$product.tax_rate1') {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row[$cell], 'properties' => ['data-ref' => 'product_table-product.tax1-td']];
|
|
} elseif ($cell == '$product.tax_rate2') {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row[$cell], 'properties' => ['data-ref' => 'product_table-product.tax2-td']];
|
|
} elseif ($cell == '$product.tax_rate3') {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row[$cell], 'properties' => ['data-ref' => 'product_table-product.tax3-td']];
|
|
}
|
|
else if($cell == '$product.unit_cost' || $cell == '$task.rate') {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row[$cell], 'properties' => ['style' => 'white-space: nowrap;', 'data-ref' => "{$_type}_table-" . substr($cell, 1) . '-td']];
|
|
}
|
|
else {
|
|
$element['elements'][] = ['element' => 'td', 'content' => $row[$cell], 'properties' => ['data-ref' => "{$_type}_table-" . substr($cell, 1) . '-td']];
|
|
}
|
|
}
|
|
}
|
|
|
|
$elements[] = $element;
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
public function tableTotals(): array
|
|
{
|
|
$_variables = array_key_exists('variables', $this->context)
|
|
? $this->context['variables']
|
|
: ['values' => ['$entity.public_notes' => nl2br($this->entity->public_notes), '$entity.terms' => $this->entity->terms, '$entity_footer' => $this->entity->footer], 'labels' => []];
|
|
|
|
if ($this->type == 'delivery_note') {
|
|
return [];
|
|
}
|
|
|
|
$variables = $this->context['pdf_variables']['total_columns'];
|
|
|
|
$elements = [
|
|
['element' => 'div', 'properties' => ['style' => 'display: flex; flex-direction: column;'], 'elements' => [
|
|
['element' => 'p', 'content' => strtr($_variables['values']['$entity.public_notes'], $_variables), 'properties' => ['data-ref' => 'total_table-public_notes', 'style' => 'text-align: left;']],
|
|
['element' => 'p', 'content' => '', 'properties' => ['style' => 'text-align: left; display: flex; flex-direction: column;'], 'elements' => [
|
|
['element' => 'span', 'content' => '$entity.terms_label: ', 'properties' => ['hidden' => $this->entityVariableCheck('$entity.terms'), 'data-ref' => 'total_table-terms-label', 'style' => 'font-weight: bold; text-align: left;']],
|
|
['element' => 'span', 'content' => strtr($_variables['values']['$entity.terms'], $_variables), 'properties' => ['data-ref' => 'total_table-terms', 'style' => 'text-align: left;']],
|
|
['element' => 'span', 'content' => strtr($_variables['values']['$entity_footer'], $_variables), 'properties' => ['data-ref' => 'total_table-footer', 'style' => 'text-align: left;']],
|
|
]],
|
|
['element' => 'img', 'properties' => ['hidden' => $this->client->getSetting('signature_on_pdf'), 'style' => 'max-width: 50%; height: auto;', 'src' => '$contact.signature']],
|
|
['element' => 'div', 'properties' => ['style' => 'margin-top: 1.5rem; display: flex; align-items: flex-start;'], 'elements' => [
|
|
['element' => 'img', 'properties' => ['src' => '$invoiceninja.whitelabel', 'style' => 'height: 2.5rem;', 'hidden' => $this->entity->user->account->isPaid() ? 'true' : 'false', 'id' => 'invoiceninja-whitelabel-logo']],
|
|
]],
|
|
]],
|
|
['element' => 'div', 'properties' => ['class' => 'totals-table-right-side'], 'elements' => []],
|
|
];
|
|
|
|
foreach (['discount', 'custom_surcharge1', 'custom_surcharge2', 'custom_surcharge3', 'custom_surcharge4'] as $property) {
|
|
$variable = sprintf('%s%s', '$', $property);
|
|
|
|
if (
|
|
!is_null($this->entity->{$property}) &&
|
|
!empty($this->entity->{$property}) &&
|
|
$this->entity->{$property} != 0
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
$variables = array_filter($variables, function ($m) use ($variable) {
|
|
return $m != $variable;
|
|
});
|
|
}
|
|
|
|
foreach ($variables as $variable) {
|
|
if ($variable == '$total_taxes') {
|
|
$taxes = $this->entity->calc()->getTotalTaxMap();
|
|
|
|
if (!$taxes) {
|
|
continue;
|
|
}
|
|
|
|
foreach ($taxes as $i => $tax) {
|
|
$elements[1]['elements'][] = ['element' => 'div', 'elements' => [
|
|
['element' => 'span', 'content', 'content' => $tax['name'], 'properties' => ['data-ref' => 'totals-table-total_tax_' . $i . '-label']],
|
|
['element' => 'span', 'content', 'content' => Number::formatMoney($tax['total'], $this->context['client']), 'properties' => ['data-ref' => 'totals-table-total_tax_' . $i]],
|
|
]];
|
|
}
|
|
} elseif ($variable == '$line_taxes') {
|
|
$taxes = $this->entity->calc()->getTaxMap();
|
|
|
|
if (!$taxes) {
|
|
continue;
|
|
}
|
|
|
|
foreach ($taxes as $i => $tax) {
|
|
$elements[1]['elements'][] = ['element' => 'div', 'elements' => [
|
|
['element' => 'span', 'content', 'content' => $tax['name'], 'properties' => ['data-ref' => 'totals-table-line_tax_' . $i . '-label']],
|
|
['element' => 'span', 'content', 'content' => Number::formatMoney($tax['total'], $this->context['client']), 'properties' => ['data-ref' => 'totals-table-line_tax_' . $i]],
|
|
]];
|
|
}
|
|
} else {
|
|
$elements[1]['elements'][] = ['element' => 'div', 'elements' => [
|
|
['element' => 'span', 'content' => $variable . '_label', 'properties' => ['data-ref' => 'totals_table-' . substr($variable, 1) . '-label']],
|
|
['element' => 'span', 'content' => $variable, 'properties' => ['data-ref' => 'totals_table-' . substr($variable, 1)]],
|
|
]];
|
|
}
|
|
}
|
|
|
|
if (!is_null($this->entity->partial) && $this->entity->partial > 0) {
|
|
$elements[1]['elements'][] = ['element' => 'div', 'elements' => [
|
|
['element' => 'span', 'content' => '$partial_due_label', 'properties' => ['data-ref' => 'totals_table-partial_due-label']],
|
|
['element' => 'span', 'content' => '$partial_due'],
|
|
]];
|
|
}
|
|
|
|
$elements[1]['elements'][] = ['element' => 'div', 'elements' => [
|
|
['element' => 'span', 'content' => '',],
|
|
['element' => 'span', 'content' => ''],
|
|
]];
|
|
|
|
return $elements;
|
|
}
|
|
}
|