14190359521

Committed 01 Apr 2025 08:01AM UTC coverage: 98.469% (+0.2%) from 98.261%

Build # 14190359521

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9 from pixelpeter/fix_coveralls

UPDATE: use coveralls github action instead of php package

Run Details

193 of 196 relevant lines covered (98.47%)

63.98 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.27

/src/IsoCodesValidator.php

<?php

namespace Pixelpeter\IsoCodesValidation;

use Exception;
use Illuminate\Support\Arr;
use Illuminate\Validation\Validator as BaseValidator;

class IsoCodesValidator extends BaseValidator
{
    /**
     * Validate a BBAN code
     *
     * @return mixed
     */
    public function validateBban(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Bban::class, $value);
    }

    /**
     * Validate a BSN (Dutch citizen service number)
     *
     * @return mixed
     */
    public function validateBsn(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Bsn::class, $value);
    }

    /**
     * Validate a CIF code
     *
     * @return mixed
     */
    public function validateCif(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Cif::class, $value);
    }

    /**
     * Validate a credit card number
     *
     * @return mixed
     */
    public function validateCreditcard(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\CreditCard::class, $value);
    }

    // /**
    //  * Validate a EAN-8 code
    //  *
    //  * @param $attribute
    //  * @param $value
    //  * @return mixed
    //  */
    // public function validateEan8(/** @scrutinizer ignore-unused */ $attribute, $value)
    // {
    //     return $this->runIsoCodesValidator(\IsoCodes\Ean8::class, $value);
    // }

    /**
     * Validate a EAN-13 code
     *
     * @return mixed
     */
    public function validateEan13(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Ean13::class, $value);
    }

    /**
     * Validate a Global Document Type Identifier (GDTI)
     *
     * @return mixed
     */
    public function validateGdti(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gdti::class, $value);
    }

    /**
     * Validate a Global Location Number (GLN)
     *
     * @return mixed
     */
    public function validateGln(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gln::class, $value);
    }

    /**
     * Validate a Global Returnable Asset Identifier
     *
     * @return mixed
     */
    public function validateGrai(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Grai::class, $value);
    }

    /**
     * Validate a Global Service Relation Number (GS1)
     *
     * @return mixed
     */
    public function validateGsrn(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gsrn::class, $value);
    }

    /**
     * Validate a GTIN-8 code
     *
     * @return mixed
     */
    public function validateGtin8(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gtin8::class, $value);
    }

    /**
     * Validate a GTIN-12 code
     *
     * @return mixed
     */
    public function validateGtin12(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gtin12::class, $value);
    }

    /**
     * Validate a GTIN-13 code
     *
     * @return mixed
     */
    public function validateGtin13(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gtin13::class, $value);
    }

    /**
     * Validate a GTIN-14 code
     *
     * @return mixed
     */
    public function validateGtin14(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Gtin14::class, $value);
    }

    /**
     * Validate an IBAN
     *
     * @return mixed
     */
    public function validateIban(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Iban::class, $value);
    }

    /**
     * Validate a "numéro de sécurité sociale" (INSEE)
     *
     * @return mixed
     */
    public function validateInsee(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Insee::class, $value);
    }

    /**
     * Validate an IP address
     *
     * @return mixed
     */
    public function validateIpaddress(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\IP::class, $value);
    }

    /**
     * Validate an ISBN
     *
     * @return mixed
     */
    public function validateIsbn($attribute, $value, $parameters)
    {
        $this->requireParameterCount(1, $parameters, 'isbn');
        $type = $this->prepareReference($attribute, $parameters);

        return $this->runIsoCodesValidator(\IsoCodes\Isbn::class, $value, $type);
    }

    /**
     * Validate an "International Securities Identification Number" (ISIN)
     *
     * @return mixed
     */
    public function validateIsin(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Isin::class, $value);
    }

    /**
     * Validate an "International Standard Music Number" or ISMN (ISO 10957)
     *
     * @return mixed
     */
    public function validateIsmn(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Ismn::class, $value);
    }

    /**
     * Validate an "International Standard Musical Work Code" (ISWC)
     *
     * @return mixed
     */
    public function validateIswc(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Iswc::class, $value);
    }

    /**
     * Validate a MAC address
     *
     * @return mixed
     */
    public function validateMac(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Mac::class, $value);
    }

    /**
     * Validate a "Número de Identificación Fiscal" (NIF)
     *
     * @return mixed
     */
    public function validateNif(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Nif::class, $value);
    }

    /**
     * Validate a "Organisme Type12 Norme B2"
     *
     * @return mixed
     */
    public function validateOrganismeType12NormeB2($attribute, $value, $parameters)
    {
        $this->requireParameterCount(1, $parameters, 'organisme_type12_norme_b2');
        $clef = $this->prepareReference($attribute, $parameters);

        return $this->runIsoCodesValidator(\IsoCodes\OrganismeType12NormeB2::class, $value, $clef);
    }

    /**
     * Validate a phone number
     *
     * @return mixed
     */
    public function validatePhonenumber($attribute, $value, $parameters)
    {
        $this->requireParameterCount(1, $parameters, 'phonenumber');
        $country = $this->prepareReference($attribute, $parameters);

        return $this->runIsoCodesValidator(\IsoCodes\PhoneNumber::class, $value, $country);
    }

    /**
     * Validate a Stock Exchange Daily Official List (SEDOL)
     *
     * @return mixed
     */
    public function validateSedol(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Sedol::class, $value);
    }

    /**
     * Validate "Système d’Identification du Répertoire des Entreprises" (SIREN)
     *
     * @return mixed
     */
    public function validateSiren(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Siren::class, $value);
    }

    /**
     * Validate "Système d’Identification du Répertoire des ETablissements" (SIRET)
     *
     * @return mixed
     */
    public function validateSiret(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Siret::class, $value);
    }

    /**
     * Validate a European/International Article Number (SSCC)
     *
     * @return mixed
     */
    public function validateSscc(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Sscc::class, $value);
    }

    /**
     * Validate a Social Security Number (SSN)
     *
     * @return mixed
     */
    public function validateSsn(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Ssn::class, $value);
    }

    /**
     * Validate structured communication
     *
     * @return mixed
     */
    public function validateStructuredCommunication(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\StructuredCommunication::class, $value);
    }

    /**
     * Validate a SWIFT/BIC
     *
     * @return mixed
     */
    public function validateSwiftBic(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\SwiftBic::class, $value);
    }

    /**
     * Validate a Unique Device Identification
     *
     * @return mixed
     */
    public function validateUdi(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Udi::class, $value);
    }

    /**
     * Validate a UK National Insurance Number
     *
     * @return mixed
     */
    public function validateUknin(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Uknin::class, $value);
    }

    /**
     * Validate a Universal Product Code
     *
     * @return mixed
     */
    public function validateUpca(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Upca::class, $value);
    }

    /**
     * Validate Value Added Tax (VAT)
     *
     * @return mixed
     */
    public function validateVat(/** @scrutinizer ignore-unused */ $attribute, $value)
    {
        return $this->runIsoCodesValidator(\IsoCodes\Vat::class, $value);
    }

    /**
     * Validate a zip code
     *
     * @return mixed
     */
    public function validateZipcode($attribute, $value, $parameters)
    {
        $this->requireParameterCount(1, $parameters, 'zipcode');
        $country = $this->prepareReference($attribute, $parameters);

        return $this->runIsoCodesValidator(\IsoCodes\ZipCode::class, $value, $country);
    }

    /**
     * Prepare/get the reference when defined in dot notation
     *
     * @return mixed
     */
    protected function prepareReference($attribute, $parameters)
    {
        if ($keys = $this->getExplicitKeys($attribute)) {
            $parameters = $this->replaceAsterisksInParameters($parameters, $keys);
        }

        return Arr::get($this->data, $parameters[0], $parameters[0]);
    }

    /**
     * Execute the validation function
     * and catch every other Exception from underlying libraries
     * so we will only display the Laravel validation error
     *
     * @param  mixed  $reference
     * @return mixed
     */
    protected function runIsoCodesValidator($validator, $value, $reference = '')
    {
        try {
            if (empty($reference)) {
                return call_user_func($validator.'::validate', $value);
            }

            return call_user_func($validator.'::validate', $value, $reference);
        } catch (Exception $e) {
            // do nothing
        }
    }

    /**
     * Replace all country place-holders
     *
     * @param  $parameter
     * @return mixed
     */
    protected function countryReplacer($message, $reference)
    {
        return str_replace(':country', $reference, $message);
    }

    /**
     * Replace all value place-holders
     *
     * @return mixed
     */
    protected function valueReplacer($message, $attribute)
    {
        return str_replace(':value', $this->getValue($attribute), $message);
    }

    /**
     * Replace all place-holders for the bban rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceBban($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the bsn rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceBsn($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the cif rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceCif($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the creditcard rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceCreditcard($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the ena8 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceEan8($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the ean13 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceEan13($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gdti rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGdti($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gln rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGln($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the grai rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGrai($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gsrn rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGsrn($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gitin8 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGtin8($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gtin12 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGtin12($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gtin13 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGtin13($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the gtin14 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceGtin14($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the iban rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceIban($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the insee rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceInsee($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the ipaddress rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceIpaddress($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the isbn rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceIsbn($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the isin rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceIsin($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the ismn rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceIsmn($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the iswc rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceIswc($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the mac rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceMac($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the nif rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceNif($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the organisme_type12_norme_b2 rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceOrganismeType12NormeB2($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the phonenumber rule
     *
     * @return mixed
     */
    protected function replacePhonenumber($message, $attribute, /** @scrutinizer ignore-unused */ $rule, $parameter)
    {
        $reference = $this->prepareReference($attribute, $parameter);

        $message = $this->valueReplacer($message, $attribute);
        $message = $this->countryReplacer($message, $reference);

        return $message;
    }

    /**
     * Replace all place-holders for the sedol rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceSedol($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the siren rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceSiren($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the siret rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceSiret($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the sscc rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceSscc($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the ssn rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceSSn($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the structured_communication rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceStructuredCommunication($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the swift_bic rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceSwiftBic($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the udi rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceUdi($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the uknin rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceUknin($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the upca rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceUpca($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the vat rule
     *
     * @param  $rule
     * @param  $parameter
     * @return mixed
     */
    public function replaceVat($message, $attribute)
    {
        return $this->valueReplacer($message, $attribute);
    }

    /**
     * Replace all place-holders for the zipcode rule
     *
     * @return mixed
     */
    public function replaceZipcode($message, $attribute, /** @scrutinizer ignore-unused */ $rule, $parameter)
    {
        $reference = $this->prepareReference($attribute, $parameter);

        $message = $this->valueReplacer($message, $attribute);
        $message = $this->countryReplacer($message, $reference);

        return $message;
    }
}

pixelpeter / laravel-isocodes-validation / 14190359521

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous