1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-10 21:22:58 +01:00
invoiceninja/app/Export/CSV/InvoiceExport.php

159 lines
4.8 KiB
PHP
Raw Normal View History

2020-12-14 05:59:15 +01:00
<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
2022-04-27 05:20:41 +02:00
* @copyright Copyright (c) 2022. 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
2022-04-27 08:29:38 +02:00
class InvoiceExport extends BaseExport
2020-12-14 05:59:15 +01:00
{
2022-04-27 08:29:38 +02:00
private Company $company;
2020-12-14 06:03:23 +01:00
2022-04-27 08:29:38 +02:00
protected array $input;
2022-04-08 06:47:10 +02:00
private $invoice_transformer;
2022-04-27 08:29:38 +02:00
protected string $date_key = 'date';
2022-04-27 10:05:54 +02:00
protected array $entity_keys = [
2022-04-08 06:47:10 +02:00
'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_id' => 'currency_id',
2022-04-08 06:47:10 +02:00
];
private array $decorate_keys = [
'country',
'client',
2022-05-09 05:31:19 +02:00
'currency_id',
2022-04-08 10:10:14 +02:00
'status',
2022-05-10 09:04:24 +02:00
'vendor',
'project',
2022-04-08 06:47:10 +02:00
];
2022-04-27 08:29:38 +02:00
public function __construct(Company $company, array $input)
2020-12-16 12:52:40 +01:00
{
$this->company = $company;
2022-04-27 08:29:38 +02:00
$this->input = $input;
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();
if (count($this->input['report_keys']) == 0) {
2022-05-10 06:51:39 +02:00
$this->input['report_keys'] = array_values($this->entity_keys);
}
2022-04-08 06:47:10 +02:00
//insert the header
$this->csv->insertOne($this->buildHeader());
2022-04-27 08:29:38 +02:00
$query = Invoice::query()
->withTrashed()
2022-05-10 08:50:30 +02:00
->with('client')
->where('company_id', $this->company->id)
->where('is_deleted', 0);
2022-04-27 08:29:38 +02:00
$query = $this->addDateRange($query);
2022-04-08 06:47:10 +02:00
2022-04-27 08:29:38 +02:00
$query->cursor()
->each(function ($invoice) {
$this->csv->insertOne($this->buildRow($invoice));
});
2022-04-08 06:47:10 +02:00
return $this->csv->toString();
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->input['report_keys']) as $key) {
2022-05-10 06:51:39 +02:00
$keyval = array_search($key, $this->entity_keys);
if (array_key_exists($key, $transformed_invoice)) {
2022-05-10 06:51:39 +02:00
$entity[$keyval] = $transformed_invoice[$key];
} else {
2022-05-10 06:51:39 +02:00
$entity[$keyval] = '';
}
2022-04-08 06:47:10 +02:00
}
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 (in_array('country_id', $this->input['report_keys'])) {
$entity['country'] = $invoice->client->country ? ctrans("texts.country_{$invoice->client->country->name}") : '';
}
2022-05-10 06:51:39 +02:00
if (in_array('currency_id', $this->input['report_keys'])) {
2022-05-10 06:51:39 +02:00
$entity['currency_id'] = $invoice->client->currency() ? $invoice->client->currency()->code : $invoice->company->currency()->code;
}
2022-04-08 06:47:10 +02:00
if (in_array('client_id', $this->input['report_keys'])) {
2022-05-10 06:51:39 +02:00
$entity['client'] = $invoice->client->present()->name();
}
2022-04-08 06:47:10 +02:00
if (in_array('status_id', $this->input['report_keys'])) {
2022-05-10 06:51:39 +02:00
$entity['status'] = $invoice->stringStatus($invoice->status_id);
}
2022-04-08 10:10:14 +02:00
2022-04-08 06:47:10 +02:00
return $entity;
}
2020-12-16 12:52:40 +01:00
}