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


Classes:
MDB2_Schema
MDB2_Schema_Error
MDB2_Schema_Example
MDB2_Schema_Parser
MDB2_Schema_Parser2
MDB2_Schema_Tool
MDB2_Schema_Tool_ParameterException
MDB2_Schema_Validate
MDB2_Schema_Writer
Files:
action.php
class.inc.php
ibase.php
index.php
mssql.php
mysql.php
oci8.php
ParameterException.php
parse.php
Parser.php
Parser2.php
pgsql.php
result.php
Schema.php
Tool.php
Validate.php
Writer.php

Element index for package MDB2_Schema

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ 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
__construct
in file Writer.php, method MDB2_Schema_Writer::__construct()
    PHP 5 constructor
__construct
in file Validate.php, method MDB2_Schema_Validate::__construct()
    PHP 5 constructor
__construct
in file Tool.php, method MDB2_Schema_Tool::__construct()
    Run the schema tool
__construct
in file Parser2.php, method MDB2_Schema_Parser2::__construct()
    PHP 5 constructor
__construct
in file Schema.php, method MDB2_Schema_Error::__construct()
    MDB2_Schema_Error constructor.
__construct
in file Parser.php, method MDB2_Schema_Parser::__construct()
    PHP 5 constructor
top

a

$action
in file class.inc.php, variable MDB2_Schema_Example::$action
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
arrayMergeClobber
in file Schema.php, method MDB2_Schema::arrayMergeClobber()
    Clobbers two arrays together
action.php
procedural page action.php
top

b

buildFieldValue
in file Schema.php, method MDB2_Schema::buildFieldValue()
    Appends the contents of second argument + '=' to the beginning of first argument.
top

c

$constraint
in file Parser2.php, variable MDB2_Schema_Parser2::$constraint
$constraint
in file Parser.php, variable MDB2_Schema_Parser::$constraint
$constraint_name
in file Parser2.php, variable MDB2_Schema_Parser2::$constraint_name
$constraint_name
in file Parser.php, variable MDB2_Schema_Parser::$constraint_name
$count
in file Parser.php, variable MDB2_Schema_Parser::$count
compareDefinitions
in file Schema.php, method MDB2_Schema::compareDefinitions()
    Compare a previous definition with the currently parsed definition
compareSequenceDefinitions
in file Schema.php, method MDB2_Schema::compareSequenceDefinitions()
    Compare a previous definition with the currently parsed definition
compareTableDefinitions
in file Schema.php, method MDB2_Schema::compareTableDefinitions()
    Compare a previous definition with the currently parsed definition
compareTableFieldsDefinitions
in file Schema.php, method MDB2_Schema::compareTableFieldsDefinitions()
    Compare a previous definition with the currently parsed definition
compareTableIndexesDefinitions
in file Schema.php, method MDB2_Schema::compareTableIndexesDefinitions()
    Compare a previous definition with the currently 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
createTableConstraints
in file Schema.php, method MDB2_Schema::createTableConstraints()
    A method to create foreign keys for an existing table
createTableIndexes
in file Schema.php, method MDB2_Schema::createTableIndexes()
    A method to create indexes for an existing table
class.inc.php
procedural page class.inc.php
top

d

$database_definition
in file Parser2.php, variable MDB2_Schema_Parser2::$database_definition
$database_definition
in file Parser.php, variable MDB2_Schema_Parser::$database_definition
$database_loaded
in file Parser2.php, variable MDB2_Schema_Parser2::$database_loaded
$db
in file Schema.php, variable MDB2_Schema::$db
$disable_query
in file class.inc.php, variable MDB2_Schema_Example::$disable_query
$dsn
in file class.inc.php, variable MDB2_Schema_Example::$dsn
$dumptype
in file class.inc.php, variable MDB2_Schema_Example::$dumptype
disconnect
in file Schema.php, method MDB2_Schema::disconnect()
    Log out and disconnect from the database.
doDump
in file Tool.php, method MDB2_Schema_Tool::doDump()
    Creates a database schema dump and sends it to stdout
doHelp
in file Tool.php, method MDB2_Schema_Tool::doHelp()
    Displays generic help to stdout
doHelpDump
in file Tool.php, method MDB2_Schema_Tool::doHelpDump()
    Displays the help screen for "dump" command
