Class: SETUPTableDescriptor

Source Location: /setup/admin/setup.php

Class Overview

All information about a table's structure.

Variables

Methods

Class Details

[line 152]
All information about a table's structure.

This class is an "anchor" class that contains descriptors for all necessary elements of a table structure.

[ Top ]

Class Variables

$charset =

[line 192]

This table's default charset.

Tags:

var:	defaults to 'utf8'
access:	public

Type:

string

[ Top ]

$collation =

[line 197]

This table's default collation.

Tags:

var:	defaults to 'utf_general_ci'
access:	public

Type:

string

[ Top ]

$columns = array()

[line 162]

All fields of this table.

Tags:

var:	of SETUPColumnDescriptor
access:	public

Type:

array

[ Top ]

$engine =

[line 187]

This table's database engine.

Tags:

var:	Usually InnoDB
access:	public

Type:

string

[ Top ]

$foreignKeys = array()

[line 182]

All defined foreign key constraints of this table.

Tags:

var:	of SETUPForeignKeyDescriptor
access:	public

Type:

array

[ Top ]

$keys = array()

[line 172]

All defined ordinary keys (indexes) of this table.

Tags:

var:	of SETUPKeyDescriptor
access:	public

Type:

array

[ Top ]

$name =

[line 157]

The table's name.

Tags:

access:

public

Type:

string

[ Top ]

$primaryKey = array()

[line 167]

The fields which are the primary key.

Tags:

var:	of string
access:	public

Type:

array

[ Top ]

$uniqueKeys = array()

[line 177]

All defined unique keys (indexes) of this table.

Tags:

var:	of SETUPUniqueKeyDescriptor
access:	public

Type:

array

[ Top ]

Class Methods

static method extractFields [line 377]

static array extractFields(
string
$fieldDef)

Extracts the field names as array from a comma-separated list of quoted field names.

Allowed characters for field names are "word" characters and minus, i.e. letters, digits, underscore and minus. Exmaple:

`imageID`, `instanceID`, `ownerID`

Tags:

return:

of strings

Parameters:

string

$fieldDef

Comma-separated list of qouted fields without surrounding brackets.

[ Top ]

constructor __construct [line 204]

SETUPTableDescriptor __construct(
string
$createTable)

Constructs from a "CREATE TABLE" statement.

This method cannot parse arbitrary "CREATE TABLE" statements. It is designed to work with the output of "SHOW CREATE TABLE".

Parameters:

string

$createTable

[ Top ]

Documentation generated on Wed, 16 Aug 2006 15:36:44 +0200 by phpDocumentor 1.3.0RC6