Yiisoft\Validator\Rule\Compare

Complexity

Total Complexity

1

Size/Duplication

Total Lines	6
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;

/**
 * Defines validation options to check that the specified value matches with another value or attribute.
 *
 * The value being compared with a constant {@see Compare::$targetValue}, which is set
 * in the constructor.
 *
 * It supports different comparison operators, specified via the {@see Compare::$operator}.
 *
 * There are shortcut classes to use instead of specifying operator manually:
 *
 * - {@see Equal} is a shortcut for `new Compare(operator: '==')` and `new Compare(operator: '===')`.
 * - {@see NotEqual} is a shortcut for `new Compare(operator: '!=')` and `new Compare(operator: '!==')`.
 * - {@see GreaterThan} is a shortcut for `new Compare(operator: '>')`.
 * - {@see GreaterThanOrEqual} is a shortcut for `new Compare(operator: '>=')`.
 * - {@see LessThan} is a shortcut for `new Compare(operator: '<')`.
 * - {@see LessThanOrEqual} is a shortcut for `new Compare(operator: '<=')`.
 *
 * The default comparison function is based on string values, which means the values
 * are compared byte by byte. When comparing numbers, make sure to change {@see Compare::$type} to
 * {@see CompareType::NUMBER} to enable numeric comparison.
 *
 * @see CompareHandler
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class Compare extends AbstractCompare
{
    public function getName(): string
    {
        return 'compare';
    }
}