This class gives all kind of DB information using the database manager and reverse module. More...

Collaboration diagram for ilDBAnalyzer:

Public Member Functions
	__construct (ilDBInterface $ilDBInterface=null)
	ilDBAnalyzer constructor. More...

	getFieldInformation ($a_table, $a_remove_not_allowed_attributes=false)
	Get field information of a table. More...

	getBestDefinitionAlternative ($a_def)

	getAutoIncrementField ($a_table)
	Gets the auto increment field of a table. More...

	getPrimaryKeyInformation ($a_table)
	Get primary key of a table. More...

	getIndicesInformation ($a_table, $a_abstract_table=false)
	Get information on indices of a table. More...

	getConstraintsInformation ($a_table, $a_abstract_table=false)
	Get information on constraints of a table. More...

	hasSequence ($a_table)
	Check whether sequence is defined for current table (only works on "abstraced" tables) More...

Protected Attributes
	$manager

	$reverse

	$il_db

	$allowed_attributes

Detailed Description

This class gives all kind of DB information using the database manager and reverse module.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Deprecated:: Use global ilDB only. If something is missing there, please contact fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 16 of file class.ilDBAnalyzer.php.

Constructor & Destructor Documentation

◆ __construct()

ilDBAnalyzer::__construct ( ilDBInterface $ilDBInterface = null )

ilDBAnalyzer constructor.

Parameters

\ilDBInterface $ilDBInterface

Deprecated:: Use global ilDB only. If something is missing there, please contact fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 44 of file class.ilDBAnalyzer.php.

    {
        if (!$ilDBInterface instanceof ilDBInterface) {
            global $DIC;
            $ilDB = $DIC->database();
            $ilDBInterface = $ilDB;
        }
 
        $this->manager = $ilDBInterface->loadModule(ilDBConstants::MODULE_MANAGER);
        $this->reverse = $ilDBInterface->loadModule(ilDBConstants::MODULE_REVERSE);
        $this->il_db = $ilDBInterface;
        $this->allowed_attributes = $ilDBInterface->getAllowedAttributes();
    }

References $DIC, $ilDB, ilDBConstants\MODULE_MANAGER, and ilDBConstants\MODULE_REVERSE.

Member Function Documentation

◆ getAutoIncrementField()

ilDBAnalyzer::getAutoIncrementField ( $a_table )

Gets the auto increment field of a table.

This should be used on ILIAS 3.10.x "MySQL" tables only.

Parameters

string table name

Returns: string name of autoincrement field

Definition at line 152 of file class.ilDBAnalyzer.php.

    {
        $fields = $this->manager->listTableFields($a_table);
        $inf = array();
 
        foreach ($fields as $field) {
            $rdef = $this->reverse->getTableFieldDefinition($a_table, $field);
            if ($rdef[0]["autoincrement"]) {
                return $field;
            }
        }
 
        return false;
    }

◆ getBestDefinitionAlternative()

ilDBAnalyzer::getBestDefinitionAlternative ( $a_def )

Parameters

$a_def

Returns: int|string

Definition at line 116 of file class.ilDBAnalyzer.php.

    {
        // determine which type to choose
        $car = array(
            "boolean" => 10,
            "integer" => 20,
            "decimal" => 30,
            "float" => 40,
            "date" => 50,
            "time" => 60,
            "timestamp" => 70,
            "text" => 80,
            "clob" => 90,
            "blob" => 100,
        );
 
        $cur_car = 0;
        $best_alt = 0;    // best alternatice
        foreach ($a_def as $k => $rd) {
            if ($car[$rd["type"]] > $cur_car) {
                $cur_car = $car[$rd["type"]];
                $best_alt = $k;
            }
        }
 
        return $best_alt;
    }

Referenced by getFieldInformation().

Here is the caller graph for this function:

◆ getConstraintsInformation()

ilDBAnalyzer::getConstraintsInformation	(	$a_table,
		$a_abstract_table = `false`
	)

Get information on constraints of a table.

Primary key is NOT included! Fulltext indices are included and marked.

Parameters

string table name

Returns: array indices information array

