FireflyIII\Support\Form\AccountForm

Complexity

Total Complexity

33

Size/Duplication

Total Lines	291
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	activeDepositDestinations()	0	35	7
A	assetAccountCheckList()	0	33	4
B	activeWithdrawalDestinations()	0	38	7
A	longAccountList()	0	26	4
A	assetAccountList()	0	24	3
A	activeAssetAccountList()	0	21	3
A	activeLongAccountList()	0	32	5

<?php
/**
 * AccountForm.php
 * Copyright (c) 2019 thegrumpydictator@gmail.com
 *
 * This file is part of Firefly III.
 *
 * Firefly III is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Firefly III 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
 */

namespace FireflyIII\Support\Form;


use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use Log;
use Throwable;

/**
 * Class AccountForm
 *
 * All form methods that are account related.
 *
 * TODO describe all methods.
 * TODO optimize repositories and methods.
 */
class AccountForm
{
    use FormSupport;

    /**
     * Shows a <select> with all active asset accounts.
     *
     * @param string $name
     * @param mixed  $value
     * @param array  $options
     *
     * @return string
     */
    public function activeAssetAccountList(string $name, $value = null, array $options = null): string
    {
        $repository      = $this->getAccountRepository();
        $accountList     = $repository->getActiveAccountsByType([AccountType::ASSET, AccountType::DEFAULT]);
        $defaultCurrency = app('amount')->getDefaultCurrency();
        $grouped         = [];
        $date            = $this->getDate();

        /** @var Account $account */
        foreach ($accountList as $account) {
            $balance                     = app('steam')->balance($account, $date);
            $role                        = $repository->getMetaValue($account, 'account_role');
            $currency                    = $repository->getAccountCurrency($account) ?? $defaultCurrency;
            $role                        = '' === $role ? 'no_account_type' : $role;
            $key                         = (string)trans(sprintf('firefly.opt_group_%s', $role));
            $formatted                   = app('amount')->formatAnything($currency, $balance, false);
            $name                        = sprintf('%s (%s)', $account->name, $formatted);
            $grouped[$key][$account->id] = $name;
        }

        return $this->select($name, $grouped, $value, $options);
    }


    /**
     * Return a list that includes liabilities.
     *
     * @param string $name
     * @param mixed  $value
     * @param array  $options
     *
     * @return string
     */
    public function activeLongAccountList(string $name, $value = null, array $options = null): string
    {
        $types           = [AccountType::ASSET, AccountType::DEFAULT, AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN,];
        $liabilityTypes  = [AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN];
        $repository      = $this->getAccountRepository();
        $accountList     = $repository->getActiveAccountsByType($types);
        $defaultCurrency = app('amount')->getDefaultCurrency();
        $grouped         = [];
        $date            = $this->getDate();

        /** @var Account $account */
        foreach ($accountList as $account) {
            $balance  = app('steam')->balance($account, $date);
            $currency = $repository->getAccountCurrency($account) ?? $defaultCurrency;
            $role     = $repository->getMetaValue($account, 'account_role');

            if ('' === $role && !in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = 'no_account_type';
            }

            if (in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = sprintf('l_%s', $account->accountType->type);
            }

            $key                         = (string)trans(sprintf('firefly.opt_group_%s', $role));
            $formatted                   = app('amount')->formatAnything($currency, $balance, false);
            $name                        = sprintf('%s (%s)', $account->name, $formatted);
            $grouped[$key][$account->id] = $name;
        }


        return $this->select($name, $grouped, $value, $options);
    }

    /**
     * Grouped dropdown list of all accounts that are valid as the destination of a withdrawal.
     *
     * @param string $name
     * @param mixed $value
     * @param array $options
     *
     * @return string
     */
    public function activeWithdrawalDestinations(string $name, $value = null, array $options = null): string
    {
        $types           = [AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN, AccountType::EXPENSE,];
        $liabilityTypes  = [AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN];
        $repository      = $this->getAccountRepository();
        $accountList     = $repository->getActiveAccountsByType($types);
        $defaultCurrency = app('amount')->getDefaultCurrency();
        $grouped         = [];
        $date            = $this->getDate();

        $cash                     = $repository->getCashAccount();
        $key                      = (string)trans('firefly.cash_account_type');
        $grouped[$key][$cash->id] = sprintf('(%s)', (string)trans('firefly.cash'));

        // group accounts:
        /** @var Account $account */
        foreach ($accountList as $account) {
            $balance  = app('steam')->balance($account, $date);
            $currency = $repository->getAccountCurrency($account) ?? $defaultCurrency;
            $role     = (string)$repository->getMetaValue($account, 'account_role');
            if ('' === $role && !in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = 'no_account_type';
            }

            if ('no_account_type' === $role && AccountType::EXPENSE === $account->accountType->type) {
                $role = 'expense_account';
            }

            if (in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = sprintf('l_%s', $account->accountType->type);
            }
            $key                         = (string)trans('firefly.opt_group_' . $role);
            $formatted                   = app('amount')->formatAnything($currency, $balance, false);
            $name                        = sprintf('%s (%s)', $account->name, $formatted);
            $grouped[$key][$account->id] = $name;
        }

        return $this->select($name, $grouped, $value, $options);
    }

