Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe DatabaseImporter
+ Graphe d'héritage de DatabaseImporter:

Fonctions membres publiques

 __construct ()
 
 asXml ()
 
 check ()
 
 from ($from)
 
 importData ()
 
 mergeStructure ()
 
 setDbo (DatabaseInterface $db)
 
 withStructure ($setting=true)
 

Fonctions membres protégées

 getAddColumnSql ($table, \SimpleXMLElement $field)
 
 getAlterTableSql (\SimpleXMLElement $structure)
 
 getChangeColumnSql ($table, \SimpleXMLElement $field)
 
 getDropColumnSql ($table, $name)
 
 getKeyLookup ($keys)
 
 getRealTableName ($table)
 
 xmlToCreate (\SimpleXMLElement $table)
 

Attributs protégés

 $cache = ['columns' => []
 
 $db
 
 $from = []
 
 $asFormat = 'xml'
 
 $options
 

Description détaillée

Joomla Framework Database Importer Class

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor.

Sets up the default options for the importer.

Depuis
1.0

Références DatabaseImporter\asXml(), et DatabaseImporter\withStructure().

Documentation des fonctions membres

◆ asXml()

asXml ( )

Set the output option for the importer to XML format.

Renvoie
$this
Depuis
1.0

Références $this.

Référencé par DatabaseImporter\__construct().

◆ check()

check ( )
abstract

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

Renvoie
$this
Depuis
1.0
Exceptions

◆ from()

from (   $from)

Specifies the data source to import.

Paramètres
\SimpleXMLElement | string$fromThe data source to import, either as a SimpleXMLElement object or XML string.
Renvoie
$this
Depuis
1.0

Références DatabaseImporter\$from, et $this.

Référencé par MysqliImporter\check(), PgsqlImporter\check(), MysqlImporter\check(), et DatabaseImporter\importData().

◆ getAddColumnSql()

getAddColumnSql (   $table,
\SimpleXMLElement  $field 
)
protected

Get the SQL syntax to add a column.

Paramètres
string$tableThe table name.
\SimpleXMLElement$fieldThe XML field definition.
Renvoie
string
Depuis
1.0

Références $field.

Référencé par PgsqlImporter\getAlterTableSql(), MysqlImporter\getAlterTableSql(), et MysqliImporter\getAlterTableSql().

◆ getAlterTableSql()

getAlterTableSql ( \SimpleXMLElement  $structure)
abstractprotected

Get alters for table if there is a difference.

Paramètres
\SimpleXMLElement$structureThe XML structure of the table.
Renvoie
array
Depuis
2.0.0

◆ getChangeColumnSql()

getChangeColumnSql (   $table,
\SimpleXMLElement  $field 
)
protected

Get the syntax to alter a column.

Paramètres
string$tableThe name of the database table to alter.
\SimpleXMLElement$fieldThe XML definition for the field.
Renvoie
string
Depuis
1.0

Références $field.

◆ getDropColumnSql()

getDropColumnSql (   $table,
  $name 
)
protected

Get the SQL syntax to drop a column.

Paramètres
string$tableThe table name.
string$nameThe name of the field to drop.
Renvoie
string
Depuis
1.0

Références $name.

Référencé par PgsqlImporter\getAlterTableSql(), MysqlImporter\getAlterTableSql(), et MysqliImporter\getAlterTableSql().

◆ getKeyLookup()

getKeyLookup (   $keys)
protected

Get the details list of keys for a table.

Paramètres
array$keysAn array of objects that comprise the keys for the table.
Renvoie
array The lookup array. array({key name} => array(object, ...))
Depuis
1.0

Références $key.

◆ getRealTableName()

getRealTableName (   $table)
protected

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

Paramètres
string$tableThe name of the table.
Renvoie
string The real name of the table.
Depuis
1.0

Références $prefix.

Référencé par PgsqlImporter\getAlterTableSql(), MysqlImporter\getAlterTableSql(), MysqliImporter\getAlterTableSql(), et DatabaseImporter\importData().

◆ importData()

importData ( )

Import the data from the source into the existing tables.

Renvoie
void
Note
Currently only supports XML format.
Depuis
2.0.0
Exceptions

Références $data, DatabaseImporter\$from, $rows, $xml, DatabaseImporter\from(), et DatabaseImporter\getRealTableName().

◆ mergeStructure()

mergeStructure ( )

Merges the incoming structure definition with the existing structure.

Renvoie
void
Note
Currently only supports XML format.
Depuis
1.0
Exceptions

Références $query, $sql, et $xml.

◆ setDbo()

setDbo ( DatabaseInterface  $db)

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

Paramètres
DatabaseInterface$dbThe database connector.
Renvoie
$this
Depuis
1.0

Références $db, et $this.

◆ withStructure()

withStructure (   $setting = true)

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

Paramètres
boolean$settingTrue to import the structure, false to not.
Renvoie
$this
Depuis
1.0

Références $this.

Référencé par DatabaseImporter\__construct().

◆ xmlToCreate()

xmlToCreate ( \SimpleXMLElement  $table)
abstractprotected

Get the SQL syntax to add a table.

Paramètres
\SimpleXMLElement$tableThe table information.
Renvoie
string
Depuis
2.0.0
Exceptions

Documentation des champs

◆ $asFormat

$asFormat = 'xml'
protected

◆ $cache

$cache = ['columns' => []
protected

◆ $db

$db
protected

◆ $from

$from = []
protected

◆ $options

$options
protected

La documentation de cette classe a été générée à partir du fichier suivant :