News Repository provides basic CRUD operations and optimized database access for news operations with batch loading and optimized queries. More...

Collaboration diagram for ILIAS\News\Persistence\NewsRepository:

Public Member Functions
	__construct (protected readonly \ilDBInterface $db, protected readonly Factory $factory)

	findById (int $news_id)

	findByIds (array $news_ids)

	filterContext (array $contexts, NewsCriteria $criteria)

	loadLazyItems (array $news_ids, array $group_context_types)

	findByContextsBatch (array $contexts, NewsCriteria $criteria)

	findByContextsBatchLazy (array $contexts, NewsCriteria $criteria)

	countByContextsBatch (array $contexts)

Private Member Functions
	buildFindQuery (?array $news_ids=null)

	buildBatchQuery (array $obj_ids, NewsCriteria $criteria, bool $only_id=false)

Static Private Member Functions
static	parseTimePeriod (string\|int $time_period)

Detailed Description

News Repository provides basic CRUD operations and optimized database access for news operations with batch loading and optimized queries.

Definition at line 35 of file NewsRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\News\Persistence\NewsRepository::__construct	(	protected readonly \ilDBInterface	$db,
		protected readonly Factory	$factory
	)

Definition at line 37 of file NewsRepository.php.

40 {

41 }

Member Function Documentation

◆ buildBatchQuery()

ILIAS\News\Persistence\NewsRepository::buildBatchQuery	(	array	$obj_ids,
		NewsCriteria	$criteria,
		bool	$only_id = `false`
	)

private

Definition at line 238 of file NewsRepository.php.

                                                                                                   : array
    {
        $values = [];
        $types = [];
        $joins = '';
 
        if ($only_id) {
            $columns = ['il_news_item.id'];
        } else {
            $columns = [
                'il_news_item.*',
                'COALESCE((SELECT ref_id FROM object_reference WHERE object_reference.obj_id = il_news_item.context_obj_id LIMIT 1), 0) AS ref_id'
            ];
        }
 
        if ($criteria->isIncludeReadStatus()) {
            if ($criteria->getReadUserId() === null) {
                throw new \InvalidArgumentException("Read user id is required for read status");
            }
 
            $columns[] = 'il_news_read.user_id AS user_read';
            $joins .= 'LEFT JOIN il_news_read ON il_news_item.id = il_news_read.news_id AND il_news_read.user_id = %s ';
 
            $values[] = $criteria->getReadUserId();
            $types[] = ilDBConstants::T_INTEGER;
        }
 
        $query = "SELECT " . join(', ', $columns) . " FROM il_news_item {$joins} WHERE "
            . $this->db->in('context_obj_id', $obj_ids, false, ilDBConstants::T_INTEGER);
 
        if ($criteria->getPeriod() > 0) {
            $query .= " AND creation_date >= %s";
            $values[] = self::parseTimePeriod($criteria->getPeriod());
            $types[] = ilDBConstants::T_TIMESTAMP;
        }
 
        if ($criteria->getStartDate()) {
            $query .= " AND creation_date >= %s";
            $values[] = $criteria->getStartDate()->format('Y-m-d H:i:s');
            $types[] = ilDBConstants::T_TIMESTAMP;
        }
 
        if ($criteria->isNoAutoGenerated()) {
            $query .= " AND priority = 1 AND content_type = 'text'";
        }
 
        if ($criteria->getMinPriority() !== null || $criteria->getMaxPriority() !== null) {
            $operator = $criteria->getMinPriority() !== null ? '>=' : '<=';
            $query .= " AND n.priority {$operator} %s";
            $values[] = $criteria->getMinPriority();
            $types[] = ilDBConstants::T_INTEGER;
        }
 
        if ($criteria->isOnlyPublic()) {
            $query .= " AND visibility = '" . NEWS_PUBLIC . "'";
        }
 
        $query .= " ORDER BY creation_date DESC";
 
        return [$query, $types, $values];
    }

