JDatabaseExporterMySQL

MySQL export driver.

package

Joomla.Platform

subpackage

Database

since

11.1

Methods

__construct

Constructor.

__construct() 

Sets up the default options for the exporter.

since

11.1

__toString

Magic function to exports the data to a string.

__toString() : string
since

11.1

throws

\Exceptionif an error is encountered.

Response

string

asXml

Set the output option for the exporter to XML format.

asXml() : \JDatabaseExporterMySQL
since

11.1

Response

\JDatabaseExporterMySQLMethod supports chaining.

buildXml

Builds the XML data for the tables to export.

buildXml() : string
since

11.1

throws

\Exceptionif an error occurs.

Response

stringAn XML string

buildXmlStructure

Builds the XML structure to export.

buildXmlStructure() : array
since

11.1

throws

\Exceptionif an error occurs.

Response

arrayAn array of XML lines (strings).

check

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

check() : \JDatabaseExporterMySQL
since

11.1

throws

\Exceptionif an error is encountered.

Response

\JDatabaseExporterMySQLMethod supports chaining.

from

Specifies a list of table names to export.

from(mixed $from) : \JDatabaseExporterMySQL
since

11.1

throws

\Exceptionif input is not a string or array.

Arguments

$from

mixedThe name of a single table, or an array of the table names to export.

Response

\JDatabaseExporterMySQLMethod supports chaining.

getGenericTableName

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

getGenericTableName(string $table) : string
since

11.1

Arguments

$table

stringThe name of the table.

Response

stringThe name of the table with the database prefix replaced with #__.

setDbo

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

setDbo(\JDatabaseMySQL $db) : \JDatabaseExporterMySQL
since

11.1

Arguments

$db

\JDatabaseMySQLThe database connector.

Response

\JDatabaseExporterMySQLMethod supports chaining.

withStructure

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

withStructure(boolean $setting = true) : \JDatabaseExporterMySQL
since

11.1

Arguments

$setting

booleanTrue to export the structure, false to not.

Response

\JDatabaseExporterMySQLMethod supports chaining.

Properties

cache

An array of cached data.

since

11.1

Type(s)

array

db

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

since

11.1

Type(s)

\JDatabaseMySQL

from

An array input sources (table names).

since

11.1

Type(s)

array

asFormat

The type of output format (xml).

since

11.1

Type(s)

string

options

An array of options for the exporter.

since

11.1

Type(s)

\JObject