Multi-Level News Cache Implementation: More...

Collaboration diagram for ILIAS\News\Persistence\NewsCache:

Public Member Functions
	__construct ()

	getAggregatedContexts (array $contexts)
	Level-1 Cache stores a collection of the aggregated contexts for the provided base context. More...

	storeAggregatedContexts (array $contexts, array $aggregated)

	invalidateAggregatedContexts (array $contexts)

	getUserContextAccess (int $user_id, NewsCriteria $criteria)
	Level-2 Cache stores a collection of the base news contexts for a specific user. More...

	storeUserContextAccess (int $user_id, NewsCriteria $criteria, array $contexts)

	invalidateUserContextAccess (int $user_id)

	getNewsForUser (int $user_id, NewsCriteria $criteria)
	Level-3 Cache stores a collection of the news items for a specific user. More...

	storeNewsForUser (int $user_id, NewsCriteria $criteria, NewsCollection $news)

	invalidateNewsForUser (int $user_id, NewsCriteria $criteria)

	flush ()

Protected Member Functions
	generateL1Key (string\|array $contexts)

	generateL3Key (int $user_id, NewsCriteria $criteria)

Protected Attributes
readonly bool	$enabled

readonly int	$cache_ttl

readonly ilCache	$il_cache

Detailed Description

Multi-Level News Cache Implementation:

Level 1: Context Cache - Context-specific data
Level 2: User Context Cache - User-specific data
Level 3: User News Cache - List of news items for a user

Definition at line 35 of file NewsCache.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\News\Persistence\NewsCache::__construct ( )

