Invoice / Quote exports

This commit is contained in:
David Bomba 2022-04-08 14:54:59 +10:00
parent 6ac34ac5a1
commit 0d1deaa89d
2 changed files with 156 additions and 15 deletions

View File

@ -15,7 +15,7 @@ use App\Libraries\MultiDB;
use App\Models\Client; use App\Models\Client;
use App\Models\Company; use App\Models\Company;
use App\Models\Invoice; use App\Models\Invoice;
use App\Transformers\CreditTransformer; use App\Transformers\InvoiceTransformer;
use App\Utils\Ninja; use App\Utils\Ninja;
use Illuminate\Support\Facades\App; use Illuminate\Support\Facades\App;
use League\Csv\Writer; use League\Csv\Writer;
@ -36,7 +36,6 @@ class InvoiceExport
'custom_surcharge2' => 'custom_surcharge2', 'custom_surcharge2' => 'custom_surcharge2',
'custom_surcharge3' => 'custom_surcharge3', 'custom_surcharge3' => 'custom_surcharge3',
'custom_surcharge4' => 'custom_surcharge4', 'custom_surcharge4' => 'custom_surcharge4',
'country' => 'country_id',
'custom_value1' => 'custom_value1', 'custom_value1' => 'custom_value1',
'custom_value2' => 'custom_value2', 'custom_value2' => 'custom_value2',
'custom_value3' => 'custom_value3', 'custom_value3' => 'custom_value3',
@ -46,7 +45,6 @@ class InvoiceExport
'due_date' => 'due_date', 'due_date' => 'due_date',
'exchange_rate' => 'exchange_rate', 'exchange_rate' => 'exchange_rate',
'footer' => 'footer', 'footer' => 'footer',
'invoice' => 'invoice_id',
'number' => 'number', 'number' => 'number',
'paid_to_date' => 'paid_to_date', 'paid_to_date' => 'paid_to_date',
'partial' => 'partial', 'partial' => 'partial',
@ -63,13 +61,12 @@ class InvoiceExport
'tax_rate3' => 'tax_rate3', 'tax_rate3' => 'tax_rate3',
'terms' => 'terms', 'terms' => 'terms',
'total_taxes' => 'total_taxes', 'total_taxes' => 'total_taxes',
'currency' => 'currency' 'currency' => 'client_id'
]; ];
private array $decorate_keys = [ private array $decorate_keys = [
'country', 'country',
'client', 'client',
'invoice',
'currency', 'currency',
]; ];
@ -77,7 +74,7 @@ class InvoiceExport
{ {
$this->company = $company; $this->company = $company;
$this->report_keys = $report_keys; $this->report_keys = $report_keys;
$this->invoice_transformer = new CreditTransformer(); $this->invoice_transformer = new InvoiceTransformer();
} }
public function run() public function run()
@ -120,7 +117,7 @@ class InvoiceExport
return $header; return $header;
} }
private function buildRow(Credit $invoice) :array private function buildRow(Invoice $invoice) :array
{ {
$transformed_invoice = $this->invoice_transformer->transform($invoice); $transformed_invoice = $this->invoice_transformer->transform($invoice);
@ -136,18 +133,11 @@ class InvoiceExport
} }
private function decorateAdvancedFields(Credit $invoice, array $entity) :array private function decorateAdvancedFields(Invoice $invoice, array $entity) :array
{ {
if(array_key_exists('country_id', $entity))
$entity['country_id'] = $invoice->client->country ? ctrans("texts.country_{$invoice->client->country->name}") : "";
if(array_key_exists('currency', $entity)) if(array_key_exists('currency', $entity))
$entity['currency'] = $invoice->client->currency()->code; $entity['currency'] = $invoice->client->currency()->code;
if(array_key_exists('invoice_id', $entity))
$entity['invoice_id'] = $invoice->invoice ? $invoice->invoice->number : "";
if(array_key_exists('client_id', $entity)) if(array_key_exists('client_id', $entity))
$entity['client_id'] = $invoice->client->present()->name(); $entity['client_id'] = $invoice->client->present()->name();

View File

@ -0,0 +1,151 @@
<?php
/**
* Quote Ninja (https://quoteninja.com).
*
* @link https://github.com/quoteninja/quoteninja source repository
*
* @copyright Copyright (c) 2021. Quote Ninja LLC (https://quoteninja.com)
*
* @license https://www.elastic.co/licensing/elastic-license
*/
namespace App\Export\CSV;
use App\Libraries\MultiDB;
use App\Models\Client;
use App\Models\Company;
use App\Models\Quote;
use App\Transformers\QuoteTransformer;
use App\Utils\Ninja;
use Illuminate\Support\Facades\App;
use League\Csv\Writer;
class QuoteExport
{
private $company;
private $report_keys;
private $quote_transformer;
private array $entity_keys = [
'amount' => 'amount',
'balance' => 'balance',
'client' => 'client_id',
'custom_surcharge1' => 'custom_surcharge1',
'custom_surcharge2' => 'custom_surcharge2',
'custom_surcharge3' => 'custom_surcharge3',
'custom_surcharge4' => 'custom_surcharge4',
'custom_value1' => 'custom_value1',
'custom_value2' => 'custom_value2',
'custom_value3' => 'custom_value3',
'custom_value4' => 'custom_value4',
'date' => 'date',
'discount' => 'discount',
'due_date' => 'due_date',
'exchange_rate' => 'exchange_rate',
'footer' => 'footer',
'number' => 'number',
'paid_to_date' => 'paid_to_date',
'partial' => 'partial',
'partial_due_date' => 'partial_due_date',
'po_number' => 'po_number',
'private_notes' => 'private_notes',
'public_notes' => 'public_notes',
'status' => 'status_id',
'tax_name1' => 'tax_name1',
'tax_name2' => 'tax_name2',
'tax_name3' => 'tax_name3',
'tax_rate1' => 'tax_rate1',
'tax_rate2' => 'tax_rate2',
'tax_rate3' => 'tax_rate3',
'terms' => 'terms',
'total_taxes' => 'total_taxes',
'currency' => 'client_id',
'invoice' => 'invoice_id',
];
private array $decorate_keys = [
'client',
'currency',
'invoice'
];
public function __construct(Company $company, array $report_keys)
{
$this->company = $company;
$this->report_keys = $report_keys;
$this->quote_transformer = new QuoteTransformer();
}
public function run()
{
MultiDB::setDb($this->company->db);
App::forgetInstance('translator');
App::setLocale($this->company->locale());
$t = app('translator');
$t->replace(Ninja::transformTranslations($this->company->settings));
//load the CSV document from a string
$this->csv = Writer::createFromString();
//insert the header
$this->csv->insertOne($this->buildHeader());
Quote::with('client')->where('company_id', $this->company->id)
->where('is_deleted',0)
->cursor()
->each(function ($quote){
$this->csv->insertOne($this->buildRow($quote));
});
return $this->csv->toString();
}
private function buildHeader() :array
{
$header = [];
foreach(array_keys($this->report_keys) as $key)
$header[] = ctrans("texts.{$key}");
return $header;
}
private function buildRow(Quote $quote) :array
{
$transformed_quote = $this->quote_transformer->transform($quote);
$entity = [];
foreach(array_values($this->report_keys) as $key){
$entity[$key] = $transformed_quote[$key];
}
return $this->decorateAdvancedFields($quote, $entity);
}
private function decorateAdvancedFields(Quote $quote, array $entity) :array
{
if(array_key_exists('currency', $entity))
$entity['currency'] = $quote->client->currency()->code;
if(array_key_exists('client_id', $entity))
$entity['client_id'] = $quote->client->present()->name();
if(array_key_exists('invoice', $entity))
$entity['invoice'] = $quote->invoice ? $quote->invoice->number : "";
return $entity;
}
}