tflori/orm

» API Reference » ORM\Dbal\Type\Enum

ORM\Dbal\Type\Enum

Table of Contents

• Abstract
• Methods
  • $enum->__construct - Set constructor
  • Enum::factory - Returns a new Type object
  • Enum::fits - Check if this type fits to $columnDefinition
  • $enum->getAllowedValues -
  • $enum->validate - Check if $value is valid for this type

Abstract

Extends: ORM\Dbal\Type

Enum data type

Methods

ORM\Dbal\Type\Enum::__construct

public function __construct(string[] $allowedValues)

Set constructor

Parameters

ORM\Dbal\Type\Enum::__construct

↑ top

ORM\Dbal\Type\Enum::factory

public static function factory(
    \ORM\Dbal\Dbal $dbal, 
    array $columnDefinition, 
): static

Returns a new Type object

This method is only for types covered by mapping. Use fromDefinition instead for custom types.

Parameters

ORM\Dbal\Type\Enum::factory

↑ top

ORM\Dbal\Type\Enum::fits

public static function fits(array $columnDefinition): bool

Check if this type fits to $columnDefinition

Parameters

ORM\Dbal\Type\Enum::fits

↑ top

ORM\Dbal\Type\Enum::getAllowedValues

public function getAllowedValues(): string[]

ORM\Dbal\Type\Enum::getAllowedValues

↑ top

ORM\Dbal\Type\Enum::validate

public function validate(mixed $value): bool|\ORM\Dbal\Error

Check if $value is valid for this type

Parameters

ORM\Dbal\Type\Enum::validate

↑ top