devsergeev/inn-validator

There is no license information available for the latest version (2.0.3) of this package.

Inn validator

2.0.3 2023-10-08 10:13 UTC

Requires

• php: >=8.1
• ext-mbstring: *

Requires (Dev)

• phpunit/phpunit: ^8
• roave/security-advisories: dev-master

Unknown License

• devsergeev

• validator
• checksum
• INN
• inn-validator
• inn validator

README

Описание

Валидирует ИНН (идентификационный номер налогоплательщика) как физлица (12 цифр), так и юрлица (10 цифр). Осуществляет проверку того, что ИНН удовлетворяет следующим условиям (см википедию):

• состоит из 10 или 12 символов
• состоит только из цифр
• имеет правильную котрольную сумму

Установка с помощью composer

composer require devsergeev/inn-validator

Пример использования

use \devsergeev\validators\InnValidator;

try {
    InnValidator::check($inn);
} catch (InvalidArgumentException $e) {
    echo $e->getMessage();
    echo $e->getCode();
}

Метод InnValidator::check(string $inn) возвращает true, если строка $inn является валидным ИНН. В противном случае будет выброшено исключение с соответствующим сообщением об ошибке.

Несмотря на то, что валидатор имеет встроенные сообщения об ошибках ИНН, вы можете задать свои сообщения:

use \devsergeev\validators\InnValidator;

InnValidator::$messageInvalidLenght   = 'Ваше сообщение о недопустимой длине ИНН';
InnValidator::$messageOnlyDigits      = 'Ваше сообщение о том, что ИНН должен состоять только из цифр';
InnValidator::$messageInvalidChecksum = 'Ваше сообщение о неправильной контрольной сумме';

try {
    InnValidator::check($inn);
} catch (InvalidArgumentException $e) {
    echo $e->getMessage();
}

Пример использования кодов исключения и альтернативная реализация своих сообщений:

use \devsergeev\validators\InnValidator;

try {
    InnValidator::check($inn);
} catch (InvalidArgumentException $e) {
    switch ($e->getCode()) {
        case InnValidator::CODE_INVALID_LENGHT:
            $message = 'Ваше сообщение о недопустимой длине ИНН';
            break;
        case InnValidator::CODE_NOT_ONLY_DIGITS:
            $message = 'Ваше сообщение о том, что ИНН должен состоять только из цифр';
            break;
        case InnValidator::CODE_INVALID_CHECKSUM:
            $message = 'Ваше сообщение о неправильной контрольной сумме';
            break;
    }
    echo $message;
}

Docker-compose для разработки

Создать docker-compose

docker-compose -f ./docker/docker-compose.yml --env-file ./docker/.env up

Запустить bash

docker-compose -f ./docker/docker-compose.yml --env-file ./docker/.env run --rm php-cli bash

Установить зависимости

composer install

Запустить тесты

vendor/bin/phpunit