Docs For Class MDB2_Tools

mixed connect(

&$dbinfo, [mixed
$options = false], mixed
$dbinfo)

Create a new MDB2 connection object and connect to the specified database

Return: MDB2_OK on success, or a MDB2 error object
See: MDB2::parseDSN
Access: public

Parameters:

mixed	`$dbinfo`	—	'data source name', see the MDB2::parseDSN method for a description of the dsn format. Can also be specified as an array of the format returned by MDB2::parseDSN. Finally you can also pass an existing db object to be used.
mixed	`$options`	—	An associative array of option names and their values.
	`&$dbinfo`	—

[ Top ]

string debugOutput(
)

output debug info

Return: content of the debug_output class variable
Access: public

[ Top ]

void disconnect(
)

Log out and disconnect from the database.

Access: public

[ Top ]

mixed dumpDatabase(
array
$arguments, [integer
$dump = MDB2_MANAGER_DUMP_ALL])

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.

Return: MDB2_OK on success, or a MDB2 error object
Access: public

Parameters:

array	`$arguments`	—	an associative array that takes pairs of tag names and values that define dump options. array ( 'definition' => Boolean true : dump currently parsed definition default: dump currently connected database 'Output_Mode' => String 'file' : dump into a file default: dump using a function 'output' => String depending on the 'Output_Mode' name of the file name of the function 'EndOfLine' => String end of line delimiter that should be used default: "\n" );
integer	`$dump`	—	constant that determines what data to dump MDB2_MANAGER_DUMP_ALL : the entire db MDB2_MANAGER_DUMP_STRUCTURE : only the structure of the db MDB2_MANAGER_DUMP_CONTENT : only the content of the db

[ Top ]

mixed getDefinitionFromDatabase(
)

Attempt to reverse engineer a schema structure from an existing MDB2 This method can be used if no xml schema file exists yet.

The resulting xml schema file may need some manual adjustments.

Return: MDB2_OK or array with all ambiguities on success, or a MDB2 error object
Access: public

[ Top ]

mixed getOption(
string
$option)

returns the value of an option

Return: the option value or error object
Access: public

Parameters:

string $option — option name

[ Top ]

array getWarnings(
)

get all warnings in reverse order.

This means that the last warning is the first element in the array

Return: with warnings
See: MDB2_Tools_Manager::resetWarnings()
Access: public

[ Top ]

mixed parseDatabaseDefinitionFile(
string
$input_file, array
$variables, [bool
$fail_on_invalid_names = true])

Parse a database definition file by creating a Metabase schema format parser object and passing the file contents as parser input data stream.

Return: MDB2_OK on success, or a MDB2 error object
Access: public

Parameters:

string	`$input_file`	—	the path of the database schema file.
array	`$variables`	—	an associative array that the defines the text string values that are meant to be used to replace the variables that are used in the schema description.
bool	`$fail_on_invalid_names`	—	(optional) make function fail on invalid names

[ Top ]

object a &raiseError(
[mixed
$code = null], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null], mixed
$nativecode)

This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.

Return: PEAR error object
See: PEAR_Error
Access: public

Parameters:

