Collaboration diagram for ilBenchmark:

Public Member Functions
	__construct ()
	Constructor. More...

	clearData ()
	delete all measurement data More...

	start (string $a_module, string $a_bench)
	start measurement More...

	stop (string $a_module, string $a_bench)
	stop measurement More...

	save ()
	save all measurements More...

	isDbBenchEnabled ()
	Check wether benchmarking is enabled or not. More...

	enableDbBenchmarkForUserName (?string $a_user)

	disableDbBenchmark ()

	startDbBench (string $a_sql)
	start measurement More...

	stopDbBench ()

	getDbBenchRecords ()

Data Fields
const	DB_BENCH_USER = "db_bench_user"

const	ENABLE_DB_BENCH = "enable_db_bench"

Private Member Functions
	initSettins ()

	retrieveSetting (string $keyword)

	retrieveDB ()

	isDBavailable ()

	retrieveUser ()

	isUserAvailable ()

	microtimeDiff (string $t1, string $t2)

	getCurrentRecordNumber ()
	get current number of benchmark records More...

Private Attributes
ilDBInterface	$db = null

ilSetting	$settings = null

ilObjUser	$user = null

Container	$dic

string	$start = ''

string	$temporary_sql_storage = ''

array	$collected_db_benchmarks = []

bool	$stop_db_recording = false

int	$bench_max_records = 2000

bool	$db_bechmark_enabled = null

int	$db_bechmark_user_id = null

Detailed Description

Class ilBenchmark.

Definition at line 24 of file class.ilBenchmark.php.

Constructor & Destructor Documentation

◆ __construct()

ilBenchmark::__construct ( )

Constructor.

Definition at line 48 of file class.ilBenchmark.php.

    {
        global $DIC;
        $this->dic = $DIC;
        $this->initSettins();//(int) ($this->retrieveSetting("bench_max_records") ?? 0);
    }

References $DIC, and initSettins().

Here is the call graph for this function:

Member Function Documentation

◆ clearData()

ilBenchmark::clearData ( )

delete all measurement data

Definition at line 113 of file class.ilBenchmark.php.

                               : void
    {
        if ($this->isDBavailable()) {
            $db = $this->retrieveDB();
            if ($db !== null) {
                $db->manipulate("DELETE FROM benchmark");
            }
        }
    }

References $db, isDBavailable(), ilDBInterface\manipulate(), and retrieveDB().

Referenced by ilObjSystemFolderGUI\clearBenchObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableDbBenchmark()

ilBenchmark::disableDbBenchmark ( )

Definition at line 217 of file class.ilBenchmark.php.

                                        : void
    {
        $this->db_bechmark_enabled = false;
        $this->settings->set(self::ENABLE_DB_BENCH, '0');
        $this->db_bechmark_user_id = null;
        $this->settings->set(self::DB_BENCH_USER, '0');
    }

References ILIAS\Repository\settings().