doHelpInit
in file Tool.php, method MDB2_Schema_Tool::doHelpInit()
    Displays the help screen for "init" command
doHelpLoad
in file Tool.php, method MDB2_Schema_Tool::doHelpLoad()
    Displays the help screen for "load" command
doInit
in file Tool.php, method MDB2_Schema_Tool::doInit()
    Initializes a database with data
doLoad
in file Tool.php, method MDB2_Schema_Tool::doLoad()
    Loads a database schema
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 Parser2.php, variable MDB2_Schema_Parser2::$error
$error
in file Parser.php, variable MDB2_Schema_Parser::$error
errorMessage
in file Schema.php, method MDB2_Schema::errorMessage()
    Return a textual error message for a MDB2 error code
top

f

$fail_on_invalid_names
in file Validate.php, variable MDB2_Schema_Validate::$fail_on_invalid_names
$field
in file Parser.php, variable MDB2_Schema_Parser::$field
$field
in file Parser2.php, variable MDB2_Schema_Parser2::$field
$field_name
in file Parser.php, variable MDB2_Schema_Parser::$field_name
$field_name
in file Parser2.php, variable MDB2_Schema_Parser2::$field_name
$file
in file class.inc.php, variable MDB2_Schema_Example::$file
$force_defaults
in file Validate.php, variable MDB2_Schema_Validate::$force_defaults
factory
in file Schema.php, method MDB2_Schema::factory()
    Create a new MDB2 object for the specified database type type
factory
in file class.inc.php, method MDB2_Schema_Example::factory()
    Creates a MDB2_Schema_Example instance
top

g

getAction
in file Tool.php, method MDB2_Schema_Tool::getAction()
    Reads the first parameter from the argument array and returns the action.
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.
getExpression
in file Schema.php, method MDB2_Schema::getExpression()
    Generates a string that represents a value that would be associated with a column in a DML instruction.
getFileOrDsn
in file Tool.php, method MDB2_Schema_Tool::getFileOrDsn()
    Loads a file or a dsn from the arguments
getInstructionFields
in file Schema.php, method MDB2_Schema::getInstructionFields()
    Walks the parsed DML instruction array, field by field, storing them and their processed values inside a new array.
getInstructionWhere
in file Schema.php, method MDB2_Schema::getInstructionWhere()
    Translates the parsed WHERE expression of a DML instruction (array structure) to a SQL WHERE clause (string).
getOperator
in file Schema.php, method MDB2_Schema::getOperator()
    Returns the matching SQL operator
getOption
in file Schema.php, method MDB2_Schema::getOption()
    returns the value of an option
getSchemaOptions
in file Tool.php, method MDB2_Schema_Tool::getSchemaOptions()
    Returns an array of options for MDB2_Schema constructor
getWarnings
in file Schema.php, method MDB2_Schema::getWarnings()
    Get all warnings in reverse order
top

i

$index
in file Parser2.php, variable MDB2_Schema_Parser2::$index
$index
in file Parser.php, variable MDB2_Schema_Parser::$index
$index_name
in file Parser2.php, variable MDB2_Schema_Parser2::$index_name
$index_name
in file Parser.php, variable MDB2_Schema_Parser::$index_name
$init
in file Parser2.php, variable MDB2_Schema_Parser2::$init
$init
in file Parser.php, variable MDB2_Schema_Parser::$init
$init_expression
in file Parser.php, variable MDB2_Schema_Parser::$init_expression
$init_field
in file Parser.php, variable MDB2_Schema_Parser::$init_field
$init_function
in file Parser.php, variable MDB2_Schema_Parser::$init_function
initializeTable
in file Schema.php, method MDB2_Schema::initializeTable()
    Inititialize the table with data
isBoolean
in file Validate.php, method MDB2_Schema_Validate::isBoolean()
    Verifies if a given value can be considered boolean. If yes, set value to true or false according to its actual contents and return true. If not, keep its contents untouched and return false.
isError
in file Schema.php, method MDB2_Schema::isError()
    Tell whether a value is an MDB2_Schema error.
ibase.php
procedural page ibase.php
index.php
procedural page index.php
top

m

$max_identifiers_length
in file Validate.php, variable MDB2_Schema_Validate::$max_identifiers_length
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.
mssql.php
procedural page mssql.php
mysql.php
procedural page mysql.php
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, class MDB2_Schema_Error
    MDB2_Schema_Error implements a class for reporting portable database error messages.
