New in Symfony 4.2: DivisibleBy constraint

September 14, 2018 Javier Eguiluz

In Symfony 4.2, the Validator component has introduced a new DivisibleBy constraint to check whether one number is a multiple of ("divisible by") some other number. It's mostly useful for enforcing specific increments on a number:

// src/Entity/Item.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;

class Item
{
    /**
     * @Assert\DivisibleBy(0.25)
     */
    protected $weight;

    /**
     * @Assert\DivisibleBy(
     *     value = 5,
     *     message = "This item requires to be stocked in multiples of 5 units."
     * )
     */
    protected $quantity;
}

These constraints ensure that the weight of the Item is provided in increments of 0.25 (e.g. 0.75 and 4.50 would be correct, but 0.18 or 7.32 wouldn't) and the quantity must be divisible by 5 (25 and 22620 would be correct but 12 or 123456 wouldn't).

Comments

Nurlan Alekberov said on Sep 14, 2018 at 09:01 #1

This is so business specific, but still helpful.

Benjamin Dieleman said on Sep 14, 2018 at 10:04 #2

22,620 is divisible by 5 ?
Of course but the result a float, not what is expected.

Christophe Coevoet said on Sep 14, 2018 at 10:35 #3

@Benjamin in English, the decimal separator is the dot. the comma is the thousands separator.

George Mponos said on Sep 14, 2018 at 15:49 #4

what?

Philippe Villiers said on Sep 15, 2018 at 22:24 #5

@javier I would suggest not using the thousands separator in the example as it seems to confuse people ;)

Javier Eguiluz said on Sep 17, 2018 at 06:19 #6

@Philippe good idea! I've updated the blog post to remove the thousands separator. Thanks!