Optimized News Collection with memory-efficient data structures to support large news feeds. More...

Inheritance diagram for ILIAS\News\Data\NewsCollection:

Collaboration diagram for ILIAS\News\Data\NewsCollection:

Public Member Functions
	__construct (array $news_items=[])

	addNewsItems (array $news_items)
	Add multiple news items efficiently. More...

	addNewsItem (NewsItem $item)
	Add a single news item with indexing. More...

	getNewsItems ()

	getNewsForContext (int $context_obj_id, string $context_obj_type)

	getNewsByType (string $obj_type)

	setUserReadStatus (int $user_id, array $read_news_ids)

	isReadByUser (int $user_id, int $news_id)

	getUserReadStatus (int $user_id)

	groupFiles ()

	groupForums (bool $group_posting_sequence)

	getGroupingFor (NewsItem $item)
	Returns the grouping for a given news item. More...

	getAggregatedNews (bool $aggregate_files=false, bool $aggregate_forums=false, bool $group_posting_sequence=false)
	Get news items in a format compatible with the legacy rendering implementation. More...

	jsonSerialize ()

	getIterator ()

	count ()

	isEmpty ()

	first ()

	last ()

	contains (int $news_id)

	getById (int $news_id)

	getPageFor (int $news_id)

	pick (int $offset)

	pluck (string $key, bool $wrap=false)

	toArray ()

	merge (NewsCollection $other)
	Merge with another collection and returns it as a new collection. More...

	limit (?int $limit)
	Limit the number of news items and returns it as a new collection. More...

	exclude (array $news_ids)
	Returns a new collection with only the news items that are not in the provided list. More...

	load (array $news_ids=[])

Protected Attributes
array	$news_items = []

array	$context_map = []

array	$type_map = []

array	$user_read_status = []

array	$grouped_items_map = []

Detailed Description

Optimized News Collection with memory-efficient data structures to support large news feeds.

It's designed for context-based filtering and fast_lookups.

Definition at line 29 of file NewsCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\News\Data\NewsCollection::__construct ( array $news_items = [] )

Definition at line 45 of file NewsCollection.php.

    {
        $this->addNewsItems($news_items);
    }

References ILIAS\News\Data\NewsCollection\addNewsItems().

Here is the call graph for this function:

Member Function Documentation

◆ addNewsItem()

ILIAS\News\Data\NewsCollection::addNewsItem ( NewsItem $item )

Add a single news item with indexing.

Definition at line 64 of file NewsCollection.php.

                                               : static
    {
        $id = $item->getId();
        $this->news_items[$id] = $item;
 
        // Build context index for fast context-based lookups
        $context_key = $item->getContextObjId() . '_' . $item->getContextObjType();
        $this->context_map[$context_key][] = $id;
 
        // Build type index for fast type-based filtering
        $this->type_map[$item->getContextObjType()][] = $id;
 
        return $this;
    }

References $id, ILIAS\News\Data\NewsItem\getContextObjId(), ILIAS\News\Data\NewsItem\getContextObjType(), and ILIAS\News\Data\NewsItem\getId().

Referenced by ILIAS\News\Data\LazyNewsCollection\addNewsItems(), and ILIAS\News\Data\NewsCollection\addNewsItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addNewsItems()

ILIAS\News\Data\NewsCollection::addNewsItems ( array $news_items )

Add multiple news items efficiently.

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 53 of file NewsCollection.php.

                                                   : static
    {
        foreach ($news_items as $item) {
            $this->addNewsItem($item);
        }
        return $this;
    }

References ILIAS\News\Data\NewsCollection\$news_items, and ILIAS\News\Data\NewsCollection\addNewsItem().

Referenced by ILIAS\News\Data\NewsCollection\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contains()

ILIAS\News\Data\NewsCollection::contains ( int $news_id )

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 344 of file NewsCollection.php.

                                          : bool
    {
        return isset($this->news_items[$news_id]);
    }

◆ count()

ILIAS\News\Data\NewsCollection::count ( )

Definition at line 324 of file NewsCollection.php.

                           : int
    {
        return count($this->news_items);
    }

