Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. PositiveOrZero

PositiveOrZero

5.2 version
Maintained
4.4 5.2 current 5.3 dev
Unmaintained
4.3 5.0 5.1
edit this page

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
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
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/Entity/Person.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    /**
     * @Assert\PositiveOrZero
     */
    protected $siblings;
}
  • Attributes
     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 $siblings;
}
  • YAML
    1
2
3
4
5
    # config/validator/validation.yaml
App\Entity\Person:
    properties:
        siblings:
            - PositiveOrZero: ~
  • XML
     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>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // 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.