InputGuard\Guards\IterableStringableGuard

Complexity

Total Complexity

5

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	extraStringValidation()	0	4	3
A	__construct()	0	4	1
A	validateIterableElement()	0	3	1

<?php
declare(strict_types=1);

namespace InputGuard\Guards;

use InputGuard\Guards\Bases\SingleIterableInput;
use InputGuard\Guards\Bases\StringBase;

/**
 * Base valid inputs:
 * 1) An empty iterable.
 * 2) An iterable of scalars (can be cast back and forth by PHP), and a class with a __toString() method.
 *
 * Modifiable validations:
 * 1) Number of elements in the iterable.
 * 2) Character length for each element.
 * 3) Regex on each element.
 */
class IterableStringableGuard implements Guard
{
    use ErrorMessagesBase;
    use SingleIterableInput;
    use StringBase {
        // Use the iterable's validation as the primary validation logic and rename the string validation method.
        SingleIterableInput::validation insteadof StringBase;
        StringBase::validation as stringValidation;
    }

    public function __construct($input, ?iterable $default = null)
    {
        $this->input = $input;
        $this->value = $default;
    }

    protected function extraStringValidation($input): bool
    {
        // Short circuit for anything not a integer, float, string, boolean, or object with a __toString method.
        return \is_scalar($input) || (\is_object($input) && method_exists($input, '__toString'));
    }

    protected function validateIterableElement($element, &$value): bool
    {
        return $this->stringValidation($element, $value);
    }
}