Inheritance diagram for ILIAS\Cron\Job\Collection\OrderedJobEntities:

Collaboration diagram for ILIAS\Cron\Job\Collection\OrderedJobEntities:

Public Member Functions
	__construct (private readonly \ILIAS\Cron\Job\JobCollection $origin, mixed $sort, bool $reverse_order=false)

	getIterator ()

	count ()

	add (\ILIAS\Cron\Job\JobEntity $job)

	filter (callable $callable)
	Returns all the elements of this collection that satisfy the predicate $callable. More...

	slice (int $offset, ?int $length=null)
	Extracts a slice of $length elements starting at position $offset from the Collection. More...

	toArray ()

	add (\ILIAS\Cron\Job\JobEntity $job)

	filter (callable $callable)
	Returns all the elements of this collection that satisfy the predicate $callable. More...

	slice (int $offset, ?int $length=null)
	Extracts a slice of $length elements starting at position $offset from the Collection. More...

	toArray ()

Data Fields
final const int	ORDER_BY_NONE = 0

final const int	ORDER_BY_NAME = 1

final const int	ORDER_BY_STATUS = 2

final const int	ORDER_AS_PROVIDED = 1

final const int	ORDER_REVERSE = -1

Private Member Functions
	getSortedJobs ()

Private Attributes
mixed	$sort

array	$sorted_jobs = null

Detailed Description

Definition at line 23 of file OrderedJobEntities.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Cron\Job\Collection\OrderedJobEntities::__construct	(	private readonly \ILIAS\Cron\Job\JobCollection	$origin,
		mixed	$sort,
		bool	$reverse_order = `false`
	)

Parameters

int|callable(

ILIAS\Cron\Job\JobEntity, \ILIAS\Cron\Job\JobEntity): int|\Closure(\ILIAS\Cron\Job\JobEntity, \ILIAS\Cron\Job\JobEntity): int $sort

Definition at line 42 of file OrderedJobEntities.php.

      {
        $order = $reverse_order ? self::ORDER_REVERSE : self::ORDER_AS_PROVIDED;
 
        if ($sort === self::ORDER_BY_NAME) {
            $this->sort = static function (\ILIAS\Cron\Job\JobEntity $left, \ILIAS\Cron\Job\JobEntity $right) use (
                $order
            ): int {
                return $order * \ilStr::strCmp($left->getEffectiveTitle(), $right->getEffectiveTitle());
            };
        } elseif ($sort === self::ORDER_BY_STATUS) {
            $this->sort = static function (\ILIAS\Cron\Job\JobEntity $left, \ILIAS\Cron\Job\JobEntity $right) use (
                $order
            ): int {
                return $order * ($right->getJobStatus() <=> $left->getJobStatus());
            };
        } elseif ($sort === self::ORDER_BY_NONE) {
            $this->sort = $order;
        } elseif (\is_callable($sort)) {
            $this->sort = $sort;
            if ($reverse_order) {
                $this->sort = static fn(
                    \ILIAS\Cron\Job\JobEntity $left,
                    \ILIAS\Cron\Job\JobEntity $right
                ): int => -$sort($left, $right);
            }
        } else {
            throw new \InvalidArgumentException(
                'The SortableIterator takes a PHP callable or a valid built-in sort algorithm as an argument.'
            );
        }
    }

References ILIAS\Cron\Job\Collection\OrderedJobEntities\$sort, ILIAS\Cron\Job\Collection\OrderedJobEntities\ORDER_AS_PROVIDED, ILIAS\Cron\Job\Collection\OrderedJobEntities\ORDER_REVERSE, ILIAS\UI\examples\Symbol\Glyph\Sort\sort(), and ilStr\strCmp().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ILIAS\Cron\Job\Collection\OrderedJobEntities::add ( \ILIAS\Cron\Job\JobEntity $job )

Implements ILIAS\Cron\Job\JobCollection.

Definition at line 91 of file OrderedJobEntities.php.

                                                       : void
    {
        $this->origin->add($job);
        $this->sorted_jobs = null;
    }

◆ count()

ILIAS\Cron\Job\Collection\OrderedJobEntities::count ( )

Definition at line 86 of file OrderedJobEntities.php.

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

◆ filter()

ILIAS\Cron\Job\Collection\OrderedJobEntities::filter ( callable $callable )

Returns all the elements of this collection that satisfy the predicate $callable.

Parameters

callable(

ILIAS\Cron\Job\JobEntity): bool $callable

Returns: static

Implements ILIAS\Cron\Job\JobCollection.

Definition at line 97 of file OrderedJobEntities.php.

                                              : static
    {
        return new static(
            $this->origin->filter($callable),
            $this->sort
        );
    }

References ILIAS\Cron\Job\Collection\OrderedJobEntities\$sort.

◆ getIterator()

ILIAS\Cron\Job\Collection\OrderedJobEntities::getIterator ( )

Returns: \ArrayIterator<int, \ILIAS\Cron\Job\JobEntity>

Definition at line 81 of file OrderedJobEntities.php.

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

