ILIAS\Tracking\Status\Collection Class Reference

Inheritance diagram for ILIAS\Tracking\Status\Collection:

Collaboration diagram for ILIAS\Tracking\Status\Collection:

Public Member Functions
	__construct (protected FactoryInterface $factory, LPStatusInterface ... $elements)
	getElementsByStatusIds (string ... $lp_status_ids)
	getElementByStatusId (string $lp_status_id)
	current ()
	key ()
	next ()
	valid ()
	rewind ()
	count ()
	getElementsByStatusIds (string ... $lp_status_ids)
	getElementByStatusId (string $lp_status_id)
	current ()
	key ()

Protected Attributes
array	$elements
int	$index

Detailed Description

Definition at line 23 of file Collection.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Tracking\Status\Collection::__construct	(	protected FactoryInterface	$factory,
		LPStatusInterface ...	$elements
	)

Definition at line 29 of file Collection.php.

      {
        $this->elements = $elements;
        $this->index = 0;
    }

References ILIAS\Tracking\Status\Collection\$elements.

Member Function Documentation

count()

ILIAS\Tracking\Status\Collection::count

(

)

Definition at line 87 of file Collection.php.

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

current()

ILIAS\Tracking\Status\Collection::current

(

)

Implements ILIAS\Tracking\Status\CollectionInterface.

Definition at line 62 of file Collection.php.

                             : LPStatusInterface
    {
        return $this->elements[$this->index];
    }

getElementByStatusId()

ILIAS\Tracking\Status\Collection::getElementByStatusId

(

string

$lp_status_id

)

Implements ILIAS\Tracking\Status\CollectionInterface.

Definition at line 51 of file Collection.php.

     : LPStatusInterface|null {
        foreach ($this->elements as $element) {
            if ($element->getLPStatusId() === $lp_status_id) {
                return $element;
            }
        }
        return null;
    }

Referenced by ILIAS\Tracking\Status\Collection\getElementsByStatusIds().

Here is the caller graph for this function:

getElementsByStatusIds()

ILIAS\Tracking\Status\Collection::getElementsByStatusIds

(

string ...

$lp_status_ids

)

Implements ILIAS\Tracking\Status\CollectionInterface.

Definition at line 37 of file Collection.php.

     : CollectionInterface {
        $elements = [];
        foreach ($lp_status_ids as $lp_status_id) {
            $element = $this->getElementByStatusId($lp_status_id);
            if (is_null($element)) {
                continue;
            }
            $elements[] = $element;
        }
        return $this->factory->collection(...$elements);
    }

References ILIAS\Tracking\Status\Collection\$elements, and ILIAS\Tracking\Status\Collection\getElementByStatusId().

Here is the call graph for this function:

key()

ILIAS\Tracking\Status\Collection::key

(

)

Implements ILIAS\Tracking\Status\CollectionInterface.

Definition at line 67 of file Collection.php.

                         : int
    {
        return $this->index;
    }

next()

ILIAS\Tracking\Status\Collection::next

(

)

Definition at line 72 of file Collection.php.

                          : void
    {
        $this->index++;
    }

rewind()

ILIAS\Tracking\Status\Collection::rewind

(

)

Definition at line 82 of file Collection.php.

                            : void
    {
        $this->index = 0;
    }

valid()

ILIAS\Tracking\Status\Collection::valid

(

)

Definition at line 77 of file Collection.php.

                           : bool
    {
        return isset($this->elements[$this->index]);
    }

Field Documentation

$elements

array ILIAS\Tracking\Status\Collection::$elements

protected

Definition at line 26 of file Collection.php.

Referenced by ILIAS\Tracking\Status\Collection\__construct(), and ILIAS\Tracking\Status\Collection\getElementsByStatusIds().

$index

int ILIAS\Tracking\Status\Collection::$index

protected

Definition at line 27 of file Collection.php.

---

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

• components/ILIAS/Tracking/classes/status/Collection.php