Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 2.77 KB

MaxLength.rst

File metadata and controls

83 lines (61 loc) · 2.77 KB
Raw

MaxLength

Validates that the length of a string is not larger than the given limit.

Applies to property or method<validation-property-target>
Options
Class Symfony\\Component\\Validator\\Constraints\\MaxLength
Validator Symfony\\Component\\Validator\\Constraints\\MaxLengthValidator

Basic Usage

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Blog:
    properties:
        summary:
            - MaxLength: 100
// src/Acme/BlogBundle/Entity/Blog.php
use Symfony\Component\Validator\Constraints as Assert;

class Blog
{
    /**
     * @Assert\MaxLength(100)
     */
    protected $summary;
}
<!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
<class name="Acme\BlogBundle\Entity\Blog">
    <property name="summary">
        <constraint name="MaxLength">
            <value>100</value>
        </constraint>
    </property>
</class>

Options

limit

type: integer [default option<validation-default-option>]

This required option is the "max" value. Validation will fail if the length of the give string is greater than this number.

message

type: string default: This value is too long. It should have {{ limit }} characters or less

The message that will be shown if the underlying string has a length that is longer than the limit option.

charset

type: charset default: UTF-8

If the PHP extension "mbstring" is installed, then the PHP function mb_strlen will be used to calculate the length of the string. The value of the charset option is passed as the second argument to that function.