Référence de la classe JDatabaseExporter

Graphe d'héritage de JDatabaseExporter:

Liste de tous les membres

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

Définition à la ligne 19 du fichier exporter.php.

---

Documentation des constructeurs et destructeur

JDatabaseExporter::__construct

(

)

Constructor.

Sets up the default options for the exporter.

Depuis:

13.1

Définition à la ligne 68 du fichier exporter.php.

        {
                $this->options = new stdClass;

                $this->cache = array('columns' => array(), 'keys' => array());

                // Set up the class defaults:

                // Export with only structure
                $this->withStructure();

                // Export as xml.
                $this->asXml();

                // Default destination is a string using $output = (string) $exporter;
        }

---

Documentation des fonctions membres

JDatabaseExporter::__toString

(

)

Magic function to exports the data to a string.

Renvoie:

string

Depuis:

13.1

Exceptions:

Exception

if an error is encountered.

Définition à la ligne 93 du fichier exporter.php.

        {
                // Check everything is ok to run first.
                $this->check();

                // Get the format.
                switch ($this->asFormat)
                {
                        case 'xml':
                        default:
                                $buffer = $this->buildXml();
                                break;
                }

                return $buffer;
        }

JDatabaseExporter::asXml

(

)

Set the output option for the exporter to XML format.

Renvoie:

DatabaseExporter Method supports chaining.

Depuis:

13.1

Définition à la ligne 117 du fichier exporter.php.

        {
                $this->asFormat = 'xml';

                return $this;
        }

JDatabaseExporter::buildXml ( )

abstractprotected

Builds the XML data for the tables to export.

Renvoie:

string An XML string

Depuis:

13.1

Exceptions:

Exception

if an error occurs.

Réimplémentée dans JDatabaseExporterMysqli, et JDatabaseExporterPostgresql.

JDatabaseExporter::buildXmlStructure ( )

abstractprotected

Builds the XML structure to export.

Renvoie:

array An array of XML lines (strings).

Depuis:

13.1

Exceptions:

Exception

if an error occurs.

Réimplémentée dans JDatabaseExporterMysqli, et JDatabaseExporterPostgresql.

JDatabaseExporter::check ( )

abstract

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

Renvoie:

DatabaseDriver Method supports chaining.

Depuis:

13.1

Exceptions:

Exception

if an error is encountered.

Réimplémentée dans JDatabaseExporterPostgresql, JDatabaseExporterMysqli, et JDatabaseExporterMysql.

JDatabaseExporter::from

(

$from

)

Specifies a list of table names to export.

Paramètres:

mixed

$from

The name of a single table, or an array of the table names to export.

Renvoie:

JDatabaseExporter Method supports chaining.

Depuis:

13.1

Exceptions:

Exception

if input is not a string or array.

Définition à la ligne 164 du fichier exporter.php.

        {
                if (is_string($from))
                {
                        $this->from = array($from);
                }
                elseif (is_array($from))
                {
                        $this->from = $from;
                }
                else
                {
                        throw new Exception('JPLATFORM_ERROR_INPUT_REQUIRES_STRING_OR_ARRAY');
                }

                return $this;
        }

JDatabaseExporter::getGenericTableName (   $table )

protected

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

Paramètres:

string

$table

The name of the table.

Renvoie:

string The name of the table with the database prefix replaced with #__.

Depuis:

13.1

Définition à la ligne 191 du fichier exporter.php.

        {
                $prefix = $this->db->getPrefix();

                // Replace the magic prefix if found.
                $table = preg_replace("|^$prefix|", '#__', $table);

                return $table;
        }

JDatabaseExporter::setDbo

(

JDatabaseDriver

$db

)

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

Paramètres:

JDatabaseDriver

$db

The database connector.

Renvoie:

JDatabaseExporter Method supports chaining.

Depuis:

13.1

Définition à la ligne 210 du fichier exporter.php.

        {
                $this->db = $db;

                return $this;
        }

JDatabaseExporter::withStructure

(

$setting = true

)

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

Paramètres:

boolean

$setting

True to export the structure, false to not.

Renvoie:

JDatabaseExporter Method supports chaining.

Depuis:

13.1

Définition à la ligne 226 du fichier exporter.php.

        {
                $this->options->withStructure = (boolean) $setting;

                return $this;
        }

---

Documentation des données membres

JDatabaseExporter::$asFormat = 'xml'

protected

Définition à la ligne 27 du fichier exporter.php.

JDatabaseExporter::$cache = array()

protected

Définition à la ligne 35 du fichier exporter.php.

JDatabaseExporter::$db = null

protected

Définition à la ligne 43 du fichier exporter.php.

JDatabaseExporter::$from = array()

protected

Définition à la ligne 51 du fichier exporter.php.

JDatabaseExporter::$options = null

protected

Définition à la ligne 59 du fichier exporter.php.

---

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

• jplatform-13.1/joomla/database/exporter.php