DatabaseImporter

Joomla Framework Database Importer Class

abstract
since

1.0

Methods

__construct

Constructor.

__construct() 

Sets up the default options for the exporter.

since

1.0

asXml

Set the output option for the exporter to XML format.

asXml() : \Joomla\Database\DatabaseImporter
since

1.0

Response

\Joomla\Database\DatabaseImporterMethod supports chaining.

check

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

check() : \Joomla\Database\DatabaseImporter
abstract
since

1.0

throws

\Exceptionif an error is encountered.

Response

\Joomla\Database\DatabaseImporterMethod supports chaining.

from

Specifies the data source to import.

from(mixed $from) : \Joomla\Database\DatabaseImporter
since

1.0

Arguments

$from

mixedThe data source to import.

Response

\Joomla\Database\DatabaseImporterMethod supports chaining.

getAddColumnSQL

Get the SQL syntax to add a column.

getAddColumnSQL(string $table, \SimpleXMLElement $field) : string
since

1.0

Arguments

$table

stringThe table name.

$field

\SimpleXMLElementThe XML field definition.

Response

string

getChangeColumnSQL

Get the syntax to alter a column.

getChangeColumnSQL(string $table, \SimpleXMLElement $field) : string
since

1.0

Arguments

$table

stringThe name of the database table to alter.

$field

\SimpleXMLElementThe XML definition for the field.

Response

string

getDropColumnSql

Get the SQL syntax to drop a column.

getDropColumnSql(string $table, string $name) : string
since

1.0

Arguments

$table

stringThe table name.

$name

stringThe name of the field to drop.

Response

string

getKeyLookup

Get the details list of keys for a table.

getKeyLookup(array $keys) : array
since

1.0

Arguments

$keys

arrayAn array of objects that comprise the keys for the table.

Response

arrayThe lookup array. array({key name} => array(object, ...))

getRealTableName

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

getRealTableName(string $table) : string
since

1.0

Arguments

$table

stringThe name of the table.

Response

stringThe real name of the table.

mergeStructure

Merges the incoming structure definition with the existing structure.

mergeStructure() : void
note

Currently only supports XML format.

since

1.0

throws

\RuntimeExceptionon error.

setDbo

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

setDbo(\Joomla\Database\DatabaseDriver $db) : \Joomla\Database\DatabaseImporter
since

1.0

Arguments

$db

\Joomla\Database\DatabaseDriverThe database connector.

Response

\Joomla\Database\DatabaseImporterMethod supports chaining.

withStructure

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

withStructure(boolean $setting = true) : \Joomla\Database\DatabaseImporter
since

1.0

Arguments

$setting

booleanTrue to export the structure, false to not.

Response

\Joomla\Database\DatabaseImporterMethod supports chaining.

Properties

cache

An array of cached data.

since

1.0

Type(s)

array

db

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

from

The input source.

since

1.0

Type(s)

mixed

asFormat

The type of input format.

since

1.0

Type(s)

string

options

An array of options for the exporter.

since

1.0

Type(s)

object