Yiisoft\Validator\Rule\Required

Complexity

Total Complexity

5

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	validateValue()	0	9	3
A	getName()	0	3	1
A	getOptions()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\HasValidationErrorMessage;
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
{
    use HasValidationErrorMessage;

    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;
    }

    /**
     * @inheritDoc
     * @return string
     */
    public function getName(): string
    {
        return 'required';
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function getOptions(): array
    {
        return array_merge(
            ['message' => $this->translateMessage($this->message)],
            parent::getOptions()
        );
    }
}