PositiveOrZero
Edit this pagePositiveOrZero
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:
- Attributes
- YAML
- XML
- PHP
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;
}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 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.
