News Criteria DTO for querying news items supports caching, JSON serialization, and validation. More...

Inheritance diagram for ILIAS\News\Data\NewsCriteria:

Collaboration diagram for ILIAS\News\Data\NewsCriteria:

Public Member Functions
	getPeriod ()

	isOnlyPublic ()

	getMinPriority ()

	getMaxPriority ()

	getLimit ()

	isPreventNesting ()

	isNoAutoGenerated ()

	getExcludedNewsIds ()

	isIncludeReadStatus ()

	getReadUserId ()

	getStartDates ()

	withPeriod (?int $period)

	withOnlyPublic (bool $only_public)

	withMinPriority (?int $min_priority)

	withMaxPriority (?int $max_priority)

	withLimit (?int $limit)

	withPreventNesting (bool $stop_nesting)

	withNoAutoGenerated (bool $no_auto_generated)

	withExcludedNewsIds (array $excluded_news_ids)

	withIncludeReadStatus (bool $include_read_status)

	withReadUserId (?int $read_user_id)

	withStartDates (array $start_dates)

	jsonSerialize ()

	toArray ()

	hasPriorityFilters ()
	Check if criteria has priority filters. More...

	validate ()
	Validate criteria parameters. More...

Detailed Description

News Criteria DTO for querying news items supports caching, JSON serialization, and validation.

Definition at line 28 of file NewsCriteria.php.

Member Function Documentation

◆ getExcludedNewsIds()

ILIAS\News\Data\NewsCriteria::getExcludedNewsIds ( )

Definition at line 87 of file NewsCriteria.php.

                                        : array
    {
        return $this->excluded_news_ids;
    }

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

Here is the caller graph for this function:

◆ getLimit()

ILIAS\News\Data\NewsCriteria::getLimit ( )

Definition at line 72 of file NewsCriteria.php.

                              : ?int
    {
        return $this->limit;
    }

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

Here is the caller graph for this function:

◆ getMaxPriority()

ILIAS\News\Data\NewsCriteria::getMaxPriority ( )

Definition at line 67 of file NewsCriteria.php.

                                    : ?int
    {
        return $this->max_priority;
    }

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

Here is the caller graph for this function:

◆ getMinPriority()

ILIAS\News\Data\NewsCriteria::getMinPriority ( )

Definition at line 62 of file NewsCriteria.php.

                                    : ?int
    {
        return $this->min_priority;
    }

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

Here is the caller graph for this function:

◆ getPeriod()

ILIAS\News\Data\NewsCriteria::getPeriod ( )

Definition at line 52 of file NewsCriteria.php.

                               : ?int
    {
        return $this->period;
    }

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

Here is the caller graph for this function:

◆ getReadUserId()

ILIAS\News\Data\NewsCriteria::getReadUserId ( )

Definition at line 97 of file NewsCriteria.php.

                                   : ?int
    {
        return $this->read_user_id;
    }

Referenced by ILIAS\News\Persistence\NewsRepository\buildBatchQuery(), ILIAS\News\Persistence\NewsRepository\findByContextsBatch(), ILIAS\News\Persistence\NewsRepository\findByContextsBatchLazy(), and ILIAS\News\Domain\NewsCollectionService\getNewsForUser().

Here is the caller graph for this function:

◆ getStartDates()

ILIAS\News\Data\NewsCriteria::getStartDates ( )

Returns: array<int, DateTimeImmutable>

Definition at line 105 of file NewsCriteria.php.

                                   : array
    {
        return $this->start_dates;
    }

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

Here is the caller graph for this function:

◆ hasPriorityFilters()

ILIAS\News\Data\NewsCriteria::hasPriorityFilters ( )

Check if criteria has priority filters.

Definition at line 219 of file NewsCriteria.php.

                                        : bool
    {
        return $this->min_priority !== null || $this->max_priority !== null;
    }

◆ isIncludeReadStatus()

ILIAS\News\Data\NewsCriteria::isIncludeReadStatus ( )

Definition at line 92 of file NewsCriteria.php.

                                         : bool
    {
        return $this->include_read_status ?? false;
    }

Referenced by ILIAS\News\Persistence\NewsRepository\buildBatchQuery(), ILIAS\News\Persistence\NewsRepository\findByContextsBatch(), ILIAS\News\Persistence\NewsRepository\findByContextsBatchLazy(), and ILIAS\News\Domain\NewsCollectionService\getNewsForUser().

Here is the caller graph for this function:

◆ isNoAutoGenerated()

ILIAS\News\Data\NewsCriteria::isNoAutoGenerated ( )

Definition at line 82 of file NewsCriteria.php.

                                       : bool
    {
        return $this->no_auto_generated;
    }

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

Here is the caller graph for this function:

◆ isOnlyPublic()

ILIAS\News\Data\NewsCriteria::isOnlyPublic ( )

Definition at line 57 of file NewsCriteria.php.

                                  : bool
    {
        return $this->only_public;
    }

Referenced by ILIAS\News\Persistence\NewsRepository\buildBatchQuery(), ILIAS\News\Domain\NewsCollectionService\filterByAccess(), ILIAS\News\Domain\UserContextResolver\filterContexts(), ILIAS\News\Persistence\NewsCache\generateL3Key(), ILIAS\News\Persistence\NewsCache\getUserContextAccess(), and ILIAS\News\Persistence\NewsCache\storeUserContextAccess().

Here is the caller graph for this function:

◆ isPreventNesting()

ILIAS\News\Data\NewsCriteria::isPreventNesting ( )

Definition at line 77 of file NewsCriteria.php.

                                      : bool
    {
        return $this->prevent_nesting;
    }

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

