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

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

Count

2.3 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

Count
- Basic Usage
- Options
  - min
  - max
  - minMessage
  - maxMessage
  - exactMessage

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	min max minMessage maxMessage exactMessage
Class	`Symfony\Component\Validator\Constraints\Count`
Validator	`Symfony\Component\Validator\Constraints\CountValidator`

Basic Usage¶

To verify that the emails array field contains between 1 and 5 elements you might add the following:

Annotations

// 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();
}

YAML

# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Participant:
    properties:
        emails:
            - Count:
                min: 1
                max: 5
                minMessage: 'You must specify at least one email'
                maxMessage: 'You cannot specify more than {{ limit }} emails'

XML

<!-- src/AppBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="AppBundle\Entity\Participant">
        <property name="emails">
            <constraint name="Count">
                <option name="min">1</option>
                <option name="max">5</option>
                <option name="minMessage">You must specify at least one email</option>
                <option name="maxMessage">You cannot specify more than {{ limit }} emails</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

// src/AppBundle/Entity/Participant.php
namespace AppBundle\Entity;

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

class Participant
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('emails', new Assert\Count(array(
            'min'        => 1,
            'max'        => 5,
            'minMessage' => 'You must specify at least one email',
            'maxMessage' => 'You cannot specify more than {{ limit }} emails',
        )));
    }
}

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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.