WARNING: You are browsing the documentation for Symfony 2.0 which is not maintained anymore. Consider upgrading your projects to Symfony 4.2.

MinLength

2.0 version
Unmaintained

MinLength

Validates that the length of a string is at least as long as the given limit.

Applies to property or method
Options
Class MinLength
Validator MinLengthValidator

Basic Usage

  • YAML
    1
    2
    3
    4
    5
    # src/Acme/BlogBundle/Resources/config/validation.yml
    Acme\BlogBundle\Entity\Blog:
        properties:
            firstName:
                - MinLength: { limit: 3, message: "Your name must have at least {{ limit }} characters." }
    
  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // src/Acme/BlogBundle/Entity/Blog.php
    namespace Acme\BlogBundle\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Blog
    {
        /**
         * @Assert\MinLength(
         *     limit=3,
         *     message="Your name must have at least {{ limit }} characters."
         * )
         */
        protected $summary;
    }
    
  • XML
    1
    2
    3
    4
    5
    6
    7
    8
    9
    <!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
    <class name="Acme\BlogBundle\Entity\Blog">
        <property name="summary">
            <constraint name="MinLength">
                <option name="limit">3</option>
                <option name="message">Your name must have at least {{ limit }} characters.</option>
            </constraint>
        </property>
    </class>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    // src/Acme/BlogBundle/Entity/Blog.php
    namespace Acme\BlogBundle\Entity;
    
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Blog
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('summary', new Assert\MinLength(array(
                'limit'   => 3,
                'message' => 'Your name must have at least {{ limit }} characters.',
            )));
        }
    }
    

Options

limit

type: integer [default option]

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

message

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

The message that will be shown if the underlying string has a length that is shorter 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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.