Référence de la classe JDatabaseImporterPostgresql

Graphe d'héritage de JDatabaseImporterPostgresql:

Graphe de collaboration de JDatabaseImporterPostgresql:

Liste de tous les membres

Fonctions membres publiques
	check ()
Fonctions membres publiques inherited from JDatabaseImporter
	__construct ()
	asXml ()
	from ($from)
	setDbo (JDatabaseDriver $db)
	withStructure ($setting=true)

Fonctions membres protégées
	getAddColumnSQL ($table, SimpleXMLElement $field)
	getAddIndexSQL (SimpleXMLElement $field)
	getAlterTableSQL (SimpleXMLElement $structure)
	getDropSequenceSQL ($name)
	getAddSequenceSQL ($field)
	getChangeSequenceSQL ($field)
	getChangeColumnSQL ($table, SimpleXMLElement $field)
	getAlterColumnSQL ($table, $field)
	getColumnSQL (SimpleXMLElement $field)
	getDropIndexSQL ($name)
	getDropPrimaryKeySQL ($table, $name)
	getIdxLookup ($keys)
	getSeqLookup ($sequences)
Fonctions membres protégées inherited from JDatabaseImporter
	getDropColumnSQL ($table, $name)
	getRealTableName ($table)
	mergeStructure ()

Additional Inherited Members
Attributs protégés inherited from JDatabaseImporter
	$cache = array()
	$db = null
	$from = array()
	$asFormat = 'xml'
	$options = null

---

Description détaillée

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

---

Documentation des fonctions membres

JDatabaseImporterPostgresql::check

(

)

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

Renvoie:

JDatabaseImporterPostgresql Method supports chaining.

Depuis:

12.1

Exceptions:

Exception

if an error is encountered.

Réimplémentée à partir de JDatabaseImporter.

Définition à la ligne 29 du fichier postgresql.php.

        {
                // Check if the db connector has been set.
                if (!($this->db instanceof JDatabaseDriverPostgresql))
                {
                        throw new Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
                }

                // Check if the tables have been specified.
                if (empty($this->from))
                {
                        throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
                }

                return $this;
        }

JDatabaseImporterPostgresql::getAddColumnSQL (   $table, SimpleXMLElement  $field  )

protected

Get the SQL syntax to add a column.

Paramètres:

string	$table	The table name.
SimpleXMLElement	$field	The XML field definition.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 56 du fichier postgresql.php.

        {
                return 'ALTER TABLE ' . $this->db->quoteName($table) . ' ADD COLUMN ' . $this->getColumnSQL($field);
        }

JDatabaseImporterPostgresql::getAddIndexSQL ( SimpleXMLElement  $field )

protected

Get the SQL syntax to add an index.

Paramètres:

SimpleXMLElement

$field

The XML index definition.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 70 du fichier postgresql.php.

        {
                return (string) $field['Query'];
        }

JDatabaseImporterPostgresql::getAddSequenceSQL (   $field )

protected

Get the syntax to add a sequence.

Paramètres:

SimpleXMLElement

$field

The XML definition for the sequence.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 275 du fichier postgresql.php.

        {
                /* For older database version that doesn't support these fields use default values */
                if (version_compare($this->db->getVersion(), '9.1.0') < 0)
                {
                        $field['Min_Value'] = '1';
                        $field['Max_Value'] = '9223372036854775807';
                        $field['Increment'] = '1';
                        $field['Cycle_option'] = 'NO';
                        $field['Start_Value'] = '1';
                }

                return 'CREATE SEQUENCE ' . (string) $field['Name'] .
                        ' INCREMENT BY ' . (string) $field['Increment'] . ' MINVALUE ' . $field['Min_Value'] .
                        ' MAXVALUE ' . (string) $field['Max_Value'] . ' START ' . (string) $field['Start_Value'] .
                        (((string) $field['Cycle_option'] == 'NO') ? ' NO' : '') . ' CYCLE' .
                        ' OWNED BY ' . $this->db->quoteName((string) $field['Schema'] . '.' . (string) $field['Table'] . '.' . (string) $field['Column']);
        }

JDatabaseImporterPostgresql::getAlterColumnSQL (   $table,   $field  )

protected

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

Paramètres:

