Linna\Filter\Rules\Str

Complexity

Total Complexity

3

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	8	2
A	getMessage()	0	3	1

<?php

/**
 * Linna Filter
 *
 * @author Sebastian Rapetti <sebastian.rapetti@alice.it>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types = 1);

namespace Linna\Filter\Rules;

/**
 * Check if provided value is a string.
 *
 */
class Str extends AbstractString implements RuleSanitizeInterface
{
    /**
     * @var array Rule properties
     */
    public static $config = [
        'class' => 'Str1ng',
        'full_class' => __CLASS__,
        'alias' => ['string', 'str', 's'],
        'args_count' => 0,
        'args_type' => [],
        'has_validate' => true,
        'has_sanitize' => true
    ];

    /**
     * @var string Error message
     */
    private $message = '';

    /**
     * Validate.
     *
     * @param mixed $received
     *
     * @return bool
     */
    public function validate($received): bool
    {
        if (!is_string($received)) {
            $this->message = "Received value is not a string";
            return true;
        }

        return false;
    }

    /**
     * Return error message.
     *
     * @return string Error message
     */
    public function getMessage(): string
    {
        return $this->message;
    }
}