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

Fonctions membres publiques

 __construct ()
 
 __toString ()
 
 asXml ()
 
 check ()
 
 from ($from)
 
 setDbo (DatabaseInterface $db)
 
 withStructure ($setting=true)
 
 withData ($setting=false)
 

Fonctions membres protégées

 buildXml ()
 
 buildXmlStructure ()
 
 getGenericTableName ($table)
 
 buildXmlData ()
 

Attributs protégés

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

Description détaillée

Joomla Framework Database Exporter Class

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor.

Sets up the default options for the exporter.

Depuis
1.0

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

Documentation des fonctions membres

◆ __toString()

__toString ( )

Magic function to exports the data to a string.

Renvoie
string
Depuis
1.0

Références $buffer, DatabaseExporter\buildXml(), et DatabaseExporter\check().

◆ asXml()

asXml ( )

Set the output option for the exporter to XML format.

Renvoie
$this
Depuis
1.0

Références $this.

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

◆ buildXml()

buildXml ( )
abstractprotected

Builds the XML data for the tables to export.

Renvoie
string An XML string
Depuis
1.0
Exceptions

Référencé par DatabaseExporter\__toString().

◆ buildXmlData()

buildXmlData ( )
protected

Builds the XML data to export.

Renvoie
array An array of XML lines (strings).
Depuis
2.0.0
Exceptions

Références $buffer, $field, $fields, $key, $rows, $value, ENT_COMPAT, DatabaseExporter\from(), et DatabaseExporter\getGenericTableName().

Référencé par MysqlExporter\buildXml(), et MysqliExporter\buildXml().

◆ buildXmlStructure()

buildXmlStructure ( )
abstractprotected

Builds the XML structure to export.

Renvoie
array An array of XML lines (strings).
Depuis
1.0
Exceptions

◆ check()

check ( )
abstract

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

Renvoie
$this
Depuis
1.0
Exceptions

Référencé par DatabaseExporter\__toString().

◆ from()

from (   $from)

Specifies a list of table names to export.

Paramètres
string[]|string$from The name of a single table, or an array of the table names to export.
Renvoie
$this
Depuis
1.0
Exceptions

Références DatabaseExporter\$from, $this, et elseif.

Référencé par DatabaseExporter\buildXmlData(), MysqlExporter\buildXmlStructure(), MysqliExporter\buildXmlStructure(), PgsqlExporter\buildXmlStructure(), MysqlExporter\check(), et MysqliExporter\check().

◆ getGenericTableName()

getGenericTableName (   $table)
protected

Get the generic name of the table, converting the database prefix to the wildcard string.

Paramètres
string$tableThe name of the table.
Renvoie
string The name of the table with the database prefix replaced with #__.
Depuis
1.0

Références $prefix.

Référencé par DatabaseExporter\buildXmlData(), PgsqlExporter\buildXmlStructure(), MysqliExporter\buildXmlStructure(), et MysqlExporter\buildXmlStructure().

◆ setDbo()

setDbo ( DatabaseInterface  $db)

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

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

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

◆ withData()

withData (   $setting = false)

Sets an internal option to export the data of the input table(s).

Paramètres
boolean$settingTrue to export the data, false to not.
Renvoie
$this
Depuis
2.0.0

Références $this.

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

◆ withStructure()

withStructure (   $setting = true)

Sets an internal option to export the structure of the input table(s).

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

Références $this.

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

Documentation des champs

◆ $asFormat

$asFormat = 'xml'
protected

◆ $cache

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

◆ $db

$db
protected

Référencé par DatabaseExporter\setDbo().

◆ $from

$from = []
protected

Référencé par DatabaseExporter\from().

◆ $options

$options
protected

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