Here is the caller graph for this function:

◆ jsonSerialize()

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

Definition at line 194 of file NewsCriteria.php.

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

References ILIAS\News\Data\NewsCriteria\toArray().

Here is the call graph for this function:

◆ toArray()

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

Definition at line 199 of file NewsCriteria.php.

                             : array
    {
        return [
            'period' => $this->period,
            'only_public' => $this->only_public,
            'min_priority' => $this->min_priority,
            'max_priority' => $this->max_priority,
            'limit' => $this->limit,
            'stop_nesting' => $this->prevent_nesting,
            'no_auto_generated' => $this->no_auto_generated,
            'excluded_news_ids' => $this->excluded_news_ids,
            'include_read_status' => $this->include_read_status,
            'read_user_id' => $this->read_user_id,
            'start_dates' => $this->start_dates
        ];
    }

Referenced by ILIAS\News\Data\NewsCriteria\jsonSerialize().

Here is the caller graph for this function:

◆ validate()

ILIAS\News\Data\NewsCriteria::validate ( )

Validate criteria parameters.

Definition at line 227 of file NewsCriteria.php.

                              : void
    {
        if ($this->min_priority !== null && $this->max_priority !== null && $this->min_priority > $this->max_priority) {
            throw new \InvalidArgumentException('Min priority cannot be greater than max priority');
        }
 
        if ($this->limit !== null && $this->limit < 0) {
            throw new \InvalidArgumentException('Limit cannot be negative');
        }
    }

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

Here is the caller graph for this function:

◆ withExcludedNewsIds()

ILIAS\News\Data\NewsCriteria::withExcludedNewsIds ( array $excluded_news_ids )

Definition at line 159 of file NewsCriteria.php.

                                                                 : self
    {
        $new = clone $this;
        $new->excluded_news_ids = array_map('intval', $excluded_news_ids);
        return $new;
    }

◆ withIncludeReadStatus()

ILIAS\News\Data\NewsCriteria::withIncludeReadStatus ( bool $include_read_status )

Definition at line 166 of file NewsCriteria.php.

                                                                    : self
    {
        $new = clone $this;
        $new->include_read_status = $include_read_status;
        return $new;
    }

◆ withLimit()

ILIAS\News\Data\NewsCriteria::withLimit ( ?int $limit )

Definition at line 138 of file NewsCriteria.php.

                                          : self
    {
        $new = clone $this;
        $new->limit = $limit;
        return $new;
    }

◆ withMaxPriority()

ILIAS\News\Data\NewsCriteria::withMaxPriority ( ?int $max_priority )

Definition at line 131 of file NewsCriteria.php.

                                                       : self
    {
        $new = clone $this;
        $new->max_priority = $max_priority;
        return $new;
    }

◆ withMinPriority()

ILIAS\News\Data\NewsCriteria::withMinPriority ( ?int $min_priority )

Definition at line 124 of file NewsCriteria.php.

                                                       : self
    {
        $new = clone $this;
        $new->min_priority = $min_priority;
        return $new;
    }

◆ withNoAutoGenerated()

ILIAS\News\Data\NewsCriteria::withNoAutoGenerated ( bool $no_auto_generated )

Definition at line 152 of file NewsCriteria.php.

                                                                : self
    {
        $new = clone $this;
        $new->no_auto_generated = $no_auto_generated;
        return $new;
    }

◆ withOnlyPublic()

ILIAS\News\Data\NewsCriteria::withOnlyPublic ( bool $only_public )

Definition at line 117 of file NewsCriteria.php.

                                                     : self
    {
        $new = clone $this;
        $new->only_public = $only_public;
        return $new;
    }

◆ withPeriod()

ILIAS\News\Data\NewsCriteria::withPeriod ( ?int $period )

Definition at line 110 of file NewsCriteria.php.

                                            : self
    {
        $new = clone $this;
        $new->period = $period;
        return $new;
    }

◆ withPreventNesting()

ILIAS\News\Data\NewsCriteria::withPreventNesting ( bool $stop_nesting )

Definition at line 145 of file NewsCriteria.php.

                                                          : self
    {
        $new = clone $this;
        $new->prevent_nesting = $stop_nesting;
        return $new;
    }

◆ withReadUserId()

ILIAS\News\Data\NewsCriteria::withReadUserId ( ?int $read_user_id )

Definition at line 173 of file NewsCriteria.php.

                                                      : self
    {
        $new = clone $this;
        $new->read_user_id = $read_user_id;
        return $new;
    }

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

Here is the caller graph for this function:

◆ withStartDates()

ILIAS\News\Data\NewsCriteria::withStartDates ( array $start_dates )

Parameters

array<int,DateTimeImmutable> $start_dates

Definition at line 183 of file NewsCriteria.php.

                                                      : self
    {
        $new = clone $this;
        $new->start_dates = $start_dates;
        return $new;
    }

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

Here is the caller graph for this function:

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ getExcludedNewsIds()

◆ getLimit()

◆ getMaxPriority()

◆ getMinPriority()

◆ getPeriod()

◆ getReadUserId()

◆ getStartDates()

◆ hasPriorityFilters()

◆ isIncludeReadStatus()

◆ isNoAutoGenerated()

◆ isOnlyPublic()

◆ isPreventNesting()

◆ jsonSerialize()

◆ toArray()

◆ validate()

◆ withExcludedNewsIds()

◆ withIncludeReadStatus()

◆ withLimit()

◆ withMaxPriority()

◆ withMinPriority()

◆ withNoAutoGenerated()

◆ withOnlyPublic()

◆ withPeriod()

◆ withPreventNesting()

◆ withReadUserId()

◆ withStartDates()