Skip to content

[Validator] Add docs for number constraints #11254

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

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
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
82 changes: 82 additions & 0 deletions reference/constraints/Negative.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
Negative
========

.. versionadded:: 4.3

The ``Negative`` constraint was introduced in Symfony 4.3.

Validates that a value is a negative number. To force that a value is a negative
number or equal to zero, see :doc:`/reference/constraints/NegativeOrZero`.
To force a value is positive, see :doc:`/reference/constraints/Positive`.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `groups`_
- `message`_
- `payload`_
Class :class:`Symfony\\Component\\Validator\\Constraints\\Negative`
Validator :class:`Symfony\\Component\\Validator\\Constraints\\LesserThanValidator`
========== ===================================================================

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

The following constraint ensure that:

* the ``withdraw`` of a bankaccount ``TransferItem`` is a negative number (lesser than zero)

.. configuration-block::

.. code-block:: php-annotations

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

use Symfony\Component\Validator\Constraints as Assert;

class TransferItem
{
/**
* @Assert\Negative
*/
protected $withdraw;
}

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\TransferItem:
properties:
withdraw:
- Negative

.. 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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

<class name="App\Entity\TransferItem">
<property name="withdraw">
<constraint name="Negative"></constraint>
</property>
</class>
</constraint-mapping>

.. code-block:: php

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

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

class TransferItem
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('withdraw', new Assert\Negative();
}
}
83 changes: 83 additions & 0 deletions reference/constraints/NegativeOrZero.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
NegativeOrZero
==============

.. versionadded:: 4.3

The ``NegativeOrZero`` constraint was introduced in Symfony 4.3.

Validates that a value is a negative number or equal to zero. To force that a value
is only a negative number, see :doc:`/reference/constraints/Negative`.
To force a value is positive or equal to zero,
see :doc:`/reference/constraints/PositiveOrZero`.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `groups`_
- `message`_
- `payload`_
Class :class:`Symfony\\Component\\Validator\\Constraints\\NegativeOrZero`
Validator :class:`Symfony\\Component\\Validator\\Constraints\\LesserThanOrEqualValidator`
========== ===================================================================

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

The following constraint ensure that:

* the ``withdraw`` of a bankaccount ``TransferItem`` is a negative number or equal to zero

.. configuration-block::

.. code-block:: php-annotations

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

use Symfony\Component\Validator\Constraints as Assert;

class TransferItem
{
/**
* @Assert\NegativeOrZero
*/
protected $withdraw;
}

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\TransferItem:
properties:
withdraw:
- NegativeOrZero

.. 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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

<class name="App\Entity\TransferItem">
<property name="withdraw">
<constraint name="NegativeOrZero"></constraint>
</property>
</class>
</constraint-mapping>

.. code-block:: php

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

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

class TransferItem
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('withdraw', new Assert\NegativeOrZero();
}
}
82 changes: 82 additions & 0 deletions reference/constraints/Positive.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
Positive
========

.. versionadded:: 4.3

The ``Positive`` constraint was introduced in Symfony 4.3.

Validates that a value is a positive number. To force that a value is positive
number or equal to zero, see :doc:`/reference/constraints/PositiveOrZero`.
To force a value is negative, see :doc:`/reference/constraints/Negative`.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `groups`_
- `message`_
- `payload`_
Class :class:`Symfony\\Component\\Validator\\Constraints\\Positive`
Validator :class:`Symfony\\Component\\Validator\\Constraints\\GreaterThanValidator`
========== ===================================================================

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

The following constraint ensure that:

* the ``income`` of an ``Employee`` is a positive number (greater than zero)

.. configuration-block::

.. code-block:: php-annotations

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

use Symfony\Component\Validator\Constraints as Assert;

class Employee
{
/**
* @Assert\Positive
*/
protected $income;
}

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\Employee:
properties:
income:
- Positive

.. 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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

<class name="App\Entity\Employee">
<property name="income">
<constraint name="Positive"></constraint>
</property>
</class>
</constraint-mapping>

.. code-block:: php

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

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

class Employee
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('income', new Assert\Positive();
}
}
83 changes: 83 additions & 0 deletions reference/constraints/PositiveOrZero.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
PositiveOrZero
==============

.. versionadded:: 4.3

The ``PositiveOrZero`` constraint was introduced in Symfony 4.3.

Validates that a value is a positive number or equal to zero. To force that
a value is only a positiven umber, see :doc:`/reference/constraints/Positive`.
To force a value is negative or equal to zero,
see :doc:`/reference/constraints/NegativeOrZero`.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `groups`_
- `message`_
- `payload`_
Class :class:`Symfony\\Component\\Validator\\Constraints\\PositiveOrZero`
Validator :class:`Symfony\\Component\\Validator\\Constraints\\GreaterThanOrEqualValidator`
========== ===================================================================

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

The following constraint ensure that:

* the number of ``siblings`` of a ``Person`` is positive or zero

.. configuration-block::

.. code-block:: php-annotations

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

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
/**
* @Assert\PositiveOrZero
*/
protected $siblings;
}

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\Person:
properties:
siblings:
- PositiveOrZero

.. 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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

<class name="App\Entity\Person">
<property name="siblings">
<constraint name="PositiveOrZero"></constraint>
</property>
</class>
</constraint-mapping>

.. code-block:: php

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

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

class Person
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('siblings', new Assert\PositiveOrZero();
}
}
7 changes: 7 additions & 0 deletions reference/constraints/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ Comparison Constraints
* :doc:`Range </reference/constraints/Range>`
* :doc:`DivisibleBy </reference/constraints/DivisibleBy>`

Number Constraints
~~~~~~~~~~~~~~~~~~
* :doc:`Date </reference/constraints/Positive>`
* :doc:`Date </reference/constraints/PositiveOrZero>`
* :doc:`Date </reference/constraints/Negative>`
* :doc:`Date </reference/constraints/NegativeOrZero>`

Date Constraints
~~~~~~~~~~~~~~~~

Expand Down