Class JDatabaseImporter

Joomla Platform Database Importer Class

Direct known subclasses

JDatabaseImporterMysqli, JDatabaseImporterPdomysql, JDatabaseImporterPostgresql

Indirect known subclasses

JDatabaseImporterMysql

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/importer.php

Methods summary

`public`	# `__construct( )` Constructor. Constructor. Sets up the default options for the exporter. Since 13.1
`public JDatabaseImporter`	# `asXml( )` Set the output option for the exporter to XML format. Set the output option for the exporter to XML format. Returns `JDatabaseImporter` - Method supports chaining. Since 13.1
`abstract public JDatabaseImporter`	# `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 `JDatabaseImporter` - Method supports chaining. Throws `Exception` - if an error is encountered. Since 13.1
`public JDatabaseImporter`	# `from( mixed $from )` Specifies the data source to import. Specifies the data source to import. Parameters `$from` `mixed` - $from The data source to import. Returns `JDatabaseImporter` - Method supports chaining. Since 13.1
`protected string`	# `getDropColumnSql( string $table, string $name )` Get the SQL syntax to drop a column. Get the SQL syntax to drop a column. Parameters `$table` `string` - $table The table name. `$name` `string` - $name The name of the field to drop. Returns `string` Since 13.1
`protected string`	# `getRealTableName( string $table )` Get the real name of the table, converting the prefix wildcard string if present. Get the real name of the table, converting the prefix wildcard string if present. Parameters `$table` `string` - $table The name of the table. Returns `string` - The real name of the table. Since 13.1
`public`	# `mergeStructure( )` Merges the incoming structure definition with the existing structure. Merges the incoming structure definition with the existing structure. Throws `RuntimeException` - on error. Since 13.1 Note Currently only supports XML format.
`public JDatabaseImporter`	# `setDbo( JDatabaseDriver $db )` Sets the database connector to use for exporting structure and/or data. Sets the database connector to use for exporting structure and/or data. Parameters `$db` `JDatabaseDriver` - $db The database connector. Returns `JDatabaseImporter` - Method supports chaining. Since 13.1
`public JDatabaseImporter`	# `withStructure( boolean $setting = true )` Sets an internal option to merge the structure based on the input data. Sets an internal option to merge the structure based on the input data. Parameters `$setting` `boolean` - $setting True to export the structure, false to not. Returns `JDatabaseImporter` - Method supports chaining. Since 13.1

Magic methods summary

Properties summary

`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 mixed`	`$from`	# The input source. The input source. Since 13.1
`protected string`	`$asFormat`	# The type of input format (XML). The type of input format (XML). 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 JDatabaseImporter

Direct known subclasses

Indirect known subclasses

Methods summary

Since

Returns

Since

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Throws

Since

Note

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since