Sprain\SwissQrBill\Reference\RfCreditorReferenceGenerator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	loadValidatorMetadata()	0	12	1
A	generate()	0	5	1
A	doGenerate()	0	11	2

<?php declare(strict_types=1);

namespace Sprain\SwissQrBill\Reference;

use kmukku\phpIso11649\phpIso11649;
use Sprain\SwissQrBill\String\StringModifier;
use Sprain\SwissQrBill\Validator\Exception\InvalidCreditorReferenceException;
use Sprain\SwissQrBill\Validator\SelfValidatableInterface;
use Sprain\SwissQrBill\Validator\SelfValidatableTrait;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

final class RfCreditorReferenceGenerator implements SelfValidatableInterface
{
    use SelfValidatableTrait;

    private string $reference;

    public static function generate(string $reference): string
    {
        $generator = new self($reference);

        return $generator->doGenerate();
    }

    public function __construct(string $reference)
    {
        $this->reference = StringModifier::stripWhitespace($reference);
    }

    public function doGenerate(): string
    {
        if (!$this->isValid()) {
            throw new InvalidCreditorReferenceException(
                'The provided data is not valid to generate a creditor reference.'
            );
        }

        $generator = new phpIso11649();

        return $generator->generateRfReference($this->reference, false);

The expression return $generator->generateRfReference($this->reference, false) could return the type false which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraints('reference', [
            new Assert\Regex([
                'pattern' => '/^[a-zA-Z0-9]*$/',
                'match' => true
            ]),
            new Assert\Length([
                'min' => 1,
                'max' => 21 // 25 minus 'RF' prefix minus 2-digit check sum
            ]),
            new Assert\NotBlank()
        ]);
    }
}