Docs For Class JDatabaseImporter

Description

Joomla Platform Database Importer Class

abstract:
since: 12.1

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

Direct descendents

Class	Description
JDatabaseImporterMysqli	MySQLi import driver.
JDatabaseImporterPostgresql	PostgreSQL import driver.

Variable Summary

string $asFormat

array $cache

JDatabaseDriver $db

mixed $from

object $options

Method Summary

JDatabaseImporter __construct ()

JDatabaseImporter asXml ()

JDatabaseImporter check ()

JDatabaseImporter from (mixed $from)

string getDropColumnSQL (string $table, string $name)

string getRealTableName (string $table)

void mergeStructure ()

JDatabaseImporter setDbo (JDatabaseDriver $db)

JDatabaseImporter withStructure ([boolean $setting = true])

Variables

string $asFormat = 'xml' (line 49)

The type of input format (XML).

since: 13.1
access: protected

array $cache = array() (line 25)

var: An array of cached data.
since: 13.1
access: protected

JDatabaseDriver $db = null (line 33)

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

since: 13.1
access: protected

mixed $from = array() (line 41)

The input source.

since: 13.1
access: protected

object $options = null (line 57)

An array of options for the exporter.

since: 13.1
access: protected

Methods

Constructor __construct (line 66)

Constructor.

Sets up the default options for the exporter.

since: 13.1
access: public

JDatabaseImporter __construct ()

asXml (line 90)

Set the output option for the exporter to XML format.

return: Method supports chaining.
since: 13.1
access: public

JDatabaseImporter asXml ()

check (line 105)

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

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

JDatabaseImporter check ()

Redefined in descendants as:

JDatabaseImporterMysqli::check() : Checks if all data and options are in order prior to exporting.
JDatabaseImporterMysql::check() : Checks if all data and options are in order prior to exporting.
JDatabaseImporterPostgresql::check() : Checks if all data and options are in order prior to exporting.

from (line 116)

Specifies the data source to import.

return: Method supports chaining.
since: 13.1
access: public

JDatabaseImporter from (mixed $from)

mixed $from: The data source to import.

getDropColumnSQL (line 133)

Get the SQL syntax to drop a column.

since: 13.1
access: protected

string getDropColumnSQL (string $table, string $name)

string $table: The table name.
string $name: The name of the field to drop.

getRealTableName (line 147)

Get the real name of the table, converting the prefix wildcard string if present.

return: The real name of the table.
since: 13.1
access: protected

string getRealTableName (string $table)

string $table: The name of the table.

mergeStructure (line 166)

Merges the incoming structure definition with the existing structure.

since: 13.1
throws: RuntimeException on error.
access: protected

void mergeStructure ()

setDbo (line 244)

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

return: Method supports chaining.
since: 13.1
access: public

JDatabaseImporter setDbo (JDatabaseDriver $db)

JDatabaseDriver $db: The database connector.

withStructure (line 260)

Sets an internal option to merge the structure based on the input data.

return: Method supports chaining.
since: 13.1
access: public

JDatabaseImporter withStructure ([boolean $setting = true])

boolean $setting: True to export the structure, false to not.