Skip to content

[Validator] Document the DivisibleBy constraint #10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 6, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions reference/constraints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Validation Constraints Reference
constraints/GreaterThan
constraints/GreaterThanOrEqual
constraints/Range
constraints/DivisibleBy

constraints/Date
constraints/DateTime
Expand Down
129 changes: 129 additions & 0 deletions reference/constraints/DivisibleBy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
DivisibleBy
===========

Validates that a value is divisible by another value, defined in the options.

+----------------+---------------------------------------------------------------------------+
| Applies to | :ref:`property or method<validation-property-target>` |
+----------------+---------------------------------------------------------------------------+
| Options | - `value`_ |
| | - `message`_ |
| | - `payload`_ |
| | - `propertyPath`_ |
+----------------+---------------------------------------------------------------------------+
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\DivisibleBy` |
+----------------+---------------------------------------------------------------------------+
| Validator | :class:`Symfony\\Component\\Validator\\Constraints\\DivisibleByValidator` |
+----------------+---------------------------------------------------------------------------+

Basic Usage
-----------

The following constraints ensure that:

* the ``weight`` of the ``Item`` is provided in increments of ``0.25``
* the ``quantity`` of the ``Item`` must be divisible by ``5``

.. configuration-block::

.. code-block:: php-annotations

// 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
* )
*/
protected $quantity;
}

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\Item:
properties:
weight:
- DivisibleBy: 0.25
quantity:
- DivisibleBy:
value: 5

.. code-block:: xml

<!-- 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 http://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>

.. code-block:: php

// src/Entity/Item.php
namespace App\Entity;

use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class Item
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('weight', new Assert\DivisibleBy(0.25));

$metadata->addPropertyConstraint('quantity', new Assert\DivisibleBy(array(
'value' => 5,
)));
}
}

Options
-------

.. include:: /reference/constraints/_comparison-value-option.rst.inc

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.

.. include:: /reference/constraints/_payload-option.rst.inc

propertyPath
~~~~~~~~~~~~

**type**: ``string``

It defines the object property whose value is used to make the comparison.

For example, if you want to compare the ``$value`` property of some object
with regard to the ``$increments`` property of the same object, use
``propertyPath="increments"`` in the comparison constraint of ``$value``.
1 change: 1 addition & 0 deletions reference/constraints/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Comparison Constraints
* :doc:`GreaterThan </reference/constraints/GreaterThan>`
* :doc:`GreaterThanOrEqual </reference/constraints/GreaterThanOrEqual>`
* :doc:`Range </reference/constraints/Range>`
* :doc:`DivisibleBy </reference/constraints/DivisibleBy>`

Date Constraints
~~~~~~~~~~~~~~~~
Expand Down