Inheritance diagram for ILIAS\Export\ImportStatus\ilCollection:

Collaboration diagram for ILIAS\Export\ImportStatus\ilCollection:

Public Member Functions
	__construct (ilImportStatusFactoryInterface $status,)

	hasStatusType (StatusType $type)

	withAddedStatus (ilHandlerInterface $import_status)

	getCollectionOfAllByType (StatusType $type)

	getMergedCollectionWith (ilCollectionInterface $other)

	current ()

	next ()

	key ()

	valid ()

	rewind ()

	count ()

	toArray ()

	withNumberingEnabled (bool $enabled)

	toString (StatusType ... $types)

	mergeContentToElements (ilImportStatusContentHandlerInterface $content, bool $at_front=true)

Public Member Functions inherited from ILIAS\Export\ImportStatus\I\ilCollectionInterface
	hasStatusType (StatusType $type)

	withAddedStatus (ilImportStatusHandlerInterface $import_status)

	getCollectionOfAllByType (StatusType $type)

	toString (StatusType ... $types)

Protected Member Functions
	getArrayOfElementsWithType (StatusType $type)

Protected Attributes
ilImportStatusFactoryInterface	$status

array	$elements

int	$index

int	$minIndex

bool	$is_numbering_enabled

Detailed Description

Definition at line 28 of file class.ilCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Export\ImportStatus\ilCollection::__construct ( ilImportStatusFactoryInterface $status )

Definition at line 39 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\$minIndex, and ILIAS\Export\ImportStatus\ilCollection\$status.

       {
         $this->elements = [];
         $this->minIndex = 0;
         $this->index = $this->minIndex;
         $this->is_numbering_enabled = false;
         $this->status = $status;
     }

Member Function Documentation

◆ count()

ILIAS\Export\ImportStatus\ilCollection::count ( )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 113 of file class.ilCollection.php.

Referenced by ILIAS\Export\ImportStatus\ilCollection\hasStatusType(), ILIAS\Export\ImportStatus\ilCollection\toString(), and ILIAS\Export\ImportStatus\ilCollection\valid().

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

Here is the caller graph for this function:

◆ current()

ILIAS\Export\ImportStatus\ilCollection::current ( )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 88 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\$index.

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

◆ getArrayOfElementsWithType()

ILIAS\Export\ImportStatus\ilCollection::getArrayOfElementsWithType ( StatusType $type )

protected

Returns: ilHandlerInterface[]

Definition at line 52 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilHandler\getType(), and ILIAS\Export\ImportStatus\ilCollection\toArray().

