ILIAS\News\Domain\NewsCollectionService Class Reference

News Collection Service orchestrates all news-related operations and provides a high-level API for the news service. More...

Collaboration diagram for ILIAS\News\Domain\NewsCollectionService:

Public Member Functions
	__construct (private readonly NewsRepository $repository, private readonly NewsCache $cache, private readonly UserContextResolver $user_context_resolver, private readonly \ilObjectDataCache $object_data, private readonly \ilRbacSystem $rbac)
	getNewsForUser (\ilObjUser $user, NewsCriteria $criteria, bool $lazy=false)
	getNewsForContext (NewsContext $context, NewsCriteria $criteria, int $user_id, bool $lazy=false)
	getNewsForContainer (int $ref_id, int $context_obj_id, string $context_type, NewsCriteria $criteria, int $user_id, bool $lazy=false)
	invalidateCache (int $user_id)

Private Member Functions
	getNewsForContexts (array $contexts, NewsCriteria $criteria, int $user_id, bool $lazy)
	fetchContextData (array $contexts)
	filterByAccess (array $contexts, NewsCriteria $criteria, int $user_id)
	applyFinalProcessing (NewsCollection $collection, NewsCriteria $criteria)
	Apply the last steps of the news collection processing pipeline: Exclude, Limit. More...

Detailed Description

News Collection Service orchestrates all news-related operations and provides a high-level API for the news service.

Definition at line 34 of file NewsCollectionService.php.

Constructor & Destructor Documentation

__construct()

ILIAS\News\Domain\NewsCollectionService::__construct	(	private readonly NewsRepository	$repository,
		private readonly NewsCache	$cache,
		private readonly UserContextResolver	$user_context_resolver,
		private readonly \ilObjectDataCache	$object_data,
		private readonly \ilRbacSystem	$rbac
	)

Definition at line 36 of file NewsCollectionService.php.

      {
    }

Member Function Documentation

applyFinalProcessing()

ILIAS\News\Domain\NewsCollectionService::applyFinalProcessing ( NewsCollection  $collection, NewsCriteria  $criteria  )

private

Apply the last steps of the news collection processing pipeline: Exclude, Limit.

Definition at line 231 of file NewsCollectionService.php.

                                                                                             : NewsCollection
    {
        return $collection->exclude($criteria->getExcludedNewsIds())->limit($criteria->getLimit());
    }

References ILIAS\News\Data\NewsCollection\exclude(), ILIAS\News\Data\NewsCriteria\getExcludedNewsIds(), and ILIAS\News\Data\NewsCriteria\getLimit().

Referenced by ILIAS\News\Domain\NewsCollectionService\getNewsForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

fetchContextData()

ILIAS\News\Domain\NewsCollectionService::fetchContextData ( array  $contexts )

private

Parameters

NewsContext[]

$contexts

Returns

NewsContext[]

Definition at line 165 of file NewsCollectionService.php.

                                                      : array
    {
        // Batch loads object_data and object_references using preloading
        $obj_ids = array_filter(array_map(fn($context) => $context->getObjId(), $contexts));
        $this->object_data->preloadObjectCache($obj_ids);
 
        for ($i = 0; $i < count($contexts); $i++) {
            $context = $contexts[$i];
 
            if ($context->getObjId() === null) {
                $context->setObjId($this->object_data->lookupObjId($context->getRefId()));
            }
 
            if ($context->getObjType() === null) {
                $context->setObjType($this->object_data->lookupType($context->getObjId()));
            }
 
            $contexts[$i] = $context;
        }
 
        return $contexts;
    }

filterByAccess()

ILIAS\News\Domain\NewsCollectionService::filterByAccess ( array  $contexts, NewsCriteria  $criteria, int  $user_id  )

private

Parameters

NewsContext[]

$contexts

Returns

NewsContext[]

Definition at line 192 of file NewsCollectionService.php.

                                                                                          : array
    {
        if ($criteria->isOnlyPublic()) {
            return $contexts;
        }
 
        // Remove contexts without news items or outside the criteria
        $contexts = $this->repository->filterContext($contexts, $criteria);
 
        // Preload rbac cache
        $this->rbac->preloadRbacPaCache(array_map(fn($context) => $context->getRefId(), $contexts), $user_id);
 
        // Order contexts by level to keep tree hierarchy
        usort($contexts, fn($a, $b) => $a->getLevel() <=> $b->getLevel());
        $filtered = [];
        $ac_result = [];
 
        foreach ($contexts as $context) {
            // Filter object and skip access check if the parent object was denied
            if (isset($ac_result[$context->getParentRefId()]) && !$ac_result[$context->getParentRefId()]) {
                continue;
            }
 
            $ac_result[$context->getRefId()] = $this->rbac->checkAccess(
                'read',
                $context->getRefId(),
                $context->getObjType(),
            );
 
            if ($ac_result[$context->getRefId()]) {
                $filtered[] = $context;
            }
        }
        return $filtered;
    }

