ilPluginStateDBOverIlDBInterface Class Reference

Implementation of ilPluginStateDB over ilDBInterface. More...

Inheritance diagram for ilPluginStateDBOverIlDBInterface:

Collaboration diagram for ilPluginStateDBOverIlDBInterface:

Public Member Functions
	__construct (Data\Factory $data_factory, \ilDBInterface $db)
	isPluginActivated (string $id)
	setActivation (string $id, bool $activated)
	getCurrentPluginVersion (string $id)
	getCurrentPluginDBVersion (string $id)
	setCurrentPluginVersion (string $id, Version $version, int $db_version)
	remove (string $id)

Protected Member Functions
	getData ()

Protected Attributes
const	TABLE_NAME = "il_plugin"
Data Factory	$data_factory
ilDBInterface	$db
bool	$has_data = false
array	$data = null

Detailed Description

Implementation of ilPluginStateDB over ilDBInterface.

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

Constructor & Destructor Documentation

__construct()

ilPluginStateDBOverIlDBInterface::__construct	(	Data\Factory	$data_factory,
		\ilDBInterface	$db
	)

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

References $data_factory, and $db.

    {
        $this->data_factory = $data_factory;
        $this->db = $db;
    }

Member Function Documentation

getCurrentPluginDBVersion()

ilPluginStateDBOverIlDBInterface::getCurrentPluginDBVersion

(

string

$id

)

Implements ilPluginStateDB.

Definition at line 94 of file class.ilPluginStateDBOverIlDBInterface.php.

References $id, and getData().

                                                         : ?int
    {
        $this->getData();
        return $this->data[$id][2] ?? null;
    }

Here is the call graph for this function:

getCurrentPluginVersion()

ilPluginStateDBOverIlDBInterface::getCurrentPluginVersion

(

string

$id

)

Implements ilPluginStateDB.

Definition at line 88 of file class.ilPluginStateDBOverIlDBInterface.php.

References $id, and getData().

                                                       : ?Version
    {
        $this->getData();
        return $this->data[$id][1] ?? null;
    }

Here is the call graph for this function:

getData()

ilPluginStateDBOverIlDBInterface::getData ( )

protected

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

References $data, $res, and ILIAS\Repository\int().

Referenced by getCurrentPluginDBVersion(), getCurrentPluginVersion(), isPluginActivated(), setActivation(), and setCurrentPluginVersion().

                                : void
    {
        if ($this->has_data) {
            return;
        }

        $res = $this->db->query("SELECT * FROM " . self::TABLE_NAME);
        $this->data = [];
        foreach ($this->db->fetchAll($res) as $data) {
            $this->data[$data["plugin_id"]] = [
                (bool) $data["active"],
                $data["last_update_version"] ? $this->data_factory->version($data["last_update_version"]) : null,
                $data["db_version"] ? (int) $data["db_version"] : null
            ];
        }
        $this->has_data = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isPluginActivated()

ilPluginStateDBOverIlDBInterface::isPluginActivated

(

string

$id

)

Implements ilPluginStateDB.

Definition at line 62 of file class.ilPluginStateDBOverIlDBInterface.php.

References $id, and getData().

                                                 : bool
    {
        $this->getData();
        return $this->data[$id][0] ?? false;
    }

Here is the call graph for this function:

remove()

ilPluginStateDBOverIlDBInterface::remove

(

string

$id

)

Implements ilPluginStateDB.

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

References $id.

                                      : void
    {
        $this->db->manipulate(
            "DELETE FROM " . self::TABLE_NAME . " WHERE plugin_id = " . $this->db->quote($id, "text")
        );
        $this->has_data = false;
    }

setActivation()

ilPluginStateDBOverIlDBInterface::setActivation	(	string	$id,
		bool	$activated
	)

Implements ilPluginStateDB.

Definition at line 68 of file class.ilPluginStateDBOverIlDBInterface.php.

References getData().

                                                              : void
    {
        $this->getData();
        if (!isset($this->data[$id])) {
            throw new \InvalidArgumentException(
                "Unknown plugin '$id'"
            );
        }
        $this->db->update(
            self::TABLE_NAME,
            [
                "active" => ["integer", $activated ? 1 : 0]
            ],
            [
                "plugin_id" => ["text", $id]
            ]
        );
        $this->has_data = false;
    }

Here is the call graph for this function:

setCurrentPluginVersion()

ilPluginStateDBOverIlDBInterface::setCurrentPluginVersion	(	string	$id,
		Version	$version,
		int	$db_version
	)

Implements ilPluginStateDB.

Definition at line 100 of file class.ilPluginStateDBOverIlDBInterface.php.

References getData().

                                                                                          : void
    {
        $this->getData();
        if (isset($this->data[$id])) {
            $this->db->update(
                self::TABLE_NAME,
                [
                    "last_update_version" => ["text", (string) $version],
                    "db_version" => ["integer", $db_version]
                ],
                [
                    "plugin_id" => ["text", $id]
                ]
            );
        } else {
            $this->db->insert(
                self::TABLE_NAME,
                [
                    "plugin_id" => ["text", $id],
                    "active" => ["integer", 0],
                    "last_update_version" => ["text", (string) $version],
                    "db_version" => ["integer", $db_version]
                ]
            );
        }
        $this->has_data = false;
    }

Here is the call graph for this function:

Field Documentation

$data

array ilPluginStateDBOverIlDBInterface::$data = null

protected

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

Referenced by getData().

$data_factory

Data Factory ilPluginStateDBOverIlDBInterface::$data_factory

protected

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

Referenced by __construct().

$db

ilDBInterface ilPluginStateDBOverIlDBInterface::$db

protected

Definition at line 33 of file class.ilPluginStateDBOverIlDBInterface.php.

Referenced by __construct().

$has_data

bool ilPluginStateDBOverIlDBInterface::$has_data = false

protected

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

TABLE_NAME

const ilPluginStateDBOverIlDBInterface::TABLE_NAME = "il_plugin"

protected

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

---

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

• components/ILIAS/Component/classes/class.ilPluginStateDBOverIlDBInterface.php