Class JDatabaseExporterMySQL

Description

MySQL export driver.

  • since: 11.1

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


	
			
Direct descendents
Class Description
JDatabaseExporterMySQLi MySQL export driver.
Variable Summary
Method Summary
JDatabaseExporterMySQL __construct ()
string buildXml ()
JDatabaseExporterMySQL from (mixed $from)
string getGenericTableName (string $table)
JDatabaseExporterMySQL withStructure ([boolean $setting = true])
string __toString ()
Variables
string $asFormat = 'xml' (line 51)

The type of output format (xml).

  • since: 11.1
  • access: protected
array $cache = array() (line 27)

An array of cached data.

  • since: 11.1
  • access: protected
JDatabaseMySQL $db = null (line 35)

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

  • since: 11.1
  • access: protected
array $from = array() (line 43)

An array input sources (table names).

  • since: 11.1
  • access: protected
JObject $options = null (line 59)

An array of options for the exporter.

  • since: 11.1
  • access: protected
Methods
Constructor __construct (line 68)

Constructor.

Sets up the default options for the exporter.

  • since: 11.1
  • access: public
JDatabaseExporterMySQL __construct ()
asXml (line 119)

Set the output option for the exporter to XML format.

  • return: Method supports chaining.
  • since: 11.1
  • access: public
buildXml (line 134)

Builds the XML data for the tables to export.

  • return: An XML string
  • since: 11.1
  • throws: Exception if an error occurs.
  • access: protected
string buildXml ()
buildXmlStructure (line 158)

Builds the XML structure to export.

  • return: An array of XML lines (strings).
  • since: 11.1
  • throws: Exception if an error occurs.
  • access: protected
array buildXmlStructure ()
check (line 203)

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

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

Redefined in descendants as:
from (line 250)

Specifies a list of table names to export.

  • return: Method supports chaining.
  • since: 11.1
  • throws: Exception if input is not a string or array.
  • access: public
JDatabaseExporterMySQL from (mixed $from)
  • mixed $from: The name of a single table, or an array of the table names to export.
getGenericTableName (line 229)

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: 11.1
  • access: protected
string getGenericTableName (string $table)
  • string $table: The name of the table.
setDbo (line 277)

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

  • return: Method supports chaining.
  • since: 11.1
  • access: public

Redefined in descendants as:
withStructure (line 293)

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

  • return: Method supports chaining.
  • since: 11.1
  • access: public
JDatabaseExporterMySQL 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: 11.1
  • throws: Exception if an error is encountered.
  • access: public
string __toString ()

Documentation generated on Mon, 25 Jun 2012 13:58:01 -0500 by phpDocumentor 1.4.4