mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
83f3eddf44
- Dropped some "setParameters" calls if unused in transformer. - Add correct copyright - Sprintf instead of string concat - Small ident changes courtesy of phpstorm.
232 lines
10 KiB
PHP
232 lines
10 KiB
PHP
<?php
|
|
|
|
/**
|
|
* AccountTransformer.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Transformers;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\Support\Facades\Amount;
|
|
|
|
/**
|
|
* Class AccountTransformer
|
|
*/
|
|
class AccountTransformer extends AbstractTransformer
|
|
{
|
|
protected bool $convertToPrimary;
|
|
protected TransactionCurrency $primary;
|
|
protected AccountRepositoryInterface $repository;
|
|
|
|
/**
|
|
* AccountTransformer constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->repository = app(AccountRepositoryInterface::class);
|
|
$this->convertToPrimary = Amount::convertToPrimary();
|
|
$this->primary = Amount::getPrimaryCurrency();
|
|
}
|
|
|
|
/**
|
|
* Transform the account.
|
|
*
|
|
* @throws FireflyException
|
|
*/
|
|
public function transform(Account $account): array
|
|
{
|
|
if (null === $account->meta) {
|
|
$account->meta = [
|
|
'currency' => null,
|
|
];
|
|
}
|
|
|
|
// get account type:
|
|
$accountType = (string)config(sprintf('firefly.shortNamesByFullName.%s', $account->full_account_type));
|
|
$liabilityType = (string)config(sprintf('firefly.shortLiabilityNameByFullName.%s', $account->full_account_type));
|
|
$liabilityType = '' === $liabilityType ? null : strtolower($liabilityType);
|
|
$liabilityDirection = $account->meta['liability_direction'] ?? null;
|
|
$accountRole = $this->getAccountRole($account, $accountType);
|
|
$hasCurrencySettings = null !== $account->meta['currency'];
|
|
$includeNetWorth = 1 === (int)($account->meta['include_net_worth'] ?? 0);
|
|
$longitude = $account->meta['location']['longitude'] ?? null;
|
|
$latitude = $account->meta['location']['latitude'] ?? null;
|
|
$zoomLevel = $account->meta['location']['zoom_level'] ?? null;
|
|
$order = $account->order;
|
|
|
|
// get primary currency as fallback:
|
|
$currency = $this->primary; // assume primary currency
|
|
if ($hasCurrencySettings) {
|
|
$currency = $account->meta['currency'];
|
|
}
|
|
|
|
// no order for some accounts:
|
|
if (!in_array(strtolower($accountType), ['liability', 'liabilities', 'asset'], true)) {
|
|
$order = null;
|
|
}
|
|
|
|
// get some listed information from the account meta-data:
|
|
[$creditCardType, $monthlyPaymentDate] = $this->getCCInfo($account, $accountRole, $accountType);
|
|
$openingBalanceDate = $this->getOpeningBalance($account, $accountType);
|
|
[$interest, $interestPeriod] = $this->getInterest($account, $accountType);
|
|
|
|
return [
|
|
'id' => (string)$account->id,
|
|
'created_at' => $account->created_at->toAtomString(),
|
|
'updated_at' => $account->updated_at->toAtomString(),
|
|
'active' => $account->active,
|
|
'order' => $order,
|
|
'name' => $account->name,
|
|
'type' => strtolower($accountType),
|
|
'account_role' => $accountRole,
|
|
|
|
'object_group_id' => $account->meta['object_group_id'],
|
|
'object_group_order' => $account->meta['object_group_order'],
|
|
'object_group_title' => $account->meta['object_group_title'],
|
|
|
|
// currency information, structured for 6.3.0.
|
|
'object_has_currency_setting' => $hasCurrencySettings,
|
|
|
|
// currency is object specific or primary, already determined above.
|
|
'currency_id' => (string)$currency['id'],
|
|
'currency_name' => $currency['name'],
|
|
'currency_code' => $currency['code'],
|
|
'currency_symbol' => $currency['symbol'],
|
|
'currency_decimal_places' => $currency['decimal_places'],
|
|
|
|
'primary_currency_id' => (string)$this->primary->id,
|
|
'primary_currency_name' => $this->primary->name,
|
|
'primary_currency_code' => $this->primary->code,
|
|
'primary_currency_symbol' => $this->primary->symbol,
|
|
'primary_currency_decimal_places' => $this->primary->decimal_places,
|
|
|
|
// balances, structured for 6.3.0.
|
|
'current_balance' => $account->meta['balances']['current_balance'],
|
|
'pc_current_balance' => $account->meta['balances']['pc_current_balance'],
|
|
|
|
'opening_balance' => $account->meta['balances']['opening_balance'],
|
|
'pc_opening_balance' => $account->meta['balances']['pc_opening_balance'],
|
|
|
|
'virtual_balance' => $account->meta['balances']['virtual_balance'],
|
|
'pc_virtual_balance' => $account->meta['balances']['pc_virtual_balance'],
|
|
|
|
'debt_amount' => $account->meta['balances']['debt_amount'],
|
|
'pc_debt_amount' => $account->meta['balances']['pc_debt_amount'],
|
|
|
|
'balance_difference' => $account->meta['balances']['balance_difference'],
|
|
'pc_balance_difference' => $account->meta['balances']['pc_balance_difference'],
|
|
|
|
'current_balance_date' => $account->meta['current_balance_date']->toAtomString(),
|
|
'notes' => $account->meta['notes'] ?? null,
|
|
'monthly_payment_date' => $monthlyPaymentDate,
|
|
'credit_card_type' => $creditCardType,
|
|
'account_number' => $account->meta['account_number'],
|
|
'iban' => '' === $account->iban ? null : $account->iban,
|
|
'bic' => $account->meta['BIC'] ?? null,
|
|
'opening_balance_date' => $openingBalanceDate,
|
|
'liability_type' => $liabilityType,
|
|
'liability_direction' => $liabilityDirection,
|
|
'interest' => $interest,
|
|
'interest_period' => $interestPeriod,
|
|
'include_net_worth' => $includeNetWorth,
|
|
'longitude' => $longitude,
|
|
'latitude' => $latitude,
|
|
'zoom_level' => $zoomLevel,
|
|
'last_activity' => $account->meta['last_activity']?->toAtomString(),
|
|
'links' => [
|
|
[
|
|
'rel' => 'self',
|
|
'uri' => sprintf('/accounts/%d', $account->id),
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
private function getAccountRole(Account $account, string $accountType): ?string
|
|
{
|
|
$accountRole = $account->meta['account_role'] ?? null;
|
|
if ('asset' !== $accountType || '' === (string)$accountRole) {
|
|
return null;
|
|
}
|
|
|
|
return $accountRole;
|
|
}
|
|
|
|
private function getCCInfo(Account $account, ?string $accountRole, string $accountType): array
|
|
{
|
|
$monthlyPaymentDate = null;
|
|
$creditCardType = null;
|
|
if ('ccAsset' === $accountRole && 'asset' === $accountType) {
|
|
$creditCardType = $account->meta['cc_type'] ?? null;
|
|
$monthlyPaymentDate = $account->meta['cc_monthly_payment_date'] ?? null;
|
|
}
|
|
if (null !== $monthlyPaymentDate) {
|
|
// try classic date:
|
|
if (10 === strlen($monthlyPaymentDate)) {
|
|
$object = Carbon::createFromFormat('!Y-m-d', $monthlyPaymentDate, config('app.timezone'));
|
|
if (!$object instanceof Carbon) {
|
|
$object = today(config('app.timezone'));
|
|
}
|
|
$monthlyPaymentDate = $object->toAtomString();
|
|
}
|
|
if (10 !== strlen((string)$monthlyPaymentDate)) {
|
|
$monthlyPaymentDate = Carbon::parse($monthlyPaymentDate, config('app.timezone'))->toAtomString();
|
|
}
|
|
}
|
|
|
|
return [$creditCardType, $monthlyPaymentDate];
|
|
}
|
|
|
|
private function getOpeningBalance(Account $account, string $accountType): ?string
|
|
{
|
|
$openingBalanceDate = null;
|
|
if (in_array($accountType, ['asset', 'liabilities'], true)) {
|
|
$openingBalanceDate = $account->meta['opening_balance_date'] ?? null;
|
|
}
|
|
if (null !== $openingBalanceDate) {
|
|
$object = Carbon::createFromFormat('Y-m-d H:i:s', $openingBalanceDate, config('app.timezone'));
|
|
if (!$object instanceof Carbon) {
|
|
$object = today(config('app.timezone'));
|
|
}
|
|
$openingBalanceDate = $object->toAtomString();
|
|
|
|
}
|
|
|
|
return $openingBalanceDate;
|
|
}
|
|
|
|
private function getInterest(Account $account, string $accountType): array
|
|
{
|
|
$interest = null;
|
|
$interestPeriod = null;
|
|
if ('liabilities' === $accountType) {
|
|
$interest = $account->meta['interest'] ?? null;
|
|
$interestPeriod = $account->meta['interest_period'] ?? null;
|
|
}
|
|
|
|
return [$interest, $interestPeriod];
|
|
}
|
|
}
|