dimtrovich / validation

src/Traits/IbanTrait.php

<?php

/**
 * This file is part of Dimtrovich/Validation.
 *
 * (c) 2023 Dimitri Sitchet Tomkeu <devcode.dst@gmail.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Dimtrovich\Validation\Traits;

/**
 * @credit <a href="https://github.com/milwad-dev/laravel-validate">milwad/laravel-validate - Milwad\LaravelValidate\Traits\IbanTrait</a>
 */
trait IbanTrait
{
    /**
     * Set value of $countries property.
     *
     * @return void
     */
    private function setCountries(?array $countries)
    {
        if (empty($countries)) {
            $this->countries = [];

The property countries does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            return;
        }

        if (is_array($countries[0])) {
            $countries = $countries[0];
        }

        foreach ($countries as $country) {
            $this->countries[] = $country;
        }
    }

    /**
     * Check IBAN is valid.
     */
    private function isIbanValid(string $iban): bool
    {
        if (! $this->checkIbanFormat($iban)) {
            return false;
        }

        // Connect Iban title with value (code) ex: 8330001234567NO .
        $parsedIban = substr($iban, 4) . substr($iban, 0, 4);

        // Replace iban value with character map.
        $parsedIban = strtr($parsedIban, $this->characterMap);

        return bcmod($parsedIban, '97') === '1';
    }

    /**
     * Check IBAN format is valid.
     */
    private function checkIbanFormat(string $iban): bool
    {
        if (empty($iban)) {
            return false;
        }

        $ibanCountryCode = $this->getIbanCountryCode($iban);

        return ! (empty($this->checkIfBcmodIsAvailable())
            || ! $this->twoFirstCharactersValid($ibanCountryCode)
            || ! $this->isCountriesValid($ibanCountryCode)
            || ! $this->isIbanLengthValid($iban, $ibanCountryCode));
    }

    /**
     * Get IBAN country code.
     */
    private function getIbanCountryCode(string $iban): string
    {
        return substr($iban, 0, 2);
    }

    /**
     * Check if bcmod function is available.
     */
    private function checkIfBcmodIsAvailable(): bool
    {
        return function_exists('bcmod');
    }

    /**
     * Check two first character's validity.
     */
    private function twoFirstCharactersValid(string $countryCode): bool
    {
        return ! empty($countryCode) && ctype_alpha($countryCode);
    }

    /**
     * Check countries of the IBAN.
     */
    private function isCountriesValid(string $ibanCountryCode): bool
    {
        if (empty($this->countries)) {
            return true;
        }

        foreach ($this->countries as $country) {
            if ($this->isCountryValid($country, $ibanCountryCode)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Check country of the IBAN.
     */
    private function isCountryValid(string $country, string $ibanCountryCode): bool
    {
        return ! empty($country)
            && isset($this->ibanLengthByCountry[$country])
            && $ibanCountryCode === $country;
    }

    /**
     * Check country of the IBAN.
     */
    private function isIbanLengthValid(string $iban, string $ibanCountryCode): bool
    {
        return strlen($iban) === $this->ibanLengthByCountry[$ibanCountryCode];
    }
}