PositiveOrZero

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

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

Validates that a value is a positive number or equal to zero. If you don't want to allow zero as value, use Positive instead.

Applies to	property or method
Class	PositiveOrZero
Validator	GreaterThanOrEqualValidator

Basic Usage

The following constraint ensures that the number of siblings of a Person is positive or zero:

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

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    #[Assert\PositiveOrZero]
    protected int $siblings;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\Person:
    properties:
        siblings:
            - PositiveOrZero: ~
    

        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\Person">
        <property name="siblings">
            <constraint name="PositiveOrZero"></constraint>
        </property>
    </class>
</constraint-mapping>
    

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

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

class Person
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('siblings', new Assert\PositiveOrZero());
    }
}
    

Available 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 either positive or zero.

The default message supplied when the value is not greater than or equal to 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