DatabaseExporter
Joomla Framework Database Exporter Class
| 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() : \Joomla\Database\DatabaseExporter
| since |
1.0 |
|---|
Response
\Joomla\Database\DatabaseExporterMethod supports chaining.
buildXml
Builds the XML data for the tables to export.
buildXml() : string
| since |
1.0 |
|---|---|
| throws |
|
Response
stringAn XML string
buildXmlStructure
Builds the XML structure to export.
buildXmlStructure() : array
| since |
1.0 |
|---|---|
| throws |
|
Response
arrayAn array of XML lines (strings).
check
Checks if all data and options are in order prior to exporting.
check() : \Joomla\Database\DatabaseDriver
| since |
1.0 |
|---|---|
| throws |
|
Response
\Joomla\Database\DatabaseDriverMethod supports chaining.
from
Specifies a list of table names to export.
from(mixed from) : \Joomla\Database\DatabaseExporter
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- from
mixedThe name of a single table, or an array of the table names to export.
Response
\Joomla\Database\DatabaseExporterMethod supports chaining.
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 exporting structure and/or data from MySQL.
setDbo(\Joomla\Database\DatabaseDriver db) : \Joomla\Database\DatabaseExporter
| since |
1.0 |
|---|
Arguments
- db
\Joomla\Database\DatabaseDriverThe database connector.
Response
\Joomla\Database\DatabaseExporterMethod supports chaining.
withStructure
Sets an internal option to export the structure of the input table(s).
withStructure(bool setting = true) : \Joomla\Database\DatabaseExporter
| since |
1.0 |
|---|
Arguments
- setting
boolTrue to export the structure, false to not.
Response
\Joomla\Database\DatabaseExporterMethod supports chaining.
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\DatabaseDriver
from
An array input sources (table names).
| since |
1.0 |
|---|
Type(s)
array
options
An array of options for the exporter.
| since |
1.0 |
|---|
Type(s)
object