Referenced by ILIAS\Export\ImportStatus\ilCollection\getCollectionOfAllByType(), and ILIAS\Export\ImportStatus\ilCollection\hasStatusType().

                                                                    : array
     {
         return array_filter(
             $this->toArray(),
             function (ilHandler $s) use ($type) {
                 return $s->getType() === $type;
             }
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCollectionOfAllByType()

ILIAS\Export\ImportStatus\ilCollection::getCollectionOfAllByType ( StatusType $type )

Definition at line 74 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\getArrayOfElementsWithType().

Referenced by ILIAS\Export\ImportStatus\ilCollection\toString().

                                                               : ilCollectionInterface
     {
         $clone = clone $this;
         $clone->elements = $this->getArrayOfElementsWithType($type);
         return $clone;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMergedCollectionWith()

ILIAS\Export\ImportStatus\ilCollection::getMergedCollectionWith ( ilCollectionInterface $other )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 81 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\I\ilCollectionInterface\toArray(), and ILIAS\Export\ImportStatus\ilCollection\toArray().

                                                                          : ilCollectionInterface
     {
         $clone = clone $this;
         $clone->elements = array_merge($this->toArray(), $other->toArray());
         return $clone;
     }

Here is the call graph for this function:

◆ hasStatusType()

ILIAS\Export\ImportStatus\ilCollection::hasStatusType ( StatusType $type )

Definition at line 62 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\count(), and ILIAS\Export\ImportStatus\ilCollection\getArrayOfElementsWithType().

                                                    : bool
     {
         return count($this->getArrayOfElementsWithType($type)) > 0;
     }

Here is the call graph for this function:

◆ key()

ILIAS\Export\ImportStatus\ilCollection::key ( )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 98 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\$index.

                          : int
     {
         return $this->index;
     }

◆ mergeContentToElements()

ILIAS\Export\ImportStatus\ilCollection::mergeContentToElements	(	ilImportStatusContentHandlerInterface	$content,
		bool	$at_front = `true`
	)

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 154 of file class.ilCollection.php.

      : ilCollectionInterface {
         $clone = clone $this;
         $new_elements = [];
         foreach ($clone->toArray() as $element) {
             $new_elements[] = $at_front
                 ? $this->status->handler()
                     ->withType($element->getType())
                     ->withContent($content->mergeWith($element->getContent()))
                 : $this->status->handler()
                     ->withType($element->getType())
                     ->withContent($element->getContent()->mergeWith($content));
         }
         $clone->elements = $new_elements;
         return $clone;
     }

◆ next()

ILIAS\Export\ImportStatus\ilCollection::next ( )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 93 of file class.ilCollection.php.

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

◆ rewind()

ILIAS\Export\ImportStatus\ilCollection::rewind ( )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 108 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\$minIndex.

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

◆ toArray()

ILIAS\Export\ImportStatus\ilCollection::toArray ( )

Returns: ilHandlerInterface[]

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 121 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\$elements.

Referenced by ILIAS\Export\ImportStatus\ilCollection\getArrayOfElementsWithType(), and ILIAS\Export\ImportStatus\ilCollection\getMergedCollectionWith().

                              : array
     {
         return $this->elements;
     }

Here is the caller graph for this function:

◆ toString()

ILIAS\Export\ImportStatus\ilCollection::toString ( StatusType ... $types )

Definition at line 133 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\count(), and ILIAS\Export\ImportStatus\ilCollection\getCollectionOfAllByType().

                                                   : string
     {
         $collection = $this->status->collection();
         $msg = "<br>Listing status messages (of type(s)";
         foreach ($types as $type) {
             $msg .= " " . $type->name;
             $collection = $collection->getMergedCollectionWith($this->getCollectionOfAllByType($type));
         }
         $msg .= "):<br>";
         $elements = $collection->toArray();
         for($i = 0; $i < count($elements); $i++) {
             $faied_status = $elements[$i];
             $msg .= "<br>";
             $msg .= $this->is_numbering_enabled
                 ? '[' . $i . ']: '
                 : '';
             $msg .= $faied_status->getContent()->toString();
         }
         return $msg;
     }

Here is the call graph for this function:

◆ valid()

ILIAS\Export\ImportStatus\ilCollection::valid ( )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 103 of file class.ilCollection.php.

References ILIAS\Export\ImportStatus\ilCollection\count().

                            : bool
     {
         return $this->minIndex <= $this->index && $this->index < $this->count();
     }

Here is the call graph for this function:

◆ withAddedStatus()

ILIAS\Export\ImportStatus\ilCollection::withAddedStatus ( ilHandlerInterface $import_status )

Definition at line 67 of file class.ilCollection.php.

                                                                       : ilCollection
     {
         $clone = clone $this;
         $clone->elements[] = $import_status;
         return $clone;
     }

◆ withNumberingEnabled()

ILIAS\Export\ImportStatus\ilCollection::withNumberingEnabled ( bool $enabled )

Implements ILIAS\Export\ImportStatus\I\ilCollectionInterface.

Definition at line 126 of file class.ilCollection.php.

                                                        : ilCollectionInterface
     {
         $clone = clone $this;
         $clone->is_numbering_enabled = $enabled;
         return $clone;
     }

Field Documentation

◆ $elements

array ILIAS\Export\ImportStatus\ilCollection::$elements

protected

Definition at line 34 of file class.ilCollection.php.

Referenced by ILIAS\Export\ImportStatus\ilCollection\toArray().

◆ $index

int ILIAS\Export\ImportStatus\ilCollection::$index

protected

Definition at line 35 of file class.ilCollection.php.

Referenced by ILIAS\Export\ImportStatus\ilCollection\current(), and ILIAS\Export\ImportStatus\ilCollection\key().

◆ $is_numbering_enabled

bool ILIAS\Export\ImportStatus\ilCollection::$is_numbering_enabled

protected

Definition at line 37 of file class.ilCollection.php.

◆ $minIndex

int ILIAS\Export\ImportStatus\ilCollection::$minIndex

protected

Definition at line 36 of file class.ilCollection.php.

Referenced by ILIAS\Export\ImportStatus\ilCollection\__construct(), and ILIAS\Export\ImportStatus\ilCollection\rewind().

◆ $status

ilImportStatusFactoryInterface ILIAS\Export\ImportStatus\ilCollection::$status

protected

Definition at line 30 of file class.ilCollection.php.

Referenced by ILIAS\Export\ImportStatus\ilCollection\__construct().

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

components/ILIAS/Export/classes/ImportStatus/class.ilCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ count()

◆ current()

◆ getArrayOfElementsWithType()

◆ getCollectionOfAllByType()

◆ getMergedCollectionWith()

◆ hasStatusType()

◆ key()

◆ mergeContentToElements()

◆ next()

◆ rewind()

◆ toArray()

◆ toString()

◆ valid()

◆ withAddedStatus()

◆ withNumberingEnabled()

Field Documentation

◆ $elements

◆ $index

◆ $is_numbering_enabled

◆ $minIndex

◆ $status