References ILIAS\News\Data\NewsCriteria\getMaxPriority(), ILIAS\News\Data\NewsCriteria\getMinPriority(), ILIAS\News\Data\NewsCriteria\getPeriod(), ILIAS\News\Data\NewsCriteria\getReadUserId(), ILIAS\News\Data\NewsCriteria\getStartDate(), ILIAS\News\Data\NewsCriteria\isIncludeReadStatus(), ILIAS\News\Data\NewsCriteria\isNoAutoGenerated(), ILIAS\News\Data\NewsCriteria\isOnlyPublic(), NEWS_PUBLIC, ILIAS\News\Persistence\NewsRepository\parseTimePeriod(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TIMESTAMP.

Referenced by ILIAS\News\Persistence\NewsRepository\findByContextsBatch(), and ILIAS\News\Persistence\NewsRepository\findByContextsBatchLazy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFindQuery()

ILIAS\News\Persistence\NewsRepository::buildFindQuery ( ?array $news_ids = null )

private

Definition at line 140 of file NewsRepository.php.

                                                            : string
    {
        $query = "
            SELECT il_news_item.*, 
               COALESCE(
                    (SELECT ref_id FROM object_reference WHERE object_reference.obj_id = il_news_item.context_obj_id LIMIT 1), 
                    0
                ) AS ref_id 
            FROM il_news_item ";
 
        if ($news_ids !== null) {
            $query .= "WHERE " . $this->db->in('id', $news_ids, false, \ilDBConstants::T_INTEGER);
        }
 
        return $query;
    }

References ilDBConstants\T_INTEGER.

Referenced by ILIAS\News\Persistence\NewsRepository\findByIds(), and ILIAS\News\Persistence\NewsRepository\loadLazyItems().

Here is the caller graph for this function:

◆ countByContextsBatch()

ILIAS\News\Persistence\NewsRepository::countByContextsBatch ( array $contexts )

Parameters

NewsContext[] $contexts

Returns: array{0: NewsContext, 1: int}[]

Definition at line 216 of file NewsRepository.php.

                                                         : array
    {
        $context_map = [];
        foreach ($contexts as $context) {
            $context_map[$context->getObjId()] = $context;
        }
 
        $in_clause = $this->db->in('context_obj_id', array_keys($context_map), false, ilDBConstants::T_INTEGER);
        $query = "SELECT context_obj_id, count(context_obj_id) as count FROM il_news_item WHERE {$in_clause} GROUP BY context_obj_id";
        $result = $this->db->query($query);
 
        $count = [];
        foreach ($this->db->fetchAll($result) as $row) {
            $count[] = [
                $context_map[$row['context_obj_id']],
                $row['count']
            ];
        }
 
        return $count;
    }

References ilDBConstants\T_INTEGER.

◆ filterContext()

ILIAS\News\Persistence\NewsRepository::filterContext	(	array	$contexts,
		NewsCriteria	$criteria
	)

Parameters

NewsContext[] $contexts

Returns: NewsContext[]

Definition at line 71 of file NewsRepository.php.

                                                                          : array
    {
        $obj_ids = array_map(fn($context) => $context->getObjId(), $contexts);
 
        $values = [];
        $types = [];
        $query = "SELECT DISTINCT (context_obj_id) AS obj_id FROM il_news_item WHERE ";
        $query .= $this->db->in('context_obj_id', $obj_ids, false, \ilDBConstants::T_INTEGER);
 
        if ($criteria->getPeriod() > 0) {
            $query .= " AND creation_date >= %s";
            $values[] = self::parseTimePeriod($criteria->getPeriod());
            $types[] = ilDBConstants::T_TIMESTAMP;
        }
 
        if ($criteria->getStartDate()) {
            $query .= " AND creation_date >= %s";
            $values[] = $criteria->getStartDate()->format('Y-m-d H:i:s');
            $types[] = ilDBConstants::T_TIMESTAMP;
        }
 
        $result = $this->db->queryF($query, $types, $values);
        $needed_obj_ids = array_column($this->db->fetchAll($result), 'obj_id', 'obj_id');
 
        return array_filter($contexts, fn($context) => isset($needed_obj_ids[$context->getObjId()]));
    }

References ILIAS\News\Data\NewsCriteria\getPeriod(), ILIAS\News\Data\NewsCriteria\getStartDate(), ILIAS\News\Persistence\NewsRepository\parseTimePeriod(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TIMESTAMP.

Here is the call graph for this function:

◆ findByContextsBatch()

ILIAS\News\Persistence\NewsRepository::findByContextsBatch	(	array	$contexts,
		NewsCriteria	$criteria
	)

Parameters

NewsContext[] $contexts

Definition at line 160 of file NewsRepository.php.

                                                                                : NewsCollection
    {
        if (empty($contexts)) {
            return new NewsCollection();
        }
 
        $obj_ids = array_map(fn($context) => $context->getObjId(), $contexts);
        $result = $this->db->queryF(...$this->buildBatchQuery($obj_ids, $criteria));
 
        $items = [];
        $user_read = [];
 
        while ($row = $this->db->fetchAssoc($result)) {
            $items[] = $this->factory->newsItem($row);
            $user_read[$row['id']] = isset($row['user_read']) && $row['user_read'] !== 0;
        }
 
        $collection = new NewsCollection($items);
        if ($criteria->isIncludeReadStatus()) {
            $collection->setUserReadStatus($criteria->getReadUserId(), $user_read);
        }
 
        return $collection;
    }

References ILIAS\News\Persistence\NewsRepository\buildBatchQuery(), factory(), ILIAS\News\Data\NewsCriteria\getReadUserId(), and ILIAS\News\Data\NewsCriteria\isIncludeReadStatus().

Here is the call graph for this function:

◆ findByContextsBatchLazy()

ILIAS\News\Persistence\NewsRepository::findByContextsBatchLazy	(	array	$contexts,
		NewsCriteria	$criteria
	)

Parameters

NewsContext[] $contexts

Definition at line 188 of file NewsRepository.php.

                                                                                    : NewsCollection
    {
        if (empty($contexts)) {
            return new NewsCollection();
        }
 
        $obj_ids = array_map(fn($context) => $context->getObjId(), $contexts);
        $result = $this->db->queryF(...$this->buildBatchQuery($obj_ids, $criteria, true));
 
        $items = [];
        $user_read = [];
        while ($row = $this->db->fetchAssoc($result)) {
            $items[] = $row['id'];
            $user_read[$row['id']] = isset($row['user_read']) && $row['user_read'] !== 0;
        }
 
        $collection = new LazyNewsCollection($items, fn(...$args) => $this->loadLazyItems(...$args));
        if ($criteria->isIncludeReadStatus()) {
            $collection->setUserReadStatus($criteria->getReadUserId(), $user_read);
        }
 
        return $collection;
    }

References ILIAS\News\Persistence\NewsRepository\buildBatchQuery(), ILIAS\News\Data\NewsCriteria\getReadUserId(), ILIAS\News\Data\NewsCriteria\isIncludeReadStatus(), and ILIAS\News\Persistence\NewsRepository\loadLazyItems().

Here is the call graph for this function:

◆ findById()

ILIAS\News\Persistence\NewsRepository::findById ( int $news_id )

Definition at line 43 of file NewsRepository.php.

                                          : ?NewsItem
    {
        $query = "SELECT * FROM il_news_item WHERE id = %s";
        $result = $this->db->queryF($query, [\ilDBConstants::T_INTEGER], [$news_id]);
 
        return $result->numRows()
            ? $this->factory->newsItem($this->db->fetchAssoc($result))
            : null;
    }

References factory(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ findByIds()

ILIAS\News\Persistence\NewsRepository::findByIds ( array $news_ids )

Parameters

int[] $news_ids

Returns: NewsItem[]

Definition at line 57 of file NewsRepository.php.

                                              : array
    {
        if (empty($news_ids)) {
            return [];
        }
 
        $result = $this->db->query($this->buildFindQuery($news_ids));
        return array_map(fn($row) => $this->factory->newsItem($row), $this->db->fetchAll($result));
    }

References ILIAS\News\Persistence\NewsRepository\buildFindQuery(), and factory().

Here is the call graph for this function:

◆ loadLazyItems()

ILIAS\News\Persistence\NewsRepository::loadLazyItems	(	array	$news_ids,
		array	$group_context_types
	)

Parameters

int[]	$news_ids
string[]	$group_context_types

Returns: NewsItem[]

Definition at line 104 of file NewsRepository.php.

                                                                              : array
    {
        if (empty($news_ids)) {
            return [];
        }
 
        $result = $this->db->query($this->buildFindQuery($news_ids));
        $news_items = [];
        $additional_obj_ids = [];
 
        foreach ($this->db->fetchAll($result) as $row) {
            $news_item = $this->factory->newsItem($row);
 
            if (in_array($news_item->getContextObjType(), $group_context_types)) {
                $additional_obj_ids[] = $news_item->getContextObjId();
            }
 
            $news_items[] = $news_item;
        }
 
        if (empty($additional_obj_ids)) {
            return $news_items;
        }
 
        // Fetch all additional items with same context_obj_id for grouping
        $query = $this->buildFindQuery()
            . " WHERE " . $this->db->in('context_obj_id', $additional_obj_ids, false, \ilDBConstants::T_INTEGER)
            . " AND " . $this->db->in('id', $news_ids, true, \ilDBConstants::T_INTEGER);
        $result = $this->db->query($query);
 
        return array_merge(
            $news_items,
            array_map(fn($row) => $this->factory->newsItem($row), $this->db->fetchAll($result))
        );
    }

References ILIAS\News\Persistence\NewsRepository\buildFindQuery(), factory(), and ilDBConstants\T_INTEGER.

Referenced by ILIAS\News\Persistence\NewsRepository\findByContextsBatchLazy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseTimePeriod()

static ILIAS\News\Persistence\NewsRepository::parseTimePeriod ( string|int $time_period )

staticprivate

Definition at line 300 of file NewsRepository.php.

                                                                    : string
    {
        // time period is a number of days
        if (is_numeric($time_period) && $time_period > 0) {
            return date('Y-m-d H:i:s', time() - ($time_period * 24 * 60 * 60));
        }
 
        // time period is datetime (string)
        if (preg_match("/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/", $time_period)) {
            return $time_period;
        }
 
        return '';
    }

Referenced by ILIAS\News\Persistence\NewsRepository\buildBatchQuery(), and ILIAS\News\Persistence\NewsRepository\filterContext().

Here is the caller graph for this function:

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

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildBatchQuery()

◆ buildFindQuery()

◆ countByContextsBatch()

◆ filterContext()

◆ findByContextsBatch()

◆ findByContextsBatchLazy()

◆ findById()

◆ findByIds()

◆ loadLazyItems()

◆ parseTimePeriod()