arConnectorCache Class Reference

Class ilGSStorageCache. More...

Inheritance diagram for arConnectorCache:

Collaboration diagram for arConnectorCache:

Public Member Functions
	__construct (arConnector $arConnectorDB, int $ttl=self::CACHE_TTL_SECONDS)
	ilGSStorageCache constructor. More...
	nextID (ActiveRecord $ar)
	checkConnection (ActiveRecord $ar)
	installDatabase (ActiveRecord $ar, $fields)
	updateDatabase (ActiveRecord $ar)
	resetDatabase (ActiveRecord $ar)
	truncateDatabase (ActiveRecord $ar)
	checkTableExists (ActiveRecord $ar)
	checkFieldExists (ActiveRecord $ar, $field_name)
	removeField (ActiveRecord $ar, $field_name)
	renameField (ActiveRecord $ar, $old_name, $new_name)
	create (ActiveRecord $ar)
	read (ActiveRecord $ar)
	update (ActiveRecord $ar)
	delete (ActiveRecord $ar)
	readSet (ActiveRecordList $arl)
	affectedRows (ActiveRecordList $arl)
	quote ($value, $type)
	updateIndices (ActiveRecord $ar)
Public Member Functions inherited from arConnector
	nextID (ActiveRecord $ar)
	checkConnection (ActiveRecord $ar)
	installDatabase (ActiveRecord $ar, $fields)
	updateDatabase (ActiveRecord $ar)
	resetDatabase (ActiveRecord $ar)
	truncateDatabase (ActiveRecord $ar)
	checkTableExists (ActiveRecord $ar)
	checkFieldExists (ActiveRecord $ar, $field_name)
	removeField (ActiveRecord $ar, $field_name)
	renameField (ActiveRecord $ar, $old_name, $new_name)
	create (ActiveRecord $ar)
	read (ActiveRecord $ar)
	update (ActiveRecord $ar)
	delete (ActiveRecord $ar)
	readSet (ActiveRecordList $arl)
	affectedRows (ActiveRecordList $arl)
	quote ($value, $type)
	updateIndices (ActiveRecord $ar)
	fixDate ($value)

Data Fields
const	CACHE_TTL_SECONDS = 180

Private Member Functions
	storeActiveRecordInCache (ActiveRecord $ar)
	Stores an active record into the Cache. More...

Private Attributes
	$ttl
	$arConnectorDB
	$cache

Detailed Description

Class ilGSStorageCache.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.arConnectorCache.php.

Constructor & Destructor Documentation

__construct()

arConnectorCache::__construct	(	arConnector	$arConnectorDB,
		int	$ttl = self::CACHE_TTL_SECONDS
	)

ilGSStorageCache constructor.

Parameters

arConnector	$arConnectorDB
int	$ttl

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

    {
        $this->ttl = $ttl;
        $this->arConnectorDB = $arConnectorDB;
        $this->cache = ilGlobalCache::getInstance(ilGlobalCache::COMP_GLOBAL_SCREEN);
    }

References $arConnectorDB, $ttl, ilGlobalCache\COMP_GLOBAL_SCREEN, and ilGlobalCache\getInstance().

Here is the call graph for this function:

Member Function Documentation

affectedRows()

arConnectorCache::affectedRows

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

Returns

int

Reimplemented from arConnector.

Definition at line 245 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->affectedRows($arl);
    }

References arConnectorDB\affectedRows().

Here is the call graph for this function:

checkConnection()

arConnectorCache::checkConnection

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

Reimplemented from arConnector.

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

    {
        return $this->arConnectorDB->checkConnection($ar);
    }

References arConnectorDB\checkConnection().

Here is the call graph for this function:

checkFieldExists()

arConnectorCache::checkFieldExists	(	ActiveRecord	$ar,
			$field_name
	)

Parameters

ActiveRecord	$ar
	$field_name

Returns

mixed

Reimplemented from arConnector.

Definition at line 125 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->checkFieldExists($ar, $field_name);
    }

References arConnectorDB\checkFieldExists().

Here is the call graph for this function:

checkTableExists()

arConnectorCache::checkTableExists

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

Reimplemented from arConnector.

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

    {
        return $this->arConnectorDB->checkTableExists($ar);
    }

References arConnectorDB\checkTableExists().

Here is the call graph for this function:

create()

arConnectorCache::create

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

void

Reimplemented from arConnector.

Definition at line 163 of file class.arConnectorCache.php.

    {
        $this->arConnectorDB->create($ar);
        $this->storeActiveRecordInCache($ar);
    }

References arConnectorDB\create(), and storeActiveRecordInCache().

Here is the call graph for this function:

delete()

arConnectorCache::delete

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

void

Reimplemented from arConnector.

Definition at line 218 of file class.arConnectorCache.php.

    {
        $this->arConnectorDB->delete($ar);
 
        if ($this->cache->isActive()) {
            $key = $ar->getConnectorContainerName() . "_" . $ar->getPrimaryFieldValue();
            $this->cache->delete($key);
        }
    }

References $key, and arConnectorDB\delete().

Here is the call graph for this function:

installDatabase()

arConnectorCache::installDatabase	(	ActiveRecord	$ar,
			$fields
	)

Parameters

ActiveRecord	$ar
	$fields

Returns

bool

Reimplemented from arConnector.

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

    {
        return $this->arConnectorDB->installDatabase($ar, $fields);
    }

