MDB2_Schema
[ class tree: MDB2_Schema ] [ index: MDB2_Schema ] [ all elements ]
Packages:
MDB2
MDB2_Schema


Classes:
MDB2_Schema
MDB2_Schema_Error
MDB2_Schema_Parser
MDB2_Schema_Writer
Files:
clitest.php
Console_TestListener.php
HTML_TestListener.php
MDB2_Schema_testcase.php
Parser.php
Schema.php
test.php
testchoose.php
testUtils.php
Writer.php

Element index for package MDB2_Schema

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

_

_escapeSpecialChars
in file Writer.php, method MDB2_Schema_Writer::_escapeSpecialChars()
    add escapecharacters to all special characters in a string
top

a

alterDatabase
in file Schema.php, method MDB2_Schema::alterDatabase()
    Execute the necessary actions to implement the requested changes in a database structure.
alterDatabaseIndexes
in file Schema.php, method MDB2_Schema::alterDatabaseIndexes()
    Execute the necessary actions to implement the requested changes in the indexes inside a database structure.
alterDatabaseSequences
in file Schema.php, method MDB2_Schema::alterDatabaseSequences()
    Execute the necessary actions to implement the requested changes in the sequences inside a database structure.
alterDatabaseTables
in file Schema.php, method MDB2_Schema::alterDatabaseTables()
    Execute the necessary actions to implement the requested changes in the tables inside a database structure.
apiVersion
in file Schema.php, method MDB2_Schema::apiVersion()
    Return the MDB2 API version
top

c

$count
in file Parser.php, variable MDB2_Schema_Parser::$count
cdataHandler
in file Parser.php, method MDB2_Schema_Parser::cdataHandler()
compareDefinitions
in file Schema.php, method MDB2_Schema::compareDefinitions()
    compare a previous definition with the currenlty parsed definition
compareSequenceDefinitions
in file Schema.php, method MDB2_Schema::compareSequenceDefinitions()
    compare a previous definition with the currenlty parsed definition
compareTableDefinitions
in file Schema.php, method MDB2_Schema::compareTableDefinitions()
    compare a previous definition with the currenlty parsed definition
compareTableFieldsDefinitions
in file Schema.php, method MDB2_Schema::compareTableFieldsDefinitions()
    compare a previous definition with the currenlty parsed definition
compareTableIndexesDefinitions
in file Schema.php, method MDB2_Schema::compareTableIndexesDefinitions()
    compare a previous definition with the currenlty parsed definition
connect
in file Schema.php, method MDB2_Schema::connect()
    Create a new MDB2 connection object and connect to the specified database
createDatabase
in file Schema.php, method MDB2_Schema::createDatabase()
    Create a database space within which may be created database objects
createSequence
in file Schema.php, method MDB2_Schema::createSequence()
    create a sequence
createTable
in file Schema.php, method MDB2_Schema::createTable()
    create a table and inititialize the table if data is available
createTableIndexes
in file Schema.php, method MDB2_Schema::createTableIndexes()
    create a indexes om a table
clitest.php
procedural page clitest.php
Console_TestListener.php
procedural page Console_TestListener.php
top

d

$database_definition
in file Parser.php, variable MDB2_Schema_Parser::$database_definition
$database_definition
in file Schema.php, variable MDB2_Schema::$database_definition
$db
in file Schema.php, variable MDB2_Schema::$db
disconnect
in file Schema.php, method MDB2_Schema::disconnect()
    Log out and disconnect from the database.
dumpDatabase
in file Schema.php, method MDB2_Schema::dumpDatabase()
    Dump a previously parsed database structure in the Metabase schema XML based format suitable for the Metabase parser. This function may optionally dump the database definition with initialization commands that specify the data that is currently present in the tables.
dumpDatabase
in file Writer.php, method MDB2_Schema_Writer::dumpDatabase()
    Dump a previously parsed database structure in the Metabase schema XML based format suitable for the Metabase parser. This function may optionally dump the database definition with initialization commands that specify the data that is currently present in the tables.
