GetBalance.php

<?php

namespace Fhp\Action;

use Fhp\Model\SEPAAccount;
use Fhp\PaginateableAction;
use Fhp\Protocol\BPD;
use Fhp\Protocol\Message;
use Fhp\Protocol\UnexpectedResponseException;
use Fhp\Protocol\UPD;
use Fhp\Segment\BaseSegment;
use Fhp\Segment\Common\Kti;
use Fhp\Segment\Common\Kto;
use Fhp\Segment\Common\KtvV3;
use Fhp\Segment\SAL\HISAL;
use Fhp\Segment\SAL\HKSALv4;
use Fhp\Segment\SAL\HKSALv5;
use Fhp\Segment\SAL\HKSALv6;
use Fhp\Segment\SAL\HKSALv7;
use Fhp\UnsupportedException;

/**
 * Runs an HKSAL request the current balance of the given account.
 */
class GetBalance extends PaginateableAction
{
    // Request (if you add a field here, update __serialize() and __unserialize() as well).
    /** @var SEPAAccount */
    private $account;
    /** @var bool */
    private $allAccounts;

    // Response
    /** @var HISAL[] */
    private $response = [];

    /**
     * @param SEPAAccount $account The account to get the balance for. This can be constructed based on information
     *     that the user entered, or it can be {@link SEPAAccount} instance retrieved from {@link GetSEPAAccounts}.
     * @param bool $allAccounts If set to true, will return balances for all accounts of the user. You still need to
     *     pass one of the accounts into $account, though.
     */
    public static function create(SEPAAccount $account, bool $allAccounts = false): GetBalance
    {
        $result = new GetBalance();
        $result->account = $account;
        $result->allAccounts = $allAccounts;
        return $result;
    }

    /**
     * @deprecated Beginning from PHP7.4 __unserialize is used for new generated strings, then this method is only used for previously generated strings - remove after May 2023
     */
    public function serialize(): string
    {
        return serialize($this->__serialize());
    }

    public function __serialize(): array
    {
        return [
            parent::__serialize(),
            $this->account, $this->allAccounts,
        ];
    }

    /**
     * @deprecated Beginning from PHP7.4 __unserialize is used for new generated strings, then this method is only used for previously generated strings - remove after May 2023
     *
     * @param string $serialized
     * @return void
     */
    public function unserialize($serialized)
    {
        self::__unserialize(unserialize($serialized));
    }

    public function __unserialize(array $serialized): void
    {
        list(
            $parentSerialized,
            $this->account, $this->allAccounts,
        ) = $serialized;

        is_array($parentSerialized) ?
            parent::__unserialize($parentSerialized) :
            parent::unserialize($parentSerialized);
    }

    /**
     * @return HISAL[]
     */
    public function getBalances()
    {
        $this->ensureDone();
        return $this->response;
    }

    protected function createRequest(BPD $bpd, ?UPD $upd)
    {
        /** @var BaseSegment $hisals */
        $hisals = $bpd->requireLatestSupportedParameters('HISALS');
        switch ($hisals->getVersion()) {
            case 4:
                return HKSALv4::create(Kto::fromAccount($this->account));
            case 5:
                return HKSALv5::create(KtvV3::fromAccount($this->account), $this->allAccounts);
            case 6:
                return HKSALv6::create(KtvV3::fromAccount($this->account), $this->allAccounts);
            case 7:
                return HKSALv7::create(Kti::fromAccount($this->account), $this->allAccounts);
            default:
                throw new UnsupportedException('Unsupported HKSAL version: ' . $hisals->getVersion());
        }
    }

    public function processResponse(Message $response)
    {
        parent::processResponse($response);

        $responseSegments = $response->findSegments(HISAL::class);
        if (count($responseSegments) === 0) {
            throw new UnexpectedResponseException('No HISAL segments received!');
        }
        $this->response = array_merge($this->response, $responseSegments);
    }
}