MiladRahimi\Jwt\Validator\BaseValidator

Complexity

Total Complexity

8

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	18	6
A	addRequiredRule()	0	3	1
A	addOptionalRule()	0	3	1

<?php

declare(strict_types=1);

namespace MiladRahimi\Jwt\Validator;

use MiladRahimi\Jwt\Exceptions\ValidationException;

/**
 * The BaseValidator is an implementation of the Validator interface,
 * utilizing predefined rules to validate claims. It is strongly recommended
 * to use or extend this implementation rather than creating your own
 * Validator interface implementation.
 */
class BaseValidator implements Validator
{
    /**
     * @var array<string,array>
     */
    protected array $rules = [];

    /**
     * Add a new required rule
     */
    public function addRequiredRule(string $claimName, Rule $rule)
    {
        $this->rules[$claimName][] = [$rule, true];
    }

    /**
     * Add a new required rule
     */
    public function addOptionalRule(string $claimName, Rule $rule)
    {
        $this->rules[$claimName][] = [$rule, false];
    }

    /**
     * @inheritdoc
     */
    public function validate(array $claims)
    {
        foreach ($this->rules as $claimName => $rules) {
            $exists = isset($claims[$claimName]);
            $value = $exists ? $claims[$claimName] : null;

            foreach ($rules as $ruleAndState) {
                /**
                 * @var Rule $rule
                 * @var bool $required
                 */
                [$rule, $required] = $ruleAndState;

                if ($exists) {
                    $rule->validate($claimName, $value);
                } elseif ($required) {
                    $message = "The `$claimName` is required.";
                    throw  new ValidationException($message);
                }
            }
        }
    }
}