    /**
     * Grouped dropdown list of all accounts that are valid as the destination of a withdrawal.
     *
     * @param string $name
     * @param mixed  $value
     * @param array  $options
     *
     * @return string
     */
    public function activeDepositDestinations(string $name, $value = null, array $options = null): string
    {
        $types                    = [AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN, AccountType::REVENUE,];
        $liabilityTypes           = [AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN];
        $repository               = $this->getAccountRepository();
        $accountList              = $repository->getActiveAccountsByType($types);
        $defaultCurrency          = app('amount')->getDefaultCurrency();
        $grouped                  = [];
        $date                     = $this->getDate();
        $cash                     = $repository->getCashAccount();
        $key                      = (string)trans('firefly.cash_account_type');
        $grouped[$key][$cash->id] = sprintf('(%s)', (string)trans('firefly.cash'));

        // group accounts:
        /** @var Account $account */
        foreach ($accountList as $account) {
            $balance  = app('steam')->balance($account, $date);
            $currency = $repository->getAccountCurrency($account) ?? $defaultCurrency;
            $role     = (string)$repository->getMetaValue($account, 'account_role');
            if ('' === $role && !in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = 'no_account_type';
            }
            if ('no_account_type' === $role && AccountType::REVENUE === $account->accountType->type) {
                $role = 'revenue_account';
            }
            if (in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = sprintf('l_%s', $account->accountType->type); // @codeCoverageIgnore
            }
            $key                         = (string)trans(sprintf('firefly.opt_group_%s', $role));
            $formatted                   = app('amount')->formatAnything($currency, $balance, false);
            $name                        = sprintf('%s (%s)', $account->name, $formatted);
            $grouped[$key][$account->id] = $name;
        }

        return $this->select($name, $grouped, $value, $options);
    }


    /**
     * Check list of asset accounts.
     *
     * @param string $name
     * @param array $options
     *
     * @return string
     *
     */
    public function assetAccountCheckList(string $name, array $options = null): string
    {
        $options  = $options ?? [];
        $label    = $this->label($name, $options);
        $options  = $this->expandOptionArray($name, $label, $options);
        $classes  = $this->getHolderClasses($name);
        $selected = request()->old($name) ?? [];

        // get all asset accounts:
        $repository    = $this->getAccountRepository();
        $types         = [AccountType::ASSET, AccountType::DEFAULT];
        $assetAccounts = $repository->getAccountsByType($types);
        $grouped       = [];
        // group accounts:
        /** @var Account $account */
        foreach ($assetAccounts as $account) {
            $role = $repository->getMetaValue($account, 'account_role');
            if (null === $role) {
                $role = 'no_account_type';
            }
            $key                         = (string)trans(sprintf('firefly.opt_group_%s', $role));
            $grouped[$key][$account->id] = $account->name;
        }

        unset($options['class']);
        try {
            $html = view('form.assetAccountCheckList', compact('classes', 'selected', 'name', 'label', 'options', 'grouped'))->render();
        } catch (Throwable $e) {
            Log::debug(sprintf('Could not render assetAccountCheckList(): %s', $e->getMessage()));
            $html = 'Could not render assetAccountCheckList.';
        }

        return $html;
    }

    /**
     * Basic list of asset accounts.
     *
     * @param string $name
     * @param mixed $value
     * @param array $options
     *
     * @return string
     */
    public function assetAccountList(string $name, $value = null, array $options = null): string
    {
        $repository      = $this->getAccountRepository();
        $types           = [AccountType::ASSET, AccountType::DEFAULT];
        $accountList     = $repository->getAccountsByType($types);
        $defaultCurrency = app('amount')->getDefaultCurrency();
        $grouped         = [];
        $date            = $this->getDate();

        /** @var Account $account */
        foreach ($accountList as $account) {
            $balance  = app('steam')->balance($account, $date);
            $currency = $repository->getAccountCurrency($account) ?? $defaultCurrency;
            $role     = (string)$repository->getMetaValue($account, 'account_role');
            if ('' === $role) {
                $role = 'no_account_type';
            }

            $key                         = (string)trans(sprintf('firefly.opt_group_%s', $role));
            $formatted                   = app('amount')->formatAnything($currency, $balance, false);
            $grouped[$key][$account->id] = sprintf('%s (%s)', $account->name, $formatted);
        }

        return $this->select($name, $grouped, $value, $options);
    }


    /**
     * Same list but all liabilities as well.
     *
     * @param string $name
     * @param mixed $value
     * @param array $options
     *
     * @return string
     */
    public function longAccountList(string $name, $value = null, array $options = null): string
    {
        $types           = [AccountType::ASSET, AccountType::DEFAULT, AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN,];
        $liabilityTypes  = [AccountType::MORTGAGE, AccountType::DEBT, AccountType::CREDITCARD, AccountType::LOAN];
        $repository      = $this->getAccountRepository();
        $accountList     = $repository->getAccountsByType($types);
        $defaultCurrency = app('amount')->getDefaultCurrency();
        $grouped         = [];
        $date            = $this->getDate();
        /** @var Account $account */
        foreach ($accountList as $account) {
            $balance  = app('steam')->balance($account, $date);
            $currency = $repository->getAccountCurrency($account) ?? $defaultCurrency;
            $role     = (string)$repository->getMetaValue($account, 'account_role');
            if ('' === $role) {
                $role = 'no_account_type';
            }
            if (in_array($account->accountType->type, $liabilityTypes, true)) {
                $role = sprintf('l_%s', $account->accountType->type);
            }
            $key                         = (string)trans(sprintf('firefly.opt_group_%s', $role));
            $formatted                   = app('amount')->formatAnything($currency, $balance, false);
            $grouped[$key][$account->id] = sprintf('%s (%s)', $account->name, $formatted);
        }

        return $this->select($name, $grouped, $value, $options);
    }
}