Count
Edit this pageWarning: You are browsing the documentation for Symfony 2.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.0 (the current stable version).
Count
Validates that a given collection's (i.e. an array or an object that implements Countable) element count is between some minimum and maximum value.
Applies to | property or method |
Options | |
Class | Count |
Validator | CountValidator |
Basic Usage
To verify that the emails
array field contains between 1 and 5 elements
you might add the following:
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/AppBundle/Entity/Participant.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Participant
{
/**
* @Assert\Count(
* min = "1",
* max = "5",
* minMessage = "You must specify at least one email",
* maxMessage = "You cannot specify more than {{ limit }} emails"
* )
*/
protected $emails = array();
}
Options
min
type: integer
This required option is the "min" count value. Validation will fail if the given collection elements count is less than this min value.
max
type: integer
This required option is the "max" count value. Validation will fail if the given collection elements count is greater than this max value.
minMessage
type: string
default: This collection should contain {{ limit }} elements or more.
The message that will be shown if the underlying collection elements count is less than the min option.
maxMessage
type: string
default: This collection should contain {{ limit }} elements or less.
The message that will be shown if the underlying collection elements count is more than the max option.
exactMessage
type: string
default: This collection should contain exactly {{ limit }} elements.
The message that will be shown if min and max values are equal and the underlying collection elements count is not exactly this value.