mirror of
				https://github.com/invoiceninja/invoiceninja.git
				synced 2025-10-31 13:27:33 -04:00 
			
		
		
		
	Shift automatically applies the Laravel coding style - which uses the PSR-2 coding style as a base with some minor additions. You may customize the code style applied by adding a [PHP CS Fixer][1] or [PHP CodeSniffer][2] ruleset to your project root. Feel free to use [Shift's Laravel ruleset][3] to help you get started. For more information on customizing the code style applied by Shift, [watch this short video][4]. [1]: https://github.com/FriendsOfPHP/PHP-CS-Fixer [2]: https://github.com/squizlabs/PHP_CodeSniffer [3]: https://gist.github.com/laravel-shift/cab527923ed2a109dda047b97d53c200 [4]: https://laravelshift.com/videos/shift-code-style
		
			
				
	
	
		
			168 lines
		
	
	
		
			5.8 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			168 lines
		
	
	
		
			5.8 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php
 | |
| /**
 | |
|  * Invoice Ninja (https://invoiceninja.com).
 | |
|  *
 | |
|  * @link https://github.com/invoiceninja/invoiceninja source repository
 | |
|  *
 | |
|  * @copyright Copyright (c) 2022. Invoice Ninja LLC (https://invoiceninja.com)
 | |
|  *
 | |
|  * @license https://www.elastic.co/licensing/elastic-license
 | |
|  */
 | |
| 
 | |
| namespace App\Export\CSV;
 | |
| 
 | |
| use App\Libraries\MultiDB;
 | |
| use App\Models\Client;
 | |
| use App\Models\ClientContact;
 | |
| use App\Models\Company;
 | |
| use App\Transformers\ClientContactTransformer;
 | |
| use App\Transformers\ClientTransformer;
 | |
| use App\Utils\Ninja;
 | |
| use Illuminate\Support\Facades\App;
 | |
| use League\Csv\Writer;
 | |
| 
 | |
| class ContactExport extends BaseExport
 | |
| {
 | |
|     private Company $company;
 | |
| 
 | |
|     protected array $input;
 | |
| 
 | |
|     private ClientTransformer $client_transformer;
 | |
| 
 | |
|     private ClientContactTransformer $contact_transformer;
 | |
| 
 | |
|     protected string $date_key = 'created_at';
 | |
| 
 | |
|     protected array $entity_keys = [
 | |
|         'address1' => 'client.address1',
 | |
|         'address2' => 'client.address2',
 | |
|         'balance' => 'client.balance',
 | |
|         'city' => 'client.city',
 | |
|         'country' => 'client.country_id',
 | |
|         'credit_balance' => 'client.credit_balance',
 | |
|         'custom_value1' => 'client.custom_value1',
 | |
|         'custom_value2' => 'client.custom_value2',
 | |
|         'custom_value3' => 'client.custom_value3',
 | |
|         'custom_value4' => 'client.custom_value4',
 | |
|         'id_number' => 'client.id_number',
 | |
|         'industry' => 'client.industry_id',
 | |
|         'last_login' => 'client.last_login',
 | |
|         'name' => 'client.name',
 | |
|         'number' => 'client.number',
 | |
|         'paid_to_date' => 'client.paid_to_date',
 | |
|         'client_phone' => 'client.phone',
 | |
|         'postal_code' => 'client.postal_code',
 | |
|         'private_notes' => 'client.private_notes',
 | |
|         'public_notes' => 'client.public_notes',
 | |
|         'shipping_address1' => 'client.shipping_address1',
 | |
|         'shipping_address2' => 'client.shipping_address2',
 | |
|         'shipping_city' => 'client.shipping_city',
 | |
|         'shipping_country' => 'client.shipping_country_id',
 | |
|         'shipping_postal_code' => 'client.shipping_postal_code',
 | |
|         'shipping_state' => 'client.shipping_state',
 | |
|         'state' => 'client.state',
 | |
|         'vat_number' => 'client.vat_number',
 | |
|         'website' => 'client.website',
 | |
|         'currency' => 'client.currency',
 | |
|         'first_name' => 'contact.first_name',
 | |
|         'last_name' => 'contact.last_name',
 | |
|         'contact_phone' => 'contact.phone',
 | |
|         'contact_custom_value1' => 'contact.custom_value1',
 | |
|         'contact_custom_value2' => 'contact.custom_value2',
 | |
|         'contact_custom_value3' => 'contact.custom_value3',
 | |
|         'contact_custom_value4' => 'contact.custom_value4',
 | |
|         'email' => 'contact.email',
 | |
|     ];
 | |
| 
 | |
|     private array $decorate_keys = [
 | |
|         'client.country_id',
 | |
|         'client.shipping_country_id',
 | |
|         'client.currency',
 | |
|         'client.industry',
 | |
|     ];
 | |
| 
 | |
|     public function __construct(Company $company, array $input)
 | |
|     {
 | |
|         $this->company = $company;
 | |
|         $this->input = $input;
 | |
|         $this->client_transformer = new ClientTransformer();
 | |
|         $this->contact_transformer = new ClientContactTransformer();
 | |
|     }
 | |
| 
 | |
|     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();
 | |
| 
 | |
|         if (count($this->input['report_keys']) == 0) {
 | |
|             $this->input['report_keys'] = array_values($this->entity_keys);
 | |
|         }
 | |
| 
 | |
|         //insert the header
 | |
|         $this->csv->insertOne($this->buildHeader());
 | |
| 
 | |
|         $query = ClientContact::query()
 | |
|                         ->where('company_id', $this->company->id);
 | |
| 
 | |
|         $query = $this->addDateRange($query);
 | |
| 
 | |
|         $query->cursor()->each(function ($contact) {
 | |
|             $this->csv->insertOne($this->buildRow($contact));
 | |
|         });
 | |
| 
 | |
|         return $this->csv->toString();
 | |
|     }
 | |
| 
 | |
|     private function buildRow(ClientContact $contact) :array
 | |
|     {
 | |
|         $transformed_contact = false;
 | |
| 
 | |
|         $transformed_client = $this->client_transformer->transform($contact->client);
 | |
|         $transformed_contact = $this->contact_transformer->transform($contact);
 | |
| 
 | |
|         $entity = [];
 | |
| 
 | |
|         foreach (array_values($this->input['report_keys']) as $key) {
 | |
|             $parts = explode('.', $key);
 | |
|             $keyval = array_search($key, $this->entity_keys);
 | |
| 
 | |
|             if ($parts[0] == 'client' && array_key_exists($parts[1], $transformed_client)) {
 | |
|                 $entity[$keyval] = $transformed_client[$parts[1]];
 | |
|             } elseif ($parts[0] == 'contact' && array_key_exists($parts[1], $transformed_contact)) {
 | |
|                 $entity[$keyval] = $transformed_contact[$parts[1]];
 | |
|             } else {
 | |
|                 $entity[$keyval] = '';
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         return $this->decorateAdvancedFields($contact->client, $entity);
 | |
|     }
 | |
| 
 | |
|     private function decorateAdvancedFields(Client $client, array $entity) :array
 | |
|     {
 | |
|         if (in_array('client.country_id', $this->input['report_keys'])) {
 | |
|             $entity['country'] = $client->country ? ctrans("texts.country_{$client->country->name}") : '';
 | |
|         }
 | |
| 
 | |
|         if (in_array('client.shipping_country_id', $this->input['report_keys'])) {
 | |
|             $entity['shipping_country'] = $client->shipping_country ? ctrans("texts.country_{$client->shipping_country->name}") : '';
 | |
|         }
 | |
| 
 | |
|         if (in_array('client.currency', $this->input['report_keys'])) {
 | |
|             $entity['currency'] = $client->currency() ? $client->currency()->code : $client->company->currency()->code;
 | |
|         }
 | |
| 
 | |
|         if (in_array('client.industry_id', $this->input['report_keys'])) {
 | |
|             $entity['industry_id'] = $client->industry ? ctrans("texts.industry_{$client->industry->name}") : '';
 | |
|         }
 | |
| 
 | |
|         return $entity;
 | |
|     }
 | |
| }
 |