Yiisoft\Validator\Rule\Required

Complexity

Total Complexity

4

Size/Duplication

Total Lines	19
Duplicated Lines	0 %

Test Coverage

Coverage

62.5%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	message()	0	4	1
A	validateValue()	0	9	3

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\Rule;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\DataSetInterface;

/**
 * RequiredValidator validates that the specified attribute does not have null or empty value.
 */
class Required extends Rule
{
    private string $message = 'Value cannot be blank.';

    protected function validateValue($value, DataSetInterface $dataSet = null): Result
    {
        $result = new Result();

        if ($this->isEmpty(is_string($value) ? trim($value) : $value)) {
            $result->addError($this->translateMessage($this->message));
        }

        return $result;
    }

    public function message(string $message): self
    {
        $this->message = $message;
        return $this;
    }
}