arConnectorCache Class Reference

Class ilGSStorageCache. More...

Inheritance diagram for arConnectorCache:

Collaboration diagram for arConnectorCache:

Public Member Functions
	__construct (private arConnector $arConnector)
	ilGSStorageCache constructor. More...
	getContainerKey ()
	isForced ()
	nextID (ActiveRecord $activeRecord)
	checkConnection (ActiveRecord $activeRecord)
	installDatabase (ActiveRecord $activeRecord, array $fields)
	updateDatabase (ActiveRecord $activeRecord)
	resetDatabase (ActiveRecord $activeRecord)
	truncateDatabase (ActiveRecord $activeRecord)
	checkTableExists (ActiveRecord $activeRecord)
	checkFieldExists (ActiveRecord $activeRecord, string $field_name)
	removeField (ActiveRecord $activeRecord, string $field_name)
	renameField (ActiveRecord $activeRecord, string $old_name, string $new_name)
	create (ActiveRecord $activeRecord)
	read (ActiveRecord $activeRecord)
	update (ActiveRecord $activeRecord)
	delete (ActiveRecord $activeRecord)
	readSet (ActiveRecordList $activeRecordList)
	affectedRows (ActiveRecordList $activeRecordList)
	quote ($value, string $type)
	updateIndices (ActiveRecord $activeRecord)
Public Member Functions inherited from arConnector
	nextID (ActiveRecord $activeRecord)
	checkConnection (ActiveRecord $activeRecord)
	installDatabase (ActiveRecord $activeRecord, array $fields)
	updateDatabase (ActiveRecord $activeRecord)
	resetDatabase (ActiveRecord $activeRecord)
	truncateDatabase (ActiveRecord $activeRecord)
	checkTableExists (ActiveRecord $activeRecord)
	checkFieldExists (ActiveRecord $activeRecord, string $field_name)
	removeField (ActiveRecord $activeRecord, string $field_name)
	renameField (ActiveRecord $activeRecord, string $old_name, string $new_name)
	create (ActiveRecord $activeRecord)
	read (ActiveRecord $activeRecord)
	update (ActiveRecord $activeRecord)
	delete (ActiveRecord $activeRecord)
	readSet (ActiveRecordList $activeRecordList)
	affectedRows (ActiveRecordList $activeRecordList)
	quote (mixed $value, string $type)
	updateIndices (ActiveRecord $activeRecord)
	fixDate (string $value)

Protected Member Functions
	buildCacheKey (ActiveRecord $activeRecord)

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

Private Attributes
Container	$cache_container

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 27 of file class.arConnectorCache.php.

Constructor & Destructor Documentation

__construct()

arConnectorCache::__construct

(

private arConnector

$arConnector

)

ilGSStorageCache constructor.

Parameters

int

$ttl

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

References $DIC.

    {
        global $DIC;
        $this->cache_container = $DIC->globalCache()->get($this);
    }

Member Function Documentation

affectedRows()

arConnectorCache::affectedRows

(

ActiveRecordList

$activeRecordList

)

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

References arConnector\affectedRows().

                                                                    : int
    {
        return $this->arConnector->affectedRows($activeRecordList);
    }

Here is the call graph for this function:

buildCacheKey()

arConnectorCache::buildCacheKey ( ActiveRecord  $activeRecord )

protected

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

References ActiveRecord\getConnectorContainerName(), and ActiveRecord\getPrimaryFieldValue().

