Joomla! API

Download
Launch

DatabaseExporter

Joomla Framework Database Exporter Class

abstract
since

1.0
package

Joomla Framework

Methods

__construct

Constructor.

__construct() : mixed

Sets up the default options for the exporter.

since

1.0

Response

mixed

__toString

Magic function to exports the data to a string.

__toString() : string
since

1.0

Response

string

asXml

Set the output option for the exporter to XML format.

asXml() : $this
since

1.0

Response

$this

buildXml

Builds the XML data for the tables to export.

buildXml() : string
abstract
since

1.0
throws

\Exceptionif an error occurs.

Response

stringAn XML string

buildXmlData

Builds the XML data to export.

buildXmlData() : array
since

2.0.0
throws

\Exceptionif an error occurs.

Response

arrayAn array of XML lines (strings).

buildXmlStructure

Builds the XML structure to export.

buildXmlStructure() : array
abstract
since

1.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() : $this
abstract
since

1.0
throws

\Exceptionif an error is encountered.

Response

$this

from

Specifies a list of table names to export.

from(string[]|string from) : $this
since

1.0
throws

\InvalidArgumentException

Arguments

from

string[]|stringThe name of a single table, or an array of the table names to export.

Response

$this

getGenericTableName

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

getGenericTableName(string table) : string
since

1.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 importing structure and/or data.

setDbo(\Joomla\Database\DatabaseInterface db) : $this
since

1.0

Arguments

db

\Joomla\Database\DatabaseInterfaceThe database connector.

Response

$this

withData

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

withData(bool setting = false) : $this
since

2.0.0

Arguments

setting

boolTrue to export the data, false to not.

Response

$this

withStructure

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

withStructure(bool setting = true) : $this
since

1.0

Arguments

setting

boolTrue to export the structure, false to not.

Response

$this

Properties

asFormat

The type of output format.

since

1.0

Type(s)

string

cache

An array of cached data.

since

1.0

Type(s)

array

db

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

since

1.0

Type(s)

\Joomla\Database\DatabaseInterface

from

An array input sources (table names).

since

1.0

Type(s)

string[]

options

An array of options for the exporter.

since

1.0

Type(s)

\stdClass
  • \ Joomla
  • \ Database
  • \ DatabaseExporter