string	$table	The name of the database table to alter.
SimpleXMLElement	$field	The XML field definition.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 347 du fichier postgresql.php.

        {
                // TODO Incorporate into parent class and use $this.
                $blobs = array('text', 'smalltext', 'mediumtext', 'largetext');

                $fName = (string) $field['Field'];
                $fType = (string) $field['Type'];
                $fNull = (string) $field['Null'];
                $fDefault = (isset($field['Default']) && $field['Default'] != 'NULL' ) ?
                                                preg_match('/^[0-9]$/', $field['Default']) ? $field['Default'] : $this->db->quote((string) $field['Default'])
                                        : null;

                $query = ' TYPE ' . $fType;

                if ($fNull == 'NO')
                {
                        if (in_array($fType, $blobs) || $fDefault === null)
                        {
                                $query .= ",\nALTER COLUMN " . $this->db->quoteName($fName) . ' SET NOT NULL' .
                                                ",\nALTER COLUMN " . $this->db->quoteName($fName) . ' DROP DEFAULT';
                        }
                        else
                        {
                                $query .= ",\nALTER COLUMN " . $this->db->quoteName($fName) . ' SET NOT NULL' .
                                                ",\nALTER COLUMN " . $this->db->quoteName($fName) . ' SET DEFAULT ' . $fDefault;
                        }
                }
                else
                {
                        if ($fDefault !== null)
                        {
                                $query .= ",\nALTER COLUMN " . $this->db->quoteName($fName) . ' DROP NOT NULL' .
                                                ",\nALTER COLUMN " . $this->db->quoteName($fName) . ' SET DEFAULT ' . $fDefault;
                        }
                }

                /* sequence was created in other function, here is associated a default value but not yet owner */
                if (strpos($fDefault, 'nextval') !== false)
                {
                        $query .= ";\nALTER SEQUENCE " . $this->db->quoteName($table . '_' . $fName . '_seq') . ' OWNED BY ' . $this->db->quoteName($table . '.' . $fName);
                }

                return $query;
        }

JDatabaseImporterPostgresql::getAlterTableSQL ( SimpleXMLElement  $structure )

protected

Get alters for table if there is a difference.

Paramètres:

SimpleXMLElement

$structure

The XML structure of the table.

Renvoie:

array

Depuis:

12.1