References Vendor\Package\$a, Vendor\Package\$b, $user_id, ILIAS\News\Data\NewsCriteria\isOnlyPublic(), ILIAS\Repository\rbac(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

getNewsForContainer()

ILIAS\News\Domain\NewsCollectionService::getNewsForContainer	(	int	$ref_id,
		int	$context_obj_id,
		string	$context_type,
		NewsCriteria	$criteria,
		int	$user_id,
		bool	$lazy = false
	)

Definition at line 94 of file NewsCollectionService.php.

     : NewsCollection {
        if (in_array($context_type, ['grp', 'crs'])) {
            // see #31471, #30687, and ilMembershipNotification
            if (!\ilContainer::_lookupContainerSetting($context_obj_id, 'cont_use_news', '1')
                || (
                    !\ilContainer::_lookupContainerSetting($context_obj_id, 'cont_use_news', '1')
                       && !\ilContainer::_lookupContainerSetting($context_obj_id, 'news_timeline')
                )) {
                return new NewsCollection();
            }
 
            if (\ilBlockSetting::_lookup('news', 'hide_news_per_date', 0, $context_obj_id)) {
                $hide_date = \ilBlockSetting::_lookup('news', 'hide_news_date', 0, $context_obj_id);
                if (!empty($hide_date)) {
                    $criteria = $criteria->withStartDate(new \DateTimeImmutable($hide_date));
                }
            }
        }
 
        $context = new NewsContext($ref_id, $context_obj_id, $context_type);
        return $this->applyFinalProcessing($this->getNewsForContexts([$context], $criteria, $user_id, $lazy), $criteria);
    }

References ilBlockSetting\_lookup(), ilContainer\_lookupContainerSetting(), and ILIAS\News\Data\NewsCriteria\withStartDate().

Here is the call graph for this function:

getNewsForContext()

ILIAS\News\Domain\NewsCollectionService::getNewsForContext	(	NewsContext	$context,
		NewsCriteria	$criteria,
		int	$user_id,
		bool	$lazy = false
	)

Definition at line 85 of file NewsCollectionService.php.

     : NewsCollection {
        return $this->applyFinalProcessing($this->getNewsForContexts([$context], $criteria, $user_id, $lazy), $criteria);
    }

getNewsForContexts()

ILIAS\News\Domain\NewsCollectionService::getNewsForContexts ( array  $contexts, NewsCriteria  $criteria, int  $user_id, bool  $lazy  )

private

Parameters

NewsContext[]

$contexts

Definition at line 132 of file NewsCollectionService.php.

                                                                                                          : NewsCollection
    {
        // 1. Try context cache first (L1)
        $cached = $this->cache->getAggregatedContexts($contexts);
        $hits = $cached['hit'];
 
        if (!empty($cached['missing'])) {
            // 2. Batch load missing context object information [DPL 2]
            $remaining = $this->fetchContextData($cached['missing']);
 
            // 3. Perform aggregation [DPL 3]
            if (!$criteria->isPreventNesting()) {
                $aggregated = (new NewsAggregator())->aggregate($remaining);
                $this->cache->storeAggregatedContexts($remaining, $aggregated);
                $hits = array_merge($hits, $aggregated);
            } else {
                $hits = array_merge($hits, $remaining);
            }
        }
 
        // 4. Perform access checks [DPL 3]
        $aggregated = $this->filterByAccess($hits, $criteria, $user_id);
 
        // 5. Batch load news from the database [DPL 4]
        return $lazy
            ? $this->repository->findByContextsBatchLazy($aggregated, $criteria)
            : $this->repository->findByContextsBatch($aggregated, $criteria);
    }

References $user_id, ILIAS\News\Data\NewsCriteria\isPreventNesting(), and ILIAS\UI\examples\Deck\repository().

Referenced by ILIAS\News\Domain\NewsCollectionService\getNewsForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

getNewsForUser()

ILIAS\News\Domain\NewsCollectionService::getNewsForUser	(	\ilObjUser	$user,
		NewsCriteria	$criteria,
		bool	$lazy = false
	)

Definition at line 45 of file NewsCollectionService.php.

                                                                                                : NewsCollection
    {
        // 1. Try user cache first
        $cached_news = $this->cache->getNewsForUser($user->getId(), $criteria);
        if ($cached_news !== null) {
            // Transform the lazy collection to a normal collection if needed
            if (!$lazy) {
                $news_collection = new NewsCollection($this->repository->findByIds($cached_news->pluck('id')));
            } else {
                $news_collection = $cached_news->withFetchCallback(
                    fn(...$args) => $this->repository->loadLazyItems(...$args)
                );
            }
 
            // Apply request-specific filtering [DPL 5]
            return $this->applyFinalProcessing($news_collection, $criteria);
        }
 
        // 2. Add missing criteria and validate it
        if ($criteria->isIncludeReadStatus() && $criteria->getReadUserId() === null) {
            $criteria = $criteria->withReadUserId($user->getId());
        }
        $criteria->validate();
 
        // 3. Get user accessible contexts [DPL 1]
        $user_contexts = $this->user_context_resolver->getAccessibleContexts($user, $criteria);
        if (empty($user_contexts)) {
            return new NewsCollection();
        }
 
        // 4. Query news for resolved contexts [DPL 2-4]
        $news_collection = $this->getNewsForContexts($user_contexts, $criteria, $user->getId(), $lazy);
 
        // 5. Store in cache
        $this->cache->storeNewsForUser($user->getId(), $criteria, $news_collection);
 
        // 6. Apply request-specific filtering [DPL 5]
        return $this->applyFinalProcessing($news_collection, $criteria);
    }

References ILIAS\News\Domain\NewsCollectionService\applyFinalProcessing(), ilObject\getId(), ILIAS\News\Domain\NewsCollectionService\getNewsForContexts(), ILIAS\News\Data\NewsCriteria\getReadUserId(), ILIAS\News\Data\NewsCriteria\isIncludeReadStatus(), ILIAS\UI\examples\Deck\repository(), ILIAS\News\Data\NewsCriteria\validate(), and ILIAS\News\Data\NewsCriteria\withReadUserId().

Here is the call graph for this function:

invalidateCache()

ILIAS\News\Domain\NewsCollectionService::invalidateCache

(

int

$user_id

)

Definition at line 124 of file NewsCollectionService.php.

                                                 : void
    {
        $this->cache->invalidateNewsForUser($user_id, new NewsCriteria());
    }

References $user_id.

---

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

• components/ILIAS/News/src/Domain/NewsCollectionService.php