README.md

Bulgaria vat number format validators config

This package provides a preconfigured configuration class for vat number format validators for Bulgaria country. Is an extension of the package https://github.com/rocketfellows/specific-country-vat-number-format-validators-config.

Installation

composer require rocketfellows/bg-vat-number-format-validators-config

Dependencies

• https://github.com/rocketfellows/specific-country-vat-number-format-validators-config v1.0.0;
• https://github.com/rocketfellows/bg-vat-format-validator v1.0.0;

References

• https://github.com/rocketfellows/country-vat-format-validator-interface
• https://github.com/arslanim/iso-standard-3166

List of package components

• rocketfellows\BGVatNumberFormatValidatorsConfig\BGVatNumberFormatValidatorsConfig - preconfigured configuration class for vat number format validators for Bulgaria country;

BGVatNumberFormatValidatorsConfig description

A configuration class that provides a match for the vat number format validators for the country Bulgaria.

Class interface:

• getCountry - returns Bulgaria Country instance;
• getValidators - returns validators tuple

When initializing the default configuration, the getValidators function returns a tuple with a single validator - an instance of BGVatFormatValidator.

$config = new BGVatNumberFormatValidatorsConfig();

$config->getCountry();      // returns Bulgaria Country instance
$config->getValidators();   // returns CountryVatFormatValidators with one item - instance of BGVatFormatValidator

You can override the default validator by initializing the configuration class object with a new default validator through the first parameter of the class constructor. Attention - validator must implement interface CountryVatFormatValidatorInterface.

$newDefaultValidator = new NewDefaultValidator();                       // instance of CountryVatFormatValidatorInterface
$config = new BGVatNumberFormatValidatorsConfig($newDefaultValidator);  // initialize with new default validator

$config->getValidators();   // returns CountryVatFormatValidators with one item - $newDefaultValidator

You can add additional validators to the default validator via the second constructor parameter.

Attention - additional validators parameter must be instance of tuple CountryVatFormatValidators. And each additional validator must implement interface CountryVatFormatValidatorInterface.

$firstAdditionalValidator = new FirstAdditionalValidator();   // instance of CountryVatFormatValidatorInterface
$secondAdditionalValidator = new SecondAdditionalValidator(); // instance of CountryVatFormatValidatorInterface

$config = new BGVatNumberFormatValidatorsConfig(
    null,
    (
        new CountryVatFormatValidators(
            $firstAdditionalValidator,
            $secondAdditionalValidator
        )
    )
);

// returns CountryVatFormatValidators with three items:
// default preconfigured validator by default - instance of BGVatFormatValidator
// $firstAdditionalValidator - from additional tuple
// $secondAdditionalValidator - from additional tuple
$config->getValidators();

You can also completely rebuild the configuration by passing the default validator and a tuple of additional validators to the config class constructor.

$defaultValidator = new DefaultValidator();                   // instance of CountryVatFormatValidatorInterface
$firstAdditionalValidator = new FirstAdditionalValidator();   // instance of CountryVatFormatValidatorInterface
$secondAdditionalValidator = new SecondAdditionalValidator(); // instance of CountryVatFormatValidatorInterface

$config = new BGVatNumberFormatValidatorsConfig(
    $defaultValidator,
    (
        new CountryVatFormatValidators(
            $firstAdditionalValidator,
            $secondAdditionalValidator
        )
    )
);

// returns CountryVatFormatValidators with three items:
// $defaultValidator from constructor first parameter
// $firstAdditionalValidator - from additional tuple
// $secondAdditionalValidator - from additional tuple
$config->getValidators();

More use case examples can be found in the package's unit tests.

Contributing

Welcome to pull requests. If there is a major changes, first please open an issue for discussion.

Please make sure to update tests as appropriate.