Définition à la ligne 84 du fichier postgresql.php.

        {
                $table = $this->getRealTableName($structure['name']);
                $oldFields = $this->db->getTableColumns($table);
                $oldKeys = $this->db->getTableKeys($table);
                $oldSequence = $this->db->getTableSequences($table);
                $alters = array();

                // Get the fields and keys from the XML that we are aiming for.
                $newFields = $structure->xpath('field');
                $newKeys = $structure->xpath('key');
                $newSequence = $structure->xpath('sequence');

                /* Sequence section */
                $oldSeq = $this->getSeqLookup($oldSequence);
                $newSequenceLook = $this->getSeqLookup($newSequence);

                foreach ($newSequenceLook as $kSeqName => $vSeq)
                {
                        if (isset($oldSeq[$kSeqName]))
                        {
                                // The field exists, check it's the same.
                                $column = $oldSeq[$kSeqName][0];

                                /* For older database version that doesn't support these fields use default values */
                                if (version_compare($this->db->getVersion(), '9.1.0') < 0)
                                {
                                        $column->Min_Value = '1';
                                        $column->Max_Value = '9223372036854775807';
                                        $column->Increment = '1';
                                        $column->Cycle_option = 'NO';
                                        $column->Start_Value = '1';
                                }

                                // Test whether there is a change.
                                $change = ((string) $vSeq[0]['Type'] != $column->Type) || ((string) $vSeq[0]['Start_Value'] != $column->Start_Value)
                                        || ((string) $vSeq[0]['Min_Value'] != $column->Min_Value) || ((string) $vSeq[0]['Max_Value'] != $column->Max_Value)
                                        || ((string) $vSeq[0]['Increment'] != $column->Increment) || ((string) $vSeq[0]['Cycle_option'] != $column->Cycle_option)
                                        || ((string) $vSeq[0]['Table'] != $column->Table) || ((string) $vSeq[0]['Column'] != $column->Column)
                                        || ((string) $vSeq[0]['Schema'] != $column->Schema) || ((string) $vSeq[0]['Name'] != $column->Name);

                                if ($change)
                                {
                                        $alters[] = $this->getChangeSequenceSQL($kSeqName, $vSeq);
                                }

                                // Unset this field so that what we have left are fields that need to be removed.
                                unset($oldSeq[$kSeqName]);
                        }
                        else
                        {
                                // The sequence is new
                                $alters[] = $this->getAddSequenceSQL($newSequenceLook[$kSeqName][0]);
                        }
                }

                // Any sequences left are orphans
                foreach ($oldSeq as $name => $column)
                {
                        // Delete the sequence.
                        $alters[] = $this->getDropSequenceSQL($name);
                }

                /* Field section */
                // Loop through each field in the new structure.
                foreach ($newFields as $field)
                {
                        $fName = (string) $field['Field'];

                        if (isset($oldFields[$fName]))
                        {
                                // The field exists, check it's the same.
                                $column = $oldFields[$fName];

                                // Test whether there is a change.
                                $change = ((string) $field['Type'] != $column->Type) || ((string) $field['Null'] != $column->Null)
                                        || ((string) $field['Default'] != $column->Default);

                                if ($change)
                                {
                                        $alters[] = $this->getChangeColumnSQL($table, $field);
                                }

                                // Unset this field so that what we have left are fields that need to be removed.
                                unset($oldFields[$fName]);
                        }
                        else
                        {
                                // The field is new.
                                $alters[] = $this->getAddColumnSQL($table, $field);
                        }
                }

                // Any columns left are orphans
                foreach ($oldFields as $name => $column)
                {
                        // Delete the column.
                        $alters[] = $this->getDropColumnSQL($table, $name);
                }

                /* Index section */
                // Get the lookups for the old and new keys
                $oldLookup = $this->getIdxLookup($oldKeys);
                $newLookup = $this->getIdxLookup($newKeys);

                // Loop through each key in the new structure.
                foreach ($newLookup as $name => $keys)
                {
                        // Check if there are keys on this field in the existing table.
                        if (isset($oldLookup[$name]))
                        {
                                $same = true;
                                $newCount = count($newLookup[$name]);
                                $oldCount = count($oldLookup[$name]);

                                // There is a key on this field in the old and new tables. Are they the same?
                                if ($newCount == $oldCount)
                                {
                                        for ($i = 0; $i < $newCount; $i++)
                                        {
                                                // Check only query field -> different query means different index
                                                $same = ((string) $newLookup[$name][$i]['Query'] == $oldLookup[$name][$i]->Query);

                                                if (!$same)
                                                {
                                                        // Break out of the loop. No need to check further.
                                                        break;
                                                }
                                        }
                                }
                                else
                                {
                                        // Count is different, just drop and add.
                                        $same = false;
                                }

                                if (!$same)
                                {
                                        $alters[] = $this->getDropIndexSQL($name);
                                        $alters[]  = (string) $newLookup[$name][0]['Query'];
                                }

                                // Unset this field so that what we have left are fields that need to be removed.
                                unset($oldLookup[$name]);
                        }
                        else
                        {
                                // This is a new key.
                                $alters[] = (string) $newLookup[$name][0]['Query'];
                        }
                }

                // Any keys left are orphans.
                foreach ($oldLookup as $name => $keys)
                {
                        if ($oldLookup[$name][0]->is_primary == 'TRUE')
                        {
                                $alters[] = $this->getDropPrimaryKeySQL($table, $oldLookup[$name][0]->Index);
                        }
                        else
                        {
                                $alters[] = $this->getDropIndexSQL($name);
                        }
                }

                return $alters;
        }

JDatabaseImporterPostgresql::getChangeColumnSQL (   $table, SimpleXMLElement  $field  )

protected

Get the syntax to alter a column.

Paramètres:

string	$table	The name of the database table to alter.
SimpleXMLElement	$field	The XML definition for the field.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 331 du fichier postgresql.php.

        {
                return 'ALTER TABLE ' . $this->db->quoteName($table) . ' ALTER COLUMN ' . $this->db->quoteName((string) $field['Field']) . ' '
                        . $this->getAlterColumnSQL($table, $field);
        }

JDatabaseImporterPostgresql::getChangeSequenceSQL (   $field )

protected

Get the syntax to alter a sequence.

Paramètres:

SimpleXMLElement

$field

The XML definition for the sequence.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 303 du fichier postgresql.php.

        {
                /* For older database version that doesn't support these fields use default values */
                if (version_compare($this->db->getVersion(), '9.1.0') < 0)
                {
                        $field['Min_Value'] = '1';
                        $field['Max_Value'] = '9223372036854775807';
                        $field['Increment'] = '1';
                        $field['Cycle_option'] = 'NO';
                        $field['Start_Value'] = '1';
                }

                return 'ALTER SEQUENCE ' . (string) $field['Name'] .
                        ' INCREMENT BY ' . (string) $field['Increment'] . ' MINVALUE ' . (string) $field['Min_Value'] .
                        ' MAXVALUE ' . (string) $field['Max_Value'] . ' START ' . (string) $field['Start_Value'] .
                        ' OWNED BY ' . $this->db->quoteName((string) $field['Schema'] . '.' . (string) $field['Table'] . '.' . (string) $field['Column']);
        }

