Docs For Class jDbTable

Class jDbTable

Description

abstract:

Located in /db/jDbTable.class.php (line 15)

Direct descendents

Class	Description
mysqlDbTable
sqlite3DbTable
ociDbTable
sqliteDbTable
pgsqlDbTable
mssqlDbTable

Variable Summary

array $columns

array $indexes

string $name

jDbPrimaryKey $primaryKey

array $references

jDbSchema $schema

array $uniqueKeys

Method Summary

jDbTable __construct (string $name, jDbSchema $schema)

void addColumn (jDbColumn $column)

void addIndex (jDbIndex $index)

void addReference (jDbReference $reference)

void addUniqueKey (jDbUniqueKey $key)

void alterColumn (jDbColumn $column, [ $oldName = ''])

void alterIndex (jDbIndex $index)

void alterReference (jDbReference $reference)

void alterUniqueKey (jDbUniqueKey $key)

void dropColumn ( $name)

void dropIndex ( $indexName)

void dropPrimaryKey ()

void dropReference ( $refName)

void dropUniqueKey ( $indexName)

void getColumn ( $name)

Iterator getColumns ()

void getIndex ( $name)

array getIndexes ()

void getName ()

jDbPrimaryKey|false getPrimaryKey ()

void getReference ( $refName)

array getReferences ()

void getUniqueKey ( $name)

array getUniqueKeys ()

void setPrimaryKey (jDbPrimaryKey $key)

void _addColumn (jDbColumn $new)

void _alterColumn (jDbColumn $old, jDbColumn $new)

void _createIndex (jDbIndex $index)

void _createReference (jDbReference $ref)

void _dropIndex (jDbIndex $index)

void _dropReference (jDbReference $ref)

void _loadColumns ()

void _loadIndexesAndKeys ()

void _loadReferences ()

Variables

array $columns = null (line 30)

var: of jDbColumns. null means "columns are not loaded"
access: protected

array $indexes = null (line 45)

var: list of indexes, jDbIndex. null means "indexes are not loaded"
access: protected

string $name (line 20)

var: the name of the table
access: protected

jDbPrimaryKey $primaryKey = null (line 35)

var: the primary key. null means "primary key is not loaded". false means : no primary key
access: protected

array $references = null (line 50)

var: list of references, jDbReference. null means "references are not loaded"
access: protected

jDbSchema $schema (line 25)

var: the schema which holds the table
access: protected

array $uniqueKeys = null (line 40)

var: list unique keys, jDbUniqueKey. null means "unique key are not loaded"
access: protected

Methods

Constructor __construct (line 56)

jDbTable __construct (string $name, jDbSchema $schema)

string $name: the table name
jDbSchema $schema

addColumn (line 84)

access: public

void addColumn (jDbColumn $column)

jDbColumn $column

addIndex (line 150)

access: public

void addIndex (jDbIndex $index)

jDbIndex $index

addReference (line 225)

access: public

void addReference (jDbReference $reference)

jDbReference $reference

addUniqueKey (line 187)

access: public

void addUniqueKey (jDbUniqueKey $key)

jDbUniqueKey $key

alterColumn (line 89)

access: public

void alterColumn (jDbColumn $column, [ $oldName = ''])

jDbColumn $column
$oldName

alterIndex (line 154)

access: public

void alterIndex (jDbIndex $index)

jDbIndex $index

alterReference (line 229)

access: public

void alterReference (jDbReference $reference)

jDbReference $reference

alterUniqueKey (line 191)

access: public

void alterUniqueKey (jDbUniqueKey $key)

jDbUniqueKey $key

dropColumn (line 100)

access: public

void dropColumn ( $name)

$name

dropIndex (line 163)

access: public

void dropIndex ( $indexName)

$indexName

dropPrimaryKey (line 125)

access: public

void dropPrimaryKey ()

dropReference (line 238)

access: public

void dropReference ( $refName)

$refName

dropUniqueKey (line 200)

access: public

void dropUniqueKey ( $indexName)

$indexName

getColumn (line 77)

access: public

void getColumn ( $name)

$name

getColumns (line 70)

return: on jDbColumn
access: public

Iterator getColumns ()

getIndex (line 142)

access: public

void getIndex ( $name)

$name

getIndexes (line 136)

return: of jDbIndex
access: public

array getIndexes ()

getName (line 62)

access: public

void getName ()

getPrimaryKey (line 109)

return: false if there is no primary key
access: public

jDbPrimaryKey|false getPrimaryKey ()

getReference (line 216)

access: public

void getReference ( $refName)

$refName

getReferences (line 210)

return: of jDbReference
access: public

array getReferences ()

getUniqueKey (line 179)

access: public

void getUniqueKey ( $name)

$name

getUniqueKeys (line 173)

return: of jDbUniqueKey
access: public

array getUniqueKeys ()

setPrimaryKey (line 115)

access: public

void setPrimaryKey (jDbPrimaryKey $key)

jDbPrimaryKey $key

_addColumn (line 249)

abstract:
access: protected

void _addColumn (jDbColumn $new)

jDbColumn $new

Redefined in descendants as:

_alterColumn (line 247)

abstract:
access: protected

void _alterColumn (jDbColumn $old, jDbColumn $new)

jDbColumn $old
jDbColumn $new

Redefined in descendants as:

_createIndex (line 253)

abstract:
access: protected

void _createIndex (jDbIndex $index)

jDbIndex $index

Redefined in descendants as:

_createReference (line 259)

abstract:
access: protected

void _createReference (jDbReference $ref)

jDbReference $ref

Redefined in descendants as:

_dropIndex (line 255)

abstract:
access: protected

void _dropIndex (jDbIndex $index)

jDbIndex $index

Redefined in descendants as:

_dropReference (line 261)

abstract:
access: protected

void _dropReference (jDbReference $ref)

jDbReference $ref

Redefined in descendants as:

_loadColumns (line 245)

abstract:
access: protected

void _loadColumns ()

Redefined in descendants as:

_loadIndexesAndKeys (line 251)

abstract:
access: protected

void _loadIndexesAndKeys ()

Redefined in descendants as:

_loadReferences (line 257)

abstract:
access: protected

void _loadReferences ()

Redefined in descendants as:

Documentation generated on Mon, 26 Oct 2015 21:53:22 +0100 by phpDocumentor 1.4.3