Symfony
sponsored by SensioLabs
Menu
  • About
  • Documentation
  • Screencasts
  • Cloud
  • Certification
  • Community
  • Businesses
  • News
  • Download
  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Max
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud
Search by Algolia

Table of Contents

  • Basic Usage
  • Options
    • limit
    • message
    • invalidMessage

Max

Edit this page

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

Consider upgrading your projects to Symfony 6.2.

Max

Caution

The Max constraint is deprecated since version 2.1 and will be removed in Symfony 2.3. Use Range with the max option instead.

Validates that a given number is less than some maximum number.

Applies to property or method
Options
  • limit
  • message
  • invalidMessage
Class Max
Validator MaxValidator

Basic Usage

To verify that the "age" field of a class is not greater than "50", you might add the following:

  • YAML
  • Annotations
  • XML
  • PHP
1
2
3
4
5
# src/Acme/EventBundle/Resources/config/validation.yml
Acme\EventBundle\Entity\Participant:
    properties:
        age:
            - Max: { limit: 50, message: You must be 50 or under to enter. }
1
2
3
4
5
6
7
8
9
10
11
12
// src/Acme/EventBundle/Entity/Participant.php
namespace Acme\EventBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Participant
{
    /**
     * @Assert\Max(limit = 50, message = "You must be 50 or under to enter.")
     */
     protected $age;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!-- src/Acme/EventBundle/Resources/config/validation.yml -->
<?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="Acme\EventBundle\Entity\Participant">
        <property name="age">
            <constraint name="Max">
                <option name="limit">50</option>
                <option name="message">You must be 50 or under to enter.</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// src/Acme/EventBundle/Entity/Participant.php
namespace Acme\EventBundle\Entity;

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

class Participant
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('age', new Assert\Max(array(
            'limit'   => 50,
            'message' => 'You must be 50 or under to enter.',
        )));
    }
}

Options

limit

type: integer [default option]

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

message

type: string default: This value should be {{ limit }} or less.

The message that will be shown if the underlying value is greater than the limit option.

invalidMessage

type: string default: This value should be a valid number.

The message that will be shown if the underlying value is not a number (per the is_numeric PHP function).

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
We stand with Ukraine.
Version:
Symfony Code Performance Profiling

Symfony Code Performance Profiling

Be trained by SensioLabs experts (2 to 6 day sessions -- French or English).

Be trained by SensioLabs experts (2 to 6 day sessions -- French or English).

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

Avatar of Steve Frécinaux, a Symfony contributor

Thanks Steve Frécinaux for being a Symfony contributor

1 commit • 30 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
Search by Algolia