References arConnectorDB\installDatabase().

Here is the call graph for this function:

nextID()

arConnectorCache::nextID

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

Reimplemented from arConnector.

Definition at line 45 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->nextID($ar);
    }

References arConnectorDB\nextID().

Here is the call graph for this function:

quote()

arConnectorCache::quote	(		$value,
			$type
	)

Parameters

$value
$type

Returns

string

Reimplemented from arConnector.

Definition at line 257 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->quote($value, $type);
    }

References $type, and arConnectorDB\quote().

Here is the call graph for this function:

read()

arConnectorCache::read

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

array

Reimplemented from arConnector.

Definition at line 175 of file class.arConnectorCache.php.

    {
        if ($this->cache->isActive()) {
            $key = $ar->getConnectorContainerName() . "_" . $ar->getPrimaryFieldValue();
            $cached_value = $this->cache->get($key);
            if (is_array($cached_value)) {
                return $cached_value;
            }
 
            if ($cached_value instanceof stdClass) {
                return [$cached_value];
            }
        }
 
        $results = $this->arConnectorDB->read($ar);
 
        if ($this->cache->isActive()) {
            $key = $ar->getConnectorContainerName() . "_" . $ar->getPrimaryFieldValue();
 
            $this->cache->set($key, $results, self::CACHE_TTL_SECONDS);
        }
 
        return $results;
    }

References $key, $results, ActiveRecord\getConnectorContainerName(), ActiveRecord\getPrimaryFieldValue(), and arConnectorDB\read().

Here is the call graph for this function:

readSet()

arConnectorCache::readSet

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

Returns

mixed

Reimplemented from arConnector.

Definition at line 234 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->readSet($arl);
    }

References arConnectorDB\readSet().

Here is the call graph for this function:

removeField()

arConnectorCache::removeField	(	ActiveRecord	$ar,
			$field_name
	)

Parameters

ActiveRecord	$ar
	$field_name

Returns

bool

Exceptions

arException

Reimplemented from arConnector.

Definition at line 138 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->removeField($ar, $field_name);
    }

References arConnectorDB\removeField().

Here is the call graph for this function:

renameField()

arConnectorCache::renameField	(	ActiveRecord	$ar,
			$old_name,
			$new_name
	)

Parameters

ActiveRecord	$ar
	$old_name
	$new_name

Returns

bool

Exceptions

arException

Reimplemented from arConnector.

Definition at line 152 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->renameField($ar, $old_name, $new_name);
    }

References arConnectorDB\renameField().

Here is the call graph for this function:

resetDatabase()

arConnectorCache::resetDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

true

Reimplemented from arConnector.

Definition at line 90 of file class.arConnectorCache.php.

    {
        return $this->arConnectorDB->resetDatabase($ar);
    }

References arConnectorDB\resetDatabase().

Here is the call graph for this function:

storeActiveRecordInCache()

arConnectorCache::storeActiveRecordInCache ( ActiveRecord  $ar )

private

Stores an active record into the Cache.

Parameters

ActiveRecord

$ar

Returns

void

Definition at line 279 of file class.arConnectorCache.php.

    {
        if ($this->cache->isActive()) {
            $key = $ar->getConnectorContainerName() . "_" . $ar->getPrimaryFieldValue();
            $value = $ar->__asStdClass();
 
            $this->cache->set($key, $value, self::CACHE_TTL_SECONDS);
        }
    }

References $key, ActiveRecord\__asStdClass(), ActiveRecord\getConnectorContainerName(), and ActiveRecord\getPrimaryFieldValue().

Referenced by create(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

truncateDatabase()

arConnectorCache::truncateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

void

Reimplemented from arConnector.

Definition at line 101 of file class.arConnectorCache.php.

    {
        $this->arConnectorDB->truncateDatabase($ar);
    }

References arConnectorDB\truncateDatabase().

Here is the call graph for this function:

update()

arConnectorCache::update

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

void

Reimplemented from arConnector.

Definition at line 206 of file class.arConnectorCache.php.

    {
        $this->arConnectorDB->update($ar);
        $this->storeActiveRecordInCache($ar);
    }

References storeActiveRecordInCache(), and arConnectorDB\update().

Here is the call graph for this function:

updateDatabase()

arConnectorCache::updateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

Reimplemented from arConnector.

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

    {
        return $this->arConnectorDB->updateDatabase($ar);
    }

References arConnectorDB\updateDatabase().

Here is the call graph for this function:

updateIndices()

arConnectorCache::updateIndices

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Reimplemented from arConnector.

Definition at line 266 of file class.arConnectorCache.php.

    {
        $this->arConnectorDB->updateIndices($ar);
    }

References arConnectorDB\updateIndices().

Here is the call graph for this function:

Field Documentation

$arConnectorDB

arConnectorCache::$arConnectorDB

private

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

Referenced by __construct().

$cache

arConnectorCache::$cache

private

Definition at line 22 of file class.arConnectorCache.php.

$ttl

arConnectorCache::$ttl

private

Definition at line 14 of file class.arConnectorCache.php.

Referenced by __construct().

CACHE_TTL_SECONDS

const arConnectorCache::CACHE_TTL_SECONDS = 180

Definition at line 23 of file class.arConnectorCache.php.

---

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

• Services/ActiveRecord/Connector/class.arConnectorCache.php