Docs For Class atkDDL

Child Class	Description
atkMockDDL	A mock data definition abstraction.
atkMsSqlDDL	MSSQL ddl driver.
atkMysqlDDL	MySQL ddl driver.
atkOci8DDL	Oracle 8i ddl driver.
atkPgsqlDDL	PostgreSQL ddl driver.

[ Top ]

Property Summary

mixed	$m_db
mixed	$m_fields
string	$m_idxnameFormat	Postfix for index names
mixed	$m_indexes
mixed	$m_primarykey
mixed	$m_remove_field
mixed	$m_table

[ Top ]

Method Summary

atkDDL	atkDDL()	Default constructor
void	addField()	Add a field to the table definition.
void	addFields()	Add multiple fields at once using the given metadata.
An	buildAlter()	Build one or more ALTER TABLE queries and return them as an array of strings.
String	buildConstraints()	Convert all constraints to a string that can be used in a CREATE TABLE statement.
The	buildCreate()	Build a CREATE TABLE query and return it as a string.
The	buildDrop()	Build a DROP TABLE query and return it as a string.
void	buildField()	Generate a string for a field, to be used inside a CREATE TABLE statement.
String	buildFields()	Convert all fields to a string that can be used in a CREATE or ALTER TABLE statement.
void	buildPrimaryKey()	Generate a string that defines the primary key, for use inside the CREATE TABLE statement.
string	buildView()	Build CREATE VIEW query
string	calculateDecimalFieldSize()	Calculate the correct field size for decimal fields We should add the decimals to the size, since size is specified including the decimals.
atkDDL	&create()	Static factory method for creating a new atkDDL instance. This static method will determine the database type (mysql, oci, etc) and instantiate the correct DDL class.
boolean	createIndex()	Create an index
void	dropField()	Drop a field from the table definition.
boolean	dropIndex()	Drop an existing index
bool	dropSequence()	Drop sequence
string	dropView()	Build DROP VIEW query
true	executeAlter()	Build and execute ALTER TABLE queries.
true	executeCreate()	Build and execute the CREATE TABLE query.
true	executeCreateView()	Build and execute CREATE VIEW query
true	executeDrop()	Build and execute the DROP TABLE query.
true	executeDropView()	Build and execute DROP VIEW query
void	getGenericType()	Convert an database specific type to an ATK generic datatype.
string	getIndexName()	Get Indexname
void	getType()	Convert an ATK generic datatype to a database specific type.
void	loadMetaData()	Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.
true	needsQuotes()	Method to determine whether quotes are needed around the values for a given generic datatype.
true	needsSize()	Method to determine whether a given generic field type needs to have a size defined.
bool	renameSequence()	Rename sequence
bool	renameTable()	Rename table name
void	setTable()	Set the name of the table.
An	_buildConstraintsArray()	Convert all constraints to an array that can be used in a CREATE or ALTER TABLE statement.
void	_buildFieldsArray()	Convert all fields to string that can be used in a CREATE or ALTER TABLE statement. Fields will be returned in an array. (INTERNAL USE ONLY)

[ Top ]

Properties

mixed $m_db [line 46]

[ Top ]

mixed $m_fields = array() [line 42]

[ Top ]

string $m_idxnameFormat = "%s_idx" [line 54]

Postfix for index names

API Tags:

Access:

protected

[ Top ]

mixed $m_indexes = array() [line 44]

[ Top ]

mixed $m_primarykey = array() [line 45]

[ Top ]

mixed $m_remove_field [line 43]

[ Top ]

mixed $m_table = array() [line 41]

[ Top ]

Methods

Constructor atkDDL [line 61]

atkDDL atkDDL(
)

Default constructor

[ Top ]

addField [line 116]

void addField(
string
$name, string
$generictype, [int
$size = 0], [int
$flags = 0], [mixed
$default = NULL] 
)

Add a field to the table definition.

Parameters:

string	$name:	The name of the field
string	$generictype:	The datatype of the field (should be one of the generic types supported by ATK).
int	$size:	The size of the field (if appropriate)
int	$flags:	The DDL_ flags for this field.
mixed	$default:	The default value to be used when inserting new rows.

[ Top ]

addFields [line 169]

void addFields(
array
$meta 
)

Add multiple fields at once using the given metadata.

NOTE: defaults are not supported yet!

Parameters:

array

$meta:

The fields meta data.

[ Top ]

buildAlter [line 267]

An buildAlter(
)

Build one or more ALTER TABLE queries and return them as an array of strings.

The default implementation assumes that multiple fields can be added with one single ALTER TABLE statement. If a database needs to be supported which doesn't have this ability, then an override for this function should be implemented in the appropriate atk<database>ddl class.

API Tags:

Return:

array of ALTER TABLE queries.

Redefined in descendants as:

