AccountRepository::clearCache() - Code Metrics - Inspection of "Update accounts' balance in check-accounting cronj..." - Ecodev/my-ichtus - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 667027...052b73 )

by Sylvain

created 2019-05-17 15:02 UTC

AccountRepository::clearCache() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Application\Repository;

use Application\DBAL\Types\AccountTypeType;
use Application\Model\Account;
use Application\Model\User;
use Application\Utility;
use Doctrine\DBAL\Exception\InvalidArgumentException;
use Money\Money;

class AccountRepository extends AbstractRepository implements LimitedAccessSubQueryInterface
{
    private const PARENT_ACCOUNT_ID_FOR_USER = 10011;
    const ACCOUNT_ID_FOR_BANK = 10025;

    /**
     * @var string[]
     */
    private $totalBalanceCache = [];

    /**
     * Clear all caches
     */
    public function clearCache(): void
    {
        $this->totalBalanceCache = [];
    }

    /**
     * Returns pure SQL to get ID of all objects that are accessible to given user.
     *
     * @param null|User $user
     *
     * @return string
     */
    public function getAccessibleSubQuery(?User $user): string
    {
        if (!$user) {
            return '-1';
        }

        if (in_array($user->getRole(), [User::ROLE_RESPONSIBLE, User::ROLE_ADMINISTRATOR], true)) {
            return $this->getAllIdsQuery();
        }

        return $this->getAllIdsForOwnerQuery($user);
    }

    /**
     * Unsecured way to get a account from its ID.
     *
     * This should only be used in tests or controlled environment.
     *
     * @param int $id
     *
     * @throws \Exception
     *
     * @return Account
     */
    public function getOneById(int $id): Account
    {
        $this->getAclFilter()->setEnabled(false);
        $account = $this->findOneById($id);
        $this->getAclFilter()->setEnabled(true);
        if (!$account) {
            throw new \Exception('Account #' . $id . ' not found');
        }

        return $account;

    }

    /**
     * This will return, and potentially create, an account for the given user
     *
     * @param User $user
     *
     * @return Account
     */
    public function getOrCreate(User $user): Account
    {
        // If an account already exists, because getOrCreate was called once before without flushing in between,
        // then can return immediately
        if ($user->getAccount()) {
            return $user->getAccount();
        }

        $this->getAclFilter()->setEnabled(false);
        $account = $this->findOneByOwner($user);
        $account = $this->findOneByOwner($user);
        $this->getAclFilter()->setEnabled(true);

        if (!$account) {
            $account = new Account();
            $this->getEntityManager()->persist($account);
            $account->setOwner($user);
            $account->setType(AccountTypeType::LIABILITY);
            $account->setName($user->getName());

            $maxCode = $this->getEntityManager()->getConnection()->fetchColumn('SELECT MAX(code) FROM account WHERE parent_id = ' . self::PARENT_ACCOUNT_ID_FOR_USER);
            $newCode = ++$maxCode;
            $account->setCode((string) $newCode);

            $parent = $this->getOneById(self::PARENT_ACCOUNT_ID_FOR_USER);
            $account->setParent($parent);
        }

        return $account;
    }

    /**
     * Sum balance by account type
     *
     * @API\Input(type="AccountType")
     *
     * @param string $accountType
     *
     * @return Money
     */
    public function totalBalanceByType(string $accountType): Money
    {
        $qb = $this->getEntityManager()->getConnection()->createQueryBuilder()
            ->select('SUM(balance)')
            ->from($this->getClassMetadata()->getTableName())
            ->where('type = :type');

        $qb->setParameter('type', $accountType);

        $result = $qb->execute();

        return Money::CHF($result->fetchColumn());
        return Money::CHF(/** @scrutinizer ignore-type */ $result->fetchColumn());
    }

    /**
     * Calculate the total balance of all child accounts of a group account
     *
     * @param Account $parentAccount
     *
     * @throws \Doctrine\DBAL\DBALException
     *
     * @return Money
     */
    public function totalBalanceByParent(Account $parentAccount): Money
    {
        if ($parentAccount->getType() !== AccountTypeType::GROUP) {
            throw new InvalidArgumentException(sprintf(
                'Cannot compute total balance for Account #%d of type %s',
                $parentAccount->getId(),
                $parentAccount->getType()
            ));
        }

        $cacheKey = Utility::getCacheKey(func_get_args());
        if (array_key_exists($cacheKey, $this->totalBalanceCache)) {
            return $this->totalBalanceCache[$cacheKey];

        }

        $connection = $this->getEntityManager()->getConnection();

        $sql = 'WITH RECURSIVE child AS
          (SELECT id, parent_id, `type`, balance
           FROM account WHERE id = ?
           UNION
           SELECT account.id, account.parent_id, account.type, account.balance
           FROM account
           JOIN child ON account.parent_id = child.id)
        SELECT SUM(balance) FROM child WHERE `type` <> ?';

        $result = $connection->executeQuery($sql, [$parentAccount->getId(), AccountTypeType::GROUP]);

        return Money::CHF($result->fetchColumn());
        return Money::CHF(/** @scrutinizer ignore-type */ $result->fetchColumn());
    }

    /**
     * Update accounts' balance
     *
     * @param null|Account $account the account to update, or null for all accounts
     *
     * @throws \Doctrine\DBAL\DBALException
     */
    public function updateAccountBalance(?Account $account = null): void
    {
        $connection = $this->getEntityManager()->getConnection();
        $sql = 'CALL update_account_balance(?)';

        if ($account) {
            $connection->executeQuery($sql, [$account->getId()]);
        } else {
            foreach ($this->findAll() as $a) {
                $connection->executeQuery($sql, [$a->getId()]);
            }
        }
    }
}


Ecodev / my-ichtus

Push — master ( 667027...052b73 )

AccountRepository::clearCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like