dumpDatabaseChanges
in file Schema.php, method MDB2_Schema::dumpDatabaseChanges()
    Dump the changes between two database definitions.
dumpSequence
in file Writer.php, method MDB2_Schema_Writer::dumpSequence()
    dump the structure of a sequence
top

e

$element
in file Parser.php, variable MDB2_Schema_Parser::$element
$elements
in file Parser.php, variable MDB2_Schema_Parser::$elements
$error
in file Parser.php, variable MDB2_Schema_Parser::$error
endHandler
in file Parser.php, method MDB2_Schema_Parser::endHandler()
errorHandler
in file testUtils.php, function errorHandler()
errorHandlerPEAR
in file testUtils.php, function errorHandlerPEAR()
errorMessage
in file Schema.php, method MDB2_Schema::errorMessage()
    Return a textual error message for a MDB2_Schema error code
top

f

$fail_on_invalid_names
in file Parser.php, variable MDB2_Schema_Parser::$fail_on_invalid_names
$field
in file Parser.php, variable MDB2_Schema_Parser::$field
$field_name
in file Parser.php, variable MDB2_Schema_Parser::$field_name
factory
in file Schema.php, method MDB2_Schema::factory()
    Create a new MDB2 object for the specified database type type
top

g

getBacktrace
in file testUtils.php, function getBacktrace()
    Little helper function that gets a backtrace if available
getDefinitionFromDatabase
in file Schema.php, method MDB2_Schema::getDefinitionFromDatabase()
    Attempt to reverse engineer a schema structure from an existing MDB2 This method can be used if no xml schema file exists yet.
getOption
in file Schema.php, method MDB2_Schema::getOption()
    returns the value of an option
getTests
in file testUtils.php, function getTests()
    given a class name it returns an array of test* methods
getWarnings
in file Schema.php, method MDB2_Schema::getWarnings()
    get all warnings in reverse order.
grepForTest
in file testUtils.php, function grepForTest()
    this is used (with array filter) to filter out the test*
top

h

htmlErrorHandler
in file test.php, function htmlErrorHandler()
htmlErrorHandlerPEAR
in file test.php, function htmlErrorHandlerPEAR()
HTML_TestListener.php
procedural page HTML_TestListener.php
top

i

$index
in file Parser.php, variable MDB2_Schema_Parser::$index
$index_name
in file Parser.php, variable MDB2_Schema_Parser::$index_name
$init
in file Parser.php, variable MDB2_Schema_Parser::$init
$init_name
in file Parser.php, variable MDB2_Schema_Parser::$init_name
$init_value
in file Parser.php, variable MDB2_Schema_Parser::$init_value
$invalid_names
in file Parser.php, variable MDB2_Schema_Parser::$invalid_names
initializeTable
in file Schema.php, method MDB2_Schema::initializeTable()
    inititialize the table with data
isBoolean
in file Parser.php, method MDB2_Schema_Parser::isBoolean()
isError
in file Schema.php, method MDB2_Schema::isError()
    Tell whether a value is a MDB2_Schema error.
top

m

MDB2_Schema
in file Schema.php, class MDB2_Schema
    The database manager is a class that provides a set of database management services like installing, altering and dumping the data structures of databases.
MDB2_SCHEMA_DUMP_ALL
in file Schema.php, constant MDB2_SCHEMA_DUMP_ALL
MDB2_SCHEMA_DUMP_CONTENT
in file Schema.php, constant MDB2_SCHEMA_DUMP_CONTENT
MDB2_SCHEMA_DUMP_STRUCTURE
in file Schema.php, constant MDB2_SCHEMA_DUMP_STRUCTURE
MDB2_SCHEMA_ERROR
in file Schema.php, constant MDB2_SCHEMA_ERROR
    The method mapErrorCode in each MDB2_Schema_dbtype implementation maps native error codes to one of these.
MDB2_Schema_Error
in file Schema.php, class MDB2_Schema_Error
    MDB2_Schema_Error implements a class for reporting portable database error messages.