atkPgsqlDDL::buildAlter() : Build one or more ALTER TABLE queries and return them as an array of strings.

[ Top ]

buildConstraints [line 473]

String buildConstraints(
)

Convert all constraints to a string that can be used in a CREATE TABLE statement.

API Tags:

Return:

containing constraints to be used in a CREATE or ALTER TABLE statement

[ Top ]

buildCreate [line 230]

The buildCreate(
)

Build a CREATE TABLE query and return it as a string.

API Tags:

Return:

CREATE TABLE query.

Redefined in descendants as:

atkMysqlDDL::buildCreate() : Build a CREATE TABLE query and return it as a string.

[ Top ]

buildDrop [line 308]

The buildDrop(
)

Build a DROP TABLE query and return it as a string.

API Tags:

Return:

DROP TABLE query.

[ Top ]

buildField [line 334]

void buildField(
string
$name, string
$generictype, [int
$size = 0], [int
$flags = 0], [mixed
$default = NULL] 
)

Generate a string for a field, to be used inside a CREATE TABLE statement.

This function tries to be generic, so it will work in the largest number of databases. Databases that won't work with this syntax, should override this method in the database specific ddl class.

Parameters:

string	$name:	The name of the field
string	$generictype:	The datatype of the field (should be one of the generic types supported by ATK).
int	$size:	The size of the field (if appropriate)
int	$flags:	The DDL_ flags for this field.
mixed	$default:	The default value to be used when inserting new rows.

Redefined in descendants as:

atkMysqlDDL::buildField() : Generate a string for a field, to be used inside a CREATE TABLE statement.

[ Top ]

buildFields [line 444]

String buildFields(
)

Convert all fields to a string that can be used in a CREATE or ALTER TABLE statement.

API Tags:

Return:

containing fields to be used in a CREATE or ALTER TABLE statement

[ Top ]

buildPrimaryKey [line 366]

void buildPrimaryKey(
[array
$fieldlist = array()] 
)

Generate a string that defines the primary key, for use inside the CREATE TABLE statement.

This function will be overrided by the database specific subclasses of atkDDL.

Parameters:

array

$fieldlist:

An array of fields that define the primary key.

[ Top ]

buildView [line 593]

string buildView(
string
$name, string
$select, string
$with_check_option 
)

Build CREATE VIEW query

Parameters:

string	$name:	- name of view
string	$select:	- SQL SELECT statement
string	$with_check_option:	- use SQL WITH CHECK OPTION

API Tags:

Return:

CREATE VIEW query string

Redefined in descendants as:

atkMysqliDDL::buildView() : Build CREATE VIEW query

[ Top ]

calculateDecimalFieldSize [line 144]

string calculateDecimalFieldSize(
string
$size 
)

Calculate the correct field size for decimal fields We should add the decimals to the size, since size is specified including the decimals.

Parameters:

string

$size:

Current size

API Tags:

Return:

New size

[ Top ]

create [line 73]

atkDDL &create(
[String
$database = NULL] 
)

Static factory method for creating a new atkDDL instance. This static method will determine the database type (mysql, oci, etc) and instantiate the correct DDL class.

Parameters:

String

$database:

The database driver to use

API Tags:

Return:

instance of db specific DDL driver

[ Top ]

createIndex [line 649]

boolean createIndex(
string
$name, array
$definition 
)

Create an index

Parameters:

string	$name:	Index name
array	$definition:	associative array that defines properties of the index to be created. example array('fields' => array('user_id' => array('sorting' => 'ascending' 'length' => 3 ), 'lastname' => array() ) )

[ Top ]

dropField [line 157]

void dropField(
string
$name 
)

Drop a field from the table definition.

Parameters:

string

$name:

The name of the field

[ Top ]

dropIndex [line 678]

boolean dropIndex(
string
$name 
)

Drop an existing index

Parameters:

string

$name:

Index name

[ Top ]

dropSequence [line 715]

bool dropSequence(
string
$name 
)

Drop sequence

Parameters:

string

$name:

Sequence name

Redefined in descendants as:

atkMysqlDDL::dropSequence() : Drop sequence

[ Top ]

dropView [line 628]

string dropView(
string
$name 
)

Build DROP VIEW query

Parameters:

string

$name:

- name of view

API Tags:

Return:

CREATE VIEW query string

Redefined in descendants as:

atkMysqliDDL::dropView() : Build DROP VIEW query

[ Top ]

executeAlter [line 514]

true executeAlter(
)

Build and execute ALTER TABLE queries.