Definition at line 262 of file class.ilDBAnalyzer.php.

    {
        $constraints = $this->manager->listTableConstraints($a_table);
 
        $cons = array();
        foreach ($constraints as $c) {
            $info = $this->reverse->getTableConstraintDefinition($a_table, $c);
            //var_dump($info);
            $i = array();
            if ($info["unique"]) {
                $i["name"] = $c;
                $i["type"] = "unique";
                foreach ($info["fields"] as $k => $f) {
                    $i["fields"][$k] = array(
                        "position" => $f["position"],
                        "sorting" => $f["sorting"],
                    );
                }
                $cons[] = $i;
            }
        }
 
        return $cons;
    }

References Vendor\Package\$c, Vendor\Package\$f, and $i.

◆ getFieldInformation()

ilDBAnalyzer::getFieldInformation	(	$a_table,
		$a_remove_not_allowed_attributes = `false`
	)

Get field information of a table.

Parameters

string table name

Returns: array field information array

Definition at line 65 of file class.ilDBAnalyzer.php.

    {
        $fields = $this->manager->listTableFields($a_table);
        $inf = array();
        foreach ($fields as $field) {
            $rdef = $this->reverse->getTableFieldDefinition($a_table, $field);
            // is this possible?
            if (isset($rdef["mdb2type"]) && isset($rdef["type"]) && $rdef["type"] != $rdef["mdb2type"]) {
                throw new ilDatabaseException("ilDBAnalyzer::getFielInformation: Found type != mdb2type: $a_table, $field");
            }
 
            $best_alt = $this->getBestDefinitionAlternative($rdef);
 
            // collect other alternatives
            reset($rdef);
            $alt_types = "";
            foreach ($rdef as $k => $rd) {
                if ($k != $best_alt) {
                    $alt_types .= ($rdef[$k]["type"] ?? "") . ($rdef[$k]["length"] ?? "") . " ";
                }
            }
 
            $inf[$field] = array(
                "notnull" => $rdef[$best_alt]["notnull"] ?? null,
                "nativetype" => $rdef[$best_alt]["nativetype"] ?? null,
                "length" => $rdef[$best_alt]["length"] ?? null,
                "unsigned" => $rdef[$best_alt]["unsigned"] ?? null,
                "default" => $rdef[$best_alt]["default"] ?? null,
                "fixed" => $rdef[$best_alt]["fixed"] ?? null,
                "autoincrement" => $rdef[$best_alt]["autoincrement"] ?? null,
                "type" => $rdef[$best_alt]["type"] ?? null,
                "alt_types" => $alt_types,
            );
 
            if ($a_remove_not_allowed_attributes) {
                foreach ($inf[$field] as $k => $v) {
                    if ($k != "type" && !in_array($k, $this->allowed_attributes[$inf[$field]["type"]])) {
                        unset($inf[$field][$k]);
                    }
                }
            }
        }
 
        return $inf;
    }

References getBestDefinitionAlternative().

Here is the call graph for this function:

◆ getIndicesInformation()

ilDBAnalyzer::getIndicesInformation	(	$a_table,
		$a_abstract_table = `false`
	)

Get information on indices of a table.

Primary key is NOT included! Fulltext indices are included and marked.

Parameters

string table name

Returns: array indices information array

Definition at line 205 of file class.ilDBAnalyzer.php.

    {
        //$constraints = $this->manager->listTableConstraints($a_table);
        $indexes = $this->manager->listTableIndexes($a_table);
 
        // get additional information if database is MySQL
        $mysql_info = array();
 
        $set = $this->il_db->query("SHOW INDEX FROM " . $a_table);
        while ($rec = $this->il_db->fetchAssoc($set)) {
            if (!empty($rec["Key_name"])) {
                $mysql_info[$rec["Key_name"]] = $rec;
            } else {
                $mysql_info[$rec["key_name"]] = $rec;
            }
        }
 
 
        $ind = array();
        foreach ($indexes as $c) {
            $info = $this->reverse->getTableIndexDefinition($a_table, $c);
 
            $i = array();
            if (!$info["primary"]) {
                $i["name"] = $c;
                $i["fulltext"] = false;
                $suffix = ($a_abstract_table) ? "_idx" : "";
 
                if ($mysql_info[$i["name"]]["Index_type"] == "FULLTEXT"
                    || $mysql_info[$i["name"] . "_idx"]["Index_type"] == "FULLTEXT"
                    || $mysql_info[$i["name"]]["index_type"] == "FULLTEXT"
                    || $mysql_info[$i["name"] . "_idx"]["index_type"] == "FULLTEXT"
                ) {
                    $i["fulltext"] = true;
                }
                foreach ($info["fields"] as $k => $f) {
                    $i["fields"][$k] = array(
                        "position" => $f["position"],
                        "sorting" => $f["sorting"],
                    );
                }
                $ind[] = $i;
            }
        }
 
        return $ind;
    }