MDB2_SCHEMA_ERROR
in file Schema.php, constant MDB2_SCHEMA_ERROR
    If you add an error code here, make sure you also add a textual version of it in MDB2_Schema::errorMessage().
MDB2_SCHEMA_ERROR_INVALID
in file Schema.php, constant MDB2_SCHEMA_ERROR_INVALID
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_ERROR_VALIDATE
in file Schema.php, constant MDB2_SCHEMA_ERROR_VALIDATE
MDB2_SCHEMA_ERROR_WRITER
in file Schema.php, constant MDB2_SCHEMA_ERROR_WRITER
MDB2_Schema_Example
in file class.inc.php, class MDB2_Schema_Example
    An example of how to use MDB2_Schema
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()
    PHP 4 compatible constructor
MDB2_Schema_Parser2
in file Parser2.php, class MDB2_Schema_Parser2
    Parses an XML schema file
MDB2_Schema_Parser2
in file Parser2.php, method MDB2_Schema_Parser2::MDB2_Schema_Parser2()
    PHP 4 compatible constructor
MDB2_Schema_Tool
in file Tool.php, class MDB2_Schema_Tool
    Command line tool to work with database schemas
MDB2_Schema_Tool_ParameterException
in file ParameterException.php, class MDB2_Schema_Tool_ParameterException
    To be implemented yet
MDB2_Schema_Validate
in file Validate.php, method MDB2_Schema_Validate::MDB2_Schema_Validate()
    PHP 4 compatible constructor
MDB2_Schema_Validate
in file Validate.php, class MDB2_Schema_Validate
    Validates an XML schema file
MDB2_Schema_Writer
in file Writer.php, method MDB2_Schema_Writer::MDB2_Schema_Writer()
    PHP 4 compatible constructor
MDB2_Schema_Writer
in file Writer.php, class MDB2_Schema_Writer
    Writes an XML schema file
top

o

$options
in file Parser2.php, variable MDB2_Schema_Parser2::$options
$options
in file class.inc.php, variable MDB2_Schema_Example::$options
$options
in file Schema.php, variable MDB2_Schema::$options
oci8.php
procedural page oci8.php
top

p

parse.php
procedural page parse.php
Parser.php
procedural page Parser.php
Parser2.php
procedural page Parser2.php
pgsql.php
procedural page pgsql.php
ParameterException.php
procedural page ParameterException.php
parse
in file Parser2.php, method MDB2_Schema_Parser2::parse()
    Main method. Parses XML Schema File.
parseDatabaseDefinition
in file Schema.php, method MDB2_Schema::parseDatabaseDefinition()
    Parse a database definition from a file or an array
parseDatabaseDefinitionFile
in file Schema.php, method MDB2_Schema::parseDatabaseDefinitionFile()
    Parse a database definition file by creating a schema format parser object and passing the file contents as parser input data stream.
printQueries
in file action.php, function printQueries()
    Aux function to print SQL queries (debug mode)
top

r

result.php
procedural page result.php
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.
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.
readPasswordFromStdin
in file Tool.php, method MDB2_Schema_Tool::readPasswordFromStdin()
    Reads a password from stdin
resetWarnings
in file Schema.php, method MDB2_Schema::resetWarnings()
    reset the warning array
run
in file Tool.php, method MDB2_Schema_Tool::run()
    Runs the tool with command line arguments
top

s

$sequence
in file Parser.php, variable MDB2_Schema_Parser::$sequence
$sequence
in file Parser2.php, variable MDB2_Schema_Parser2::$sequence
$sequence_name
in file Parser.php, variable MDB2_Schema_Parser::$sequence_name
$sequence_name
in file Parser2.php, variable MDB2_Schema_Parser2::$sequence_name
$show_structure
in file class.inc.php, variable MDB2_Schema_Example::$show_structure
$structure
in file Parser2.php, variable MDB2_Schema_Parser2::$structure
$structure
in file Parser.php, variable MDB2_Schema_Parser::$structure
Schema.php
procedural page Schema.php
saveCookies
in file class.inc.php, method MDB2_Schema_Example::saveCookies()
    Saves user preferences as browser cookies
