TableDefinition class

Framework\Database\Definition\Table\TableDefinition

Class TableDefinition.

Extends Framework\Database\Definition\Table\DefinitionPart

Defined in libraries/database/src/Definition/Table/TableDefinition.php

Properties #

$database
-
$columns
-
$indexes
-
$checks
-
$condition
-

$database

protected \Framework\Database\Database $database

$columns

protected array $columns = array ( )

$indexes

protected array $indexes = array ( )

$checks

protected array $checks = array ( )

$condition

protected ?string $condition = NULL

Methods #

__construct()
TableDefinition constructor.
check()
Adds a check constraint to the Table Definition list.
column()
Adds a column to the Table Definition list.
index()
Adds an index to the Table Definition list.
renderChecks()
-
renderColumns()
-
renderIndexes()
-
sql()
-

__construct()

public function __construct(\Framework\Database\Database $database, ?string $condition = NULL)

TableDefinition constructor.

Parameters
  • \Framework\Database\Database $database
  • ?string $condition

check()

public function check(Closure $expression): \Framework\Database\Definition\Table\Check

Adds a check constraint to the Table Definition list.

Parameters
  • Closure $expression - Must return a string with the check expression. The function receives a Database instance in the first parameter.
Returns \Framework\Database\Definition\Table\Check

column()

public function column(string $name, ?string $changeName = NULL): \Framework\Database\Definition\Table\Columns\ColumnDefinition

Adds a column to the Table Definition list.

Parameters
  • string $name - Column name
  • ?string $changeName - New column name. Used on ALTER TABLE CHANGE
Returns \Framework\Database\Definition\Table\Columns\ColumnDefinition

index()

public function index(?string $name = NULL): \Framework\Database\Definition\Table\Indexes\IndexDefinition

Adds an index to the Table Definition list.

Parameters
  • ?string $name - Index name
Returns \Framework\Database\Definition\Table\Indexes\IndexDefinition

renderChecks()

protected function renderChecks(): string
Returns string

renderColumns()

protected function renderColumns(?string $prefix = NULL): string
Parameters
  • ?string $prefix
Returns string

renderIndexes()

protected function renderIndexes(?string $prefix = NULL): string
Parameters
  • ?string $prefix
Returns string

sql()

protected function sql(?string $prefix = NULL): string
Parameters
  • ?string $prefix
Returns string

Inherited methods #