JDatabaseImporterMysql
Extends \JDatabaseImporterMysqliMySQL import driver.
| since |
11.1 |
|---|---|
| deprecated |
4.0 Use MySQLi or PDO MySQL instead |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct()
Sets up the default options for the exporter.
| since |
13.1 |
|---|
asXml
Set the output option for the exporter to XML format.
asXml() : \JDatabaseImporter
check
Checks if all data and options are in order prior to exporting.
check() : \JDatabaseImporter
| since |
13.1 |
|---|---|
| throws |
|
Response
\JDatabaseImporterMethod supports chaining.
from
Specifies the data source to import.
from(mixed $from) : \JDatabaseImporter
| since |
13.1 |
|---|
Arguments
$from
mixedThe data source to import.
Response
\JDatabaseImporterMethod supports chaining.
getAddColumnSql
Get the SQL syntax to add a column.
getAddColumnSql(string $table, \SimpleXMLElement $field) : string
| since |
11.1 |
|---|
Arguments
$table
stringThe table name.
$field
\SimpleXMLElementThe XML field definition.
Response
string
getAddKeySql
Get the SQL syntax to add a key.
getAddKeySql(string $table, array $keys) : string
| since |
11.1 |
|---|
Arguments
$table
stringThe table name.
$keys
arrayAn array of the fields pertaining to this key.
Response
string
getAlterTableSql
Get alters for table if there is a difference.
getAlterTableSql(\SimpleXMLElement $structure) : array
| since |
11.1 |
|---|
Arguments
$structure
\SimpleXMLElementThe XML structure pf the table.
Response
array
getChangeColumnSql
Get the syntax to alter a column.
getChangeColumnSql(string $table, \SimpleXMLElement $field) : string
| since |
11.1 |
|---|
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) : string
| since |
11.1 |
|---|
Arguments
$field
\SimpleXMLElementThe XML field definition.
Response
string
getDropColumnSql
Get the SQL syntax to drop a column.
getDropColumnSql(string $table, string $name) : string
| since |
13.1 |
|---|
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(string $table, string $name) : string
| since |
11.1 |
|---|
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(string $table) : string
| since |
11.1 |
|---|
Arguments
$table
stringThe table name.
Response
string
getKeyLookup
Get the details list of keys for a table.
getKeyLookup(array $keys) : array
| since |
11.1 |
|---|---|
| throws |
|
Arguments
$keys
arrayAn array of objects that comprise the keys for the table.
Response
arrayThe lookup array. array({key name} => array(object, ...))
getKeySql
Get the SQL syntax for a key.
getKeySql(array $columns) : string
| since |
11.1 |
|---|
Arguments
$columns
arrayAn 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(string $table) : string
| since |
13.1 |
|---|
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 |
13.1 |
| throws |
|
setDbo
Sets the database connector to use for exporting structure and/or data.
setDbo(\JDatabaseDriver $db) : \JDatabaseImporter
| since |
13.1 |
|---|
Arguments
$db
\JDatabaseDriverThe database connector.
Response
\JDatabaseImporterMethod supports chaining.
withStructure
Sets an internal option to merge the structure based on the input data.
withStructure(boolean $setting = true) : \JDatabaseImporter
| since |
13.1 |
|---|
Arguments
$setting
booleanTrue to export the structure, false to not.
Response
\JDatabaseImporterMethod supports chaining.
xmlToCreate
Get the SQL syntax to add a table.
xmlToCreate(\SimpleXMLElement $table) : string
| since |
11.1 |
|---|---|
| throws |
|
Arguments
$table
\SimpleXMLElementThe table information.
Response
string
Properties
cache
An array of cached data.
Type(s)
array
db
The database connector to use for exporting structure and/or data.
from
The input source.
Type(s)
mixed
asFormat
The type of input format (XML).
Type(s)
string