294 lines
9.4 KiB
PHP
294 lines
9.4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2025. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Export\CSV;
|
|
|
|
use App\Export\Decorators\Decorator;
|
|
use App\Libraries\MultiDB;
|
|
use App\Models\Company;
|
|
use App\Models\RecurringInvoice;
|
|
use App\Transformers\RecurringInvoiceTransformer;
|
|
use App\Utils\Ninja;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Support\Facades\App;
|
|
use League\Csv\Writer;
|
|
use App\Models\Product;
|
|
|
|
class RecurringInvoiceItemExport extends BaseExport
|
|
{
|
|
private $invoice_transformer;
|
|
|
|
public string $date_key = 'date';
|
|
|
|
public Writer $csv;
|
|
|
|
private Decorator $decorator;
|
|
|
|
private bool $force_keys = false;
|
|
|
|
private array $storage_array = [];
|
|
|
|
private array $storage_item_array = [];
|
|
|
|
private array $decorate_keys = [
|
|
'client',
|
|
'currency_id',
|
|
'status'
|
|
];
|
|
|
|
public function __construct(Company $company, array $input)
|
|
{
|
|
$this->company = $company;
|
|
$this->input = $input;
|
|
$this->invoice_transformer = new RecurringInvoiceTransformer();
|
|
$this->decorator = new Decorator();
|
|
}
|
|
|
|
public function init(): Builder
|
|
{
|
|
|
|
MultiDB::setDb($this->company->db);
|
|
App::forgetInstance('translator');
|
|
App::setLocale($this->company->locale());
|
|
$t = app('translator');
|
|
$t->replace(Ninja::transformTranslations($this->company->settings));
|
|
|
|
if (count($this->input['report_keys']) == 0) {
|
|
$this->force_keys = true;
|
|
$this->input['report_keys'] = array_values($this->mergeItemsKeys('recurring_invoice_report_keys'));
|
|
nlog($this->input['report_keys']);
|
|
}
|
|
|
|
$this->input['report_keys'] = array_merge($this->input['report_keys'], array_diff($this->forced_client_fields, $this->input['report_keys']));
|
|
|
|
$query = RecurringInvoice::query()
|
|
->withTrashed()
|
|
->with('client')
|
|
->whereHas('client', function ($q) {
|
|
$q->where('is_deleted', false);
|
|
})
|
|
->where('company_id', $this->company->id);
|
|
|
|
if (!$this->input['include_deleted'] ?? false) {// @phpstan-ignore-line
|
|
$query->where('is_deleted', 0);
|
|
}
|
|
|
|
$query = $this->addDateRange($query, 'invoices');
|
|
|
|
$clients = &$this->input['client_id'];
|
|
|
|
if ($clients) {
|
|
$query = $this->addClientFilter($query, $clients);
|
|
}
|
|
|
|
if ($this->input['status'] ?? false) {
|
|
$query = $this->addRecurringInvoiceStatusFilter($query, $this->input['status']);
|
|
}
|
|
$query = $this->filterByUserPermissions($query);
|
|
|
|
$query = $this->applyProductFilters($query);
|
|
|
|
if ($this->input['document_email_attachment'] ?? false) {
|
|
$this->queueDocuments($query);
|
|
}
|
|
|
|
return $query;
|
|
|
|
}
|
|
|
|
public function returnJson()
|
|
{
|
|
$query = $this->init();
|
|
|
|
$headerdisplay = $this->buildHeader();
|
|
|
|
$header = collect($this->input['report_keys'])->map(function ($key, $value) use ($headerdisplay) {
|
|
return ['identifier' => $key, 'display_value' => $headerdisplay[$value]];
|
|
})->toArray();
|
|
|
|
$query->cursor()
|
|
->each(function ($resource) {
|
|
|
|
/** @var \App\Models\RecurringInvoice $resource */
|
|
$this->iterateItems($resource);
|
|
|
|
foreach ($this->storage_array as $row) {
|
|
$this->storage_item_array[] = $this->processItemMetaData($row, $resource);
|
|
}
|
|
|
|
$this->storage_array = [];
|
|
|
|
});
|
|
|
|
return array_merge(['columns' => $header], $this->storage_item_array);
|
|
|
|
}
|
|
|
|
|
|
public function run()
|
|
{
|
|
$query = $this->init();
|
|
|
|
//load the CSV document from a string
|
|
$this->csv = Writer::fromString();
|
|
\League\Csv\CharsetConverter::addTo($this->csv, 'UTF-8', 'UTF-8');
|
|
|
|
//insert the header
|
|
$this->csv->insertOne($this->buildHeader());
|
|
|
|
$query->cursor()
|
|
->each(function ($invoice) {
|
|
|
|
/** @var \App\Models\RecurringInvoice $invoice */
|
|
$this->iterateItems($invoice);
|
|
});
|
|
|
|
$this->csv->insertAll($this->storage_array);
|
|
|
|
return $this->csv->toString();
|
|
}
|
|
|
|
private function filterItems(array $items): array
|
|
{
|
|
|
|
//if we have product filters in place, we will also need to filter the items at this level:
|
|
if (isset($this->input['product_key'])) {
|
|
|
|
$products = str_getcsv($this->input['product_key'], ',', "'");
|
|
|
|
$products = array_map(function ($product) {
|
|
return trim($product, "'");
|
|
}, $products);
|
|
|
|
$items = array_filter($items, function ($item) use ($products) {
|
|
return in_array($item->product_key, $products);
|
|
});
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
|
|
private function iterateItems(RecurringInvoice $invoice)
|
|
{
|
|
$transformed_invoice = $this->buildRow($invoice);
|
|
|
|
$transformed_items = [];
|
|
|
|
foreach ($this->filterItems($invoice->line_items) as $item) {
|
|
$item_array = [];
|
|
|
|
foreach (array_values(array_intersect($this->input['report_keys'], $this->item_report_keys)) as $key) { //items iterator produces item arr
|
|
|
|
if (str_contains($key, "item.")) {
|
|
|
|
$tmp_key = str_replace("item.", "", $key);
|
|
|
|
if ($tmp_key == 'tax_id') {
|
|
|
|
if (!property_exists($item, 'tax_id')) {
|
|
$item->tax_id = '1';
|
|
}
|
|
|
|
$item_array[$key] = $this->getTaxCategoryName((int)$item->tax_id ?? 1); // @phpstan-ignore-line
|
|
} elseif (property_exists($item, $tmp_key)) {
|
|
$item_array[$key] = $item->{$tmp_key};
|
|
} else {
|
|
$item_array[$key] = '';
|
|
}
|
|
}
|
|
}
|
|
|
|
$transformed_items = array_merge($transformed_invoice, $item_array);
|
|
$entity = $this->decorateAdvancedFields($invoice, $transformed_items);
|
|
|
|
$entity = array_merge(array_flip(array_values($this->input['report_keys'])), $entity);
|
|
|
|
$this->storage_array[] = $this->convertFloats($entity);
|
|
|
|
}
|
|
}
|
|
|
|
private function getTaxCategoryName($tax_id)
|
|
{
|
|
return match ($tax_id) {
|
|
Product::PRODUCT_TYPE_PHYSICAL => ctrans('texts.physical_goods'),
|
|
Product::PRODUCT_TYPE_SERVICE => ctrans('texts.services'),
|
|
Product::PRODUCT_TYPE_DIGITAL => ctrans('texts.digital_products'),
|
|
Product::PRODUCT_TYPE_SHIPPING => ctrans('texts.shipping'),
|
|
Product::PRODUCT_TYPE_EXEMPT => ctrans('texts.tax_exempt'),
|
|
Product::PRODUCT_TYPE_REDUCED_TAX => ctrans('texts.reduced_tax'),
|
|
Product::PRODUCT_TYPE_OVERRIDE_TAX => ctrans('texts.override_tax'),
|
|
Product::PRODUCT_TYPE_ZERO_RATED => ctrans('texts.zero_rated'),
|
|
Product::PRODUCT_TYPE_REVERSE_TAX => ctrans('texts.reverse_tax'),
|
|
default => 'Unknown',
|
|
};
|
|
}
|
|
|
|
private function buildRow(RecurringInvoice $invoice): array
|
|
{
|
|
$transformed_invoice = $this->invoice_transformer->transform($invoice);
|
|
|
|
$entity = [];
|
|
|
|
|
|
foreach (array_values($this->input['report_keys']) as $key) {
|
|
|
|
$parts = explode('.', $key);
|
|
|
|
if (is_array($parts) && $parts[0] == 'item') {
|
|
continue;
|
|
}
|
|
|
|
if (is_array($parts) && $parts[0] == 'invoice' && array_key_exists($parts[1], $transformed_invoice)) {
|
|
$entity[$key] = $transformed_invoice[$parts[1]];
|
|
} elseif (array_key_exists($key, $transformed_invoice)) {
|
|
$entity[$key] = $transformed_invoice[$key];
|
|
} else {
|
|
$entity[$key] = $this->decorator->transform($key, $invoice);
|
|
}
|
|
}
|
|
|
|
$entity = $this->decorateAdvancedFields($invoice, $entity);
|
|
return $entity;
|
|
}
|
|
|
|
private function decorateAdvancedFields(RecurringInvoice $invoice, array $entity): array
|
|
{
|
|
|
|
|
|
if (in_array('recurring_invoice.frequency_id', $this->input['report_keys']) || in_array('frequency_id', $this->input['report_keys'])) {
|
|
$entity['recurring_invoice.frequency_id'] = $invoice->frequencyForKey($invoice->frequency_id);
|
|
}
|
|
|
|
if (in_array('recurring_invoice.auto_bill_enabled', $this->input['report_keys'])) {
|
|
$entity['recurring_invoice.auto_bill_enabled'] = $invoice->auto_bill_enabled ? ctrans('texts.yes') : ctrans('texts.no');
|
|
}
|
|
|
|
if (in_array('recurring_invoice.assigned_user_id', $this->input['report_keys'])) {
|
|
$entity['recurring_invoice.assigned_user_id'] = $invoice->assigned_user ? $invoice->assigned_user->present()->name() : '';
|
|
}
|
|
|
|
if (in_array('recurring_invoice.user_id', $this->input['report_keys'])) {
|
|
$entity['recurring_invoice.user_id'] = $invoice->user ? $invoice->user->present()->name() : '';
|
|
}
|
|
|
|
|
|
if (in_array('invoice.project', $this->input['report_keys'])) {
|
|
$entity['invoice.project'] = $invoice->project ? $invoice->project->name : '';// @phpstan-ignore-line
|
|
}
|
|
|
|
|
|
return $entity;
|
|
}
|
|
|
|
}
|