ILIAS\Awareness\User\Collector\ItemCollector Interface Reference

Interface Collector. More...

Inheritance diagram for ILIAS\Awareness\User\Collector\ItemCollector:

Collaboration diagram for ILIAS\Awareness\User\Collector\ItemCollector:

Public Member Functions
	collectStructure ()
	filterItemsByVisibilty (bool $async_only=false)
	prepareItemsForUIRepresentation ()
	getItemsForUIRepresentation ()
	hasItems ()
	hasVisibleItems ()
Public Member Functions inherited from ILIAS\Awareness\User\Collector\Collector
	collectOnce ()
	Runs the Collection of all items from the providers. More...
	hasBeenCollected ()
	filterItemsByVisibilty ()
	cleanupItemsForUIRepresentation ()
	sortItemsForUIRepresentation ()

Detailed Description

Interface Collector.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 29 of file ItemCollector.php.

Member Function Documentation

collectStructure()

ILIAS\Awareness\User\Collector\ItemCollector::collectStructure

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Implemented in ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector, ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector, ILIAS\GlobalScreen\Scope\Tool\Collector\MainToolCollector, ILIAS\GlobalScreen\Scope\MetaBar\Collector\MetaBarMainCollector, and ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector.

filterItemsByVisibilty()

ILIAS\Awareness\User\Collector\ItemCollector::filterItemsByVisibilty

(

bool

$async_only = false

)

Implemented in ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector, ILIAS\GlobalScreen\Scope\Tool\Collector\MainToolCollector, ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector, ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector, and ILIAS\GlobalScreen\Scope\MetaBar\Collector\MetaBarMainCollector.

getItemsForUIRepresentation()

ILIAS\Awareness\User\Collector\ItemCollector::getItemsForUIRepresentation

(

)

Returns

Generator

Implemented in ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector, ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector, ILIAS\GlobalScreen\Scope\Tool\Collector\MainToolCollector, ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector, and ILIAS\GlobalScreen\Scope\MetaBar\Collector\MetaBarMainCollector.

hasItems()

ILIAS\Awareness\User\Collector\ItemCollector::hasItems

(

)

Returns

bool

Exceptions

LogicException

if collectOnce() has not been run first

Implemented in ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector, ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector, ILIAS\GlobalScreen\Scope\Tool\Collector\MainToolCollector, ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector, and ILIAS\GlobalScreen\Scope\MetaBar\Collector\MetaBarMainCollector.

hasVisibleItems()

ILIAS\Awareness\User\Collector\ItemCollector::hasVisibleItems

(

)

Implemented in ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector, ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector, ILIAS\GlobalScreen\Scope\Tool\Collector\MainToolCollector, ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector, and ILIAS\GlobalScreen\Scope\MetaBar\Collector\MetaBarMainCollector.

prepareItemsForUIRepresentation()

ILIAS\Awareness\User\Collector\ItemCollector::prepareItemsForUIRepresentation

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Implemented in ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector, ILIAS\GlobalScreen\Scope\Tool\Collector\MainToolCollector, ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector, ILIAS\GlobalScreen\Scope\MetaBar\Collector\MetaBarMainCollector, and ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector.

---

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

• components/ILIAS/GlobalScreen/src/Collector/ItemCollector.php