xml_database_exporter Class Reference

Inheritance diagram for xml_database_exporter:

Collaboration diagram for xml_database_exporter:

Public Member Functions
	begin_database_export ($version, $release, $timestamp, $description)
	begin_table_export (xmldb_table $table)
	finish_table_export (xmldb_table $table)
	finish_database_export ()
	export_table_data (xmldb_table $table, $data)
Protected Member Functions
	output ($text)

---

Detailed Description

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

Definition at line 35 of file xml_database_exporter.php.

---

Member Function Documentation

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.

Returns:

void

Reimplemented from database_exporter.

Definition at line 51 of file xml_database_exporter.php.

Here is the call graph for this function:

begin_table_export

(

xmldb_table $

table

)

Callback function. Outputs table opening tag.

Parameters:

xmldb_table

$table

- XMLDB object for the exported table

Returns:

void

Reimplemented from database_exporter.

Definition at line 63 of file xml_database_exporter.php.

Here is the call graph for this function:

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)

Returns:

void

Reimplemented from database_exporter.

Definition at line 90 of file xml_database_exporter.php.

Here is the call graph for this function:

finish_database_export

(

)

Callback function. Outputs moodle_database closing tag.

Reimplemented from database_exporter.

Definition at line 79 of file xml_database_exporter.php.

Here is the call graph for this function:

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.

Definition at line 72 of file xml_database_exporter.php.

Here is the call graph for this function:

output

(

$

text

)

[abstract, protected]

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

Reimplemented in file_xml_database_exporter, and string_xml_database_exporter.

Here is the caller graph for this function:

---

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

• C:/xampp/htdocs/moodle/lib/dtl/xml_database_exporter.php