Count

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
     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();
    }
    
  • YAML
    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'
    
  • XML
     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 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
     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\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.

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.