IsFalse ¶
Validates that a value is false
. Specifically, this checks to see if
the value is exactly false
, exactly the integer 0
, or exactly the
string '0'
.
Also see IsTrue.
Applies to | property or method |
Class | IsFalse |
Validator | IsFalseValidator |
Basic Usage ¶
The IsFalse
constraint can be applied to a property or a "getter" method,
but is most commonly useful in the latter case. For example, suppose that
you want to guarantee that some state
property is not in a dynamic
invalidStates
array. First, you'd create a "getter" method:
1 2 3 4 5 6 7 8 |
protected $state;
protected $invalidStates = [];
public function isStateInvalid()
{
return in_array($this->state, $this->invalidStates);
}
|
In this case, the underlying object is only valid if the isStateInvalid()
method returns false:
-
Attributes
属性
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\IsFalse(
message: "You've entered an invalid state."
)]
public function isStateInvalid()
{
// ...
}
}
|
Note
As with most of the other constraints, null
is
considered a valid value. This is to allow the use of optional values.
If the value is mandatory, a common solution is to combine this constraint
with NotNull.
Options ¶
groups
¶
type: array
| string
It defines the validation group or groups of this constraint. Read more about validation groups.
message
¶
type: string
default: This value should be false.
This message is shown if the underlying data is not false.
You can use the following parameters in this message:
Parameter | Description |
---|---|
{{ value }} |
The current (invalid) value |
{{ label }} |
Corresponding form field label |
payload
¶
type: mixed
default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.