Class JDatabaseExporter

Joomla Platform Database Exporter Class

Direct known subclasses

JDatabaseExporterMysqli, JDatabaseExporterPdomysql, JDatabaseExporterPostgresql

Indirect known subclasses

JDatabaseExporterMysql

Abstract
Package: Joomla\Platform\Database
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.1
Located at joomla/database/exporter.php

Methods summary

`public`	# `__construct( )` Constructor. Constructor. Sets up the default options for the exporter. Since 13.1
`public string`	# `__toString( )` Magic function to exports the data to a string. Magic function to exports the data to a string. Returns `string` Throws `Exception` - if an error is encountered. Since 13.1
`public DatabaseExporter`	# `asXml( )` Set the output option for the exporter to XML format. Set the output option for the exporter to XML format. Returns `DatabaseExporter` - Method supports chaining. Since 13.1
`abstract protected string`	# `buildXml( )` Builds the XML data for the tables to export. Builds the XML data for the tables to export. Returns `string` - An XML string Throws `Exception` - if an error occurs. Since 13.1
`abstract protected array`	# `buildXmlStructure( )` Builds the XML structure to export. Builds the XML structure to export. Returns `array` - An array of XML lines (strings). Throws `Exception` - if an error occurs. Since 13.1
`abstract public DatabaseDriver`	# `check( )` Checks if all data and options are in order prior to exporting. Checks if all data and options are in order prior to exporting. Returns `DatabaseDriver` - Method supports chaining. Throws `Exception` - if an error is encountered. Since 13.1
`public JDatabaseExporter`	# `from( mixed $from )` Specifies a list of table names to export. Specifies a list of table names to export. Parameters `$from` `mixed` - $from The name of a single table, or an array of the table names to export. Returns `JDatabaseExporter` - Method supports chaining. Throws `Exception` - if input is not a string or array. Since 13.1
`protected string`	# `getGenericTableName( string $table )` Get the generic name of the table, converting the database prefix to the wildcard string. Get the generic name of the table, converting the database prefix to the wildcard string. Parameters `$table` `string` - $table The name of the table. Returns `string` - The name of the table with the database prefix replaced with #__. Since 13.1
`public JDatabaseExporter`	# `setDbo( JDatabaseDriver $db )` Sets the database connector to use for exporting structure and/or data from MySQL. Sets the database connector to use for exporting structure and/or data from MySQL. Parameters `$db` `JDatabaseDriver` - $db The database connector. Returns `JDatabaseExporter` - Method supports chaining. Since 13.1
`public JDatabaseExporter`	# `withStructure( boolean $setting = true )` Sets an internal option to export the structure of the input table(s). Sets an internal option to export the structure of the input table(s). Parameters `$setting` `boolean` - $setting True to export the structure, false to not. Returns `JDatabaseExporter` - Method supports chaining. Since 13.1

Magic methods summary

Properties summary

`protected string`	`$asFormat`	# The type of output format (xml). The type of output format (xml). Since 13.1
`protected array`	`$cache`	# An array of cached data. An array of cached data. Since 13.1
`protected JDatabaseDriver`	`$db`	# The database connector to use for exporting structure and/or data. The database connector to use for exporting structure and/or data. Since 13.1
`protected array`	`$from`	# An array input sources (table names). An array input sources (table names). Since 13.1
`protected object`	`$options`	# An array of options for the exporter. An array of options for the exporter. Since 13.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JDatabaseExporter

Direct known subclasses

Indirect known subclasses

Methods summary

Since

Returns

Throws

Since

Returns

Since

Returns

Throws

Since

Returns

Throws

Since

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since