Дата обновления перевода 2021-09-29

ULID

New in version 5.2: Валидатор ULID был представлен в Symfony 5.2.

Валидирует, что значение является валидным Универсально-уникальным лексикографически сортируемым идентификатором (ULID).

Применяется свойство или метод
к опциям
Класс Ulid
Валидатор UlidValidator

Базовое использование

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    // src/Entity/File.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class File
    {
        /**
         * @Assert\Ulid
         */
        protected $identifier;
    }
    
  • Attributes
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    // src/Entity/File.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class File
    {
        #[Assert\Ulid]
        protected $identifier;
    }
    
  • YAML
    1
    2
    3
    4
    5
    # config/validator/validation.yaml
    App\Entity\File:
        properties:
            identifier:
                - Ulid: ~
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    <!-- config/validator/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    
        <class name="App\Entity\File">
            <property name="identifier">
                <constraint name="Ulid"/>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    // src/Entity/File.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class File
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('identifier', new Assert\Ulid());
        }
    }
    

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Опции

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

message

тип: string по умолчанию: Это не является валидным ULID.

Это сообщение отображается, когда строка не является валидным ULID.

Вы можете использовать следующие параметры в этом сообщении:

Параметр Описание
{{ value }} Текущее значение (invalid)
{{ label }} Соответствующий ярлык поля формы

normalizer

type: a PHP callable default: null

This option allows to define the PHP callable applied to the given value before checking if it is valid.

For example, you may want to pass the 'trim' string to apply the trim PHP function in order to ignore leading and trailing whitespace during validation.

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.

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.