Skip to content
  • About
    • What is Symfony?
    • Community
    • News
    • Contributing
    • Support
  • Documentation
    • Symfony Docs
    • Symfony Book
    • Screencasts
    • Symfony Bundles
    • Symfony Cloud
    • Training
  • Services
    • SensioLabs Professional services to help you with Symfony
    • Platform.sh for Symfony Best platform to deploy Symfony apps
    • SymfonyInsight Automatic quality checks for your apps
    • Symfony Certification Prove your knowledge and boost your career
    • Blackfire Profile and monitor performance of your apps
  • Other
  • Blog
  • Download
sponsored by SensioLabs
  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Count
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud

Table of Contents

  • Basic Usage
  • Options
    • groups
    • min
    • max
    • minMessage
    • maxMessage
    • exactMessage
    • payload

Count

Edit this page

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

Read the updated version of this page for Symfony 6.2 (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
  • min
  • max
  • minMessage
  • maxMessage
  • exactMessage
  • payload
  • groups
Class Count
Validator CountValidator

Basic Usage

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

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 = [];
}
1
2
3
4
5
6
7
8
9
# 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'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!-- 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 https://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>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// src/AppBundle/Entity/Participant.php
namespace AppBundle\Entity;

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

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

Options

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

min

type: integer

This option is the "min" count value. Validation will fail if the given collection elements count is less than this min value.

This option is required when the max option is not defined.

max

type: integer

This option is the "max" count value. Validation will fail if the given collection elements count is greater than this max value.

This option is required when the min option is not defined.

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.

You can use the following parameters in this message:

Parameter Description
{{ count }} The current collection size
{{ limit }} The lower limit

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.

You can use the following parameters in this message:

Parameter Description
{{ count }} The current collection size
{{ limit }} The upper limit

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.

You can use the following parameters in this message:

Parameter Description
{{ count }} The current collection size
{{ limit }} The exact expected collection size

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.
TOC
    Version
    We stand with Ukraine.
    Version:
    Symfony Code Performance Profiling

    Symfony Code Performance Profiling

    Code consumes server resources. Blackfire tells you how

    Code consumes server resources. Blackfire tells you how

    Symfony footer

    ↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

    Avatar of Guillaume, a Symfony contributor

    Thanks Guillaume (@guill) for being a Symfony contributor

    22 commits • 1.04K lines changed

    View all contributors that help us make Symfony

    Become a Symfony contributor

    Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

    Learn how to contribute

    Symfony™ is a trademark of Symfony SAS. All rights reserved.

    • What is Symfony?

      • Symfony at a Glance
      • Symfony Components
      • Case Studies
      • Symfony Releases
      • Security Policy
      • Logo & Screenshots
      • Trademark & Licenses
      • symfony1 Legacy
    • Learn Symfony

      • Symfony Docs
      • Symfony Book
      • Reference
      • Bundles
      • Best Practices
      • Training
      • eLearning Platform
      • Certification
    • Screencasts

      • Learn Symfony
      • Learn PHP
      • Learn JavaScript
      • Learn Drupal
      • Learn RESTful APIs
    • Community

      • SymfonyConnect
      • Support
      • How to be Involved
      • Code of Conduct
      • Events & Meetups
      • Projects using Symfony
      • Downloads Stats
      • Contributors
      • Backers
    • Blog

      • Events & Meetups
      • A week of symfony
      • Case studies
      • Cloud
      • Community
      • Conferences
      • Diversity
      • Documentation
      • Living on the edge
      • Releases
      • Security Advisories
      • SymfonyInsight
      • Twig
      • SensioLabs
    • Services

      • SensioLabs services
      • Train developers
      • Manage your project quality
      • Improve your project performance
      • Host Symfony projects

      Deployed on

    Follow Symfony