Joomla! API

Download
Launch

MysqlImporter

Extends DatabaseImporter

MySQL Database Importer.

since

1.0
package

Joomla Framework

Methods

__construct

Constructor.

__construct() :
inherited

Sets up the default options for the importer.

since

1.0

Response

mixed

asXml

Set the output option for the importer to XML format.

asXml() :
inherited
since

1.0

Response

$this

check

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

check() :
since

1.0
throws

RuntimeException

Response

$this

from

Specifies the data source to import.

from(\SimpleXMLElement|string from) :
inherited
since

1.0

Arguments

from

SimpleXMLElement|stringThe data source to import, either as a SimpleXMLElement object or XML string.

Response

$this

getAddColumnSql

Get the SQL syntax to add a column.

getAddColumnSql( table, \SimpleXMLElement field) :
inherited
since

1.0

Arguments

table

stringThe table name.

field

SimpleXMLElementThe XML field definition.

Response

string

getAddKeySql

Get the SQL syntax to add a key.

getAddKeySql( table, mixed||string|int keys) :
since

1.0

Arguments

table

stringThe table name.

keys

array<string|int, mixed>An array of the fields pertaining to this key.

Response

string

getAlterTableSql

Get alters for table if there is a difference.

getAlterTableSql(\SimpleXMLElement structure) : mixed||string|int
since

1.0

Arguments

structure

SimpleXMLElementThe XML structure of the table.

Response

array<string|int, mixed>

getChangeColumnSql

Get the syntax to alter a column.

getChangeColumnSql( table, \SimpleXMLElement field) :
since

1.0

Arguments

table

stringThe name of the database table to alter.

field

SimpleXMLElementThe XML definition for the field.

Response

string

getColumnSql

Get the SQL syntax for a single column that would be included in a table create or alter statement.

getColumnSql(\SimpleXMLElement field) :
since

1.0

Arguments

field

SimpleXMLElementThe XML field definition.

Response

string

getDropColumnSql

Get the SQL syntax to drop a column.

getDropColumnSql( table,  name) :
inherited
since

1.0

Arguments

table

stringThe table name.

name

stringThe name of the field to drop.

Response

string

getDropKeySql

Get the SQL syntax to drop a key.

getDropKeySql( table,  name) :
since

1.0

Arguments

table

stringThe table name.

name

stringThe name of the key to drop.

Response

string

getDropPrimaryKeySql

Get the SQL syntax to drop a key.

getDropPrimaryKeySql( table) :
since

1.0

Arguments

table

stringThe table name.

Response

string

getKeyLookup

Get the details list of keys for a table.

getKeyLookup(mixed||string|int keys) : mixed||string|int
since

1.0
throws

Exception

Arguments

keys

array<string|int, mixed>An array of objects that comprise the keys for the table.

Response

array<string|int, mixed>The lookup array. array({key name} => array(object, ...))

getKeySql

Get the SQL syntax for a key.

getKeySql(mixed||string|int columns) :
since

1.0

Arguments

columns

array<string|int, mixed>An array of SimpleXMLElement objects comprising the key.

Response

string

getRealTableName

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

getRealTableName( table) :
inherited
since

1.0

Arguments

table

stringThe name of the table.

Response

stringThe real name of the table.

importData

Import the data from the source into the existing tables.

importData() :
inherited
note

Currently only supports XML format.
since

2.0.0
throws

RuntimeExceptionon error.

Response

void

mergeStructure

Merges the incoming structure definition with the existing structure.

mergeStructure() :
inherited
note

Currently only supports XML format.
since

1.0
throws

RuntimeExceptionon error.

Response

void

setDbo

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

setDbo(\Joomla\Database\DatabaseInterface db) :
inherited
since

1.0

Arguments

db

DatabaseInterfaceThe database connector.

Response

$this

withStructure

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

withStructure( setting = true) :
inherited
since

1.0

Arguments

setting

boolTrue to import the structure, false to not.

Response

$this

xmlToCreate

Get the SQL syntax to add a table.

xmlToCreate(\SimpleXMLElement table) :
since

2.0.0
throws

RuntimeException

Arguments

table

SimpleXMLElementThe table information.

Response

string

Properties

cache

An array of cached data.

inherited
since

1.0

Type(s)

array<string|int, mixed>

db

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

inherited
since

1.0

Type(s)

DatabaseInterface

from

The input source.

inherited
since

1.0

Type(s)

mixed

asFormat

The type of input format.

inherited
since

1.0

Type(s)

string

options

An array of options for the exporter.

inherited
since

1.0

Type(s)

stdClass
  • \ Joomla
  • \ Database
  • \ Mysql
  • \ MysqlImporter