mixed	`$code`	—	integer error code, or a PEAR error object (all other parameters are ignored if this parameter is an object
int	`$mode`	—	error mode, see PEAR_Error docs
mixed	`$options`	—	If error mode is PEAR_ERROR_TRIGGER, this is the error level (E_USER_NOTICE etc). If error mode is PEAR_ERROR_CALLBACK, this is the callback function, either as a function name, or as an array of an object and method name. For other error modes this parameter is ignored.
string	`$userinfo`	—	Extra debug information. Defaults to the last query and native error code.
mixed	`$nativecode`	—	Native error code, integer or string depending the backend.

[ Top ]

void resetWarnings(
)

reset the warning array

Access: public

[ Top ]

string setDatabase(
string
$name)

Select a different database

Return: name of the database previously connected to
Access: public

Parameters:

string $name — name of the database that should be selected

[ Top ]

mixed setOption(
string
$option, mixed
$value)

set the option for the db class

Return: MDB2_OK or MDB2 Error Object
Access: public

Parameters:

string	`$option`	—	option name
mixed	`$value`	—	value for the option

[ Top ]

mixed updateDatabase(
string
$current_schema_file, [string
$previous_schema_file = false], [array
$variables = array()])

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.

If the specified previous definition file does not exist, this function will create the database from the definition specified in the current schema file. If both files exist, the function assumes that the database was previously installed based on the previous schema file and will update it by just applying the changes. If this function succeeds, the contents of the current schema file are copied to replace the previous schema file contents. Any subsequent schema changes should only be done on the file specified by the $current_schema_file to let this function make a consistent evaluation of the exact changes that need to be applied.

Return: MDB2_OK on success, or a MDB2 error object
Access: public

Parameters:

string	`$current_schema_file`	—	name of the updated database schema definition file.
string	`$previous_schema_file`	—	name the previously installed database schema definition file.
array	`$variables`	—	an associative array that is passed to the argument of the same name to the parseDatabaseDefinitionFile function. (there third param)

[ Top ]

Class: MDB2_Tools_Manager

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$database_definition = array(
        'name' => '',
        'create' => 0,
        'tables' => array())

$db =

$default_values = array(
        'integer' => 0,
        'float' => 0,
        'decimal' => 0,
        'text' => '',
        'timestamp' => '0001-01-01 00:00:00',
        'date' => '0001-01-01',
        'time' => '00:00:00'
    )

$invalid_names = array(
'user' => array(),'is'=>array(),'file'=>array('oci'=>array(),'oracle'=>array()),'notify'=>array('pgsql'=>array()),'restrict'=>array('mysql'=>array()),'password'=>array('ibase'=>array()))

$options = array(
'fail_on_invalid_names' => 1,
)

$warnings = array()

Method Detail

connect [line 246]

Parameters:

debugOutput [line 149]

disconnect [line 274]

dumpDatabase [line 1774]

Parameters:

getDefinitionFromDatabase [line 1602]

getOption [line 218]

Parameters:

getWarnings [line 178]

parseDatabaseDefinitionFile [line 1396]

Parameters:

raiseError [line 133]

Parameters:

resetWarnings [line 162]

setDatabase [line 292]

Parameters:

setOption [line 194]

Parameters:

updateDatabase [line 2057]

Parameters:

Class: MDB2_Tools_Manager

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$database_definition = array( 'name' => '', 'create' => 0, 'tables' => array())

$db =

$default_values = array( 'integer' => 0, 'float' => 0, 'decimal' => 0, 'text' => '', 'timestamp' => '0001-01-01 00:00:00', 'date' => '0001-01-01', 'time' => '00:00:00' )

$invalid_names = array( 'user' => array(),'is'=>array(),'file'=>array('oci'=>array(),'oracle'=>array()),'notify'=>array('pgsql'=>array()),'restrict'=>array('mysql'=>array()),'password'=>array('ibase'=>array()))

$options = array( 'fail_on_invalid_names' => 1, )

$warnings = array()

Method Detail

connect [line 246]

Parameters:

debugOutput [line 149]

disconnect [line 274]

dumpDatabase [line 1774]

Parameters:

getDefinitionFromDatabase [line 1602]

getOption [line 218]

Parameters:

getWarnings [line 178]

parseDatabaseDefinitionFile [line 1396]

Parameters:

raiseError [line 133]

Parameters:

resetWarnings [line 162]

setDatabase [line 292]

Parameters:

setOption [line 194]

Parameters:

updateDatabase [line 2057]

Parameters:

$database_definition = array(
'name' => '',
'create' => 0,
'tables' => array())

$default_values = array(
'integer' => 0,
'float' => 0,
'decimal' => 0,
'text' => '',
'timestamp' => '0001-01-01 00:00:00',
'date' => '0001-01-01',
'time' => '00:00:00'
)

$invalid_names = array(
'user' => array(),'is'=>array(),'file'=>array('oci'=>array(),'oracle'=>array()),'notify'=>array('pgsql'=>array()),'restrict'=>array('mysql'=>array()),'password'=>array('ibase'=>array()))

$options = array(
'fail_on_invalid_names' => 1,
)