References Vendor\Package\$c, Vendor\Package\$f, and $i.

◆ getPrimaryKeyInformation()

ilDBAnalyzer::getPrimaryKeyInformation ( $a_table )

Get primary key of a table.

Parameters

string table name

Returns: array primary key information array

Definition at line 174 of file class.ilDBAnalyzer.php.

    {
        $constraints = $this->manager->listTableConstraints($a_table);
 
        $pk = false;
        foreach ($constraints as $c) {
            $info = $this->reverse->getTableConstraintDefinition($a_table, $c);
 
            if ($info["primary"]) {
                $pk["name"] = $c;
                foreach ($info["fields"] as $k => $f) {
                    $pk["fields"][$k] = array(
                        "position" => $f["position"],
                        "sorting" => $f["sorting"],
                    );
                }
            }
        }
 
        return $pk;
    }

References Vendor\Package\$c, and Vendor\Package\$f.

Referenced by hasSequence().

Here is the caller graph for this function:

◆ hasSequence()

ilDBAnalyzer::hasSequence ( $a_table )

Check whether sequence is defined for current table (only works on "abstraced" tables)

Parameters

string table name

Returns: mixed false, if no sequence is defined, start number otherwise

Exceptions

ilDatabaseException

Deprecated:: Please do not use since this method will lead to a ilDatabaseException. Will be removed later

Definition at line 297 of file class.ilDBAnalyzer.php.

    {
        $seq = $this->manager->listSequences();
        if (is_array($seq) && in_array($a_table, $seq)) {
            // sequence field is (only) primary key field of table
            $pk = $this->getPrimaryKeyInformation($a_table);
            if (is_array($pk["fields"]) && count($pk["fields"] == 1)) {
                $seq_field = key($pk["fields"]);
            } else {
                throw new ilDatabaseException("ilDBAnalyzer::hasSequence: Error, sequence defined, but no one-field primary key given. Table: "
                                              . $a_table . ".");
            }
 
            $set = $this->il_db->query("SELECT MAX(" . $this->il_db->quoteIdentifier($seq_field) . ") ma FROM " . $this->il_db->quoteIdentifier($a_table) . "");
            $rec = $this->il_db->fetchAssoc($set);
            $next = $rec["ma"] + 1;
 
            return $next;
        }
 
        return false;
    }

References getPrimaryKeyInformation().

Here is the call graph for this function:

Field Documentation

◆ $allowed_attributes

ilDBAnalyzer::$allowed_attributes

protected

Definition at line 34 of file class.ilDBAnalyzer.php.

◆ $il_db

ilDBAnalyzer::$il_db

protected

Definition at line 30 of file class.ilDBAnalyzer.php.

◆ $manager

ilDBAnalyzer::$manager

protected

Definition at line 22 of file class.ilDBAnalyzer.php.

◆ $reverse

ilDBAnalyzer::$reverse

protected

Definition at line 26 of file class.ilDBAnalyzer.php.

The documentation for this class was generated from the following file:

Services/Database/classes/class.ilDBAnalyzer.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAutoIncrementField()

◆ getBestDefinitionAlternative()

◆ getConstraintsInformation()

◆ getFieldInformation()

◆ getIndicesInformation()

◆ getPrimaryKeyInformation()

◆ hasSequence()

Field Documentation

◆ $allowed_attributes

◆ $il_db

◆ $manager

◆ $reverse