JDatabaseImporterPostgresql::getColumnSQL ( SimpleXMLElement  $field )

protected

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

Paramètres:

SimpleXMLElement

$field

The XML field definition.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 401 du fichier postgresql.php.

        {
                // TODO Incorporate into parent class and use $this.
                $blobs = array('text', 'smalltext', 'mediumtext', 'largetext');

                $fName = (string) $field['Field'];
                $fType = (string) $field['Type'];
                $fNull = (string) $field['Null'];
                $fDefault = (isset($field['Default']) && $field['Default'] != 'NULL' ) ?
                                                preg_match('/^[0-9]$/', $field['Default']) ? $field['Default'] : $this->db->quote((string) $field['Default'])
                                        : null;

                /* nextval() as default value means that type field is serial */
                if (strpos($fDefault, 'nextval') !== false)
                {
                        $query = $this->db->quoteName($fName) . ' SERIAL';
                }
                else
                {
                        $query = $this->db->quoteName($fName) . ' ' . $fType;

                        if ($fNull == 'NO')
                        {
                                if (in_array($fType, $blobs) || $fDefault === null)
                                {
                                        $query .= ' NOT NULL';
                                }
                                else
                                {
                                        $query .= ' NOT NULL DEFAULT ' . $fDefault;
                                }
                        }
                        else
                        {
                                if ($fDefault !== null)
                                {
                                        $query .= ' DEFAULT ' . $fDefault;
                                }
                        }
                }

                return $query;
        }

JDatabaseImporterPostgresql::getDropIndexSQL (   $name )

protected

Get the SQL syntax to drop an index.

Paramètres:

string

$name

The name of the key to drop.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 454 du fichier postgresql.php.

        {
                return 'DROP INDEX ' . $this->db->quoteName($name);
        }

JDatabaseImporterPostgresql::getDropPrimaryKeySQL (   $table,   $name  )

protected

Get the SQL syntax to drop a key.

Paramètres:

string	$table	The table name.
string	$name	The constraint name.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 469 du fichier postgresql.php.

        {
                return 'ALTER TABLE ONLY ' . $this->db->quoteName($table) . ' DROP CONSTRAINT ' . $this->db->quoteName($name);
        }

JDatabaseImporterPostgresql::getDropSequenceSQL (   $name )

protected

Get the SQL syntax to drop a sequence.

Paramètres:

string

$name

The name of the sequence to drop.

Renvoie:

string

Depuis:

12.1

Définition à la ligne 261 du fichier postgresql.php.

        {
                return 'DROP SEQUENCE ' . $this->db->quoteName($name);
        }

JDatabaseImporterPostgresql::getIdxLookup (   $keys )

protected

Get the details list of keys for a table.

Paramètres:

array

$keys

An array of objects that comprise the keys for the table.

Renvoie:

array The lookup array. array({key name} => array(object, ...))

Depuis:

12.1

Exceptions:

Exception

Définition à la ligne 484 du fichier postgresql.php.

        {
                // First pass, create a lookup of the keys.
                $lookup = array();

                foreach ($keys as $key)
                {
                        if ($key instanceof SimpleXMLElement)
                        {
                                $kName = (string) $key['Index'];
                        }
                        else
                        {
                                $kName = $key->Index;
                        }

                        if (empty($lookup[$kName]))
                        {
                                $lookup[$kName] = array();
                        }

                        $lookup[$kName][] = $key;
                }

                return $lookup;
        }

JDatabaseImporterPostgresql::getSeqLookup (   $sequences )

protected

Get the details list of sequences for a table.

Paramètres:

array

$sequences

An array of objects that comprise the sequences for the table.

Renvoie:

array The lookup array. array({key name} => array(object, ...))

Depuis:

12.1

Exceptions:

Exception

Définition à la ligne 521 du fichier postgresql.php.

        {
                // First pass, create a lookup of the keys.
                $lookup = array();

                foreach ($sequences as $seq)
                {
                        if ($seq instanceof SimpleXMLElement)
                        {
                                $sName = (string) $seq['Name'];
                        }
                        else
                        {
                                $sName = $seq->Name;
                        }

                        if (empty($lookup[$sName]))
                        {
                                $lookup[$sName] = array();
                        }

                        $lookup[$sName][] = $seq;
                }

                return $lookup;
        }

---

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

• jplatform-13.1/joomla/database/importer/postgresql.php