Class: Doctrine_Export_Frontbase

Source Location: /Doctrine/Export/Frontbase.php

Class Doctrine_Export_Frontbase

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail

Doctrine_Export_Frontbase

Located in /Doctrine/Export/Frontbase.php [line 34] 

Doctrine_Connection_Module
   |
   --Doctrine_Export
      |
      --Doctrine_Export_Frontbase
Author(s): Information Tags:
Version:  $Revision$
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Export

Doctrine_Export::$valid_default_values

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::$conn
Doctrine_Connection_Module::$moduleName

Inherited From Doctrine_Export

Doctrine_Export::alterTable()
alter an existing table (this method is implemented by the drivers)
Doctrine_Export::alterTableSql()
generates the sql for altering an existing table (this method is implemented by the drivers)
Doctrine_Export::createConstraint()
create a constraint on a table
Doctrine_Export::createConstraintSql()
create a constraint on a table
Doctrine_Export::createDatabase()
create a new database (this method is implemented by the drivers)
Doctrine_Export::createDatabaseSql()
create a new database (this method is implemented by the drivers)
Doctrine_Export::createForeignKeySql()
createForeignKeySql
Doctrine_Export::createIndex()
Get the stucture of a field into an array
Doctrine_Export::createIndexSql()
Get the stucture of a field into an array
Doctrine_Export::createSequence()
create sequence
Doctrine_Export::createSequenceSql()
return RDBMS specific create sequence statement (this method is implemented by the drivers)
Doctrine_Export::createTable()
create a new table
Doctrine_Export::createTableSql()
create a new table
Doctrine_Export::dropConstraint()
drop existing constraint
Doctrine_Export::dropDatabase()
drop an existing database (this method is implemented by the drivers)
Doctrine_Export::dropDatabaseSql()
drop an existing database (this method is implemented by the drivers)
Doctrine_Export::dropIndex()
drop existing index
Doctrine_Export::dropIndexSql()
dropIndexSql
Doctrine_Export::dropSequence()
dropSequenceSql drop existing sequence (this method is implemented by the drivers)
Doctrine_Export::dropSequenceSql()
dropSequenceSql drop existing sequence
Doctrine_Export::dropTable()
dropTable drop an existing table
Doctrine_Export::dropTableSql()
dropTableSql drop an existing table
Doctrine_Export::exportClasses()
exportClasses method for exporting Doctrine_Record classes to a schema
Doctrine_Export::exportClassesSql()
exportClassesSql method for exporting Doctrine_Record classes to a schema
Doctrine_Export::exportSchema()
exportSchema method for exporting Doctrine_Record classes to a schema
Doctrine_Export::exportSql()
exportSql returns the sql for exporting Doctrine_Record classes to a schema
Doctrine_Export::exportTable()
exportTable exports given table into database based on column and option definitions
Doctrine_Export::getAdvancedForeignKeyOptions()
getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
Doctrine_Export::getCharsetFieldDeclaration()
Obtain DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getCheckDeclaration()
Obtain DBMS specific SQL code portion needed to set a CHECK constraint declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getCollationFieldDeclaration()
Obtain DBMS specific SQL code portion needed to set the COLLATION of a field declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getDeclaration()
Obtain DBMS specific SQL code portion needed to declare a generic type field to be used in statements like CREATE TABLE.
Doctrine_Export::getDefaultFieldDeclaration()
getDefaultDeclaration Obtain DBMS specific SQL code portion needed to set a default value declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getFieldDeclarationList()
Get declaration of a number of field in bulk
Doctrine_Export::getForeignKeyBaseDeclaration()
getForeignKeyBaseDeclaration Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint of a field declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getForeignKeyDeclaration()
getForeignKeyDeclaration Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint of a field declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getForeignKeyReferentialAction()
getForeignKeyReferentialAction
Doctrine_Export::getIndexDeclaration()
Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getIndexFieldDeclarationList()
getIndexFieldDeclarationList Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.
Doctrine_Export::getTemporaryTableQuery()
A method to return the required SQL string that fits between CREATE ... TABLE to create the table as a temporary table.
Doctrine_Export::getUniqueFieldDeclaration()
Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint of a field declaration to be used in statements like CREATE TABLE.

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::__construct()
Doctrine_Connection_Module::getConnection()
getConnection returns the connection object this module uses
Doctrine_Connection_Module::getModuleName()
getModuleName returns the name of this module

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Properties Method Summary | Methods Detail
boolean   alterTable()   alter an existing table
string   createDatabaseSql()   create a new database
void   createSequence()   create sequence
string   dropDatabaseSql()   drop an existing database
boolean   dropIndexSql()   drop existing index
string   dropSequenceSql()   drop existing sequence
string   dropTableSql()   drop an existing table

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Methods
Class Overview | Inherited Properties and Methods | | Properties | Method Summary | Methods Detail
alterTable  [line 160]

  boolean alterTable( string $name, $changes, boolean $check  )