References ILIAS\Cron\Job\Collection\OrderedJobEntities\getSortedJobs().

Here is the call graph for this function:

◆ getSortedJobs()

ILIAS\Cron\Job\Collection\OrderedJobEntities::getSortedJobs ( )

private

Returns: list<\ILIAS\Cron\Job\JobEntity>

Definition at line 121 of file OrderedJobEntities.php.

                                    : array
    {
        if ($this->sorted_jobs === null) {
            $list = iterator_to_array($this->origin->toArray(), false);
            if ($this->sort !== self::ORDER_AS_PROVIDED) {
                if ($this->sort === self::ORDER_REVERSE) {
                    $list = array_reverse($list);
                } else {
                    uasort($list, $this->sort);
                }
            }
            $this->sorted_jobs = $list;
        }
 
        return $this->sorted_jobs;
    }

References ILIAS\Cron\Job\Collection\OrderedJobEntities\$sorted_jobs, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ILIAS\Cron\Job\Collection\OrderedJobEntities\getIterator(), ILIAS\Cron\Job\Collection\OrderedJobEntities\slice(), and ILIAS\Cron\Job\Collection\OrderedJobEntities\toArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slice()

ILIAS\Cron\Job\Collection\OrderedJobEntities::slice	(	int	$offset,
		?int	$length = `null`
	)

Extracts a slice of $length elements starting at position $offset from the Collection.

If $length is null it returns all elements from $offset to the end of the Collection. Calling this method will only return the selected slice and NOT change the elements contained in the collection slice is called on.

Parameters

int	$offset	The offset to start from.
int \| null	$length	The maximum number of elements to return, or null for no limit.

Returns: static

Implements ILIAS\Cron\Job\JobCollection.

Definition at line 105 of file OrderedJobEntities.php.

                                                           : static
    {
        return new static(
            new JobEntities(...\array_slice($this->getSortedJobs(), $offset, $length)),
            $this->sort
        );
    }

References ILIAS\Cron\Job\Collection\OrderedJobEntities\$sort, and ILIAS\Cron\Job\Collection\OrderedJobEntities\getSortedJobs().

Here is the call graph for this function:

◆ toArray()

ILIAS\Cron\Job\Collection\OrderedJobEntities::toArray ( )

Returns: list<\ILIAS\Cron\Job\JobEntity>

Implements ILIAS\Cron\Job\JobCollection.

Definition at line 113 of file OrderedJobEntities.php.

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

References ILIAS\Cron\Job\Collection\OrderedJobEntities\getSortedJobs().

Here is the call graph for this function:

Field Documentation

◆ $sort

mixed ILIAS\Cron\Job\Collection\OrderedJobEntities::$sort

private

Definition at line 33 of file OrderedJobEntities.php.

Referenced by ILIAS\Cron\Job\Collection\OrderedJobEntities\__construct(), ILIAS\Cron\Job\Collection\OrderedJobEntities\filter(), and ILIAS\Cron\Job\Collection\OrderedJobEntities\slice().

◆ $sorted_jobs

array ILIAS\Cron\Job\Collection\OrderedJobEntities::$sorted_jobs = null

private

Definition at line 37 of file OrderedJobEntities.php.

Referenced by ILIAS\Cron\Job\Collection\OrderedJobEntities\getSortedJobs().

◆ ORDER_AS_PROVIDED

final const int ILIAS\Cron\Job\Collection\OrderedJobEntities::ORDER_AS_PROVIDED = 1

Definition at line 29 of file OrderedJobEntities.php.

Referenced by ILIAS\Cron\Job\Collection\OrderedJobEntities\__construct().

◆ ORDER_BY_NAME

final const int ILIAS\Cron\Job\Collection\OrderedJobEntities::ORDER_BY_NAME = 1

Definition at line 26 of file OrderedJobEntities.php.

◆ ORDER_BY_NONE

final const int ILIAS\Cron\Job\Collection\OrderedJobEntities::ORDER_BY_NONE = 0

Definition at line 25 of file OrderedJobEntities.php.

◆ ORDER_BY_STATUS

final const int ILIAS\Cron\Job\Collection\OrderedJobEntities::ORDER_BY_STATUS = 2

Definition at line 27 of file OrderedJobEntities.php.

◆ ORDER_REVERSE

final const int ILIAS\Cron\Job\Collection\OrderedJobEntities::ORDER_REVERSE = -1

Definition at line 30 of file OrderedJobEntities.php.

Referenced by ILIAS\Cron\Job\Collection\OrderedJobEntities\__construct().

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

components/ILIAS/Cron/src/Job/Collection/OrderedJobEntities.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ count()

◆ filter()

◆ getIterator()

◆ getSortedJobs()

◆ slice()

◆ toArray()

Field Documentation

◆ $sort

◆ $sorted_jobs

◆ ORDER_AS_PROVIDED

◆ ORDER_BY_NAME

◆ ORDER_BY_NONE

◆ ORDER_BY_STATUS

◆ ORDER_REVERSE