ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities Class Reference

Inheritance diagram for ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities:

Collaboration diagram for ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities:

Public Member Functions
	__construct (\ILIAS\Cron\Job\JobEntity ... $jobs)
	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 ()

Private Attributes
ArrayIterator	$jobs

Detailed Description

Definition at line 23 of file JobEntities.php.

Constructor & Destructor Documentation

__construct()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::__construct

(

\ILIAS\Cron\Job\JobEntity ...

$jobs

)

Definition at line 30 of file JobEntities.php.

    {
        $this->jobs = new \ArrayIterator(array_values($jobs));
    }

Member Function Documentation

add()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::add

(

\ILIAS\Cron\Job\JobEntity

$job

)

Implements ILIAS\BackgroundTasks\Task\Job\JobCollection.

Definition at line 48 of file JobEntities.php.

                                                       : void
    {
        $this->jobs->append($job);
    }

count()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::count

(

)

Definition at line 43 of file JobEntities.php.

                           : int
    {
        return iterator_count($this);
    }

filter()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::filter

(

callable

$callable

)

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

Parameters

callable(

Implements ILIAS\BackgroundTasks\Task\Job\JobCollection.

Definition at line 53 of file JobEntities.php.

                                              : static
    {
        return new static(...array_values(array_filter(iterator_to_array($this), $callable)));
    }

getIterator()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::getIterator

(

)

Returns

<int, >

Definition at line 38 of file JobEntities.php.

References ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities\$jobs.

                                 : \ArrayIterator
    {
        return $this->jobs;
    }

slice()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::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\BackgroundTasks\Task\Job\JobCollection.

Definition at line 58 of file JobEntities.php.

                                                           : static
    {
        return new static(...\array_slice(iterator_to_array($this), $offset, $length, true));
    }

toArray()

ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities::toArray

(

)

Returns

list<>

Implements ILIAS\BackgroundTasks\Task\Job\JobCollection.

Definition at line 66 of file JobEntities.php.

                             : array
    {
        return iterator_to_array($this);
    }

Field Documentation

$jobs

ArrayIterator ILIAS\BackgroundTasks\Task\Job::Collection\JobEntities::$jobs

private

Definition at line 28 of file JobEntities.php.

Referenced by ILIAS\BackgroundTasks\Task\Job\Collection\JobEntities\getIterator().

---

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

• components/ILIAS/Cron/src/Job/Collection/JobEntities.php