◆ exclude()

ILIAS\News\Data\NewsCollection::exclude ( array $news_ids )

Returns a new collection with only the news items that are not in the provided list.

Parameters

int[] $news_ids

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 421 of file NewsCollection.php.

                                            : static
    {
        if (empty($news_ids)) {
            return $this;
        }
 
        $filtered = new static();
        $filtered->addNewsItems(array_filter(
            $this->news_items,
            fn($item) => !in_array($item->getId(), $news_ids)
        ));
        return $filtered;
    }

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

Here is the caller graph for this function:

◆ first()

ILIAS\News\Data\NewsCollection::first ( )

Definition at line 334 of file NewsCollection.php.

                           : ?NewsItem
    {
        return reset($this->news_items) ?: null;
    }

◆ getAggregatedNews()

ILIAS\News\Data\NewsCollection::getAggregatedNews	(	bool	$aggregate_files = `false`,
		bool	$aggregate_forums = `false`,
		bool	$group_posting_sequence = `false`
	)

Get news items in a format compatible with the legacy rendering implementation.

This should never be introduced in new code and will be removed in the future.

Deprecated:

Returns: array<int, array<string, mixed>>

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 224 of file NewsCollection.php.

     : array {
        $items = [];
        $file_aggregation_map = [];
        $forum_aggregation_map = [];
        $last_forum = 0;
 
        foreach ($this->news_items as $item) {
            $entry = [
                'id' => $item->getId(),
                'priority' => $item->getPriority(),
                'title' => $item->getTitle(),
                'content' => $item->getContent(),
                'context_obj_id' => $item->getContextObjId(),
                'context_obj_type' => $item->getContextObjType(),
                'context_sub_obj_id' => $item->getContextSubObjId(),
                'context_sub_obj_type' => $item->getContextSubObjType(),
                'content_type' => $item->getContentType(),
                'creation_date' => $item->getCreationDate()->format('Y-m-d H:i:s'),
                'user_id' => $item->getUserId(),
                'visibility' => $item->getVisibility(),
                'content_long' => $item->getContentLong(),
                'content_is_lang_var' => $item->isContentIsLangVar(),
                'mob_id' => $item->getMobId(),
                'playtime' => $item->getPlaytime(),
                'start_date' => null, //it seems like this is not used anymore
                'end_date' => null, //it seems like this is not used anymore
                'content_text_is_lang_var' => $item->isContentTextIsLangVar(),
                'mob_cnt_download' => $item->getMobCntDownload(),
                'mob_cnt_play' => $item->getMobCntPlay(),
                'content_html' => $item->isContentHtml(),
                'update_user_id' => $item->getUpdateUserId(),
                'user_read' => (int) $this->isReadByUser($item->getUserId(), $item->getId()),
                'ref_id' => $item->getContextRefId()
            ];
 
            if ($aggregate_files && $item->getContextObjType() === 'file') {
                if (isset($file_aggregation_map[$item->getContextObjId()])) {
                    // If this file already has an aggregation entry, add it there and prevent adding it to the main list
                    $idx = $file_aggregation_map[$item->getContextObjId()];
                    $items[$idx]['aggregation'][$item->getId()] = $entry;
                    continue;
                }
 
                // If this is the first news for this file, set the aggregation array
                $entry['aggregation'] = [];
                $entry['agg_ref_id'] = $item->getContextRefId();
                $file_aggregation_map[$item->getContextObjId()] = $item->getId();
 
            }
 
            if ($aggregate_forums) {
                // If we are grouping by sequence, we need to reset the entry in the aggregation map when switching
                if ($group_posting_sequence && $last_forum !== 0 && $last_forum !== $item->getContextObjType()) {
                    $forum_aggregation_map[$last_forum] = null;
                }
 
                if ($item->getContextObjType() === 'frm') {
                    $entry['no_context_title'] = true;
 
                    if (isset($forum_aggregation_map[$item->getContextObjId()])) {
                        // If this form already has an aggregation entry, add it there and prevent adding it to the main list
                        $idx = $forum_aggregation_map[$item->getContextObjId()];
                        $items[$idx]['aggregation'][$item->getId()] = $entry;
                        continue;
                    }
 
                    // If this is the first news for this forum, set the aggregation array
                    $entry['agg_ref_id'] = $item->getContextRefId();
                    $entry['content'] = '';
                    $entry['content_long'] = '';
 
                    $forum_aggregation_map[$item->getContextObjId()] = $item->getId();
                    $last_forum = $item->getContextObjType();
 
                }
            }
 
            $items[$item->getId()] = $entry;
        }
        return $items;
    }

