byrokrat\banking\BaseAccount

Complexity

Total Complexity

20

Size/Duplication

Total Lines	171
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	getBankName()	0	4	1
A	getRawNumber()	0	4	1
A	getNumber()	0	10	2
A	__toString()	0	4	1
A	getClearingNumber()	0	4	1
A	getClearingCheckDigit()	0	4	1
A	getSerialNumber()	0	4	1
A	getCheckDigit()	0	4	1
A	get16()	0	6	1
B	equals()	0	13	9

<?php

namespace byrokrat\banking;

/**
 * Standard account number implementation
 */
class BaseAccount implements AccountNumber
{
    /**
     * @var string The name of the Bank this number belongs to
     */
    private $bankName;

    /**
     * @var string The raw parsed number
     */
    private $raw;

    /**
     * @var string Account clearing number
     */
    private $clearing;

    /**
     * @var string Check digit of the clearing number
     */
    private $clearingCheckDigit;

    /**
     * @var string Account serial number
     */
    private $serial;

    /**
     * @var string Check digit
     */
    private $checkDigit;

    /**
     * Load account number data
     *
     * @param string $bankName
     * @param string $raw
     * @param string $clearing
     * @param string $clearingCheckDigit
     * @param string $serial
     * @param string $checkDigit
     */
    public function __construct($bankName, $raw, $clearing, $clearingCheckDigit, $serial, $checkDigit)
    {
        $this->bankName = $bankName;
        $this->raw = $raw;
        $this->clearing = $clearing;
        $this->clearingCheckDigit = $clearingCheckDigit;
        $this->serial = $serial;
        $this->checkDigit = $checkDigit;
    }

    /**
     * Get name of the Bank this number belongs to
     *
     * @return string
     */
    public function getBankName()
    {
        return $this->bankName;
    }

    /**
     * Get the raw number
     *
     * @return string
     */
    public function getRawNumber()
    {
        return $this->raw;
    }

    /**
     * Get account as string
     *
     * @return string
     */
    public function getNumber()
    {
        return sprintf(
            '%s%s,%s-%s',
            $this->getClearingNumber(),
            $this->getClearingCheckDigit() !== '' ? '-' . $this->getClearingCheckDigit() : '',
            trim(chunk_split($this->getSerialNumber(), 3, ' ')),
            $this->getCheckDigit()
        );
    }

    /**
     * Get account as string
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getNumber();
    }

    /**
     * Get clearing number, 4 digits
     *
     * @return string
     */
    public function getClearingNumber()
    {
        return $this->clearing;
    }

    /**
     * Get the check digit of the clearing number
     *
     * @return string Empty if not applicable
     */
    public function getClearingCheckDigit()
    {
        return $this->clearingCheckDigit;
    }

    /**
     * Get account serial number
     *
     * @return string
     */
    public function getSerialNumber()
    {
        return $this->serial;
    }

    /**
     * Get account check digit
     *
     * @return string
     */
    public function getCheckDigit()
    {
        return $this->checkDigit;
    }

    /**
     * Get account as a 16 digit number
     *
     * Clearing number (4 digits) + x number of ceros + serial number
     *
     * @return string
     */
    public function get16()
    {
        return $this->getClearingNumber()
            . str_pad($this->getSerialNumber(), 11, '0', STR_PAD_LEFT)
            . $this->getCheckDigit();
    }

    /**
     * Check if account is considered equal to this account
     *
     * {@inheritdoc}
     */
    public function equals(AccountNumber $account, $strict = false)
    {
        return $this->getBankName() == $account->getBankName()
            && $this->getClearingNumber() == $account->getClearingNumber()
            && $this->getSerialNumber() == $account->getSerialNumber()
            && $this->getCheckDigit() == $account->getCheckDigit()
            && !(($this->getClearingCheckDigit() xor $account->getClearingCheckDigit()) && $strict)
            && (
                !$this->getClearingCheckDigit()
                || !$account->getClearingCheckDigit()
                || $this->getClearingCheckDigit() == $account->getClearingCheckDigit()
            );
    }
}