This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCache:

Collaboration diagram for ilCache:

Public Member Functions
	__construct (string $a_component, string $a_cache_name, bool $a_use_long_content=false)

	isDisabled ()
	Check if cache is disabled Forced if member view is active. More...

	setComponent (string $a_val)

	setExpiresAfter (int $a_val)
	Set expires after x seconds. More...

	getExpiresAfter ()

	getEntry (string $a_id)

	getLastAccessStatus ()

	storeEntry (string $a_id, string $a_value, ?int $a_int_key1=null, ?int $a_int_key2=null, ?string $a_text_key1=null, ?string $a_text_key2=null)

	deleteByAdditionalKeys (?int $a_int_key1=null, ?int $a_int_key2=null, ?string $a_text_key1=null, ?string $a_text_key2=null)

	deleteAllEntries ()

	deleteEntry (string $a_id)

Protected Member Functions
	getComponent ()

	setName (string $a_val)

	getName ()

	setUseLongContent (bool $a_val)

	getUseLongContent ()

	readEntry (string $a_id)

Protected Attributes
string	$entry

string	$last_access

int	$expires_after

bool	$use_long_content

string	$name

string	$component

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too. If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Cache class. The cache class stores key/value pairs. Since the primary key is only one text field. It's sometimes necessary to combine parts like "100:200" for user id 100 and ref_id 200.

However sometimes records should be deleted by pars of the main key. For this reason up to two optional additional optional integer and two additional optional text fields can be stored. A derived class may delete records based on the content of this additional keys.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilCache::__construct	(	string	$a_component,
		string	$a_cache_name,
		bool	$a_use_long_content = `false`
	)

Definition at line 37 of file class.ilCache.php.

      {
        $this->setComponent($a_component);
        $this->setName($a_cache_name);
        $this->setUseLongContent($a_use_long_content);
    }

References setComponent(), setName(), and setUseLongContent().

Here is the call graph for this function:

Member Function Documentation

◆ deleteAllEntries()

ilCache::deleteAllEntries ( )

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

                                      : void
    {
        global $ilDB;
 
        $table = $this->getUseLongContent()
            ? "cache_clob"
            : "cache_text";
 
        $q = "DELETE FROM $table WHERE " .
            "component = " . $ilDB->quote($this->getComponent(), "text") .
            " AND name = " . $ilDB->quote($this->getName(), "text");
        $ilDB->manipulate($q);
    }

References $ilDB.

◆ deleteByAdditionalKeys()

ilCache::deleteByAdditionalKeys	(	?int	$a_int_key1 = `null`,
		?int	$a_int_key2 = `null`,
		?string	$a_text_key1 = `null`,
		?string	$a_text_key2 = `null`
	)

Definition at line 187 of file class.ilCache.php.

     : void {
        global $ilDB;
 
        $table = $this->getUseLongContent()
            ? "cache_clob"
            : "cache_text";
 
        $q = "DELETE FROM $table WHERE " .
            "component = " . $ilDB->quote($this->getComponent(), "text") .
            " AND name = " . $ilDB->quote($this->getName(), "text");
 
        $fds = array("int_key_1" => array("v" => $a_int_key1, "t" => "integer"),
            "int_key_2" => array("v" => $a_int_key2, "t" => "integer"),
            "text_key_1" => array("v" => $a_text_key1, "t" => "text"),
            "text_key_2" => array("v" => $a_text_key2, "t" => "text"));
        $sep = " AND";
        foreach ($fds as $k => $fd) {
            if (!is_null($fd["v"])) {
                $q .= $sep . " " . $k . " = " . $ilDB->quote($fd["v"], $fd["t"]);
                $set = " AND";
            }
        }
        $ilDB->manipulate($q);
    }

◆ deleteEntry()

ilCache::deleteEntry ( string $a_id )

Definition at line 231 of file class.ilCache.php.

                                             : void
    {
        global $ilDB;
 
        $table = $this->getUseLongContent()
            ? "cache_clob"
            : "cache_text";
 
        $ilDB->manipulate("DELETE FROM " . $table . " WHERE "
            . " entry_id = " . $ilDB->quote($a_id, "text")
            . " AND component = " . $ilDB->quote($this->getComponent(), "text") .
            " AND name = " . $ilDB->quote($this->getName(), "text"));
    }

References $ilDB.

◆ getComponent()

ilCache::getComponent ( )

protected

Definition at line 61 of file class.ilCache.php.

                                     : string
    {
        return $this->component;
    }

References $component.

Referenced by readEntry().

Here is the caller graph for this function:

◆ getEntry()

ilCache::getEntry ( string $a_id )

final

Definition at line 99 of file class.ilCache.php.

                                                : ?string
    {
        if ($this->readEntry($a_id)) {  // cache hit
            $this->last_access = "hit";
            return $this->entry;
        }
        $this->last_access = "miss";
        return null;
    }

References $entry, and readEntry().

Here is the call graph for this function:

◆ getExpiresAfter()

ilCache::getExpiresAfter ( )

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

                                     : int
    {
        return $this->expires_after;
    }

References $expires_after.

◆ getLastAccessStatus()

ilCache::getLastAccessStatus ( )

Definition at line 134 of file class.ilCache.php.

                                         : string
    {
        return $this->last_access;
    }

References $last_access.

◆ getName()

ilCache::getName ( )

protected

Definition at line 71 of file class.ilCache.php.

                                : string
    {
        return $this->name;
    }

References $name.

Referenced by readEntry().

Here is the caller graph for this function:

◆ getUseLongContent()

ilCache::getUseLongContent ( )

protected