References ILIAS\Repository\int(), and ILIAS\News\Data\NewsCollection\isReadByUser().

Here is the call graph for this function:

◆ getById()

ILIAS\News\Data\NewsCollection::getById ( int $news_id )

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 349 of file NewsCollection.php.

                                         : ?NewsItem
    {
        return $this->news_items[$news_id] ?? null;
    }

◆ getGroupingFor()

ILIAS\News\Data\NewsCollection::getGroupingFor ( NewsItem $item )

Returns the grouping for a given news item.

It will return an array with the grouped items if the provided item is the first in the group.

Returns: array{parent: NewsItem, aggregation: NewsItem[], agg_ref_id: int, no_context_title: bool}|null

Definition at line 189 of file NewsCollection.php.

                                                  : ?array
    {
        if (!isset($this->grouped_items_map[$item->getContextObjId()])) {
            return null;
        }
 
        $aggregation = $this->grouped_items_map[$item->getContextObjId()];
        if ($aggregation['first'] !== $item->getId()) {
            return null;
        }
 
        if ($item->getContextObjType() === 'frm') {
            $item = $item->withContent('')->withContentLong('');
        }
 
        return [
            'parent' => $item,
            'aggregation' => [$item, ...array_map(fn($id) => $this->news_items[$id], $aggregation['aggregation'])],
            'agg_ref_id' => $item->getContextRefId(),
            'no_context_title' => $item->getContextObjType() === 'frm'
        ];
    }

References $id, ILIAS\News\Data\NewsItem\getContextObjId(), ILIAS\News\Data\NewsItem\getContextObjType(), ILIAS\News\Data\NewsItem\getContextRefId(), ILIAS\News\Data\NewsItem\getId(), and ILIAS\News\Data\NewsItem\withContent().

Here is the call graph for this function:

◆ getIterator()

ILIAS\News\Data\NewsCollection::getIterator ( )

Definition at line 319 of file NewsCollection.php.

                                 : ArrayIterator
    {
        return new ArrayIterator($this->news_items);
    }

◆ getNewsByType()

ILIAS\News\Data\NewsCollection::getNewsByType ( string $obj_type )

Definition at line 98 of file NewsCollection.php.

                                                   : array
    {
        if (!isset($this->type_map[$obj_type])) {
            return [];
        }
 
        return array_map(
            fn($id) => $this->news_items[$id],
            $this->type_map[$obj_type]
        );
    }

References $id.

◆ getNewsForContext()

ILIAS\News\Data\NewsCollection::getNewsForContext	(	int	$context_obj_id,
		string	$context_obj_type
	)

Definition at line 84 of file NewsCollection.php.

                                                                                    : array
    {
        $context_key = $context_obj_id . '_' . $context_obj_type;
 
        if (!isset($this->context_map[$context_key])) {
            return [];
        }
 
        return array_map(
            fn($id) => $this->news_items[$id],
            $this->context_map[$context_key]
        );
    }

References $id.

Referenced by ilNewsForContextBlockGUI\loadNewsData().

Here is the caller graph for this function:

◆ getNewsItems()

ILIAS\News\Data\NewsCollection::getNewsItems ( )

Definition at line 79 of file NewsCollection.php.

                                  : array
    {
        return $this->news_items;
    }

References ILIAS\News\Data\NewsCollection\$news_items.

Referenced by ILIAS\News\Data\NewsCollection\merge().

Here is the caller graph for this function:

◆ getPageFor()

ILIAS\News\Data\NewsCollection::getPageFor ( int $news_id )

