ilCache Class Reference

Cache class. More...

Inheritance diagram for ilCache:

Collaboration diagram for ilCache:

Public Member Functions
	__construct ($a_component, $a_cache_name, $a_use_long_content=false)
	Constructor. More...
	isDisabled ()
	Check if cache is disabled Forced if member view is active. More...
	setComponent ($a_val)
	Set component. More...
	setExpiresAfter ($a_val)
	Set expires after x seconds. More...
	getExpiresAfter ()
	Get expires after x seconds. More...
	getEntry ($a_id)
	Get entry. More...
	getLastAccessStatus ()
	Last access. More...
	storeEntry ( $a_id, $a_value, $a_int_key1=null, $a_int_key2=null, $a_text_key1=null, $a_text_key2=null)
	Store entry. More...
	deleteByAdditionalKeys ( $a_int_key1=null, $a_int_key2=null, $a_text_key1=null, $a_text_key2=null)
	Delete by additional keys. More...
	deleteAllEntries ()
	Delete all entries of cache. More...
	deleteEntry ($a_id)
	Delete entry. More...

Protected Member Functions
	getComponent ()
	Get component. More...
	setName ($a_val)
	Set name. More...
	getName ()
	Get name. More...
	setUseLongContent ($a_val)
	Set use long content. More...
	getUseLongContent ()
	Get use long content. More...
	readEntry ($a_id)
	Read entry. More...

Detailed Description

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

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

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

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

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

Here is the call graph for this function:

Member Function Documentation

deleteAllEntries()

ilCache::deleteAllEntries

(

)

Delete all entries of cache.

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

References $ilDB, $table, getComponent(), getName(), and getUseLongContent().

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

Here is the call graph for this function:

deleteByAdditionalKeys()

ilCache::deleteByAdditionalKeys	(		$a_int_key1 = null,
			$a_int_key2 = null,
			$a_text_key1 = null,
			$a_text_key2 = null
	)

Delete by additional keys.

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

References $ilDB, $table, getComponent(), getName(), and getUseLongContent().

Referenced by ilCalendarCache\deleteUserEntries().

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

Here is the call graph for this function:

Here is the caller graph for this function:

deleteEntry()

ilCache::deleteEntry

(

$a_id

)

Delete entry.

Parameters

string

key

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

References $ilDB, $table, getComponent(), getName(), and getUseLongContent().

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

Here is the call graph for this function:

getComponent()

ilCache::getComponent ( )

protected

Get component.

Returns

string component

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

Referenced by deleteAllEntries(), deleteByAdditionalKeys(), deleteEntry(), readEntry(), and storeEntry().

    {
        return $this->component;
    }

Here is the caller graph for this function:

getEntry()

ilCache::getEntry (   $a_id )

final

Get entry.

Parameters

string

entry id

Returns

string entry value

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

References readEntry().

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

Here is the call graph for this function:

getExpiresAfter()

ilCache::getExpiresAfter

(

)

Get expires after x seconds.

Returns

int expires after x seconds

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

Referenced by storeEntry().

    {
        return $this->expires_after;
    }

Here is the caller graph for this function:

getLastAccessStatus()

ilCache::getLastAccessStatus

(

)

Last access.

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

    {
        return $this->last_access;
    }

getName()

ilCache::getName ( )

protected

Get name.

Returns

string name

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

References $name.

Referenced by deleteAllEntries(), deleteByAdditionalKeys(), deleteEntry(), readEntry(), and storeEntry().

    {
        return $this->name;
    }

Here is the caller graph for this function:

getUseLongContent()

ilCache::getUseLongContent ( )

protected

Get use long content.

Returns

boolean use long content

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

Referenced by deleteAllEntries(), deleteByAdditionalKeys(), deleteEntry(), readEntry(), and storeEntry().

    {
        return $this->use_long_content;
    }

Here is the caller graph for this function:

isDisabled()

ilCache::isDisabled

(

)

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

Returns

bool

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

References ilMemberViewSettings\getInstance().

    {
        include_once './Services/Container/classes/class.ilMemberViewSettings.php';
        return ilMemberViewSettings::getInstance()->isActive();
    }

Here is the call graph for this function:

readEntry()

ilCache::readEntry (   $a_id )

protected

Read entry.

Parameters

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

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

Referenced by getEntry().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setComponent()

ilCache::setComponent

(

$a_val

)

Set component.

Parameters

string

component

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

Referenced by __construct().

    {
        $this->component = $a_val;
    }

Here is the caller graph for this function:

setExpiresAfter()

ilCache::setExpiresAfter

(

$a_val

)

Set expires after x seconds.

Parameters

int	expires after x seconds

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

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

    {
        $this->expires_after = $a_val;
    }

Here is the caller graph for this function:

setName()

ilCache::setName (   $a_val )

protected

Set name.

Parameters

string

name

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

Referenced by __construct().

    {
        $this->name = $a_val;
    }

Here is the caller graph for this function:

setUseLongContent()

ilCache::setUseLongContent (   $a_val )

protected

Set use long content.

Parameters

boolean

use long content

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

Referenced by __construct().

    {
        $this->use_long_content = $a_val;
    }

Here is the caller graph for this function:

storeEntry()

ilCache::storeEntry	(		$a_id,
			$a_value,
			$a_int_key1 = null,
			$a_int_key2 = null,
			$a_text_key1 = null,
			$a_text_key2 = null
	)

Store entry.

Parameters

string	key
string	value
int	additional optional integer key
int	additional optional integer key
string	additional optional text key
string	additional optional text key

Returns

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

References $ilDB, $table, $type, getComponent(), getExpiresAfter(), getName(), getUseLongContent(), and ILIAS_VERSION_NUMERIC.

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

Here is the call graph for this function:

---

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

• Services/Cache/classes/class.ilCache.php