ilDBAnalyzer Class Reference

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 (string $a_table, bool $a_remove_not_allowed_attributes=false)
	Get field information of a table. More...
	getBestDefinitionAlternative (array $a_def)
	getAutoIncrementField (string $a_table)
	Gets the auto increment field of a table. More...
	getPrimaryKeyInformation (string $a_table)
	Get primary key of a table. More...
	getIndicesInformation (string $a_table, bool $a_abstract_table=false)
	Get information on indices of a table. More...
	getConstraintsInformation (string $a_table, bool $a_abstract_table=false)
	Get information on constraints of a table. More...
	hasSequence (string $a_table)
	Check whether sequence is defined for current table (only works on "abstraced" tables) More...

Protected Attributes
ilDBManager	$manager
ilDBReverse	$reverse
ilDBInterface	$il_db
array	$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 32 of file class.ilDBAnalyzer.php.

Constructor & Destructor Documentation

__construct()

ilDBAnalyzer::__construct

(

?ilDBInterface

$ilDBInterface = null

)

ilDBAnalyzer constructor.

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 49 of file class.ilDBAnalyzer.php.

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

    {
        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();
    }

Member Function Documentation

getAutoIncrementField()

ilDBAnalyzer::getAutoIncrementField

(

string

$a_table

)

Gets the auto increment field of a table.

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

Returns

string|bool name of autoincrement field

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

    {
        $fields = $this->manager->listTableFields($a_table);

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

        return false;
    }

getBestDefinitionAlternative()

ilDBAnalyzer::getBestDefinitionAlternative

(

array

$a_def

)

Returns

int|string

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

Referenced by getFieldInformation().

                                                              : int|string
    {
        // determine which type to choose
        $car = [
            "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;
    }

Here is the caller graph for this function:

getConstraintsInformation()

ilDBAnalyzer::getConstraintsInformation	(	string	$a_table,
		bool	$a_abstract_table = false
	)

Get information on constraints of a table.

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

Returns

array indices information array

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

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

                                                                                              : array
    {
        $constraints = $this->manager->listTableConstraints($a_table);

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

        return $cons;
    }

getFieldInformation()

ilDBAnalyzer::getFieldInformation	(	string	$a_table,
		bool	$a_remove_not_allowed_attributes = false
	)

Get field information of a table.

Returns

array field information array

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

References getBestDefinitionAlternative(), and null.

                                                                                                       : array
    {
        $fields = $this->manager->listTableFields($a_table);
        $inf = [];
        foreach ($fields as $field) {
            $rdef = $this->reverse->getTableFieldDefinition($a_table, $field);
            // is this possible?
            if (isset($rdef["mdb2type"], $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 (array_keys($rdef) as $k) {
                if ($k !== $best_alt) {
                    $alt_types .= ($rdef[$k]["type"] ?? "") . ($rdef[$k]["length"] ?? "") . " ";
                }
            }

            $inf[$field] = [
                "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 (array_keys($inf[$field]) as $k) {
                    if ($k !== "type" && !in_array($k, $this->allowed_attributes[$inf[$field]["type"]])) {
                        unset($inf[$field][$k]);
                    }
                }
            }
        }

        return $inf;
    }

Here is the call graph for this function:

getIndicesInformation()

ilDBAnalyzer::getIndicesInformation	(	string	$a_table,
		bool	$a_abstract_table = false
	)

Get information on indices of a table.

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

Returns

array indices information array

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

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

                                                                                          : array
    {
        //$constraints = $this->manager->listTableConstraints($a_table);
        $indexes = $this->manager->listTableIndexes($a_table);

        // get additional information if database is MySQL
        $mysql_info = [];

        $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 = [];
        foreach ($indexes as $c) {
            $info = $this->reverse->getTableIndexDefinition($a_table, $c);

            $i = [];
            if (!$info["primary"]) {
                $i["name"] = $c;
                $i["fulltext"] = false;

                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] = [
                        "position" => $f["position"],
                        "sorting" => $f["sorting"],
                    ];
                }
                $ind[] = $i;
            }
        }

        return $ind;
    }

getPrimaryKeyInformation()

ilDBAnalyzer::getPrimaryKeyInformation

(

string

$a_table

)

Get primary key of a table.

Returns

array primary key information array

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

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

Referenced by hasSequence().

                                                             : array
    {
        $constraints = $this->manager->listTableConstraints($a_table);

        $pk = [];
        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] = [
                        "position" => $f["position"],
                        "sorting" => $f["sorting"],
                    ];
                }
            }
        }

        return $pk;
    }

Here is the caller graph for this function:

hasSequence()

ilDBAnalyzer::hasSequence

(

string

$a_table

)

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

Returns

float|int|bool false, if no sequence is defined, start number otherwise

Exceptions

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

References getPrimaryKeyInformation().

                                                : int|float|false
    {
        $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 (isset($pk['fields']) && 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);

            return $rec["ma"] + 1;
        }

        return false;
    }

Here is the call graph for this function:

Field Documentation

$allowed_attributes

array ilDBAnalyzer::$allowed_attributes

protected

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

$il_db

ilDBInterface ilDBAnalyzer::$il_db

protected

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

$manager

ilDBManager ilDBAnalyzer::$manager

protected

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

$reverse

ilDBReverse ilDBAnalyzer::$reverse

protected

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

---

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

• components/ILIAS/Database/classes/class.ilDBAnalyzer.php