Class Overview

class Doctrine_Import Main responsible of performing import operation. Delegates database schema reading to a reader object and passes the result to a builder object which builds a Doctrine data model.

Located in /Doctrine/Import.php [line 37]

Doctrine_Connection_Module
   |
   --Doctrine_Import

Author(s):

Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
Konsta Vesterinen <kvesteri@cc.hut.fi>

Information Tags:

Version:	$Revision: 2255 $
Link:	www.phpdoctrine.com
Since:	1.0
License:	LGPL

Properties

$sql

Methods

[ Top ]

Direct descendents

Child Class	Description
Doctrine_Import_Firebird
Doctrine_Import_Informix
Doctrine_Import_Mssql
Doctrine_Import_Mysql
Doctrine_Import_Oracle
Doctrine_Import_Pgsql
Doctrine_Import_Sqlite

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From Doctrine_Connection_Module Doctrine_Connection_Module::$conn Doctrine_Connection_Module::$moduleName	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

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::$conn

Doctrine_Connection_Module::$moduleName

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 ]

Property Summary

mixed

$sql

[ Top ]

Method Summary

array	importSchema()	importSchema
array	listDatabases()	lists all databases
array	listFunctions()	lists all availible database functions
array	listSequences()	lists all database sequences
array	listTableColumns()	lists table constraints
array	listTableConstraints()	lists table constraints
array	listTableIndexes()	lists table constraints
array	listTables()	lists tables
array	listTableTriggers()	lists table triggers
array	listTableViews()	lists table views
array	listTriggers()	lists all database triggers
array	listUsers()	lists database users
array	listViews()	lists database views

[ Top ]

Properties

mixed $sql = array() [line 39]

API Tags:

Access:

protected

Redefined in descendants as:

[ Top ]

Methods

importSchema [line 186]

array importSchema(
string
$directory, [
$databases = array()] 
)

importSchema

method for importing existing schema to Doctrine_Record classes

Parameters:

string	$directory:
array	$databases:

API Tags:

Return:	the names of the imported classes
Access:	public

[ Top ]

listDatabases [line 45]

array listDatabases(
)

lists all databases

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Oracle::listDatabases() : lists all databases
Doctrine_Import_Sqlite::listDatabases() : lists all databases

[ Top ]

listFunctions [line 58]

array listFunctions(
)

lists all availible database functions

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Firebird::listFunctions() : list all functions in the current database
Doctrine_Import_Oracle::listFunctions() : lists all availible database functions
Doctrine_Import_Sqlite::listFunctions() : lists all availible database functions

[ Top ]

listSequences [line 82]

array listSequences(
[string|null
$database = null] 
)

lists all database sequences

Parameters:

string|null

$database:

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Mssql::listSequences() : lists all database sequences
Doctrine_Import_Mysql::listSequences() : lists all database sequences
Doctrine_Import_Oracle::listSequences() : lists all database sequences
Doctrine_Import_Sqlite::listSequences() : lists all database sequences

[ Top ]

listTableColumns [line 106]

array listTableColumns(
string
$table 
)

lists table constraints

Parameters:

string

$table:

database table name

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Mssql::listTableColumns() : lists table constraints
Doctrine_Import_Mysql::listTableColumns() : lists table constraints
Doctrine_Import_Oracle::listTableColumns() : lists table constraints
Doctrine_Import_Pgsql::listTableColumns() : lists table constraints
Doctrine_Import_Sqlite::listTableColumns() : lists table constraints

[ Top ]

listTableConstraints [line 96]

array listTableConstraints(
string
$table 
)

lists table constraints

Parameters:

string

$table:

database table name

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Mysql::listTableConstraints() : lists table constraints
Doctrine_Import_Oracle::listTableConstraints() : lists table constraints
Doctrine_Import_Pgsql::listTableConstraints() : lists table constraints
Doctrine_Import_Sqlite::listTableConstraints() : lists table constraints

[ Top ]

listTableIndexes [line 116]

array listTableIndexes(
string
$table 
)

lists table constraints

Parameters:

string

$table:

database table name

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Mssql::listTableIndexes() : lists table constraints
Doctrine_Import_Mysql::listTableIndexes() : lists table constraints
Doctrine_Import_Oracle::listTableIndexes() : lists table constraints
Doctrine_Import_Pgsql::listTableIndexes() : list all indexes in a table
Doctrine_Import_Sqlite::listTableIndexes() : lists table constraints

[ Top ]

listTables [line 126]

array listTables(
[string|null
$database = null] 
)

lists tables

Parameters:

string|null

$database:

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Firebird::listTables() : list all tables in the current database
Doctrine_Import_Mssql::listTables() : lists tables
Doctrine_Import_Mysql::listTables() : lists tables
Doctrine_Import_Oracle::listTables() : lists tables
Doctrine_Import_Pgsql::listTables() : lists tables
Doctrine_Import_Sqlite::listTables() : lists tables

[ Top ]

listTableTriggers [line 136]

array listTableTriggers(
string
$table 
)

lists table triggers

Parameters:

string

$table:

database table name

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Firebird::listTableTriggers() : This function will be called to get all triggers of the current database ($this->conn->getDatabase())
Doctrine_Import_Mssql::listTableTriggers() : lists table triggers
Doctrine_Import_Oracle::listTableTriggers() : lists table triggers
Doctrine_Import_Pgsql::listTableTriggers() : lists table triggers
Doctrine_Import_Sqlite::listTableTriggers() : lists table triggers

[ Top ]

listTableViews [line 146]

array listTableViews(
string
$table 
)

lists table views

Parameters:

string

$table:

database table name

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Firebird::listTableViews() : list the views in the database that reference a given table
Doctrine_Import_Mssql::listTableViews() : lists table views
Doctrine_Import_Oracle::listTableViews() : lists table views
Doctrine_Import_Pgsql::listTableViews() : list the views in the database that reference a given table
Doctrine_Import_Sqlite::listTableViews() : lists table views

[ Top ]

listTriggers [line 72]

array listTriggers(
[string|null
$database = null] 
)

lists all database triggers

Parameters:

string|null

$database:

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Mssql::listTriggers() : lists all triggers
Doctrine_Import_Oracle::listTriggers() : lists all database triggers
Doctrine_Import_Pgsql::listTriggers() : lists all database triggers
Doctrine_Import_Sqlite::listTriggers() : lists all database triggers

[ Top ]

listUsers [line 155]

array listUsers(
)

lists database users

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Firebird::listUsers() : list all users
Doctrine_Import_Oracle::listUsers() : lists database users
Doctrine_Import_Sqlite::listUsers() : lists database users

[ Top ]

listViews [line 169]

array listViews(
[string|null
$database = null] 
)

lists database views

Parameters:

string|null

$database:

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Import_Firebird::listViews() : list the views in the database
Doctrine_Import_Mssql::listViews() : lists database views
Doctrine_Import_Mysql::listViews() : lists database views
Doctrine_Import_Oracle::listViews() : lists database views
Doctrine_Import_Sqlite::listViews() : lists database views

[ Top ]

Class: Doctrine_Import

Class Doctrine_Import