Definition at line 81 of file class.ilCache.php.

                                          : bool
    {
        return $this->use_long_content;
    }

References $use_long_content.

Referenced by readEntry().

Here is the caller graph for this function:

◆ isDisabled()

ilCache::isDisabled ( )

Check if cache is disabled Forced if member view is active.

Reimplemented in ilNewsCache, and ilListItemAccessCache.

Definition at line 51 of file class.ilCache.php.

                                : bool
    {
        return ilMemberViewSettings::getInstance()->isActive();
    }

References ilMemberViewSettings\getInstance().

Here is the call graph for this function:

◆ readEntry()

ilCache::readEntry ( string $a_id )

protected

Reimplemented in ilCalendarCache, ilNewsCache, and ilListItemAccessCache.

Definition at line 109 of file class.ilCache.php.

                                              : bool
    {
        global $ilDB;
 
        $table = $this->getUseLongContent()
            ? "cache_clob"
            : "cache_text";
 
        $query = "SELECT value FROM $table WHERE " .
            "component = " . $ilDB->quote($this->getComponent(), "text") . " AND " .
            "name = " . $ilDB->quote($this->getName(), "text") . " AND " .
            "expire_time > " . $ilDB->quote(time(), "integer") . " AND " .
            "ilias_version = " . $ilDB->quote(ILIAS_VERSION_NUMERIC, "text") . " AND " .
            "entry_id = " . $ilDB->quote($a_id, "text");
 
        $set = $ilDB->query($query);
 
        if ($rec = $ilDB->fetchAssoc($set)) {
            $this->entry = $rec["value"];
            return true;
        }
 
        return false;
    }

References $ilDB, $query, getComponent(), getName(), getUseLongContent(), and ILIAS_VERSION_NUMERIC.

Referenced by getEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setComponent()

ilCache::setComponent ( string $a_val )

Definition at line 56 of file class.ilCache.php.

                                               : void
    {
        $this->component = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setExpiresAfter()

ilCache::setExpiresAfter ( int $a_val )

Set expires after x seconds.

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

                                               : void
    {
        $this->expires_after = $a_val;
    }

Referenced by ilExampleCache\__construct(), ilCalendarCache\__construct(), ilNewsCache\__construct(), and ilListItemAccessCache\__construct().

Here is the caller graph for this function:

◆ setName()

ilCache::setName ( string $a_val )

protected

Definition at line 66 of file class.ilCache.php.

                                             : void
    {
        $this->name = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setUseLongContent()

ilCache::setUseLongContent ( bool $a_val )

protected

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

                                                     : void
    {
        $this->use_long_content = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ storeEntry()

ilCache::storeEntry	(	string	$a_id,
		string	$a_value,
		?int	$a_int_key1 = `null`,
		?int	$a_int_key2 = `null`,
		?string	$a_text_key1 = `null`,
		?string	$a_text_key2 = `null`
	)

Reimplemented in ilCalendarCache, ilNewsCache, and ilListItemAccessCache.

Definition at line 139 of file class.ilCache.php.

     : void {
        global $ilDB;
 
        $table = $this->getUseLongContent()
            ? "cache_clob"
            : "cache_text";
        $type = $this->getUseLongContent()
            ? "clob"
            : "text";
 
        // do not store values, that do not fit into the text field
        if (strlen($a_value) > 4000 && $type == "text") {
            return;
        }
 
        $set = $ilDB->replace($table, array(
            "component" => array("text", $this->getComponent()),
            "name" => array("text", $this->getName()),
            "entry_id" => array("text", $a_id)
            ), array(
            "value" => array($type, $a_value),
            "int_key_1" => array("integer", $a_int_key1),
            "int_key_2" => array("integer", $a_int_key2),
            "text_key_1" => array("text", $a_text_key1),
            "text_key_2" => array("text", $a_text_key2),
            "expire_time" => array("integer", (time() + $this->getExpiresAfter())),
            "ilias_version" => array("text", ILIAS_VERSION_NUMERIC)
            ));
 
        // In 1/2000 times, delete old entries
        $random = new \ilRandom();
        $num = $random->int(1, 2000);
        if ($num == 500) {
            $ilDB->manipulate(
                "DELETE FROM $table WHERE " .
                " ilias_version <> " . $ilDB->quote(ILIAS_VERSION_NUMERIC, "text") .
                " OR expire_time < " . $ilDB->quote(time(), "integer")
            );
        }
    }

Field Documentation

◆ $component

string ilCache::$component

protected

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

Referenced by getComponent().

◆ $entry

string ilCache::$entry

protected

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

Referenced by getEntry().

◆ $expires_after

int ilCache::$expires_after

protected

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

Referenced by getExpiresAfter().

◆ $last_access

string ilCache::$last_access

protected

Definition at line 31 of file class.ilCache.php.

Referenced by getLastAccessStatus().

◆ $name

string ilCache::$name

protected

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

Referenced by getName().

◆ $use_long_content

bool ilCache::$use_long_content

protected

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

Referenced by getUseLongContent().

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

Services/Cache/classes/class.ilCache.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteAllEntries()

◆ deleteByAdditionalKeys()

◆ deleteEntry()

◆ getComponent()

◆ getEntry()

◆ getExpiresAfter()

◆ getLastAccessStatus()

◆ getName()

◆ getUseLongContent()

◆ isDisabled()

◆ readEntry()

◆ setComponent()

◆ setExpiresAfter()

◆ setName()

◆ setUseLongContent()

◆ storeEntry()

Field Documentation

◆ $component

◆ $entry

◆ $expires_after

◆ $last_access

◆ $name

◆ $use_long_content