Docs For Class JDatabaseExporter

Description

Joomla Platform Database Exporter Class

abstract:
since: 12.1

Located in /libraries/joomla/database/exporter.php (line 19)

Direct descendents

Class	Description
JDatabaseExporterMysqli	MySQLi export driver.
JDatabaseExporterPostgresql	PostgreSQL export driver.

Variable Summary

string $asFormat

array $cache

JDatabaseDriver $db

array $from

object $options

Method Summary

JDatabaseExporter __construct ()

DatabaseExporter asXml ()

string buildXml ()

array buildXmlStructure ()

DatabaseDriver check ()

JDatabaseExporter from (mixed $from)

string getGenericTableName (string $table)

JDatabaseExporter setDbo (JDatabaseDriver $db)

JDatabaseExporter withStructure ([boolean $setting = true])

string __toString ()

Variables

string $asFormat = 'xml' (line 27)

The type of output format (xml).

since: 13.1
access: protected

array $cache = array() (line 35)

An array of cached data.

since: 13.1
access: protected

JDatabaseDriver $db = null (line 43)

The database connector to use for exporting structure and/or data.

since: 13.1
access: protected

array $from = array() (line 51)

An array input sources (table names).

since: 13.1
access: protected

object $options = null (line 59)

An array of options for the exporter.

since: 13.1
access: protected

Methods

Constructor __construct (line 68)

Constructor.

Sets up the default options for the exporter.

since: 13.1
access: public

JDatabaseExporter __construct ()

asXml (line 117)

Set the output option for the exporter to XML format.

return: Method supports chaining.
since: 13.1
access: public

DatabaseExporter asXml ()

buildXml (line 132)

Builds the XML data for the tables to export.

return: An XML string
abstract:
throws: Exception if an error occurs.
since: 13.1
access: protected

string buildXml ()

Redefined in descendants as:

JDatabaseExporterMysqli::buildXml() : Builds the XML data for the tables to export.
JDatabaseExporterPostgresql::buildXml() : Builds the XML data for the tables to export.

buildXmlStructure (line 142)

Builds the XML structure to export.

return: An array of XML lines (strings).
abstract:
throws: Exception if an error occurs.
since: 13.1
access: protected

array buildXmlStructure ()

Redefined in descendants as:

JDatabaseExporterMysqli::buildXmlStructure() : Builds the XML structure to export.
JDatabaseExporterPostgresql::buildXmlStructure() : Builds the XML structure to export.

check (line 152)

Checks if all data and options are in order prior to exporting.

return: Method supports chaining.
abstract:
throws: Exception if an error is encountered.
since: 13.1
access: public

DatabaseDriver check ()

Redefined in descendants as:

JDatabaseExporterMysqli::check() : Checks if all data and options are in order prior to exporting.
JDatabaseExporterMysql::check() : Checks if all data and options are in order prior to exporting.
JDatabaseExporterPostgresql::check() : Checks if all data and options are in order prior to exporting.

from (line 164)

Specifies a list of table names to export.

return: Method supports chaining.
since: 13.1
throws: Exception if input is not a string or array.
access: public

JDatabaseExporter from (mixed $from)

mixed $from: The name of a single table, or an array of the table names to export.

getGenericTableName (line 191)

Get the generic name of the table, converting the database prefix to the wildcard string.

return: The name of the table with the database prefix replaced with #__.
since: 13.1
access: protected

string getGenericTableName (string $table)

string $table: The name of the table.

setDbo (line 210)

Sets the database connector to use for exporting structure and/or data from MySQL.

return: Method supports chaining.
since: 13.1
access: public

JDatabaseExporter setDbo (JDatabaseDriver $db)

JDatabaseDriver $db: The database connector.

withStructure (line 226)

Sets an internal option to export the structure of the input table(s).

return: Method supports chaining.
since: 13.1
access: public

JDatabaseExporter withStructure ([boolean $setting = true])

boolean $setting: True to export the structure, false to not.

__toString (line 93)

Magic function to exports the data to a string.

since: 13.1
throws: Exception if an error is encountered.
access: public

string __toString ()