2020-12-14 05:59:15 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
|
|
*
|
|
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
|
|
*
|
2021-01-03 22:54:54 +01:00
|
|
|
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
|
2020-12-14 05:59:15 +01:00
|
|
|
*
|
2021-06-16 08:58:16 +02:00
|
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
2020-12-14 05:59:15 +01:00
|
|
|
*/
|
|
|
|
|
2020-12-14 11:43:07 +01:00
|
|
|
namespace App\Export\CSV;
|
2020-12-14 05:59:15 +01:00
|
|
|
|
2022-04-08 06:47:10 +02:00
|
|
|
use App\Libraries\MultiDB;
|
|
|
|
use App\Models\Client;
|
2020-12-14 06:03:23 +01:00
|
|
|
use App\Models\Company;
|
2022-04-08 06:47:10 +02:00
|
|
|
use App\Models\Invoice;
|
2022-04-08 06:54:59 +02:00
|
|
|
use App\Transformers\InvoiceTransformer;
|
2022-04-08 06:47:10 +02:00
|
|
|
use App\Utils\Ninja;
|
|
|
|
use Illuminate\Support\Facades\App;
|
|
|
|
use League\Csv\Writer;
|
2020-12-14 06:03:23 +01:00
|
|
|
|
2020-12-14 05:59:15 +01:00
|
|
|
class InvoiceExport
|
|
|
|
{
|
2020-12-16 12:52:40 +01:00
|
|
|
private $company;
|
2020-12-14 06:03:23 +01:00
|
|
|
|
2022-04-08 06:47:10 +02:00
|
|
|
private $report_keys;
|
|
|
|
|
|
|
|
private $invoice_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',
|
2022-04-08 06:54:59 +02:00
|
|
|
'currency' => 'client_id'
|
2022-04-08 06:47:10 +02:00
|
|
|
];
|
|
|
|
|
|
|
|
private array $decorate_keys = [
|
|
|
|
'country',
|
|
|
|
'client',
|
|
|
|
'currency',
|
2022-04-08 10:10:14 +02:00
|
|
|
'status',
|
2022-04-08 06:47:10 +02:00
|
|
|
];
|
|
|
|
|
|
|
|
public function __construct(Company $company, array $report_keys)
|
2020-12-16 12:52:40 +01:00
|
|
|
{
|
|
|
|
$this->company = $company;
|
2022-04-08 06:47:10 +02:00
|
|
|
$this->report_keys = $report_keys;
|
2022-04-08 06:54:59 +02:00
|
|
|
$this->invoice_transformer = new InvoiceTransformer();
|
2020-12-16 12:52:40 +01:00
|
|
|
}
|
2020-12-14 06:03:23 +01:00
|
|
|
|
2022-04-08 06:47:10 +02:00
|
|
|
public function run()
|
2020-12-16 12:52:40 +01:00
|
|
|
{
|
2022-04-08 06:47:10 +02:00
|
|
|
|
|
|
|
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());
|
|
|
|
|
|
|
|
Invoice::with('client')->where('company_id', $this->company->id)
|
|
|
|
->where('is_deleted',0)
|
|
|
|
->cursor()
|
|
|
|
->each(function ($invoice){
|
|
|
|
|
|
|
|
$this->csv->insertOne($this->buildRow($invoice));
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
return $this->csv->toString();
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
private function buildHeader() :array
|
|
|
|
{
|
|
|
|
|
|
|
|
$header = [];
|
|
|
|
|
|
|
|
foreach(array_keys($this->report_keys) as $key)
|
|
|
|
$header[] = ctrans("texts.{$key}");
|
|
|
|
|
|
|
|
return $header;
|
2020-12-16 12:52:40 +01:00
|
|
|
}
|
2022-04-08 06:47:10 +02:00
|
|
|
|
2022-04-08 06:54:59 +02:00
|
|
|
private function buildRow(Invoice $invoice) :array
|
2022-04-08 06:47:10 +02:00
|
|
|
{
|
|
|
|
|
|
|
|
$transformed_invoice = $this->invoice_transformer->transform($invoice);
|
|
|
|
|
|
|
|
$entity = [];
|
|
|
|
|
|
|
|
foreach(array_values($this->report_keys) as $key){
|
|
|
|
|
|
|
|
$entity[$key] = $transformed_invoice[$key];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->decorateAdvancedFields($invoice, $entity);
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2022-04-08 06:54:59 +02:00
|
|
|
private function decorateAdvancedFields(Invoice $invoice, array $entity) :array
|
2022-04-08 06:47:10 +02:00
|
|
|
{
|
|
|
|
if(array_key_exists('currency', $entity))
|
|
|
|
$entity['currency'] = $invoice->client->currency()->code;
|
|
|
|
|
|
|
|
if(array_key_exists('client_id', $entity))
|
|
|
|
$entity['client_id'] = $invoice->client->present()->name();
|
|
|
|
|
2022-04-08 10:10:14 +02:00
|
|
|
if(array_key_exists('status_id', $entity))
|
|
|
|
$entity['status_id'] = $invoice->stringStatus($invoice->status_id);
|
|
|
|
|
2022-04-08 06:47:10 +02:00
|
|
|
return $entity;
|
|
|
|
}
|
|
|
|
|
2020-12-16 12:52:40 +01:00
|
|
|
}
|