class Ulid

Validates that a value is a valid Universally Unique Lexicographically Sortable Identifier (ULID).

@author Laurent Clouet <laurent35240@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Symfony\Component\Validator\Constraints\Ulid extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of Ulid

See also

https://github.com/ulid/spec

File

vendor/symfony/validator/Constraints/Ulid.php, line 24

Namespace

Symfony\Component\Validator\Constraints
View source 
class Ulid extends Constraint {
    public const TOO_SHORT_ERROR = '7b44804e-37d5-4df4-9bdd-b738d4a45bb4';
    public const TOO_LONG_ERROR = '9608249f-6da1-4d53-889e-9864b58c4d37';
    public const TOO_LARGE_ERROR = 'df8cfb9a-ce6d-4a69-ae5a-eea7ab6f278b';
    public const INVALID_CHARACTERS_ERROR = 'e4155739-5135-4258-9c81-ae7b44b5311e';
    public const INVALID_FORMAT_ERROR = '34d5cdd7-5aac-4ba0-b9a2-b45e0bab3e2e';
    protected const ERROR_NAMES = [
        self::TOO_SHORT_ERROR => 'TOO_SHORT_ERROR',
        self::TOO_LONG_ERROR => 'TOO_LONG_ERROR',
        self::TOO_LARGE_ERROR => 'TOO_LARGE_ERROR',
        self::INVALID_CHARACTERS_ERROR => 'INVALID_CHARACTERS_ERROR',
        self::INVALID_FORMAT_ERROR => 'INVALID_FORMAT_ERROR',
    ];
    public const FORMAT_BASE_32 = 'base32';
    public const FORMAT_BASE_58 = 'base58';
    public const FORMAT_RFC_4122 = 'rfc4122';
    public string $message = 'This is not a valid ULID.';
    public string $format = self::FORMAT_BASE_32;
    
    /**
     * @param array<string,mixed>|null $options
     * @param string[]|null            $groups
     * @param self::FORMAT_*|null      $format
     */
    public function __construct(?array $options = null, ?string $message = null, ?array $groups = null, mixed $payload = null, ?string $format = null) {
        parent::__construct($options, $groups, $payload);
        $this->message = $message ?? $this->message;
        $this->format = $format ?? $this->format;
        if (!\in_array($this->format, [
            self::FORMAT_BASE_32,
            self::FORMAT_BASE_58,
            self::FORMAT_RFC_4122,
        ], true)) {
            throw new ConstraintDefinitionException(\sprintf('The "%s" validation format is not supported.', $format));
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Constraint::$groups public property The groups that the constraint belongs to.
Constraint::$payload public property Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 2
Constraint::CLASS_CONSTRAINT public constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP public constant The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption public function Returns the name of the default option. 28
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getRequiredOptions public function Returns the name of the required options. 22
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or
both. 		8
Constraint::normalizeOptions protected function
Constraint::PROPERTY_CONSTRAINT public constant Marks a constraint that can be put onto properties.
Constraint::validatedBy public function Returns the name of the class that validates this constraint. 9
Constraint::__get public function Returns the value of a lazily initialized option. 2
Constraint::__isset public function 1
Constraint::__set public function Sets the value of a lazily initialized option. 1
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.
Ulid::$format public property
Ulid::$message public property
Ulid::ERROR_NAMES protected constant Maps error codes to the names of their constants. Overrides Constraint::ERROR_NAMES
Ulid::FORMAT_BASE_32 public constant
Ulid::FORMAT_BASE_58 public constant
Ulid::FORMAT_RFC_4122 public constant
Ulid::INVALID_CHARACTERS_ERROR public constant
Ulid::INVALID_FORMAT_ERROR public constant
Ulid::TOO_LARGE_ERROR public constant
Ulid::TOO_LONG_ERROR public constant
Ulid::TOO_SHORT_ERROR public constant
Ulid::__construct public function Overrides Constraint::__construct