JDatabaseExporter

Joomla Platform Database Exporter Class

abstract
since

3.0.0

package

Joomla.Platform

Methods

__construct

Constructor.

__construct() 

Sets up the default options for the exporter.

since

3.2.0

__toString

Magic function to exports the data to a string.

__toString() : string
since

3.2.0

throws

\Exceptionif an error is encountered.

Response

string

asXml

Set the output option for the exporter to XML format.

asXml() : \JDatabaseExporter
since

3.2.0

Response

\JDatabaseExporterMethod supports chaining.

buildXml

Builds the XML data for the tables to export.

buildXml() : string
abstract
since

3.2.0

throws

\Exceptionif an error occurs.

Response

stringAn XML string

buildXmlStructure

Builds the XML structure to export.

buildXmlStructure() : array
abstract
since

3.2.0

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() : \JDatabaseDriver
abstract
since

3.2.0

throws

\Exceptionif an error is encountered.

Response

\JDatabaseDriverMethod supports chaining.

from

Specifies a list of table names to export.

from(mixed $from) : \JDatabaseExporter
since

3.2.0

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

\JDatabaseExporterMethod supports chaining.

getGenericTableName

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

getGenericTableName(string $table) : string
since

3.2.0

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(\JDatabaseDriver $db) : \JDatabaseExporter
since

3.2.0

Arguments

$db

\JDatabaseDriverThe database connector.

Response

\JDatabaseExporterMethod supports chaining.

withStructure

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

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

3.2.0

Arguments

$setting

booleanTrue to export the structure, false to not.

Response

\JDatabaseExporterMethod supports chaining.

Properties

asFormat

The type of output format (xml).

since

3.2.0

Type(s)

string

cache

An array of cached data.

since

3.2.0

Type(s)

array

db

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

since

3.2.0

Type(s)

\JDatabaseDriver

from

An array input sources (table names).

since

3.2.0

Type(s)

array

options

An array of options for the exporter.

since

3.2.0

Type(s)

object