Referenced by delete(), read(), and storeActiveRecordInCache().

                                                                : string
    {
        return $activeRecord->getConnectorContainerName() . "_" . $activeRecord->getPrimaryFieldValue();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkConnection()

arConnectorCache::checkConnection

(

ActiveRecord

$activeRecord

)

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

References arConnector\checkConnection().

                                                               : bool
    {
        return $this->arConnector->checkConnection($activeRecord);
    }

Here is the call graph for this function:

checkFieldExists()

arConnectorCache::checkFieldExists	(	ActiveRecord	$activeRecord,
		string	$field_name
	)

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

References arConnector\checkFieldExists().

                                                                                    : bool
    {
        return $this->arConnector->checkFieldExists($activeRecord, $field_name);
    }

Here is the call graph for this function:

checkTableExists()

arConnectorCache::checkTableExists

(

ActiveRecord

$activeRecord

)

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

References arConnector\checkTableExists().

                                                                : bool
    {
        return $this->arConnector->checkTableExists($activeRecord);
    }

Here is the call graph for this function:

create()

arConnectorCache::create

(

ActiveRecord

$activeRecord

)

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

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

                                                      : void
    {
        $this->arConnector->create($activeRecord);
        $this->storeActiveRecordInCache($activeRecord);
    }

Here is the call graph for this function:

delete()

arConnectorCache::delete

(

ActiveRecord

$activeRecord

)

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

References buildCacheKey(), and arConnector\delete().

                                                      : void
    {
        $this->arConnector->delete($activeRecord);
        $key = $this->buildCacheKey($activeRecord);
        $this->cache_container->delete($key);
    }

Here is the call graph for this function:

getContainerKey()

arConnectorCache::getContainerKey

(

)

Implements ILIAS\Cache\Container\Request.

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

                                     : string
    {
        return 'ar_cache';
    }

installDatabase()

arConnectorCache::installDatabase	(	ActiveRecord	$activeRecord,
		array	$fields
	)

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

References arConnector\installDatabase().

                                                                              : bool
    {
        return $this->arConnector->installDatabase($activeRecord, $fields);
    }

Here is the call graph for this function:

isForced()

arConnectorCache::isForced

(

)

Implements ILIAS\Cache\Container\Request.

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

                              : bool
    {
        return false;
    }

nextID()

arConnectorCache::nextID

(

ActiveRecord

$activeRecord

)

Returns

mixed

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

References arConnector\nextID().

    {
        return $this->arConnector->nextID($activeRecord);
    }

Here is the call graph for this function:

quote()

arConnectorCache::quote	(		$value,
		string	$type
	)

Parameters

$value

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

References arConnector\quote().

                                               : string
    {
        return $this->arConnector->quote($value, $type);
    }

Here is the call graph for this function:

read()

arConnectorCache::read

(

ActiveRecord

$activeRecord

)

Returns

[]|mixed[]

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

References $results, buildCacheKey(), null, and arConnector\read().

                                                    : array
    {
        $key = $this->buildCacheKey($activeRecord);
        if ($this->cache_container->has($key)) {
            $cached_value = $this->cache_container->get(
                $key,
                new Transformation(fn($value): ?array => is_array($value) ? $value : null)
            );
            if (is_array($cached_value)) {
                return array_map(fn($result): \stdClass => (object) $result, $cached_value);
            }
        }

        $results = $this->arConnector->read($activeRecord);

        $this->cache_container->set(
            $key,
            array_map(fn($result): array => (array) $result, $results)
        );

        return $results;
    }

Here is the call graph for this function:

readSet()

arConnectorCache::readSet

(

ActiveRecordList

$activeRecordList

)

Returns

mixed[]

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

References arConnector\readSet().

                                                               : array
    {
        return $this->arConnector->readSet($activeRecordList);
    }

Here is the call graph for this function:

removeField()

arConnectorCache::removeField	(	ActiveRecord	$activeRecord,
		string	$field_name
	)

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

References arConnector\removeField().

                                                                               : bool
    {
        return $this->arConnector->removeField($activeRecord, $field_name);
    }

Here is the call graph for this function:

renameField()

arConnectorCache::renameField	(	ActiveRecord	$activeRecord,
		string	$old_name,
		string	$new_name
	)

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

References arConnector\renameField().

                                                                                               : bool
    {
        return $this->arConnector->renameField($activeRecord, $old_name, $new_name);
    }

Here is the call graph for this function:

resetDatabase()

arConnectorCache::resetDatabase

(

ActiveRecord

$activeRecord

)

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

References arConnector\resetDatabase().

                                                             : bool
    {
        return $this->arConnector->resetDatabase($activeRecord);
    }

Here is the call graph for this function:

storeActiveRecordInCache()

arConnectorCache::storeActiveRecordInCache ( ActiveRecord  $activeRecord )

private

Stores an active record into the Cache.

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

References ActiveRecord\asArray(), and buildCacheKey().

Referenced by create(), and update().

                                                                         : void
    {
        $key = $this->buildCacheKey($activeRecord);
        $value = $activeRecord->asArray();

        $this->cache_container->set($key, $value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

truncateDatabase()

arConnectorCache::truncateDatabase

(

ActiveRecord

$activeRecord

)

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

References arConnector\truncateDatabase().

                                                                : bool
    {
        return $this->arConnector->truncateDatabase($activeRecord);
    }

Here is the call graph for this function:

update()

arConnectorCache::update

(

ActiveRecord

$activeRecord

)

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

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

                                                      : void
    {
        $this->arConnector->update($activeRecord);
        $this->storeActiveRecordInCache($activeRecord);
    }

Here is the call graph for this function:

updateDatabase()

arConnectorCache::updateDatabase

(

ActiveRecord

$activeRecord

)

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

References arConnector\updateDatabase().

                                                              : bool
    {
        return $this->arConnector->updateDatabase($activeRecord);
    }

Here is the call graph for this function:

updateIndices()

arConnectorCache::updateIndices

(

ActiveRecord

$activeRecord

)

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

References arConnector\updateIndices().

                                                             : void
    {
        $this->arConnector->updateIndices($activeRecord);
    }

Here is the call graph for this function:

Field Documentation

$cache_container

Container arConnectorCache::$cache_container

private

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

---

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

• components/ILIAS/ActiveRecord/Connector/class.arConnectorCache.php