tflori/orm

» API Reference » ORM\Dbal\Column

ORM\Dbal\Column

Table of Contents

• Abstract
• Methods
  • $column->__construct - Column constructor.
  • $column->__get - Get attributes from column
  • $column->getDefault - Get the default value of the column
  • $column->getName - Get the name of the column
  • $column->getNullable - Get the nullable status of the column
  • $column->getType - Determine and return the type
  • $column->hasDefault - Check if default value is given
  • $column->isNullable - Check if the column is nullable
  • Column::registerType - Register $type for describe
  • $column->validate - Check if $value is valid for this type

Abstract

Describes a column of a database table

Methods

ORM\Dbal\Column::__construct

public function __construct(\ORM\Dbal\Dbal $dbal, array $columnDefinition)

Column constructor.

Parameters

ORM\Dbal\Column::__construct

↑ top

ORM\Dbal\Column::__get

public function __get(string $name): mixed

Get attributes from column

Parameters

ORM\Dbal\Column::__get

↑ top

ORM\Dbal\Column::getDefault

public function getDefault(): mixed

Get the default value of the column

ORM\Dbal\Column::getDefault

↑ top

ORM\Dbal\Column::getName

public function getName(): string

Get the name of the column

ORM\Dbal\Column::getName

↑ top

ORM\Dbal\Column::getNullable

public function getNullable(): bool

Get the nullable status of the column

ORM\Dbal\Column::getNullable

↑ top

ORM\Dbal\Column::getType

public function getType(): \ORM\Dbal\Type

Determine and return the type

ORM\Dbal\Column::getType

↑ top

ORM\Dbal\Column::hasDefault

public function hasDefault(): bool

Check if default value is given

ORM\Dbal\Column::hasDefault

↑ top

ORM\Dbal\Column::isNullable

public function isNullable(): bool

Check if the column is nullable

ORM\Dbal\Column::isNullable

↑ top

ORM\Dbal\Column::registerType

public static function registerType(string $type): mixed

Register $type for describe

Parameters

ORM\Dbal\Column::registerType

↑ top

ORM\Dbal\Column::validate

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

Check if $value is valid for this type

Parameters

ORM\Dbal\Column::validate

↑ top