IsTrue
Validates that a value is true
. Specifically, this checks if the value is
exactly true
, exactly the integer 1
, or exactly the string '1'
.
Also see IsFalse.
Applies to | property or method |
Class | IsTrue |
Validator | IsTrueValidator |
Basic Usage
This constraint can be applied to properties (e.g. a termsAccepted
property
on a registration model) and methods. It's most powerful in the latter case,
where you can assert that a method returns a true value. For example, suppose
you have the following method:
1 2 3 4 5 6 7 8 9 10 11 12
// src/Entity/Author.php
namespace App\Entity;
class Author
{
protected string $token;
public function isTokenValid(): bool
{
return $this->token === $this->generateToken();
}
}
Then you can validate this method with IsTrue
as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
protected string $token;
#[Assert\IsTrue(message: 'The token is invalid.')]
public function isTokenValid(): bool
{
return $this->token === $this->generateToken();
}
// ...
}
1 2 3 4 5 6
# config/validator/validation.yaml
App\Entity\Author:
getters:
tokenValid:
- 'IsTrue':
message: The token is invalid.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
<class name="App\Entity\Author">
<getter property="tokenValid">
<constraint name="IsTrue">
<option name="message">The token is invalid.</option>
</constraint>
</getter>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints\IsTrue;
use Symfony\Component\Validator\Mapping\ClassMetadata;
class Author
{
// ...
public static function loadValidatorMetadata(ClassMetadata $metadata): void
{
$metadata->addGetterConstraint('tokenValid', new IsTrue([
'message' => 'The token is invalid.',
]));
}
public function isTokenValid(): bool
{
return $this->token === $this->generateToken();
}
// ...
}
If the isTokenValid()
returns false, the validation will fail.
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
default: null
It defines the validation group or groups of this constraint. Read more about validation groups.
message
type: string
default: This value should be true.
This message is shown if the underlying data is not true.
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.