This class is a special implementation of a NewsCollection that is designed to load the complete NewsItems only when needed. More...

Inheritance diagram for ILIAS\News\Data\LazyNewsCollection:

Collaboration diagram for ILIAS\News\Data\LazyNewsCollection:

Public Member Functions
	__construct (array $news_ids=[], protected ?\Closure $fetch_callback=null)

	withFetchCallback (\Closure $callback)

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

	load (array $news_ids=[])
	This method loads the provided NewsItems from the database. More...

	groupFiles ()

	groupForums (bool $group_posting_sequence)

	contains (int $news_id)
	This method returns `true` if the NewsItem exists in this collection. More...

	has (int $news_id)
	This method returns `true` if the NewsItem exists in this collection and has been loaded. More...

	getById (int $news_id)
	This method returns the NewsItem with the given id or null if it does not exist. More...

	pick (int $offset)
	This method returns the NewsItem of the given offset of the collection. More...

	pluck (string $key, bool $wrap=false)
	INFO: This method will load all NewsItems into the collection. More...

	toArray ()
	INFO: This method will load all NewsItems into the collection. More...

	getAggregatedNews (bool $aggregate_files=false, bool $aggregate_forums=false, bool $group_posting_sequence=false)
	INFO: This method will load all NewsItems into the collection. More...

	merge (NewsCollection $other)
	Merge with another collection 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...

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

Public Member Functions inherited from ILIAS\News\Data\NewsCollection
	__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=[])

Private Member Functions
	regroup (array $items)

Private Attributes
bool	$group_files = false

int	$group_forums = 0

Additional Inherited Members
Protected Attributes inherited from ILIAS\News\Data\NewsCollection
array	$news_items = []

array	$context_map = []

array	$type_map = []

array	$user_read_status = []

array	$grouped_items_map = []

Detailed Description

This class is a special implementation of a NewsCollection that is designed to load the complete NewsItems only when needed.

This lazy loading has the advantage that less main memory is required, since only the IDs of the NewsItems are initially stored in the collection. It also prevents large database queries from being made when only some of the data records are needed.

This class should be used with caution and should not be used across the board. If used incorrectly, lazy loading can lead to a deterioration in performance due to the N+1 problem.

Definition at line 32 of file LazyNewsCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\News\Data\LazyNewsCollection::__construct	(	array	$news_ids = `[]`,
		protected ?\Closure	$fetch_callback = `null`
	)

