Length
Edit this pageWarning: You are browsing the documentation for Symfony 2.4, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (the current stable version).
Length
Validates that a given string length is between some minimum and maximum value.
Applies to | property or method |
Options | |
Class | Length |
Validator | LengthValidator |
Basic Usage
To verify that the firstName
field length of a class is between "2" and
"50", you might add the following:
- YAML
- Annotations
- XML
- PHP
1 2 3 4 5 6 7 8 9
# src/Acme/EventBundle/Resources/config/validation.yml
Acme\EventBundle\Entity\Participant:
properties:
firstName:
- Length:
min: 2
max: 50
minMessage: "Your first name must be at least {{ limit }} characters long"
maxMessage: "Your first name cannot be longer than {{ limit }} characters long"
Options
min
type: integer
This required option is the "min" length value. Validation will fail if the given value's length is less than this min value.
max
type: integer
This required option is the "max" length value. Validation will fail if the given value's length is greater than this max value.
charset
type: string
default: UTF-8
The charset to be used when computing value's length. The grapheme_strlen PHP function is used if available. If not, the mb_strlen PHP function is used if available. If neither are available, the strlen PHP function is used.
minMessage
type: string
default: This value is too short. It should have {{ limit }} characters or more.
The message that will be shown if the underlying value's length is less than the min option.
maxMessage
type: string
default: This value is too long. It should have {{ limit }} characters or less.
The message that will be shown if the underlying value's length is more than the max option.
exactMessage
type: string
default: This value should have exactly {{ limit }} characters.
The message that will be shown if min and max values are equal and the underlying value's length is not exactly this value.