xml_database_exporter Class Reference

XML format exporter class. More...

Inheritance diagram for xml_database_exporter:

Public Member Functions
	begin_database_export ($version, $release, $timestamp, $description)
	Callback function. More...
	begin_table_export (xmldb_table $table)
	Callback function. More...
	export_database ($description=null)
	Generic method to export the database. More...
	export_table_data (xmldb_table $table, $data)
	Callback function. More...
	finish_database_export ()
	Callback function. More...
	finish_table_export (xmldb_table $table)
	Callback function. More...

Protected Member Functions
	output ($text)
	Generic output method. More...

Protected Attributes
bool	$check_schema
	Boolean flag - whether or not to check that XML database schema matches the RDBMS database schema before exporting (used by. More...
database_manager	$manager
	Database manager of the source database (a. More...
moodle_database	$mdb
	Connection to the source database (a. More...
xmldb_structure	$schema
	Source database schema in XMLDB format (a. More...

Detailed Description

XML format exporter class.

Provides logic for writing XML tags and data inside appropriate callbacks. Subclasses should define XML data sinks.

Member Function Documentation

begin_database_export()

xml_database_exporter::begin_database_export	(		$version,
			$release,
			$timestamp,
			$description
	)

Callback function.

Outputs open XML PI and moodle_database opening tag.

Parameters

float	$version	the version of the system which generating the data
string	$release	moodle release info
string	$timestamp	the timestamp of the data (in ISO 8601) format.
string	$description	a user description of the data.

Return values

void

Reimplemented from database_exporter.

begin_table_export()

xml_database_exporter::begin_table_export

(

xmldb_table

$table

)

Callback function.

Outputs table opening tag.

Parameters

xmldb_table

$table

- XMLDB object for the exported table

Return values

void

Reimplemented from database_exporter.

export_database()

database_exporter::export_database (   $description = null )

inherited

Generic method to export the database.

It checks the schema (if

See also

$check_schema is true), queries the database and calls appropriate callbacks.

Exceptions

dbtransfer_exception

if any checking (e.g. database schema) fails

Parameters

string

$description

a user description of the data.

Reimplemented in string_xml_database_exporter, and file_xml_database_exporter.

export_table_data()

xml_database_exporter::export_table_data	(	xmldb_table	$table,
			$data
	)

Callback function.

Outputs record tag with field subtags and data.

Parameters

xmldb_table	$table	- XMLDB object of the table from which data was retrieved
object	$data	- data object (fields and values from record)

Return values

void

Reimplemented from database_exporter.

finish_database_export()

xml_database_exporter::finish_database_export

(

)

Callback function.

Outputs moodle_database closing tag.

Reimplemented from database_exporter.

finish_table_export()

xml_database_exporter::finish_table_export

(

xmldb_table

$table

)

Callback function.

Outputs table closing tag.

Parameters

xmldb_table

$table

- XMLDB object for the exported table

Reimplemented from database_exporter.

output()

xml_database_exporter::output (   $text )

abstractprotected

Generic output method.

Subclasses should implement it with code specific to the target XML sink.

Reimplemented in string_xml_database_exporter, and file_xml_database_exporter.

Member Data Documentation

$check_schema

bool database_exporter::$check_schema

protectedinherited

Boolean flag - whether or not to check that XML database schema matches the RDBMS database schema before exporting (used by.

See also

export_database).

$manager

database_manager database_exporter::$manager

protectedinherited

Database manager of the source database (a.

See also

database_manager object).

$mdb

moodle_database database_exporter::$mdb

protectedinherited

Connection to the source database (a.

See also

moodle_database object).

$schema

xmldb_structure database_exporter::$schema

protectedinherited

Source database schema in XMLDB format (a.

See also

xmldb_structure object).

---

The documentation for this class was generated from the following file:

• lib/dtl/xml_database_exporter.php