BoolValue::getOptions() - Code Metrics - Inspection of "Adjust messages in `Boolean` and `IsTrue` rules, r..." - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#491)

unknown

created 2022-12-26 07:12 UTC

BoolValue::getOptions() A

↳ Parent: BoolValue

Complexity

Conditions	3
Paths	4

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	15
nc	4
nop	0
dl	0
loc	21
rs	9.7666
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
use Yiisoft\Validator\Rule\Trait\WhenTrait;
use Yiisoft\Validator\RuleWithOptionsInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\WhenInterface;

/**
 * Contains a set of options to determine if the value is "true" or "false", not limited to boolean type only. What
 * values exactly are considered "true" and "false" can be configured via {@see $trueValue} and {@see $falseValue}
 * settings accordingly. There is also an option to choose between strict and non-strict mode of comparison
 * (see {@see $strict}).
 *
 * If the purpose is to check the truthiness only, use {@see TrueValue} rule instead.
 *
 * @see BoolValueHandler Corresponding handler performing the actual validation.
 *
 * @psalm-import-type WhenType from WhenInterface
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class BoolValue implements RuleWithOptionsInterface, SkipOnEmptyInterface, SkipOnErrorInterface, WhenInterface
{
    use SkipOnEmptyTrait;
    use SkipOnErrorTrait;
    use WhenTrait;

    /**
     * @param scalar $trueValue The value that is considered to be "true". Only scalar values (either int, float, string
     * or bool) are allowed. Defaults to `1` string.
     * @param scalar $falseValue The value that is considered to be "false". Only scalar values (either int, float,
     * string or bool) are allowed. Defaults to `0` string.
     * @param bool $strict Whether the comparison to {@see $trueValue} and {@see $falseValue} is strict:
     *
     * - Strict mode uses `===` operator meaning the type and the value must both match to those set in
     * {@see $trueValue} or {@see $falseValue}.
     * - Non-strict mode uses `==` operator meaning that type juggling is performed first before the comparison. You can
     * read more in the PHP docs:
     *
     * - {@link https://www.php.net/manual/en/language.operators.comparison.php}
     * - {@link https://www.php.net/manual/en/types.comparisons.php}
     * - {@link https://www.php.net/manual/en/language.types.type-juggling.php}
     *
     * Defaults to `false` meaning non-strict mode is used.
     * @param string $incorrectInputMessage Error message used when validation fails because the type of validated value
     * is incorrect - either non-scalar value (int, float, string, bool) or null was provided. Used for more predictable
     * formatting.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the label of the attribute being validated.
     * - `{true}`: the value set in {@see $trueValue} option.
     * - `{false}`: the value set in {@see $falseValue} option.
     * - `{type}`: the type of the value being validated.
     * @param string $message Error message used when validation fails because the validated value does not match
     * neither "true" nor "false" values.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the label of the attribute being validated.
     * - `{true}`: the value set in {@see $trueValue} option.
     * - `{false}`: the value set in {@see $falseValue} option.
     * - `{value}`: the value being validated.
     * @param bool|callable|null $skipOnEmpty Whether to skip this rule if the validated value is empty / not passed.
     * See {@see SkipOnEmptyInterface}.
     * @param bool $skipOnError Whether to skip this rule if any of the previous rules gave an error. See
     * {@see SkipOnErrorInterface}.
     * @param Closure|null $when A callable to define a condition for applying the rule. See {@see WhenInterface}.
     * @psalm-param WhenType $when
     */
    public function __construct(
        private int|float|string|bool $trueValue = '1',
        private int|float|string|bool $falseValue = '0',
        private bool $strict = false,
        private string $incorrectInputMessage = 'The allowed types are integer, float, string, boolean and null.',
        private string $message = 'Value must be either "{true}" or "{false}".',
        private mixed $skipOnEmpty = null,
        private bool $skipOnError = false,
        private Closure|null $when = null,
    ) {
    }

    public function getName(): string
    {
        return 'boolean';
    }

    /**
     * Gets the value that is considered to be "true".
     *
     * @return scalar A scalar value.
     *
     * @see $trueValue
     */
    public function getTrueValue(): int|float|string|bool
    {
        return $this->trueValue;
    }

    /**
     * Gets the value that is considered to be "false".
     *
     * @return scalar A scalar value.
     *
     * @see $falseValue
     */
    public function getFalseValue(): int|float|string|bool
    {
        return $this->falseValue;
    }

    /**
     * Whether the comparison to {@see $trueValue} and {@see $falseValue} is strict.
     *
     * @return bool `true` - strict, `false` - non-strict.
     *
     * @see $strict
     */
    public function isStrict(): bool
    {
        return $this->strict;
    }

    /**
     * Gets error message used when validation fails because the type of validated value is incorrect.
     *
     * @return string Error message / template.
     *
     * @see $incorrectInputMessage
     */
    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    /**
     * Error message used when validation fails because the validated value does not match neither "true" nor "false"
     * values.
     *
     * @return string Error message / template.
     *
     * @see $message
     */
    public function getMessage(): string
    {
        return $this->message;
    }

    public function getOptions(): array
    {
        $messageParameters = [
            'true' => $this->trueValue === true ? 'true' : $this->trueValue,
            'false' => $this->falseValue === false ? 'false' : $this->falseValue,
        ];

        return [
            'trueValue' => $this->trueValue,
            'falseValue' => $this->falseValue,
            'strict' => $this->strict,
            'incorrectInputMessage' => [
                'template' => $this->incorrectInputMessage,
                'parameters' => $messageParameters,
            ],
            'message' => [
                'template' => $this->message,
                'parameters' => $messageParameters,
            ],
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
        ];
    }

    public function getHandler(): string
    {
        return BoolValueHandler::class;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Validator\Rule;
6
7			use Attribute;
8			use Closure;
9			use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
10			use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
11			use Yiisoft\Validator\Rule\Trait\WhenTrait;
12			use Yiisoft\Validator\RuleWithOptionsInterface;
13			use Yiisoft\Validator\SkipOnEmptyInterface;
14			use Yiisoft\Validator\SkipOnErrorInterface;
15			use Yiisoft\Validator\WhenInterface;
16
17			/**
18			* Contains a set of options to determine if the value is "true" or "false", not limited to boolean type only. What
19			* values exactly are considered "true" and "false" can be configured via {@see $trueValue} and {@see $falseValue}
20			* settings accordingly. There is also an option to choose between strict and non-strict mode of comparison
21			* (see {@see $strict}).
22			*
23			* If the purpose is to check the truthiness only, use {@see TrueValue} rule instead.
24			*
25			* @see BoolValueHandler Corresponding handler performing the actual validation.
26			*
27			* @psalm-import-type WhenType from WhenInterface
28			*/
29			#[Attribute(Attribute::TARGET_PROPERTY \| Attribute::IS_REPEATABLE)]
30			final class BoolValue implements RuleWithOptionsInterface, SkipOnEmptyInterface, SkipOnErrorInterface, WhenInterface
31			{
32			use SkipOnEmptyTrait;
33			use SkipOnErrorTrait;
34			use WhenTrait;
35
36			/**
37			* @param scalar $trueValue The value that is considered to be "true". Only scalar values (either int, float, string
38			* or bool) are allowed. Defaults to `1` string.
39			* @param scalar $falseValue The value that is considered to be "false". Only scalar values (either int, float,
40			* string or bool) are allowed. Defaults to `0` string.
41			* @param bool $strict Whether the comparison to {@see $trueValue} and {@see $falseValue} is strict:
42			*
43			* - Strict mode uses `===` operator meaning the type and the value must both match to those set in
44			* {@see $trueValue} or {@see $falseValue}.
45			* - Non-strict mode uses `==` operator meaning that type juggling is performed first before the comparison. You can
46			* read more in the PHP docs:
47			*
48			* - {@link https://www.php.net/manual/en/language.operators.comparison.php}
49			* - {@link https://www.php.net/manual/en/types.comparisons.php}
50			* - {@link https://www.php.net/manual/en/language.types.type-juggling.php}
51			*
52			* Defaults to `false` meaning non-strict mode is used.
53			* @param string $incorrectInputMessage Error message used when validation fails because the type of validated value
54			* is incorrect - either non-scalar value (int, float, string, bool) or null was provided. Used for more predictable
55			* formatting.
56			*
57			* You may use the following placeholders in the message:
58			*
59			* - `{attribute}`: the label of the attribute being validated.
60			* - `{true}`: the value set in {@see $trueValue} option.
61			* - `{false}`: the value set in {@see $falseValue} option.
62			* - `{type}`: the type of the value being validated.
63			* @param string $message Error message used when validation fails because the validated value does not match
64			* neither "true" nor "false" values.
65			*
66			* You may use the following placeholders in the message:
67			*
68			* - `{attribute}`: the label of the attribute being validated.
69			* - `{true}`: the value set in {@see $trueValue} option.
70			* - `{false}`: the value set in {@see $falseValue} option.
71			* - `{value}`: the value being validated.
72			* @param bool\|callable\|null $skipOnEmpty Whether to skip this rule if the validated value is empty / not passed.
73			* See {@see SkipOnEmptyInterface}.
74			* @param bool $skipOnError Whether to skip this rule if any of the previous rules gave an error. See
75			* {@see SkipOnErrorInterface}.
76			* @param Closure\|null $when A callable to define a condition for applying the rule. See {@see WhenInterface}.
77			* @psalm-param WhenType $when
78			*/
79			public function __construct(
80			private int\|float\|string\|bool $trueValue = '1',
81			private int\|float\|string\|bool $falseValue = '0',
82			private bool $strict = false,
83			private string $incorrectInputMessage = 'The allowed types are integer, float, string, boolean and null.',
84			private string $message = 'Value must be either "{true}" or "{false}".',
85			private mixed $skipOnEmpty = null,
86			private bool $skipOnError = false,
87			private Closure\|null $when = null,
88			) {
89			}
90
91			public function getName(): string
92			{
93			return 'boolean';
94			}
95
96			/**
97			* Gets the value that is considered to be "true".
98			*
99			* @return scalar A scalar value.
100			*
101			* @see $trueValue
102			*/
103			public function getTrueValue(): int\|float\|string\|bool
104			{
105			return $this->trueValue;
106			}
107
108			/**
109			* Gets the value that is considered to be "false".
110			*
111			* @return scalar A scalar value.
112			*
113			* @see $falseValue
114			*/
115			public function getFalseValue(): int\|float\|string\|bool
116			{
117			return $this->falseValue;
118			}
119
120			/**
121			* Whether the comparison to {@see $trueValue} and {@see $falseValue} is strict.
122			*
123			* @return bool `true` - strict, `false` - non-strict.
124			*
125			* @see $strict
126			*/
127			public function isStrict(): bool
128			{
129			return $this->strict;
130			}
131
132			/**
133			* Gets error message used when validation fails because the type of validated value is incorrect.
134			*
135			* @return string Error message / template.
136			*
137			* @see $incorrectInputMessage
138			*/
139			public function getIncorrectInputMessage(): string
140			{
141			return $this->incorrectInputMessage;
142			}
143
144			/**
145			* Error message used when validation fails because the validated value does not match neither "true" nor "false"
146			* values.
147			*
148			* @return string Error message / template.
149			*
150			* @see $message
151			*/
152			public function getMessage(): string
153			{
154			return $this->message;
155			}
156
157			public function getOptions(): array
158			{
159			$messageParameters = [
160			'true' => $this->trueValue === true ? 'true' : $this->trueValue,
161			'false' => $this->falseValue === false ? 'false' : $this->falseValue,
162			];
163
164			return [
165			'trueValue' => $this->trueValue,
166			'falseValue' => $this->falseValue,
167			'strict' => $this->strict,
168			'incorrectInputMessage' => [
169			'template' => $this->incorrectInputMessage,
170			'parameters' => $messageParameters,
171			],
172			'message' => [
173			'template' => $this->message,
174			'parameters' => $messageParameters,
175			],
176			'skipOnEmpty' => $this->getSkipOnEmptyOption(),
177			'skipOnError' => $this->skipOnError,
178			];
179			}
180
181			public function getHandler(): string
182			{
183			return BoolValueHandler::class;
184			}
185			}
186

yiisoft / validator

Pull Request — master (#491)

BoolValue::getOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like