PositiveOrZero

5.3 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

4.3 5.0 5.1 5.2

edit this page

Symfony 5.3 is backed by JoliCode.

PositiveOrZero
- Basic Usage
- Available Options

PositiveOrZero¶

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
Options	groups message payload
Class	`Symfony\Component\Validator\Constraints\PositiveOrZero`
Validator	`Symfony\Component\Validator\Constraints\GreaterThanOrEqualValidator`

Basic Usage¶

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

Annotations

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

use Symfony\Component\Validator\Constraints as Assert;

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

Attributes

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

use Symfony\Component\Validator\Constraints as Assert;

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

YAML

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

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>

PHP

// 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)
    {
        $metadata->addPropertyConstraint('siblings', new Assert\PositiveOrZero());
    }
}

Available Options¶

`groups`¶

type: array | string

It defines the validation group or groups this constraint belongs to. 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.