Class JDatabaseImporterMySQL

Description

MySQL import driver.

  • since: 11.1

Located in /libraries/joomla/database/database/mysqlimporter.php (line 19)


	
			
Direct descendents
Class Description
JDatabaseImporterMySQLi MySQL import driver.
Variable Summary
Method Summary
JDatabaseImporterMySQL __construct ()
JDatabaseImporterMySQL from (mixed $from)
string getAddColumnSQL (string $table, SimpleXMLElement $field)
string getAddKeySQL (string $table, array $keys)
array getAlterTableSQL (SimpleXMLElement $structure)
string getChangeColumnSQL (string $table, SimpleXMLElement $field)
string getColumnSQL (SimpleXMLElement $field)
string getDropColumnSQL (string $table, string $name)
string getDropKeySQL (string $table, string $name)
string getDropPrimaryKeySQL (string $table)
array getKeyLookup (array $keys)
string getKeySQL (array $columns)
string getRealTableName (string $table)
void mergeStructure ()
JDatabaseImporterMySQL withStructure ([boolean $setting = true])
Variables
string $asFormat = 'xml' (line 49)

The type of input format (XML).

  • since: 11.1
  • access: protected
array $cache = array() (line 25)
  • var: An array of cached data.
  • since: 11.1
  • access: protected
JDatabaseMySQL $db = null (line 33)

The database connector to use for exporting structure and/or data.

  • since: 11.1
  • access: protected
mixed $from = array() (line 41)

The input source.

  • since: 11.1
  • access: protected
JObject $options = null (line 57)

An array of options for the exporter.

  • since: 11.1
  • access: protected
Methods
Constructor __construct (line 66)

Constructor.

Sets up the default options for the exporter.

  • since: 11.1
  • access: public
JDatabaseImporterMySQL __construct ()
asXml (line 90)

Set the output option for the exporter to XML format.

  • return: Method supports chaining.
  • since: 11.1
  • access: public
check (line 105)

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

  • return: Method supports chaining.
  • since: 11.1
  • throws: Exception if an error is encountered.
  • access: public

Redefined in descendants as:
from (line 131)

Specifies the data source to import.

  • return: Method supports chaining.
  • since: 11.1
  • access: public
JDatabaseImporterMySQL from (mixed $from)
  • mixed $from: The data source to import.
getAddColumnSQL (line 148)

Get the SQL syntax to add a column.

  • since: 11.1
  • access: protected
string getAddColumnSQL (string $table, SimpleXMLElement $field)
  • string $table: The table name.
  • SimpleXMLElement $field: The XML field definition.
getAddKeySQL (line 165)

Get the SQL syntax to add a key.

  • since: 11.1
  • access: protected
string getAddKeySQL (string $table, array $keys)
  • string $table: The table name.
  • array $keys: An array of the fields pertaining to this key.
getAlterTableSQL (line 181)

Get alters for table if there is a difference.

  • since: 11.1
  • access: protected
array getAlterTableSQL (SimpleXMLElement $structure)
  • SimpleXMLElement $structure: The XML structure pf the table.
getChangeColumnSQL (line 330)

Get the syntax to alter a column.

  • since: 11.1
  • access: protected
string getChangeColumnSQL (string $table, SimpleXMLElement $field)
  • string $table: The name of the database table to alter.
  • SimpleXMLElement $field: The XML definition for the field.
getColumnSQL (line 347)

Get the SQL syntax for a single column that would be included in a table create or alter statement.

  • since: 11.1
  • access: protected
string getColumnSQL (SimpleXMLElement $field)
  • SimpleXMLElement $field: The XML field definition.
getDropColumnSQL (line 404)

Get the SQL syntax to drop a column.

  • since: 11.1
  • access: protected
string getDropColumnSQL (string $table, string $name)
  • string $table: The table name.
  • string $name: The name of the field to drop.
getDropKeySQL (line 421)

Get the SQL syntax to drop a key.

  • since: 11.1
  • access: protected
string getDropKeySQL (string $table, string $name)
  • string $table: The table name.
  • string $name: The name of the key to drop.
getDropPrimaryKeySQL (line 437)

Get the SQL syntax to drop a key.

  • since: 11.1
  • access: protected
string getDropPrimaryKeySQL (string $table)
  • string $table: The table name.
getKeyLookup (line 454)

Get the details list of keys for a table.

  • return: The lookup array. array({key name} => array(object, ...))
  • since: 11.1
  • throws: Exception
  • access: protected
array getKeyLookup (array $keys)
  • array $keys: An array of objects that comprise the keys for the table.
getKeySQL (line 487)

Get the SQL syntax for a key.

  • since: 11.1
  • access: protected
string getKeySQL (array $columns)
  • array $columns: An array of SimpleXMLElement objects comprising the key.
getRealTableName (line 534)

Get the real name of the table, converting the prefix wildcard string if present.

  • return: The real name of the table.
  • since: 11.1
  • access: protected
string getRealTableName (string $table)
  • string $table: The name of the table.
mergeStructure (line 555)

Merges the incoming structure definition with the existing structure.

  • todo: If it's not XML convert to XML first.
  • throws: Exception on error.
  • since: 11.1
  • access: protected
void mergeStructure ()
setDbo (line 629)

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

  • return: Method supports chaining.
  • since: 11.1
  • access: public

Redefined in descendants as:
withStructure (line 645)

Sets an internal option to merge the structure based on the input data.

  • return: Method supports chaining.
  • since: 11.1
  • access: public
JDatabaseImporterMySQL withStructure ([boolean $setting = true])
  • boolean $setting: True to export the structure, false to not.

Documentation generated on Mon, 25 Jun 2012 13:58:02 -0500 by phpDocumentor 1.4.4