DivisibleBy
Validates that a value is divisible by another value, defined in the options.
See also
If you need to validate that the number of elements in a collection is
divisible by a certain number, use the Count
constraint with the divisibleBy
option.
Applies to | property or method |
Class | DivisibleBy |
Validator | DivisibleByValidator |
Basic Usage
The following constraints ensure that:
- the
weight
of theItem
is provided in increments of0.25
- the
quantity
of theItem
must be divisible by5
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/Entity/Item.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Item
{
#[Assert\DivisibleBy(0.25)]
protected float $weight;
#[Assert\DivisibleBy(
value: 5,
)]
protected int $quantity;
}
1 2 3 4 5 6 7 8
# config/validator/validation.yaml
App\Entity\Item:
properties:
weight:
- DivisibleBy: 0.25
quantity:
- DivisibleBy:
value: 5
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<!-- 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\Item">
<property name="weight">
<constraint name="DivisibleBy">
<value>0.25</value>
</constraint>
</property>
<property name="quantity">
<constraint name="DivisibleBy">
<option name="value">5</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// src/Entity/Item.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;
class Item
{
// ...
public static function loadValidatorMetadata(ClassMetadata $metadata): void
{
$metadata->addPropertyConstraint('weight', new Assert\DivisibleBy(0.25));
$metadata->addPropertyConstraint('quantity', new Assert\DivisibleBy([
'value' => 5,
]));
}
}
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 a multiple of {{ compared_value }}.
This is the message that will be shown if the value is not divisible by the comparison value.
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.
propertyPath
type: string
default: null
It defines the object property whose value is used to make the comparison.
For example, if you want to compare the $endDate
property of some object
with regard to the $startDate
property of the same object, use
propertyPath="startDate"
in the comparison constraint of $endDate
.
Tip
When using this option, its value is available in error messages as the
{{ compared_value_path }}
placeholder. Although it's not intended to
include it in the error messages displayed to end users, it's useful when
using APIs for doing any mapping logic on client-side.
value
type: mixed
[default option]
This option is required. It defines the comparison value. It can be a string, number or object.