Definition at line 354 of file NewsCollection.php.

                                            : int
    {
        $pages = array_keys($this->news_items);
        return (int) array_search($news_id, $pages);
    }

◆ getUserReadStatus()

ILIAS\News\Data\NewsCollection::getUserReadStatus ( int $user_id )

Returns: array<int, bool>

Definition at line 127 of file NewsCollection.php.

                                                   : array
    {
        $result = [];
        foreach (array_keys($this->news_items) as $news_id) {
            $result[$news_id] = $this->isReadByUser($user_id, $news_id);
        }
        return $result;
    }

References ILIAS\News\Data\NewsCollection\isReadByUser().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ groupFiles()

ILIAS\News\Data\NewsCollection::groupFiles ( )

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 140 of file NewsCollection.php.

                                : static
    {
        foreach (array_filter($this->news_items) as $item) {
            if ($item->getContextObjType() === 'file') {
                if (isset($this->grouped_items_map[$item->getContextObjId()])) {
                    $this->grouped_items_map[$item->getContextObjId()]['aggregation'][] = $item->getId();
                } else {
                    $this->grouped_items_map[$item->getContextObjId()] = [
                        'first' => $item->getId(),
                        'aggregation' => []
                    ];
                }
            }
        }
        return $this;
    }

Referenced by ilNewsForContextBlockGUI\loadNewsData().

Here is the caller graph for this function:

◆ groupForums()

ILIAS\News\Data\NewsCollection::groupForums ( bool $group_posting_sequence )

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 157 of file NewsCollection.php.

                                                             : static
    {
        $last_forum = 0;
 
        foreach (array_filter($this->news_items) as $item) {
            // If we are grouping by sequence, we need to reset the entry in the aggregation map when switching
            if ($group_posting_sequence && $last_forum !== $item->getContextObjType() && $last_forum !== 0) {
                $this->grouped_items_map[$last_forum] = null;
            }
 
            if ($item->getContextObjType() === 'frm') {
                if (isset($this->grouped_items_map[$item->getContextObjId()])) {
                    $this->grouped_items_map[$item->getContextObjId()]['aggregation'][] = $item->getId();
                } else {
                    $this->grouped_items_map[$item->getContextObjId()] = [
                        'first' => $item->getId(),
                        'aggregation' => []
                    ];
                    $last_forum = $item->getContextObjId();
                }
            }
        }
 
        return $this;
    }

◆ isEmpty()

ILIAS\News\Data\NewsCollection::isEmpty ( )

Definition at line 329 of file NewsCollection.php.

                             : bool
    {
        return empty($this->news_items);
    }

◆ isReadByUser()

ILIAS\News\Data\NewsCollection::isReadByUser	(	int	$user_id,
		int	$news_id
	)

Definition at line 119 of file NewsCollection.php.

                                                            : bool
    {
        return isset($this->user_read_status[$user_id][$news_id]);
    }

References $user_id.

Referenced by ILIAS\News\Data\NewsCollection\getAggregatedNews(), and ILIAS\News\Data\NewsCollection\getUserReadStatus().

Here is the caller graph for this function:

◆ jsonSerialize()

ILIAS\News\Data\NewsCollection::jsonSerialize ( )

Definition at line 314 of file NewsCollection.php.

                                   : array
    {
        return array_values($this->news_items);
    }

◆ last()

ILIAS\News\Data\NewsCollection::last ( )

Definition at line 339 of file NewsCollection.php.

                          : ?NewsItem
    {
        return end($this->news_items) ?: null;
    }

◆ limit()

ILIAS\News\Data\NewsCollection::limit ( ?int $limit )

Limit the number of news items and returns it as a new collection.

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 403 of file NewsCollection.php.

                                      : static
    {
        if ($limit === null || $limit >= count($this->news_items)) {
            return $this;
        }
 
        $limited = new static();
        $items = array_slice($this->news_items, 0, $limit, true);
        $limited->addNewsItems($items);
 
        return $limited;
    }

◆ load()

ILIAS\News\Data\NewsCollection::load ( array $news_ids = [] )

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 435 of file NewsCollection.php.

                                              : static
    {
        return $this;
    }

