2020-02-03 11:33:07 +01:00
|
|
|
<?php
|
|
|
|
/**
|
2021-02-18 00:51:56 +01:00
|
|
|
* Invoice Ninja (https://invoiceninja.com).
|
2020-02-03 11:33:07 +01:00
|
|
|
*
|
2021-02-18 00:51:56 +01:00
|
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
2020-02-03 11:33:07 +01:00
|
|
|
*
|
2023-01-28 23:21:40 +01:00
|
|
|
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
|
2020-02-03 11:33:07 +01:00
|
|
|
*
|
2021-06-16 08:58:16 +02:00
|
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
2020-02-03 11:33:07 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
namespace App\Services\Client;
|
|
|
|
|
|
|
|
use App\Models\Client;
|
2022-09-05 09:18:08 +02:00
|
|
|
use App\Models\Credit;
|
2023-03-10 04:01:07 +01:00
|
|
|
use App\Models\Payment;
|
2023-03-07 09:52:37 +01:00
|
|
|
use App\Services\Email\Email;
|
2023-01-17 01:00:12 +01:00
|
|
|
use App\Services\Email\EmailObject;
|
|
|
|
use App\Services\Email\EmailService;
|
2023-03-18 08:24:56 +01:00
|
|
|
use App\Utils\Number;
|
|
|
|
use App\Utils\Traits\MakesDates;
|
2023-01-17 01:00:12 +01:00
|
|
|
use Illuminate\Mail\Mailables\Address;
|
2023-03-18 08:24:56 +01:00
|
|
|
use Illuminate\Support\Facades\DB;
|
2020-02-03 11:33:07 +01:00
|
|
|
|
|
|
|
class ClientService
|
|
|
|
{
|
2023-01-17 01:00:12 +01:00
|
|
|
use MakesDates;
|
2020-02-03 11:33:07 +01:00
|
|
|
|
2023-01-17 01:00:12 +01:00
|
|
|
private string $client_start_date;
|
|
|
|
|
|
|
|
private string $client_end_date;
|
|
|
|
|
2023-02-16 02:36:09 +01:00
|
|
|
public function __construct(private Client $client)
|
|
|
|
{
|
|
|
|
}
|
2020-02-03 11:33:07 +01:00
|
|
|
|
|
|
|
public function updateBalance(float $amount)
|
|
|
|
{
|
2022-11-24 10:33:52 +01:00
|
|
|
try {
|
2023-02-16 02:36:09 +01:00
|
|
|
DB::connection(config('database.default'))->transaction(function () use ($amount) {
|
2022-11-24 10:33:52 +01:00
|
|
|
$this->client = Client::withTrashed()->where('id', $this->client->id)->lockForUpdate()->first();
|
|
|
|
$this->client->balance += $amount;
|
2023-02-01 03:46:39 +01:00
|
|
|
$this->client->saveQuietly();
|
2023-01-18 06:52:32 +01:00
|
|
|
}, 2);
|
2023-02-16 02:36:09 +01:00
|
|
|
} catch (\Throwable $throwable) {
|
2022-11-24 10:33:52 +01:00
|
|
|
nlog("DB ERROR " . $throwable->getMessage());
|
|
|
|
}
|
2022-09-05 03:51:47 +02:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function updateBalanceAndPaidToDate(float $balance, float $paid_to_date)
|
|
|
|
{
|
2022-11-24 10:33:52 +01:00
|
|
|
try {
|
2023-02-16 02:36:09 +01:00
|
|
|
DB::connection(config('database.default'))->transaction(function () use ($balance, $paid_to_date) {
|
2022-11-24 10:33:52 +01:00
|
|
|
$this->client = Client::withTrashed()->where('id', $this->client->id)->lockForUpdate()->first();
|
|
|
|
$this->client->balance += $balance;
|
|
|
|
$this->client->paid_to_date += $paid_to_date;
|
2023-02-01 03:46:39 +01:00
|
|
|
$this->client->saveQuietly();
|
2023-01-18 06:52:32 +01:00
|
|
|
}, 2);
|
2023-02-16 02:36:09 +01:00
|
|
|
} catch (\Throwable $throwable) {
|
2022-11-24 10:33:52 +01:00
|
|
|
nlog("DB ERROR " . $throwable->getMessage());
|
|
|
|
}
|
|
|
|
|
2020-02-03 11:33:07 +01:00
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function updatePaidToDate(float $amount)
|
|
|
|
{
|
2023-02-16 02:36:09 +01:00
|
|
|
DB::connection(config('database.default'))->transaction(function () use ($amount) {
|
2022-09-12 00:33:59 +02:00
|
|
|
$this->client = Client::withTrashed()->where('id', $this->client->id)->lockForUpdate()->first();
|
2022-09-05 03:51:47 +02:00
|
|
|
$this->client->paid_to_date += $amount;
|
2023-02-01 03:46:39 +01:00
|
|
|
$this->client->saveQuietly();
|
2023-01-18 06:52:32 +01:00
|
|
|
}, 2);
|
2020-02-03 11:33:07 +01:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2023-03-10 04:01:07 +01:00
|
|
|
public function updatePaymentBalance()
|
|
|
|
{
|
|
|
|
$amount = Payment::where('client_id', $this->client->id)
|
|
|
|
->where('is_deleted', 0)
|
|
|
|
->whereIn('status_id', [Payment::STATUS_COMPLETED, Payment::STATUS_PENDING, Payment::STATUS_PARTIALLY_REFUNDED, Payment::STATUS_REFUNDED])
|
|
|
|
->sum(DB::Raw('amount - refunded - applied'));
|
|
|
|
|
|
|
|
DB::connection(config('database.default'))->transaction(function () use ($amount) {
|
|
|
|
$this->client = Client::withTrashed()->where('id', $this->client->id)->lockForUpdate()->first();
|
|
|
|
$this->client->payment_balance = $amount;
|
|
|
|
$this->client->saveQuietly();
|
|
|
|
}, 2);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-02-03 11:33:07 +01:00
|
|
|
public function adjustCreditBalance(float $amount)
|
|
|
|
{
|
2022-03-27 08:04:13 +02:00
|
|
|
$this->client->credit_balance += $amount;
|
2020-02-03 11:33:07 +01:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2020-10-13 05:25:51 +02:00
|
|
|
public function getCreditBalance() :float
|
|
|
|
{
|
2022-09-12 00:33:59 +02:00
|
|
|
$credits = Credit::withTrashed()->where('client_id', $this->client->id)
|
2020-10-13 05:25:51 +02:00
|
|
|
->where('is_deleted', false)
|
2022-06-21 11:57:17 +02:00
|
|
|
->where(function ($query) {
|
|
|
|
$query->whereDate('due_date', '<=', now()->format('Y-m-d'))
|
2021-07-03 23:48:16 +02:00
|
|
|
->orWhereNull('due_date');
|
|
|
|
})
|
2022-06-21 11:57:17 +02:00
|
|
|
->orderBy('created_at', 'ASC');
|
2020-10-13 05:25:51 +02:00
|
|
|
|
|
|
|
return Number::roundValue($credits->sum('balance'), $this->client->currency()->precision);
|
|
|
|
}
|
|
|
|
|
2022-06-21 11:57:17 +02:00
|
|
|
public function getCredits()
|
2020-10-13 14:28:30 +02:00
|
|
|
{
|
2022-09-05 09:18:08 +02:00
|
|
|
return Credit::where('client_id', $this->client->id)
|
2020-10-13 14:28:30 +02:00
|
|
|
->where('is_deleted', false)
|
|
|
|
->where('balance', '>', 0)
|
2022-06-21 11:57:17 +02:00
|
|
|
->where(function ($query) {
|
|
|
|
$query->whereDate('due_date', '<=', now()->format('Y-m-d'))
|
2021-07-04 01:02:16 +02:00
|
|
|
->orWhereNull('due_date');
|
|
|
|
})
|
2022-06-21 11:57:17 +02:00
|
|
|
->orderBy('created_at', 'ASC')->get();
|
2020-10-13 14:28:30 +02:00
|
|
|
}
|
|
|
|
|
2021-01-18 03:12:48 +01:00
|
|
|
public function getPaymentMethods(float $amount)
|
|
|
|
{
|
|
|
|
return (new PaymentMethod($this->client, $amount))->run();
|
|
|
|
}
|
2020-10-13 14:28:30 +02:00
|
|
|
|
2021-08-01 07:46:40 +02:00
|
|
|
public function merge(Client $mergable_client)
|
|
|
|
{
|
2021-08-01 09:21:08 +02:00
|
|
|
$this->client = (new Merge($this->client, $mergable_client))->run();
|
|
|
|
|
|
|
|
return $this;
|
2021-08-01 07:46:40 +02:00
|
|
|
}
|
|
|
|
|
2021-09-14 13:55:24 +02:00
|
|
|
/**
|
|
|
|
* Generate the client statement.
|
2022-06-21 11:57:17 +02:00
|
|
|
*
|
|
|
|
* @param array $options
|
2023-01-17 01:00:12 +01:00
|
|
|
* @param bool $send_email determines if we should send this statement direct to the client
|
2021-09-14 13:55:24 +02:00
|
|
|
*/
|
2023-01-17 01:00:12 +01:00
|
|
|
public function statement(array $options = [], bool $send_email = false)
|
2021-09-14 13:55:24 +02:00
|
|
|
{
|
2023-01-17 01:00:12 +01:00
|
|
|
$statement = (new Statement($this->client, $options));
|
|
|
|
|
|
|
|
$pdf = $statement->run();
|
|
|
|
|
2023-02-16 02:36:09 +01:00
|
|
|
if ($send_email) {
|
2023-01-17 01:00:12 +01:00
|
|
|
return $this->emailStatement($pdf, $statement->options);
|
2023-02-16 02:36:09 +01:00
|
|
|
}
|
2023-01-17 01:00:12 +01:00
|
|
|
|
|
|
|
return $pdf;
|
2021-09-14 13:55:24 +02:00
|
|
|
}
|
|
|
|
|
2023-01-17 01:00:12 +01:00
|
|
|
/**
|
|
|
|
* Emails the statement to the client
|
2023-02-16 02:36:09 +01:00
|
|
|
*
|
2023-01-17 01:00:12 +01:00
|
|
|
* @param mixed $pdf The pdf blob
|
|
|
|
* @param array $options The statement options array
|
2023-02-16 02:36:09 +01:00
|
|
|
* @return void
|
2023-01-17 01:00:12 +01:00
|
|
|
*/
|
|
|
|
private function emailStatement($pdf, array $options): void
|
|
|
|
{
|
|
|
|
$this->client_start_date = $this->translateDate($options['start_date'], $this->client->date_format(), $this->client->locale());
|
|
|
|
$this->client_end_date = $this->translateDate($options['end_date'], $this->client->date_format(), $this->client->locale());
|
|
|
|
|
2023-03-07 09:52:37 +01:00
|
|
|
// $email_service = new EmailService($this->buildStatementMailableData($pdf), $this->client->company);
|
|
|
|
// $email_service->send();
|
|
|
|
|
|
|
|
$email_object = $this->buildStatementMailableData($pdf);
|
|
|
|
Email::dispatch($email_object, $this->client->company);
|
2023-01-17 01:00:12 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Builds and returns an EmailObject for Client Statements
|
2023-02-16 02:36:09 +01:00
|
|
|
*
|
2023-01-17 01:00:12 +01:00
|
|
|
* @param mixed $pdf The PDF to send
|
|
|
|
* @return EmailObject The EmailObject to send
|
|
|
|
*/
|
|
|
|
public function buildStatementMailableData($pdf) :EmailObject
|
|
|
|
{
|
|
|
|
$email_object = new EmailObject;
|
|
|
|
$email_object->to = [new Address($this->client->present()->email(), $this->client->present()->name())];
|
|
|
|
$email_object->attachments = [['file' => base64_encode($pdf), 'name' => ctrans('texts.statement') . ".pdf"]];
|
2023-03-06 09:07:25 +01:00
|
|
|
$email_object->client_id = $this->client->id;
|
2023-01-17 01:00:12 +01:00
|
|
|
$email_object->email_template_subject = 'email_subject_statement';
|
|
|
|
$email_object->email_template_body = 'email_template_statement';
|
|
|
|
$email_object->variables = [
|
|
|
|
'$client' => $this->client->present()->name(),
|
|
|
|
'$start_date' => $this->client_start_date,
|
|
|
|
'$end_date' => $this->client_end_date,
|
|
|
|
];
|
|
|
|
|
|
|
|
return $email_object;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Saves the client instance
|
2023-02-16 02:36:09 +01:00
|
|
|
*
|
2023-01-17 01:00:12 +01:00
|
|
|
* @return Client The Client Model
|
|
|
|
*/
|
2020-02-03 11:33:07 +01:00
|
|
|
public function save() :Client
|
|
|
|
{
|
2023-02-01 05:00:45 +01:00
|
|
|
$this->client->saveQuietly();
|
2020-02-03 11:33:07 +01:00
|
|
|
|
2022-03-01 11:25:18 +01:00
|
|
|
return $this->client->fresh();
|
2020-02-03 11:33:07 +01:00
|
|
|
}
|
|
|
|
}
|