1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-21 08:51:34 +02:00
invoiceninja/app/Export/CSV/ExpenseExport.php

171 lines
5.0 KiB
PHP
Raw Normal View History

2022-04-08 09:03:03 +02:00
<?php
/**
* Expense Ninja (https://expenseninja.com).
*
* @link https://github.com/expenseninja/expenseninja source repository
*
2022-04-27 05:20:41 +02:00
* @copyright Copyright (c) 2022. Expense Ninja LLC (https://expenseninja.com)
2022-04-08 09:03:03 +02:00
*
* @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\Expense;
use App\Transformers\ExpenseTransformer;
use App\Utils\Ninja;
use Illuminate\Support\Facades\App;
use League\Csv\Writer;
2022-04-27 07:41:52 +02:00
class ExpenseExport extends BaseExport
2022-04-08 09:03:03 +02:00
{
2022-04-27 07:41:52 +02:00
private Company $company;
2022-04-08 09:03:03 +02:00
2022-04-27 07:41:52 +02:00
protected array $input;
2022-04-08 09:03:03 +02:00
private $expense_transformer;
2022-04-27 07:41:52 +02:00
protected $date_key = 'date';
2022-04-27 10:05:54 +02:00
protected array $entity_keys = [
2022-04-08 09:03:03 +02:00
'amount' => 'amount',
'category' => 'category_id',
'client' => 'client_id',
'custom_value1' => 'custom_value1',
'custom_value2' => 'custom_value2',
'custom_value3' => 'custom_value3',
'custom_value4' => 'custom_value4',
'currency' => 'currency_id',
'date' => 'date',
'exchange_rate' => 'exchange_rate',
'converted_amount' => 'foreign_amount',
'invoice_currency_id' => 'invoice_currency_id',
'payment_date' => 'payment_date',
'number' => 'number',
'payment_type_id' => 'payment_type_id',
'private_notes' => 'private_notes',
'project' => 'project_id',
'public_notes' => 'public_notes',
'tax_amount1' => 'tax_amount1',
'tax_amount2' => 'tax_amount2',
'tax_amount3' => 'tax_amount3',
'tax_name1' => 'tax_name1',
'tax_name2' => 'tax_name2',
'tax_name3' => 'tax_name3',
'tax_rate1' => 'tax_rate1',
'tax_rate2' => 'tax_rate2',
'tax_rate3' => 'tax_rate3',
'transaction_reference' => 'transaction_reference',
'vendor' => 'vendor_id',
'invoice' => 'invoice_id',
];
private array $decorate_keys = [
'client',
'currency',
'invoice',
'category',
'vendor',
'project',
'payment_type_id',
];
2022-04-27 07:41:52 +02:00
public function __construct(Company $company, array $input)
2022-04-08 09:03:03 +02:00
{
$this->company = $company;
2022-04-27 07:41:52 +02:00
$this->input = $input;
2022-04-08 09:03:03 +02:00
$this->expense_transformer = new ExpenseTransformer();
}
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();
2022-05-07 09:10:23 +02:00
if(count($this->input['report_keys']) == 0)
2022-05-10 07:06:27 +02:00
$this->input['report_keys'] = array_values($this->entity_keys);
2022-05-07 09:10:23 +02:00
2022-04-08 09:03:03 +02:00
//insert the header
$this->csv->insertOne($this->buildHeader());
2022-04-27 07:41:52 +02:00
$query = Expense::query()
->with('client')
2022-04-27 08:29:38 +02:00
->withTrashed()
2022-04-27 07:41:52 +02:00
->where('company_id', $this->company->id)
->where('is_deleted',0);
$query = $this->addDateRange($query);
$query->cursor()
->each(function ($expense){
2022-04-08 09:03:03 +02:00
2022-04-27 07:41:52 +02:00
$this->csv->insertOne($this->buildRow($expense));
2022-04-08 09:03:03 +02:00
2022-04-27 07:41:52 +02:00
});
2022-04-08 09:03:03 +02:00
return $this->csv->toString();
}
private function buildRow(Expense $expense) :array
{
$transformed_expense = $this->expense_transformer->transform($expense);
$entity = [];
2022-04-27 07:41:52 +02:00
foreach(array_values($this->input['report_keys']) as $key){
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
$keyval = array_search($key, $this->entity_keys);
if(array_key_exists($key, $transformed_expense))
$entity[$keyval] = $transformed_expense[$key];
else
$entity[$keyval] = '';
2022-04-08 09:03:03 +02:00
}
return $this->decorateAdvancedFields($expense, $entity);
}
private function decorateAdvancedFields(Expense $expense, array $entity) :array
{
2022-05-10 07:06:27 +02:00
if(in_array('currency_id', $this->input['report_keys']))
$entity['currency'] = $expense->currency ? $expense->currency->code : "";
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
if(in_array('client_id', $this->input['report_keys']))
$entity['client'] = $expense->client ? $expense->client->present()->name() : "";
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
if(in_array('invoice_id', $this->input['report_keys']))
$entity['invoice'] = $expense->invoice ? $expense->invoice->number : "";
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
if(in_array('category_id', $this->input['report_keys']))
$entity['category'] = $expense->category ? $expense->category->name : "";
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
if(in_array('vendor_id', $this->input['report_keys']))
$entity['vendor'] = $expense->vendor ? $expense->vendor->name : "";
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
if(in_array('payment_type_id', $this->input['report_keys']))
$entity['payment_type'] = $expense->payment_type ? $expense->payment_type->name : "";
2022-04-08 09:03:03 +02:00
2022-05-10 07:06:27 +02:00
if(in_array('project_id', $this->input['report_keys']))
$entity['project'] = $expense->project ? $expense->project->name : "";
2022-04-08 09:03:03 +02:00
return $entity;
}
}