◆ merge()

ILIAS\News\Data\NewsCollection::merge ( NewsCollection $other )

Merge with another collection and returns it as a new collection.

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 384 of file NewsCollection.php.

                                                : static
    {
        $merged = new static();
        $merged->addNewsItems($this->news_items);
        $merged->addNewsItems($other->getNewsItems());
 
        // Merge user read status
        foreach ($other->user_read_status as $user_id => $read_ids) {
            $merged->user_read_status[$user_id] = isset($this->user_read_status[$user_id])
                ? array_merge($this->user_read_status[$user_id], $read_ids)
                : $read_ids;
        }
 
        return $merged;
    }

References $user_id, and ILIAS\News\Data\NewsCollection\getNewsItems().

Here is the call graph for this function:

◆ pick()

ILIAS\News\Data\NewsCollection::pick ( int $offset )

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 360 of file NewsCollection.php.

                                     : ?NewsItem
    {
        $index = max(0, $offset);
        return array_values($this->news_items)[$index] ?? null;
    }

◆ pluck()

ILIAS\News\Data\NewsCollection::pluck	(	string	$key,
		bool	$wrap = `false`
	)

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 366 of file NewsCollection.php.

                                                          : array
    {
        $arr = array_column($this->toArray(), $key);
        return $wrap ? array_map(fn($item) => [$item], $arr) : $arr;
    }

Referenced by ilNewsForContextBlockGUI\initData().

Here is the caller graph for this function:

◆ setUserReadStatus()

ILIAS\News\Data\NewsCollection::setUserReadStatus	(	int	$user_id,
		array	$read_news_ids
	)

Parameters

array<int,bool> $read_news_ids

Definition at line 113 of file NewsCollection.php.

                                                                         : static
    {
        $this->user_read_status[$user_id] = array_filter($read_news_ids);
        return $this;
    }

References $user_id.

◆ toArray()

ILIAS\News\Data\NewsCollection::toArray ( )

Returns: array<int, array>

Reimplemented in ILIAS\News\Data\LazyNewsCollection.

Definition at line 375 of file NewsCollection.php.

                             : array
    {
        return array_map(fn($item) => $item->toArray(), $this->news_items);
    }

Field Documentation

◆ $context_map

array ILIAS\News\Data\NewsCollection::$context_map = []

protected

Definition at line 35 of file NewsCollection.php.

◆ $grouped_items_map

array ILIAS\News\Data\NewsCollection::$grouped_items_map = []

protected

Definition at line 43 of file NewsCollection.php.

◆ $news_items

array ILIAS\News\Data\NewsCollection::$news_items = []

protected

Definition at line 32 of file NewsCollection.php.

Referenced by ILIAS\News\Data\LazyNewsCollection\addNewsItems(), ILIAS\News\Data\NewsCollection\addNewsItems(), and ILIAS\News\Data\NewsCollection\getNewsItems().

◆ $type_map

array ILIAS\News\Data\NewsCollection::$type_map = []

protected

Definition at line 38 of file NewsCollection.php.

◆ $user_read_status

array ILIAS\News\Data\NewsCollection::$user_read_status = []

protected

Definition at line 41 of file NewsCollection.php.

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

components/ILIAS/News/src/Data/NewsCollection.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNewsItem()

◆ addNewsItems()

◆ contains()

◆ count()

◆ exclude()

◆ first()

◆ getAggregatedNews()

◆ getById()

◆ getGroupingFor()

◆ getIterator()

◆ getNewsByType()

◆ getNewsForContext()

◆ getNewsItems()

◆ getPageFor()

◆ getUserReadStatus()

◆ groupFiles()

◆ groupForums()

◆ isEmpty()

◆ isReadByUser()

◆ jsonSerialize()

◆ last()

◆ limit()

◆ load()

◆ merge()

◆ pick()

◆ pluck()

◆ setUserReadStatus()

◆ toArray()

Field Documentation

◆ $context_map

◆ $grouped_items_map

◆ $news_items

◆ $type_map

◆ $user_read_status