Documentation

rex_sql_table
in package
Uses rex_instance_pool_trait

Class to represent sql tables.

Tags
author

gharlan

Table of Contents

Constants

FIRST  = 'FIRST '

Methods

addColumn()  : $this
addForeignKey()  : $this
addIndex()  : $this
alter()  : void
Alters the table.
clearInstance()  : void
clearInstancePool()  : void
Clears the instance pool.
create()  : void
Creates the table.
drop()  : void
Drops the table if it exists.
ensure()  : void
Ensures that the table exists with the given definition.
ensureColumn()  : $this
ensureForeignKey()  : $this
ensureGlobalColumns()  : $this
ensureIndex()  : $this
ensurePrimaryIdColumn()  : $this
exists()  : bool
get()  : self
getColumn()  : rex_sql_column|null
getColumns()  : array<string|int, rex_sql_column>
getForeignKey()  : rex_sql_foreign_key|null
getForeignKeys()  : array<string|int, rex_sql_foreign_key>
getIndex()  : rex_sql_index|null
getIndexes()  : array<string|int, rex_sql_index>
getName()  : string
getPrimaryKey()  : array<int, string>|null
hasColumn()  : bool
hasForeignKey()  : bool
hasIndex()  : bool
removeColumn()  : $this
removeForeignKey()  : $this
removeIndex()  : $this
renameColumn()  : $this
renameForeignKey()  : $this
renameIndex()  : $this
setName()  : $this
setPrimaryKey()  : $this
addInstance()  : void
Adds an instance.
getInstance()  : static|null
Returns the instance for the given key.
hasInstance()  : bool
Checks whether an instance exists for the given key.

Constants

FIRST

public mixed FIRST = 'FIRST '

Methods

addColumn()

public addColumn(rex_sql_column $column[, string|null $afterColumn = null ]) : $this
Parameters
$column : rex_sql_column
$afterColumn : string|null = null

Column name or rex_sql_table::FIRST

Return values
$this

clearInstance()

public static clearInstance(string|array{: int, : string} $key) : void
Parameters
$key : string|array{: int, : string}

A table-name or a array[db-id, table-name]

clearInstancePool()

Clears the instance pool.

public static clearInstancePool() : void

drop()

Drops the table if it exists.

public drop() : void

ensure()

Ensures that the table exists with the given definition.

public ensure() : void

ensureColumn()

public ensureColumn(rex_sql_column $column[, string|null $afterColumn = null ]) : $this
Parameters
$column : rex_sql_column
$afterColumn : string|null = null

Column name or rex_sql_table::FIRST

Return values
$this

ensureGlobalColumns()

public ensureGlobalColumns([string|null $afterColumn = null ]) : $this
Parameters
$afterColumn : string|null = null

Column name or rex_sql_table::FIRST

Return values
$this

ensurePrimaryIdColumn()

public ensurePrimaryIdColumn() : $this
Return values
$this

exists()

public exists() : bool
Return values
bool

get()

public static get(non-empty-string $name[, positive-int $db = 1 ]) : self
Parameters
$name : non-empty-string
$db : positive-int = 1
Return values
self

getName()

public getName() : string
Return values
string

getPrimaryKey()

public getPrimaryKey() : array<int, string>|null
Return values
array<int, string>|null

Column names

hasColumn()

public hasColumn(string $name) : bool
Parameters
$name : string
Return values
bool

hasForeignKey()

public hasForeignKey(string $name) : bool
Parameters
$name : string
Return values
bool

hasIndex()

public hasIndex(string $name) : bool
Parameters
$name : string
Return values
bool

removeColumn()

public removeColumn(string $name) : $this
Parameters
$name : string
Return values
$this

removeForeignKey()

public removeForeignKey(string $name) : $this
Parameters
$name : string
Return values
$this

removeIndex()

public removeIndex(string $name) : $this
Parameters
$name : string
Return values
$this

renameColumn()

public renameColumn(string $oldName, string $newName) : $this
Parameters
$oldName : string
$newName : string
Tags
throws
rex_exception
Return values
$this

renameForeignKey()

public renameForeignKey(string $oldName, string $newName) : $this
Parameters
$oldName : string
$newName : string
Tags
throws
rex_exception
Return values
$this

renameIndex()

public renameIndex(string $oldName, string $newName) : $this
Parameters
$oldName : string
$newName : string
Tags
throws
rex_exception
Return values
$this

setName()

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setPrimaryKey()

public setPrimaryKey(string|array<int, string>|null $columns) : $this
Parameters
$columns : string|array<int, string>|null

Column name(s)

Tags
throws
rex_exception
Return values
$this

addInstance()

Adds an instance.

protected static addInstance(mixed $key, self $instance) : void
Parameters
$key : mixed

Key

$instance : self

Instance

getInstance()

Returns the instance for the given key.

protected static getInstance(mixed $key[, callable $createCallback = null ]) : static|null

If the instance does not exist it will be created by calling the $createCallback

Parameters
$key : mixed

Key

$createCallback : callable = null

Callback, will be called to create a new instance

Tags
psalm-param

callable(mixed...):?static $createCallback

Return values
static|null

hasInstance()

Checks whether an instance exists for the given key.

protected static hasInstance(mixed $key) : bool
Parameters
$key : mixed

Key

Return values
bool

        
On this page

Search results