Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JDatabaseExporter
+ Graphe d'héritage de JDatabaseExporter:

Fonctions membres publiques

 __construct ()
 
 __toString ()
 
 asXml ()
 
 check ()
 
 from ($from)
 
 setDbo (JDatabaseDriver $db)
 
 withStructure ($setting=true)
 

Fonctions membres protégées

 buildXml ()
 
 buildXmlStructure ()
 
 getGenericTableName ($table)
 

Attributs protégés

 $asFormat = 'xml'
 
 $cache = array()
 
 $db = null
 
 $from = array()
 
 $options = null
 

Description détaillée

Joomla Platform Database Exporter Class

Depuis
3.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor.

Sets up the default options for the exporter.

Depuis
3.2.0

Documentation des fonctions membres

◆ __toString()

__toString ( )

Magic function to exports the data to a string.

Renvoie
string
Depuis
3.2.0
Exceptions
Exceptionif an error is encountered.

Références $buffer.

◆ asXml()

asXml ( )

Set the output option for the exporter to XML format.

Renvoie
JDatabaseExporter Method supports chaining.
Depuis
3.2.0

◆ buildXml()

buildXml ( )
abstractprotected

Builds the XML data for the tables to export.

Renvoie
string An XML string
Depuis
3.2.0
Exceptions
Exceptionif an error occurs.

◆ buildXmlStructure()

buildXmlStructure ( )
abstractprotected

Builds the XML structure to export.

Renvoie
array An array of XML lines (strings).
Depuis
3.2.0
Exceptions
Exceptionif an error occurs.

◆ check()

check ( )
abstract

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

Renvoie
JDatabaseDriver Method supports chaining.
Depuis
3.2.0
Exceptions
Exceptionif an error is encountered.

◆ from()

from (   $from)

Specifies a list of table names to export.

Paramètres
mixed$fromThe name of a single table, or an array of the table names to export.
Renvoie
JDatabaseExporter Method supports chaining.
Depuis
3.2.0
Exceptions
Exceptionif input is not a string or array.

Références elseif.

◆ 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
3.2.0

Références $prefix.

◆ setDbo()

setDbo ( JDatabaseDriver  $db)

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

Paramètres
JDatabaseDriver$dbThe database connector.
Renvoie
JDatabaseExporter Method supports chaining.
Depuis
3.2.0

Références $db.

◆ 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
JDatabaseExporter Method supports chaining.
Depuis
3.2.0

Documentation des champs

◆ $asFormat

$asFormat = 'xml'
protected

◆ $cache

$cache = array()
protected

◆ $db

$db = null
protected

◆ $from

$from = array()
protected

◆ $options

$options = null
protected

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