setInputFile
in file Parser2.php, method MDB2_Schema_Parser2::setInputFile()
    Do the necessary stuff to set the input XML schema file
setOption
in file Schema.php, method MDB2_Schema::setOption()
    Sets the option for the db class
setOptions
in file class.inc.php, method MDB2_Schema_Example::setOptions()
    Sets MDB2_Schema_Example options according to user input
setPasswordIntoDsn
in file Tool.php, method MDB2_Schema_Tool::setPasswordIntoDsn()
    Takes a DSN data source name and integrates the given password into it.
top

t

$table
in file Parser.php, variable MDB2_Schema_Parser::$table
$table
in file Parser2.php, variable MDB2_Schema_Parser2::$table
$table_name
in file Parser2.php, variable MDB2_Schema_Parser2::$table_name
$table_name
in file Parser.php, variable MDB2_Schema_Parser::$table_name
Tool.php
procedural page Tool.php
throwExceptionOnError
in file Tool.php, method MDB2_Schema_Tool::throwExceptionOnError()
    Checks if the passed parameter is a PEAR_Error object and throws an exception in that case.
toStdErr
in file Tool.php, method MDB2_Schema_Tool::toStdErr()
    Writes the message to stderr
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

$val
in file Parser.php, variable MDB2_Schema_Parser::$val
$val
in file Parser2.php, variable MDB2_Schema_Parser2::$val
$valid_types
in file Writer.php, variable MDB2_Schema_Writer::$valid_types
$valid_types
in file Validate.php, variable MDB2_Schema_Validate::$valid_types
$variables
in file Parser.php, variable MDB2_Schema_Parser::$variables
$variables
in file Parser2.php, variable MDB2_Schema_Parser2::$variables
$var_mode
in file Parser.php, variable MDB2_Schema_Parser::$var_mode
Validate.php
procedural page Validate.php
validateConstraint
in file Validate.php, method MDB2_Schema_Validate::validateConstraint()
    Checks whether a parsed foreign key is valid. Modify its definition when necessary.
validateConstraintField
in file Validate.php, method MDB2_Schema_Validate::validateConstraintField()
    Checks whether a foreign-field is valid.
validateConstraintReferencedField
in file Validate.php, method MDB2_Schema_Validate::validateConstraintReferencedField()
    Checks whether a foreign-referenced field is valid.
validateDatabase
in file Validate.php, method MDB2_Schema_Validate::validateDatabase()
    Checks whether a parsed database is valid. Modify its structure and data when necessary.
validateDataField
in file Validate.php, method MDB2_Schema_Validate::validateDataField()
    Checks whether a parsed DML-field is valid. Modify its structure when necessary. This is called when validating INSERT and UPDATE.
validateDataFieldValue
in file Validate.php, method MDB2_Schema_Validate::validateDataFieldValue()
    Checks whether a given value is compatible with a table field. This is done when parsing a field for a INSERT or UPDATE instruction.
validateField
in file Validate.php, method MDB2_Schema_Validate::validateField()
    Checks whether the definition of a parsed field is valid. Modify field definition when necessary.
validateIdentifier
in file Validate.php, method MDB2_Schema_Validate::validateIdentifier()
    Checks whether a given identifier is valid for current driver.
validateIndex
in file Validate.php, method MDB2_Schema_Validate::validateIndex()
    Checks whether a parsed index is valid. Modify index definition when necessary.
validateIndexField
in file Validate.php, method MDB2_Schema_Validate::validateIndexField()
    Checks whether a parsed index-field is valid. Modify its definition when necessary.
validateInput
in file class.inc.php, method MDB2_Schema_Example::validateInput()
    Validates user input
validateSequence
in file Validate.php, method MDB2_Schema_Validate::validateSequence()
    Checks whether the definition of a parsed sequence is valid. Modify sequence definition when necessary.
validateTable
in file Validate.php, method MDB2_Schema_Validate::validateTable()
    Checks whether the definition of a parsed table is valid. Modify table definition when necessary.
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
writeExpression
in file Writer.php, method MDB2_Schema_Writer::writeExpression()
    Dumps the structure of an element. Elements can be value, column, function or expression.
writeInitialization
in file Schema.php, method MDB2_Schema::writeInitialization()
    Write initialization and sequences
top
Documentation generated on Mon, 11 Mar 2019 16:04:23 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.