InputGuard\Guards\StringGuard

Complexity

Total Complexity

4

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	value()	0	5	1
A	__construct()	0	4	1
A	validationShortCircuit()	0	4	2

<?php
declare(strict_types=1);

namespace InputGuard\Guards;

use InputGuard\Guards\Bases\SingleInput;
use InputGuard\Guards\Bases\StringBase;

/**
 * Base valid inputs:
 * 1) An empty string.
 * 2) A scalar (can be cast back and forth by PHP).
 *
 * Modifiable validations:
 * 1) Character length for the string.
 * 2) Regex on the string.
 */
class StringGuard implements Guard
{
    use ErrorMessagesBase;
    use StringBase;
    use SingleInput;

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

    protected function validationShortCircuit($input): bool
    {
        // The is_scalar is a short circuit for anything not a integer, float, string or boolean.
        return $this->strict ? \is_string($input) : \is_scalar($input);

Inline IF statements are not allowed

    }

    public function value(): ?string
    {
        $this->success();

        return $this->value;
    }
}