Note that more than one query might be performed, depending on the number of fields added, and the database capabilities (some databases are capable of adding several fields in one ALTER TABLE query, others aren't and need to perform multiple queries).

API Tags:

Return:

if the table was altered successfully false if anything went wrong, or if no table could be altered.

[ Top ]

executeCreate [line 487]

true executeCreate(
)

Build and execute the CREATE TABLE query.

API Tags:

Return:

if the table was created successfully false if anything went wrong, or if no table could be created.

[ Top ]

executeCreateView [line 569]

true executeCreateView(
string
$name, string
$select, string
$with_check_option 
)

Build and execute CREATE VIEW query

Parameters:

string	$name:	- name of view
string	$select:	- SQL SELECT statement
string	$with_check_option:	- use SQL WITH CHECK OPTION

API Tags:

Return:

if view create successfully false if error take place

[ Top ]

executeDrop [line 544]

true executeDrop(
)

Build and execute the DROP TABLE query.

API Tags:

Return:

if the table was dropped successfully false if anything went wrong, or if no table could be dropped.

[ Top ]

executeDropView [line 606]

true executeDropView(
string
$name 
)

Build and execute DROP VIEW query

Parameters:

string

$name:

- name of view

API Tags:

Return:

if view create successfully false if error take place

[ Top ]

getGenericType [line 210]

void getGenericType(
string
$type 
)

Convert an database specific type to an ATK generic datatype.

This function will be overrided by the database specific subclasses of atkDb.

Parameters:

string

$type:

The database specific datatype to convert.

API Tags:

Abstract:

Redefined in descendants as:

atkMsSqlDDL::getGenericType() : Convert an database specific type to an ATK generic datatype.
atkMysqlDDL::getGenericType() : Convert an database specific type to an ATK generic datatype.
atkMysqliDDL::getGenericType() : Convert an database specific type to an ATK generic datatype.
atkOci8DDL::getGenericType() : Convert an database specific type to an ATK generic datatype.
atkPgsqlDDL::getGenericType() : Convert an database specific type to an ATK generic datatype.

[ Top ]

getIndexName [line 692]

string getIndexName(
string
$name 
)

Get Indexname

Parameters:

string

$name:

Indexname

[ Top ]

getType [line 196]

void getType(
string
$generictype 
)

Convert an ATK generic datatype to a database specific type.

This function will be overrided by the database specific subclasses of atkDb. Note: in all derived subclasses, the following types *must* be supported: number, decimal, string, date, text, datetime, time, boolean. If the database does not have a proper field type, consider using a varchar or number to store the value.

Parameters:

string

$generictype:

The datatype to convert.

API Tags:

Abstract:

Redefined in descendants as:

atkMsSqlDDL::getType() : Convert an ATK generic datatype to a database specific type.
atkMysqlDDL::getType() : Convert an ATK generic datatype to a database specific type.
atkOci8DDL::getType() : Convert an ATK generic datatype to a database specific type.
atkPgsqlDDL::getType() : Convert an ATK generic datatype to a database specific type.

[ Top ]

loadMetaData [line 99]

void loadMetaData(
array
$tablemeta 
)

Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

Parameters:

array

$tablemeta:

table meta data array

Redefined in descendants as:

atkMysqlDDL::loadMetaData() : Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

[ Top ]

needsQuotes [line 384]

true needsQuotes(
string
$generictype 
)

Method to determine whether quotes are needed around the values for a given generic datatype.

Parameters:

string

$generictype:

The type of field.

API Tags:

Return:

if quotes should be put around values for the given type of field. false if quotes should not be used.

[ Top ]

needsSize [line 397]

true needsSize(
string
$generictype 
)

Method to determine whether a given generic field type needs to have a size defined.

Parameters:

string

$generictype:

The type of field.

API Tags:

Return:

if a size should be specified for the given field type. false if a size does not have to be specified.

Redefined in descendants as:

atkPgsqlDDL::needsSize() : Method to determine whether a given generic field type needs to have a size defined.

[ Top ]

renameSequence [line 704]

bool renameSequence(
string
$name, string
$new_name 
)

Rename sequence

Parameters:

string	$name:	The current sequence name
string	$new_name:	The new sequence name

Redefined in descendants as:

atkMysqlDDL::renameSequence() : Rename sequence

[ Top ]

renameTable [line 727]

bool renameTable(
string
$name, string
$new_name 
)

Rename table name

Parameters:

string	$name:	Table name
string	$new_name:	New table name

Redefined in descendants as:

atkMysqlDDL::renameTable() : Rename table name

[ Top ]

setTable [line 220]

void setTable(
string
$tablename 
)

Set the name of the table.

Parameters:

string

$tablename:

The name of the table

[ Top ]

_buildConstraintsArray [line 459]

An _buildConstraintsArray(
)

Convert all constraints to an array that can be used in a CREATE or ALTER TABLE statement.

API Tags:

Return:	array of constraints
Access:	private

[ Top ]

_buildFieldsArray [line 423]

void _buildFieldsArray(
)

Convert all fields to string that can be used in a CREATE or ALTER TABLE statement. Fields will be returned in an array. (INTERNAL USE ONLY)

API Tags:

Access:

private

[ Top ]