ILIAS\Awareness\User\Collector\AbstractBaseCollector Class Reference

Class AbstractBaseCollector. More...

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

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

Public Member Functions
	hasBeenCollected ()
	collectOnce ()
	Runs the Collection of all items from the providers. More...
	collectStructure ()
	prepareItemsForUIRepresentation ()
	filterItemsByVisibilty ()
	cleanupItemsForUIRepresentation ()
	sortItemsForUIRepresentation ()

Private Member Functions
	setCollected ()

Private Attributes
bool	$has_been_collected = false

Detailed Description

Class AbstractBaseCollector.

Author

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

Definition at line 27 of file AbstractBaseCollector.php.

Member Function Documentation

cleanupItemsForUIRepresentation()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::cleanupItemsForUIRepresentation

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 65 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                                     : void
    {
    }

Here is the caller graph for this function:

collectOnce()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::collectOnce

(

)

Runs the Collection of all items from the providers.

Deprecated:

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 41 of file AbstractBaseCollector.php.

References ILIAS\Awareness\User\Collector\AbstractBaseCollector\cleanupItemsForUIRepresentation(), ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectStructure(), ILIAS\Awareness\User\Collector\AbstractBaseCollector\filterItemsByVisibilty(), ILIAS\Awareness\User\Collector\AbstractBaseCollector\hasBeenCollected(), ILIAS\Awareness\User\Collector\AbstractBaseCollector\prepareItemsForUIRepresentation(), ILIAS\Awareness\User\Collector\AbstractBaseCollector\setCollected(), and ILIAS\Awareness\User\Collector\AbstractBaseCollector\sortItemsForUIRepresentation().

Referenced by ILIAS\GlobalScreen\Scope\Toast\Collector\ToastCollector\__construct(), ILIAS\GlobalScreen\UI\Footer\Entries\EntriesRepositoryDB\__construct(), ILIAS\GlobalScreen\Scope\Notification\Collector\MainNotificationCollector\__construct(), ILIAS\GlobalScreen\Scope\Layout\Collector\MainLayoutCollector\getFinalPage(), and ILIAS\GlobalScreen\UI\Footer\Groups\GroupsRepositoryDB\syncWithGlobalScreen().

                                 : void
    {
        if (!$this->hasBeenCollected()) {
            $this->collectStructure();
            $this->prepareItemsForUIRepresentation();
            $this->filterItemsByVisibilty();
            $this->cleanupItemsForUIRepresentation();
            $this->sortItemsForUIRepresentation();
            $this->setCollected();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

collectStructure()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::collectStructure

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 53 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                      : void
    {
    }

Here is the caller graph for this function:

filterItemsByVisibilty()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::filterItemsByVisibilty

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 61 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                            : void
    {
    }

Here is the caller graph for this function:

hasBeenCollected()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::hasBeenCollected

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 36 of file AbstractBaseCollector.php.

References ILIAS\Awareness\User\Collector\AbstractBaseCollector\$has_been_collected.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                      : bool
    {
        return $this->has_been_collected;
    }

Here is the caller graph for this function:

prepareItemsForUIRepresentation()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::prepareItemsForUIRepresentation

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 57 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                                     : void
    {
    }

Here is the caller graph for this function:

setCollected()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::setCollected ( )

private

Definition at line 31 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                   : void
    {
        $this->has_been_collected = true;
    }

Here is the caller graph for this function:

sortItemsForUIRepresentation()

ILIAS\Awareness\User\Collector\AbstractBaseCollector::sortItemsForUIRepresentation

(

)

Implements ILIAS\Awareness\User\Collector\Collector.

Definition at line 69 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\collectOnce().

                                                  : void
    {
    }

Here is the caller graph for this function:

Field Documentation

$has_been_collected

bool ILIAS\Awareness\User\Collector\AbstractBaseCollector::$has_been_collected = false

private

Definition at line 29 of file AbstractBaseCollector.php.

Referenced by ILIAS\Awareness\User\Collector\AbstractBaseCollector\hasBeenCollected().

---

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

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