alter an existing table

Parameters:
string   $name:  name of the table that is intended to be changed.
array   $changes: 

associative array that contains the details of each type of change that is intended to be performed. The types of changes that are currently supported are defined as follows:

name

New name for the table.

add

Associative array with the names of fields to be added as indexes of the array. The value of each entry of the array should be set to another associative array with the properties of the fields to be added. The properties of the fields should be the same as defined by the MDB2 parser.

remove

Associative array with the names of fields to be removed as indexes of the array. Currently the values assigned to each entry are ignored. An empty array should be used for future compatibility.

rename

Associative array with the names of fields to be renamed as indexes of the array. The value of each entry of the array should be set to another associative array with the entry named name with the new field name and the entry named Declaration that is expected to contain the portion of the field declaration already in DBMS specific SQL code as it is used in the CREATE TABLE statement.

change

Associative array with the names of the fields to be changed as indexes of the array. Keep in mind that if it is intended to change either the name of a field and any other properties, the change array entries should have the new names of the fields as array indexes.

The value of each entry of the array should be set to another associative array with the properties of the fields to that are meant to be changed as array entries. These entries should be assigned to the new values of the respective properties. The properties of the fields should be the same as defined by the MDB2 parser.

Example array( 'name' => 'userlist', 'add' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 ) ), 'remove' => array( 'file_limit' => array(), 'time_limit' => array() ), 'change' => array( 'name' => array( 'length' => '20', 'definition' => array( 'type' => 'text', 'length' => 20, ), ) ), 'rename' => array( 'sex' => array( 'name' => 'gender', 'definition' => array( 'type' => 'text', 'length' => 1, 'default' => 'M', ), ) ) )
boolean   $check:  indicates whether the function should just check if the DBMS driver can perform the requested table alterations if the value is true or actually perform them otherwise.

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::alterTable()
alter an existing table (this method is implemented by the drivers)

[ Top ]
createDatabaseSql  [line 42]

  string createDatabaseSql( string $name  )

create a new database

Parameters:
string   $name:  name of the database that should be created

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::createDatabaseSql()
create a new database (this method is implemented by the drivers)

[ Top ]
createSequence  [line 258]

  void createSequence( $sequenceName, [string $start = 1], [ $options = array()], string $seqName  )

create sequence

Parameters:
string   $seqName:  name of the sequence to be created
string   $start:  start value of the sequence; default is 1
array   $options:  An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', );
   $sequenceName: 

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::createSequence()
create sequence

[ Top ]
dropDatabaseSql  [line 53]

  string dropDatabaseSql( string $name  )

drop an existing database

Parameters:
string   $name:  name of the database that should be dropped

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::dropDatabaseSql()
drop an existing database (this method is implemented by the drivers)

[ Top ]
dropIndexSql  [line 303]

  boolean dropIndexSql( string $table, string $name  )

drop existing index

Parameters:
string   $table:  name of table that should be used in method
string   $name:  name of the index to be dropped

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::dropIndexSql()
dropIndexSql

[ Top ]
dropSequenceSql  [line 290]

  string dropSequenceSql( string $seqName  )

drop existing sequence

Parameters:
string   $seqName:  name of the sequence to be dropped

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::dropSequenceSql()
dropSequenceSql drop existing sequence

[ Top ]
dropTableSql  [line 65]

  string dropTableSql( string $name, object $this->conns  )

drop an existing table

Parameters:
object   $this->conns:  database object that is extended by this class
string   $name:  name of the table that should be dropped

API Tags:
Access:  public

Redefinition of:
Doctrine_Export::dropTableSql()
dropTableSql drop an existing table

[ Top ]