mysqliDbTable
extends jDbTable
in package
Tags
Table of Contents
- $attributes : array<string|int, mixed>
- $columns : array<string|int, jDbColumn>
- $indexes : array<string|int, jDbIndex>
- $name : string
- $primaryKey : jDbPrimaryKey
- $references : array<string|int, jDbReference>
- $schema : jDbSchema
- $uniqueKeys : array<string|int, jDbUniqueKey>
- __construct() : mixed
- addColumn() : bool
- add a column.
- addIndex() : mixed
- addReference() : mixed
- addUniqueKey() : mixed
- alterColumn() : bool
- change a column definition. If the column does not exist, it is created.
- alterIndex() : mixed
- alterReference() : mixed
- alterUniqueKey() : mixed
- dropColumn() : mixed
- dropIndex() : mixed
- dropPrimaryKey() : mixed
- dropReference() : mixed
- dropUniqueKey() : mixed
- getColumn() : null|jDbColumn
- getColumns() : array<string|int, jDbColumn>
- getIndex() : null|jDbIndex
- getIndexes() : array<string|int, jDbIndex>
- getName() : mixed
- getPrimaryKey() : false|jDbPrimaryKey
- getReference() : null|jDbReference
- getReferences() : array<string|int, jDbReference>
- getUniqueKey() : null|jDbUniqueKey
- getUniqueKeys() : array<string|int, jDbUniqueKey>
- setPrimaryKey() : mixed
- _addColumn() : mixed
- _alterColumn() : mixed
- _createConstraint() : mixed
- _createIndex() : mixed
- _createReference() : mixed
- _dropColumn() : mixed
- _dropConstraint() : mixed
- _dropIndex() : mixed
- _dropReference() : mixed
- _loadColumns() : mixed
- _loadIndexesAndKeys() : mixed
- _loadReferences() : mixed
- _loadTableDefinition() : mixed
- _replaceConstraint() : mixed
Properties
$attributes
public
array<string|int, mixed>
$attributes
= array()
$columns
protected
array<string|int, jDbColumn>
$columns
null means "columns are not loaded"
$indexes
protected
array<string|int, jDbIndex>
$indexes
list of indexes. null means "indexes are not loaded"
$name
protected
string
$name
the name of the table
$primaryKey
protected
jDbPrimaryKey
$primaryKey
the primary key. null means "primary key is not loaded". false means : no primary key
$references
protected
array<string|int, jDbReference>
$references
list of references. null means "references are not loaded"
$schema
protected
jDbSchema
$schema
the schema which holds the table
$uniqueKeys
protected
array<string|int, jDbUniqueKey>
$uniqueKeys
list unique keys. null means "unique key are not loaded"
Methods
__construct()
public
__construct(string $name, jDbSchema $schema) : mixed
Parameters
- $name : string
-
the table name
- $schema : jDbSchema
Return values
mixed —addColumn()
add a column.
public
addColumn(jDbColumn $column) : bool
Parameters
- $column : jDbColumn
Return values
bool —true if the column is added, false if not (already there)
addIndex()
public
addIndex(jDbIndex $index) : mixed
Parameters
- $index : jDbIndex
Return values
mixed —addReference()
public
addReference(jDbReference $reference) : mixed
Parameters
- $reference : jDbReference
Return values
mixed —addUniqueKey()
public
addUniqueKey(jDbUniqueKey $key) : mixed
Parameters
- $key : jDbUniqueKey
Return values
mixed —alterColumn()
change a column definition. If the column does not exist, it is created.
public
alterColumn(jDbColumn $column[, string $oldName = '' ][, bool $doNotCreate = false ]) : bool
Parameters
- $column : jDbColumn
-
the colum with its new properties
- $oldName : string = ''
-
the name of the column to change (if the name is changed)
- $doNotCreate : bool = false
-
true if the column shoul dnot be created when it does not exist
Return values
bool —true if changed/created
alterIndex()
public
alterIndex(jDbIndex $index) : mixed
Parameters
- $index : jDbIndex
Return values
mixed —alterReference()
public
alterReference(jDbReference $reference) : mixed
Parameters
- $reference : jDbReference
Return values
mixed —alterUniqueKey()
public
alterUniqueKey(jDbUniqueKey $key) : mixed
Parameters
- $key : jDbUniqueKey
Return values
mixed —dropColumn()
public
dropColumn(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —dropIndex()
public
dropIndex(mixed $indexName) : mixed
Parameters
- $indexName : mixed
Return values
mixed —dropPrimaryKey()
public
dropPrimaryKey() : mixed
Return values
mixed —dropReference()
public
dropReference(mixed $refName) : mixed
Parameters
- $refName : mixed
Return values
mixed —dropUniqueKey()
public
dropUniqueKey(mixed $indexName) : mixed
Parameters
- $indexName : mixed
Return values
mixed —getColumn()
public
getColumn(string $name[, bool $forChange = false ]) : null|jDbColumn
Parameters
- $name : string
- $forChange : bool = false
Return values
null|jDbColumn —getColumns()
public
getColumns() : array<string|int, jDbColumn>
Return values
array<string|int, jDbColumn> —getIndex()
public
getIndex(mixed $name) : null|jDbIndex
Parameters
- $name : mixed
Return values
null|jDbIndex —getIndexes()
public
getIndexes() : array<string|int, jDbIndex>
Return values
array<string|int, jDbIndex> —getName()
public
getName() : mixed
Return values
mixed —getPrimaryKey()
public
getPrimaryKey() : false|jDbPrimaryKey
Return values
false|jDbPrimaryKey —false if there is no primary key
getReference()
public
getReference(mixed $refName) : null|jDbReference
Parameters
- $refName : mixed
Return values
null|jDbReference —getReferences()
public
getReferences() : array<string|int, jDbReference>
Return values
array<string|int, jDbReference> —getUniqueKey()
public
getUniqueKey(mixed $name) : null|jDbUniqueKey
Parameters
- $name : mixed
Return values
null|jDbUniqueKey —getUniqueKeys()
public
getUniqueKeys() : array<string|int, jDbUniqueKey>
Return values
array<string|int, jDbUniqueKey> —setPrimaryKey()
public
setPrimaryKey(jDbPrimaryKey $key) : mixed
Parameters
- $key : jDbPrimaryKey
Return values
mixed —_addColumn()
protected
_addColumn(jDbColumn $new) : mixed
Parameters
- $new : jDbColumn
Return values
mixed —_alterColumn()
protected
_alterColumn(jDbColumn $old, jDbColumn $new) : mixed
Parameters
Return values
mixed —_createConstraint()
protected
_createConstraint(jDbConstraint $constraint) : mixed
Parameters
- $constraint : jDbConstraint
Return values
mixed —_createIndex()
protected
_createIndex(jDbIndex $index) : mixed
Parameters
- $index : jDbIndex
Return values
mixed —_createReference()
protected
_createReference(jDbReference $ref) : mixed
Parameters
- $ref : jDbReference
Return values
mixed —_dropColumn()
protected
_dropColumn(jDbColumn $col) : mixed
Parameters
- $col : jDbColumn
Return values
mixed —_dropConstraint()
protected
_dropConstraint(jDbConstraint $constraint) : mixed
Parameters
- $constraint : jDbConstraint
Return values
mixed —_dropIndex()
protected
_dropIndex(jDbIndex $index) : mixed
Parameters
- $index : jDbIndex
Return values
mixed —_dropReference()
protected
_dropReference(jDbReference $ref) : mixed
Parameters
- $ref : jDbReference
Return values
mixed —_loadColumns()
protected
_loadColumns() : mixed
Return values
mixed —_loadIndexesAndKeys()
protected
_loadIndexesAndKeys() : mixed
Return values
mixed —_loadReferences()
protected
_loadReferences() : mixed
Return values
mixed —_loadTableDefinition()
protected
_loadTableDefinition() : mixed
Return values
mixed —_replaceConstraint()
protected
_replaceConstraint(jDbConstraint $oldConstraint, jDbConstraint $newConstraint) : mixed
Parameters
- $oldConstraint : jDbConstraint
- $newConstraint : jDbConstraint