Definition at line 42 of file NewsCache.php.

      {
        $settings = new \ilSetting('news');
 
        $this->cache_ttl = (int) $settings->get('acc_cache_mins');
        $this->enabled = $this->cache_ttl !== 0;
 
        $this->il_cache = new \ilCache('ServicesNews', 'NewsMultiLevel', true);
        $this->il_cache->setExpiresAfter($this->cache_ttl * 60);
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

Member Function Documentation

◆ flush()

ILIAS\News\Persistence\NewsCache::flush ( )

Definition at line 224 of file NewsCache.php.

                           : void
    {
        $this->il_cache->deleteAllEntries();
    }

◆ generateL1Key()

ILIAS\News\Persistence\NewsCache::generateL1Key ( string|array $contexts )

protected

Definition at line 78 of file NewsCache.php.

                                                            : string
    {
        return 'agg:' . md5(is_array($contexts) ? implode(',', $contexts) : $contexts);
    }

Referenced by ILIAS\News\Persistence\NewsCache\invalidateAggregatedContexts(), and ILIAS\News\Persistence\NewsCache\storeAggregatedContexts().

Here is the caller graph for this function:

◆ generateL3Key()

ILIAS\News\Persistence\NewsCache::generateL3Key	(	int	$user_id,
		NewsCriteria	$criteria
	)

protected

Definition at line 205 of file NewsCache.php.

                                                                          : string
    {
        $payload = [
            'start_date' => $criteria->getStartDate(),
            'min_priority' => $criteria->getMinPriority(),
            'max_priority' => $criteria->getMaxPriority(),
            'no_auto_generated' => $criteria->isNoAutoGenerated(),
        ];
 
        // The Period of entries only needs to be considered if cache entries are stored for longer periods
        $period_minutes = ($criteria->getPeriod() ?? 0) * 1440;
        if ($period_minutes <= $this->cache_ttl) {
            $payload['period'] = $criteria->getPeriod();
        }
 
        return "user:{$user_id}:" . md5(serialize($payload));
    }

References $payload, ILIAS\News\Data\NewsCriteria\getMaxPriority(), ILIAS\News\Data\NewsCriteria\getMinPriority(), ILIAS\News\Data\NewsCriteria\getPeriod(), ILIAS\News\Data\NewsCriteria\getStartDate(), and ILIAS\News\Data\NewsCriteria\isNoAutoGenerated().

Referenced by ILIAS\News\Persistence\NewsCache\getNewsForUser(), ILIAS\News\Persistence\NewsCache\invalidateNewsForUser(), and ILIAS\News\Persistence\NewsCache\storeNewsForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAggregatedContexts()

ILIAS\News\Persistence\NewsCache::getAggregatedContexts ( array $contexts )

Level-1 Cache stores a collection of the aggregated contexts for the provided base context.

This method uses a greedy algorithm to collect subset matches in the cache and return both cache hits (as complete NewsContexts objects) and missing contexts.

Parameters

NewsContext[] $contexts

Returns: array{hit: NewsContext[], missing: NewsContext[]}

Definition at line 61 of file NewsCache.php.

                                                          : array
    {
        if (!$this->enabled || empty($contexts)) {
            return ['hit' => [], 'missing' => $contexts];
        }
 
        $context_ids = array_map(fn($context) => $context->getRefId(), $contexts);
        sort($context_ids, SORT_NUMERIC);
 
        if ($entry = $this->il_cache->getEntry($this->generateL1Key($context_ids))) {
            $contexts = array_map(fn($raw) => NewsContext::denormalize($raw), unserialize($entry));
            return ['hit' => $contexts, 'missing' => []];
        }
 
        return ['hit' => [], 'missing' => $contexts];
    }

References $context, ILIAS\News\Data\NewsContext\denormalize(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ getNewsForUser()

ILIAS\News\Persistence\NewsCache::getNewsForUser	(	int	$user_id,
		NewsCriteria	$criteria
	)

Level-3 Cache stores a collection of the news items for a specific user.

It returns a LazyNewsCollection or null on cache miss.

Definition at line 172 of file NewsCache.php.

                                                                        : ?LazyNewsCollection
    {
        if (!$this->enabled) {
            return null;
        }
 
        $entry = $this->il_cache->getEntry($this->generateL3Key($user_id, $criteria));
        if (!$entry) {
            return null;
        }
 
        $payload = unserialize($entry);
        return (new LazyNewsCollection(array_keys($payload)))
            ->setUserReadStatus($user_id, $payload);
    }

References $payload, $user_id, and ILIAS\News\Persistence\NewsCache\generateL3Key().

Here is the call graph for this function:

◆ getUserContextAccess()

ILIAS\News\Persistence\NewsCache::getUserContextAccess	(	int	$user_id,
		NewsCriteria	$criteria
	)

Level-2 Cache stores a collection of the base news contexts for a specific user.

It returns a list of the NewsContexts (ref_id only) or null on cache miss.

Returns: NewsContext[]|null

Definition at line 125 of file NewsCache.php.

                                                                              : ?array
    {
        if (!$this->enabled) {
            return null;
        }
 
        $entry = $this->il_cache->getEntry("access:{$user_id}");
        if (!$entry) {
            return null;
        }
 
        // Check if the stored payload matches the criteria
        $payload = unserialize($entry);
        if ($payload['only_public'] !== $criteria->isOnlyPublic()) {
            $this->invalidateUserContextAccess($user_id);
            return null;
        }
 
        return array_map(fn($ref_id) => new NewsContext($ref_id), $payload['contexts']);
    }

References $payload, $ref_id, ILIAS\News\Persistence\NewsCache\invalidateUserContextAccess(), and ILIAS\News\Data\NewsCriteria\isOnlyPublic().

Here is the call graph for this function:

◆ invalidateAggregatedContexts()

ILIAS\News\Persistence\NewsCache::invalidateAggregatedContexts ( array $contexts )

Parameters

NewsContext[] $contexts

Definition at line 104 of file NewsCache.php.

                                                                 : void
    {
        if (!$this->enabled || empty($contexts)) {
            return;
        }
 
        $context_ids = array_map(fn($context) => $context->getRefId(), $contexts);
        sort($context_ids, SORT_NUMERIC);
        $key = implode(',', $context_ids);
 
        // Delete cache entry
        $this->il_cache->deleteEntry($this->generateL1Key($key));
    }

References $context, ILIAS\News\Persistence\NewsCache\generateL1Key(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ invalidateNewsForUser()

ILIAS\News\Persistence\NewsCache::invalidateNewsForUser	(	int	$user_id,
		NewsCriteria	$criteria
	)

Definition at line 200 of file NewsCache.php.

                                                                               : void
    {
        $this->il_cache->deleteEntry($this->generateL3Key($user_id, $criteria));
    }

References ILIAS\News\Persistence\NewsCache\generateL3Key().

Here is the call graph for this function:

◆ invalidateUserContextAccess()

ILIAS\News\Persistence\NewsCache::invalidateUserContextAccess ( int $user_id )

Definition at line 160 of file NewsCache.php.

                                                             : void
    {
        if ($this->enabled) {
            $this->il_cache->deleteEntry("access:{$user_id}");
        }
    }

Referenced by ILIAS\News\Persistence\NewsCache\getUserContextAccess().

Here is the caller graph for this function:

◆ storeAggregatedContexts()

ILIAS\News\Persistence\NewsCache::storeAggregatedContexts	(	array	$contexts,
		array	$aggregated
	)

Parameters

NewsContext[]	$contexts
NewsContext[]	$aggregated

Definition at line 87 of file NewsCache.php.

                                                                               : void
    {
        if (!$this->enabled || empty($contexts)) {
            return;
        }
 
        $context_ids = array_map(fn($context) => $context->getRefId(), $contexts);
        sort($context_ids, SORT_NUMERIC);
        $key = implode(',', $context_ids);
 
        $payload = array_map(fn($context) => $context->normalize(), $aggregated);
        $this->il_cache->storeEntry($this->generateL1Key($key), serialize($payload));
    }

References $context, $payload, ILIAS\News\Persistence\NewsCache\generateL1Key(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ storeNewsForUser()

ILIAS\News\Persistence\NewsCache::storeNewsForUser	(	int	$user_id,
		NewsCriteria	$criteria,
		NewsCollection	$news
	)

Definition at line 188 of file NewsCache.php.

                                                                                                : void
    {
        if (!$this->enabled) {
            return;
        }
 
        $this->il_cache->storeEntry(
            $this->generateL3Key($user_id, $criteria),
            serialize($news->getUserReadStatus($user_id))
        );
    }

References $user_id, ILIAS\News\Persistence\NewsCache\generateL3Key(), and ILIAS\News\Data\NewsCollection\getUserReadStatus().

Here is the call graph for this function:

◆ storeUserContextAccess()

ILIAS\News\Persistence\NewsCache::storeUserContextAccess	(	int	$user_id,
		NewsCriteria	$criteria,
		array	$contexts
	)

Parameters

NewsContext[] $contexts

Definition at line 149 of file NewsCache.php.

                                                                                                 : void
    {
        if (!$this->enabled) {
            return;
        }
 
        $contexts = array_map(fn($context) => $context->getRefId(), $contexts);
        $payload = ['contexts' => $contexts, 'only_public' => $criteria->isOnlyPublic()];
        $this->il_cache->storeEntry("access:{$user_id}", serialize($payload));
    }

References $context, $payload, and ILIAS\News\Data\NewsCriteria\isOnlyPublic().

Here is the call graph for this function:

Field Documentation

◆ $cache_ttl

readonly int ILIAS\News\Persistence\NewsCache::$cache_ttl

protected

Definition at line 39 of file NewsCache.php.

◆ $enabled

readonly bool ILIAS\News\Persistence\NewsCache::$enabled

protected

Definition at line 37 of file NewsCache.php.

◆ $il_cache

readonly ilCache ILIAS\News\Persistence\NewsCache::$il_cache

protected

Definition at line 40 of file NewsCache.php.

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

components/ILIAS/News/src/Persistence/NewsCache.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ flush()

◆ generateL1Key()

◆ generateL3Key()

◆ getAggregatedContexts()

◆ getNewsForUser()

◆ getUserContextAccess()

◆ invalidateAggregatedContexts()

◆ invalidateNewsForUser()

◆ invalidateUserContextAccess()

◆ storeAggregatedContexts()

◆ storeNewsForUser()

◆ storeUserContextAccess()

Field Documentation

◆ $cache_ttl

◆ $enabled

◆ $il_cache