Definition at line 37 of file LazyNewsCollection.php.

      {
        parent::__construct();
 
        foreach ($news_ids as $news_id) {
            $this->news_items[$news_id] = null;
        }
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ addNewsItems()

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

Add multiple news items efficiently.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 58 of file LazyNewsCollection.php.

                                                   : static
    {
        foreach ($news_items as $id => $item) {
            if ($item !== null) {
                $this->addNewsItem($item);
            } else {
                $this->news_items[$id] = null;
            }
 
        }
        return $this;
    }

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

Referenced by ILIAS\News\Data\LazyNewsCollection\load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contains()

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

This method returns true if the NewsItem exists in this collection.

It does not provide any information about whether the NewsItem has been loaded or not.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 159 of file LazyNewsCollection.php.

                                          : bool
    {
        return array_key_exists($news_id, $this->news_items);
    }

◆ exclude()

ILIAS\News\Data\LazyNewsCollection::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 from ILIAS\News\Data\NewsCollection.

Definition at line 242 of file LazyNewsCollection.php.

                                            : static
    {
        return parent::exclude($news_ids)->withFetchCallback($this->fetch_callback);
    }

◆ getAggregatedNews()

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

INFO: This method will load all NewsItems into the collection.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 228 of file LazyNewsCollection.php.

     : array {
        $this->load();
        return parent::getAggregatedNews($aggregate_files, $aggregate_forums, $group_posting_sequence);
    }

◆ getById()

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

This method returns the NewsItem with the given id or null if it does not exist.

If the NewsItem was not loaded, it will be loaded from the database.

WARNING: this may cause N+1 queries when using this method in a loop. Use load instead, to batch load NewsItems.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 179 of file LazyNewsCollection.php.

                                         : ?NewsItem
    {
        if (!$this->has($news_id)) {
            $this->load([$news_id]);
        }
 
        return $this->news_items[$news_id] ?? null;
    }

References ILIAS\News\Data\LazyNewsCollection\has(), and ILIAS\News\Data\LazyNewsCollection\load().

Referenced by ILIAS\News\Data\LazyNewsCollection\pick().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ groupFiles()

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

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 116 of file LazyNewsCollection.php.

                                : static
    {
        $this->group_files = true;
        return $this;
    }

◆ groupForums()

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

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 122 of file LazyNewsCollection.php.

                                                             : static
    {
        $this->group_forums = $group_posting_sequence ? 2 : 1;
        return $this;
    }

◆ has()

ILIAS\News\Data\LazyNewsCollection::has ( int $news_id )

This method returns true if the NewsItem exists in this collection and has been loaded.

Definition at line 167 of file LazyNewsCollection.php.

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

Referenced by ILIAS\News\Data\LazyNewsCollection\getById().

Here is the caller graph for this function:

◆ limit()

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

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

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 247 of file LazyNewsCollection.php.

                                      : static
    {
        return parent::limit($limit)->withFetchCallback($this->fetch_callback);
    }

◆ load()

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

This method loads the provided NewsItems from the database.

If an empty array is provided, it will load all missing NewsItems. It will also load the dependencies of the NewsItems if grouping is enabled.

Parameters

int[] $news_ids

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 77 of file LazyNewsCollection.php.

                                              : static
    {
        if ($this->fetch_callback === null) {
            throw new \RuntimeException('No fetch callback provided');
        }
 
        if (empty($news_ids)) {
            $news_ids = array_keys(array_filter($this->news_items, fn($item) => $item === null));
        } else {
            $news_ids = array_intersect($news_ids, array_keys($this->news_items));
        }
 
        if (empty($news_ids)) {
            return $this;
        }
 
        // Check if grouping was requested
        $context_types = [];
        if ($this->group_files === true) {
            $context_types[] = 'file';
        }
        if ($this->group_forums > 0) {
            $context_types[] = 'frm';
        }
 
        // Load items from a repository
        $items = call_user_func($this->fetch_callback, $news_ids, $context_types);
        $this->addNewsItems($items);
 
        // Perform re-grouping if necessary
        $this->regroup($items);
 
        return $this;
    }

References ILIAS\News\Data\LazyNewsCollection\addNewsItems(), and ILIAS\News\Data\LazyNewsCollection\regroup().

Referenced by ILIAS\News\Data\LazyNewsCollection\getById(), ILIAS\News\Data\LazyNewsCollection\pluck(), and ILIAS\News\Data\LazyNewsCollection\toArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ merge()

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

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

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 237 of file LazyNewsCollection.php.

                                                : static
    {
        return parent::merge($other)->withFetchCallback($this->fetch_callback);
    }

◆ pick()

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

This method returns the NewsItem of the given offset of the collection.

If the NewsItem was not loaded, it will be loaded from the database.

WARNING: this may cause N+1 queries when using this method in a loop. Use load instead, to batch load NewsItems.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 195 of file LazyNewsCollection.php.

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

References ILIAS\News\Data\LazyNewsCollection\getById().

Here is the call graph for this function:

◆ pluck()

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

INFO: This method will load all NewsItems into the collection.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 206 of file LazyNewsCollection.php.

                                                          : array
    {
        if ($key === 'id') {
            return $wrap ? array_map(fn($item) => [$item], array_keys($this->news_items)) : array_keys($this->news_items);
        }
 
        $this->load();
        return parent::pluck($key, $wrap);
    }

References ILIAS\News\Data\LazyNewsCollection\load().

Here is the call graph for this function:

◆ regroup()

ILIAS\News\Data\LazyNewsCollection::regroup ( array $items )

private

Definition at line 128 of file LazyNewsCollection.php.

                                          : void
    {
        // Check if re-grouping is required
        $needs_file_grouping = false;
        $needs_forum_grouping = false;
        foreach ($items as $item) {
            if ($this->group_files === true && $item->getContextObjType() === 'file') {
                $needs_file_grouping = true;
            }
            if ($this->group_forums > 0 && $item->getContextObjType() === 'frm') {
                $needs_forum_grouping = true;
            }
        }
 
        // Perform re-grouping
        if ($needs_file_grouping) {
            parent::groupFiles();
        }
        if ($needs_forum_grouping) {
            parent::groupForums($this->group_forums === 2);
        }
    }

Referenced by ILIAS\News\Data\LazyNewsCollection\load().

Here is the caller graph for this function:

◆ toArray()

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

INFO: This method will load all NewsItems into the collection.

Reimplemented from ILIAS\News\Data\NewsCollection.

Definition at line 219 of file LazyNewsCollection.php.

                             : array
    {
        $this->load();
        return parent::toArray();
    }

References ILIAS\News\Data\LazyNewsCollection\load().

Here is the call graph for this function:

◆ withFetchCallback()

ILIAS\News\Data\LazyNewsCollection::withFetchCallback ( \Closure $callback )

Parameters

Closure(int[], string[]): NewsItem[] $callback

Definition at line 51 of file LazyNewsCollection.php.

                                                         : static
    {
        $clone = clone $this;
        $clone->fetch_callback = $callback;
        return $clone;
    }

Field Documentation

◆ $group_files

bool ILIAS\News\Data\LazyNewsCollection::$group_files = false

private

Definition at line 34 of file LazyNewsCollection.php.

◆ $group_forums

int ILIAS\News\Data\LazyNewsCollection::$group_forums = 0

private

Definition at line 35 of file LazyNewsCollection.php.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNewsItems()

◆ contains()

◆ exclude()

◆ getAggregatedNews()

◆ getById()

◆ groupFiles()

◆ groupForums()

◆ has()

◆ limit()

◆ load()

◆ merge()

◆ pick()

◆ pluck()

◆ regroup()

◆ toArray()

◆ withFetchCallback()

Field Documentation

◆ $group_files

◆ $group_forums