Referenced by enableDbBenchmarkForUserName(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableDbBenchmarkForUserName()

ilBenchmark::enableDbBenchmarkForUserName ( ?string $a_user )

Definition at line 201 of file class.ilBenchmark.php.

                                                                 : void
    {
        if ($a_user === null) {
            $this->disableDbBenchmark();
            return;
        }
        $this->initSettins();
        $this->db_bechmark_enabled = true;
        $this->settings->set(self::ENABLE_DB_BENCH, '1');
 
        $user_id = ilObjUser::_lookupId($a_user);
 
        $this->db_bechmark_user_id = $user_id;
        $this->settings->set(self::DB_BENCH_USER, (string) $user_id);
    }

References $user_id, ilObjUser\_lookupId(), disableDbBenchmark(), initSettins(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getCurrentRecordNumber()

ilBenchmark::getCurrentRecordNumber ( )

private

get current number of benchmark records

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

                                             : int
    {
        if ($this->isDBavailable()) {
            $db = $this->retrieveDB();
            if ($db !== null) {
                $cnt_set = $db->query("SELECT COUNT(*) AS cnt FROM benchmark");
                $cnt_rec = $db->fetchAssoc($cnt_set);
                return (int) $cnt_rec["cnt"];
            }
        }
        return 0;
    }

References $db, ilDBInterface\fetchAssoc(), isDBavailable(), ilDBInterface\query(), and retrieveDB().

Here is the call graph for this function:

◆ getDbBenchRecords()

ilBenchmark::getDbBenchRecords ( )

Definition at line 258 of file class.ilBenchmark.php.

                                       : array
    {
        if ($this->isDBavailable()) {
            $db = $this->retrieveDB();
            if ($db !== null) {
                $set = $db->query("SELECT * FROM benchmark");
                $b = [];
                while ($rec = $db->fetchAssoc($set)) {
                    $b[] = [
                        "sql" => $rec["sql_stmt"],
                        "time" => $rec["duration"]
                    ];
                }
                return $b;
            }
        }
        return [];
    }

References Vendor\Package\$b, $db, ilDBInterface\fetchAssoc(), isDBavailable(), ilDBInterface\query(), and retrieveDB().

Referenced by ilObjSystemFolderGUI\benchmarkSubTabs(), and ilObjSystemFolderGUI\showDbBenchResults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettins()

ilBenchmark::initSettins ( )

private

Definition at line 55 of file class.ilBenchmark.php.

                                  : void
    {
        if (!$this->settings instanceof ilSetting) {
            $global_settings_available = $this->dic->isDependencyAvailable('settings');
            if ($global_settings_available) {
                $this->settings = $this->dic->settings();
 
                $this->db_bechmark_enabled = (bool) ($this->retrieveSetting(self::ENABLE_DB_BENCH) ?? false);
                $user_id = $this->retrieveSetting(self::DB_BENCH_USER);
                $this->db_bechmark_user_id = $user_id !== null ? (int) $user_id : null;
            }
        }
    }

References $user_id, ILIAS\Repository\int(), retrieveSetting(), and ILIAS\Repository\settings().

Referenced by __construct(), enableDbBenchmarkForUserName(), and startDbBench().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDBavailable()

ilBenchmark::isDBavailable ( )

private

Definition at line 84 of file class.ilBenchmark.php.

                                    : bool
    {
        return !is_null($this->retrieveDB());
    }

References retrieveDB().

Referenced by clearData(), getCurrentRecordNumber(), getDbBenchRecords(), isDbBenchEnabled(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDbBenchEnabled()

ilBenchmark::isDbBenchEnabled ( )

Check wether benchmarking is enabled or not.

Definition at line 196 of file class.ilBenchmark.php.

                                      : bool
    {
        return $this->db_bechmark_enabled === true && $this->isDBavailable();
    }

References isDBavailable().

Referenced by save(), startDbBench(), and stopDbBench().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUserAvailable()

ilBenchmark::isUserAvailable ( )

private

Definition at line 97 of file class.ilBenchmark.php.

                                      : bool
    {
        return !is_null($this->retrieveUser());
    }

References retrieveUser().

Referenced by save(), startDbBench(), and stopDbBench().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ microtimeDiff()

ilBenchmark::microtimeDiff	(	string	$t1,
		string	$t2
	)

private

Definition at line 102 of file class.ilBenchmark.php.

                                                          : string
    {
        $partials1 = explode(" ", $t1);
        $partials2 = explode(" ", $t2);
 
        return (string) ((float) $partials2[0] - (float) $partials1[0] + (float) $partials2[1] - (float) $partials1[1]);
    }

Referenced by save().

Here is the caller graph for this function:

◆ retrieveDB()

ilBenchmark::retrieveDB ( )

private

Definition at line 76 of file class.ilBenchmark.php.

                                 : ?ilDBInterface
    {
        if (!$this->db instanceof ilDBInterface && $this->dic->isDependencyAvailable('database')) {
            $this->db = $this->dic->database();
        }
        return $this->db;
    }

References $db.

Referenced by clearData(), getCurrentRecordNumber(), getDbBenchRecords(), isDBavailable(), and save().

Here is the caller graph for this function:

◆ retrieveSetting()

ilBenchmark::retrieveSetting ( string $keyword )

private

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

                                                     : ?string
    {
        return $this->settings !== null
            ? $this->settings->get($keyword)
            : null;
    }

References ILIAS\Repository\settings().

Referenced by initSettins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveUser()

ilBenchmark::retrieveUser ( )

private

Definition at line 89 of file class.ilBenchmark.php.

                                   : ?ilObjUser
    {
        if (!$this->user instanceof ilObjUser && $this->dic->isDependencyAvailable('user')) {
            $this->user = $this->dic->user();
        }
        return $this->user;
    }

References $user, and ILIAS\Repository\user().

Referenced by isUserAvailable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilBenchmark::save ( )

save all measurements

Definition at line 144 of file class.ilBenchmark.php.

                          : void
    {
        if (!$this->isDBavailable() || !$this->isUserAvailable()) {
            return;
        }
        if ($this->isDbBenchEnabled()
            && $this->db_bechmark_user_id === $this->user->getId()) {
            if (is_array($this->collected_db_benchmarks)) {
                $this->stop_db_recording = true;
 
                $db = $this->retrieveDB();
                if ($db !== null) {
                    $db->manipulate("DELETE FROM benchmark");
                    foreach ($this->collected_db_benchmarks as $b) {
                        $id = $db->nextId('benchmark');
                        $db->insert("benchmark", [
                            "id" => ["integer", $id],
                            "duration" => ["float", $this->microtimeDiff($b["start"], $b["stop"])],
                            "sql_stmt" => ["clob", $b["sql"]]
                        ]);
                    }
                }
            }
            $this->disableDbBenchmark();
        }
    }

References Vendor\Package\$b, $db, $id, disableDbBenchmark(), ilDBInterface\insert(), isDBavailable(), isDbBenchEnabled(), isUserAvailable(), ilDBInterface\manipulate(), microtimeDiff(), ilDBInterface\nextId(), retrieveDB(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ start()

ilBenchmark::start	(	string	$a_module,
		string	$a_bench
	)

start measurement

Deprecated:

Definition at line 128 of file class.ilBenchmark.php.

                                                            : void
    {
    }

Referenced by ilObjQuestionPool\exportXMLPageObjects(), and startDbBench().

Here is the caller graph for this function:

◆ startDbBench()

ilBenchmark::startDbBench ( string $a_sql )

start measurement

Definition at line 228 of file class.ilBenchmark.php.

                                               : void
    {
        $this->initSettins();
        if (
            !$this->stop_db_recording
            && $this->isDbBenchEnabled()
            && $this->isUserAvailable()
            && $this->db_bechmark_user_id === $this->user->getId()
        ) {
            $this->start = (string) microtime();
            $this->temporary_sql_storage = $a_sql;
        }
    }

References initSettins(), isDbBenchEnabled(), isUserAvailable(), start(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ stop()

ilBenchmark::stop	(	string	$a_module,
		string	$a_bench
	)

stop measurement

Deprecated:

Definition at line 137 of file class.ilBenchmark.php.

                                                           : void
    {
    }

◆ stopDbBench()

ilBenchmark::stopDbBench ( )

Definition at line 242 of file class.ilBenchmark.php.

                                 : bool
    {
        if (
            !$this->stop_db_recording
            && $this->isDbBenchEnabled()
            && $this->isUserAvailable()
            && $this->db_bechmark_user_id === $this->user->getId()
        ) {
            $this->collected_db_benchmarks[] = ["start" => $this->start, "stop" => (string) microtime(), "sql" => $this->temporary_sql_storage];
 
            return true;
        }
 
        return false;
    }

References $start, $temporary_sql_storage, isDbBenchEnabled(), isUserAvailable(), and ILIAS\Repository\user().

Here is the call graph for this function:

Field Documentation

◆ $bench_max_records

int ilBenchmark::$bench_max_records = 2000

private

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

◆ $collected_db_benchmarks

array ilBenchmark::$collected_db_benchmarks = []

private

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

◆ $db

ilDBInterface ilBenchmark::$db = null

private

Definition at line 28 of file class.ilBenchmark.php.

Referenced by clearData(), getCurrentRecordNumber(), getDbBenchRecords(), retrieveDB(), and save().

◆ $db_bechmark_enabled

bool ilBenchmark::$db_bechmark_enabled = null

private

Definition at line 42 of file class.ilBenchmark.php.

◆ $db_bechmark_user_id

int ilBenchmark::$db_bechmark_user_id = null

private

Definition at line 43 of file class.ilBenchmark.php.

◆ $dic

Container ilBenchmark::$dic

private

Definition at line 32 of file class.ilBenchmark.php.

◆ $settings

ilSetting ilBenchmark::$settings = null

private

Definition at line 29 of file class.ilBenchmark.php.

◆ $start

string ilBenchmark::$start = ''

private

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

Referenced by stopDbBench().

◆ $stop_db_recording

bool ilBenchmark::$stop_db_recording = false

private

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

◆ $temporary_sql_storage

string ilBenchmark::$temporary_sql_storage = ''

private

Definition at line 35 of file class.ilBenchmark.php.

Referenced by stopDbBench().

◆ $user

ilObjUser ilBenchmark::$user = null

private

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

Referenced by retrieveUser().

◆ DB_BENCH_USER

const ilBenchmark::DB_BENCH_USER = "db_bench_user"

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

Referenced by ilObjSystemFolderGUI\benchmarkObject(), and ilObjSystemFolderGUI\saveBenchSettingsObject().

◆ ENABLE_DB_BENCH

const ilBenchmark::ENABLE_DB_BENCH = "enable_db_bench"

Definition at line 27 of file class.ilBenchmark.php.

Referenced by ilObjSystemFolderGUI\benchmarkObject(), and ilObjSystemFolderGUI\saveBenchSettingsObject().

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

components/ILIAS/Database/classes/class.ilBenchmark.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearData()

◆ disableDbBenchmark()

◆ enableDbBenchmarkForUserName()

◆ getCurrentRecordNumber()

◆ getDbBenchRecords()

◆ initSettins()

◆ isDBavailable()

◆ isDbBenchEnabled()

◆ isUserAvailable()

◆ microtimeDiff()

◆ retrieveDB()

◆ retrieveSetting()

◆ retrieveUser()

◆ save()

◆ start()

◆ startDbBench()

◆ stop()

◆ stopDbBench()

Field Documentation

◆ $bench_max_records

◆ $collected_db_benchmarks

◆ $db

◆ $db_bechmark_enabled

◆ $db_bechmark_user_id

◆ $dic

◆ $settings

◆ $start

◆ $stop_db_recording

◆ $temporary_sql_storage

◆ $user

◆ DB_BENCH_USER

◆ ENABLE_DB_BENCH