Positive

Warning: You are browsing the documentation for Symfony 4.x, which is no longer maintained.

Read the updated version of this page for Symfony 7.1 (the current stable version).

4.3

The Positive constraint was introduced in Symfony 4.3.

Validates that a value is a positive number. Zero is neither positive nor negative, so you must use PositiveOrZero if you want to allow zero as value.

Applies to	property or method
Class	Positive
Validator	GreaterThanValidator

Basic Usage

The following constraint ensures that the income of an Employee is a positive number (greater than zero):

        1
2
3
4
5
6
7
8
9
10
11
12
        // src/Entity/Employee.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

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

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\Employee:
    properties:
        income:
            - Positive: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- 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>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        // src/Entity/Employee.php
namespace App\Entity;

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


class Employee
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('income', new Assert\Positive());
    }
}
    

Available Options

`groups`

type: array | string

It defines the validation group or groups of this constraint. Read more about validation groups.

`message`

type: string default: This value should be positive.

The default message supplied when the value is not greater than zero.

You can use the following parameters in this message:

Parameter	Description
`{{ compared_value }}`	Always zero
`{{ compared_value_type }}`	The expected value type
`{{ value }}`	The current (invalid) 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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version