MDB2_Schema_Error
in file Schema.php, method MDB2_Schema_Error::MDB2_Schema_Error()
    MDB2_Schema_Error constructor.
MDB2_SCHEMA_ERROR_INVALID
in file Schema.php, constant MDB2_SCHEMA_ERROR_INVALID
MDB2_SCHEMA_ERROR_NODBSELECTED
in file Schema.php, constant MDB2_SCHEMA_ERROR_NODBSELECTED
MDB2_SCHEMA_ERROR_NOT_CAPABLE
in file Schema.php, constant MDB2_SCHEMA_ERROR_NOT_CAPABLE
MDB2_SCHEMA_ERROR_PARSE
in file Schema.php, constant MDB2_SCHEMA_ERROR_PARSE
MDB2_SCHEMA_ERROR_UNSUPPORTED
in file Schema.php, constant MDB2_SCHEMA_ERROR_UNSUPPORTED
MDB2_Schema_Parser
in file Parser.php, class MDB2_Schema_Parser
    Parses an XML schema file
MDB2_Schema_Parser
in file Parser.php, method MDB2_Schema_Parser::MDB2_Schema_Parser()
MDB2_Schema_Writer
in file Writer.php, class MDB2_Schema_Writer
    Writes an XML schema file
MDB2_Schema_testcase.php
procedural page MDB2_Schema_testcase.php
top

o

$options
in file Schema.php, variable MDB2_Schema::$options
top

p

parseDatabaseDefinitionFile
in file Schema.php, method MDB2_Schema::parseDatabaseDefinitionFile()
    Parse a database definition file by creating a Metabase schema format parser object and passing the file contents as parser input data stream.
PATH_SEPARATOR
in file testchoose.php, constant PATH_SEPARATOR
Parser.php
procedural page Parser.php
top

r

raiseError
in file Writer.php, method MDB2_Schema_Writer::raiseError()
    This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.
raiseError
in file Parser.php, method MDB2_Schema_Parser::raiseError()
raiseError
in file Schema.php, method MDB2_Schema::raiseError()
    This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.
resetWarnings
in file Schema.php, method MDB2_Schema::resetWarnings()
    reset the warning array
top

s

$seq
in file Parser.php, variable MDB2_Schema_Parser::$seq
$seq_name
in file Parser.php, variable MDB2_Schema_Parser::$seq_name
$structure
in file Parser.php, variable MDB2_Schema_Parser::$structure
Schema.php
procedural page Schema.php
setOption
in file Schema.php, method MDB2_Schema::setOption()
    set the option for the db class
startHandler
in file Parser.php, method MDB2_Schema_Parser::startHandler()
top

t

$table
in file Parser.php, variable MDB2_Schema_Parser::$table
$table_name
in file Parser.php, variable MDB2_Schema_Parser::$table_name
testchoose.php
procedural page testchoose.php
testUtils.php
procedural page testUtils.php
test.php
procedural page test.php
testCheck
in file testUtils.php, function testCheck()
    Little helper function that outputs check for boxes with suitable names
top

u

updateDatabase
in file Schema.php, method MDB2_Schema::updateDatabase()
    Compare the correspondent files of two versions of a database schema definition: the previously installed and the one that defines the schema that is meant to update the database.
top

v

$variables
in file Parser.php, variable MDB2_Schema_Parser::$variables
$var_mode
in file Parser.php, variable MDB2_Schema_Parser::$var_mode
validateFieldValue
in file Parser.php, method MDB2_Schema_Parser::validateFieldValue()
verifyAlterDatabase
in file Schema.php, method MDB2_Schema::verifyAlterDatabase()
    verify that the changes requested are supported
top

w

$warnings
in file Schema.php, variable MDB2_Schema::$warnings
Writer.php
procedural page Writer.php
writeInitialization
in file Schema.php, method MDB2_Schema::writeInitialization()
    write initialization and sequences
top
Documentation generated on Sun, 05 Feb 2006 11:33:36 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.