ilCtrlSubject Class Reference

Collaboration diagram for ilCtrlSubject:

Public Member Functions
	__construct ()
	attach (ilCtrlObserver $observer, ilCtrlEvent $event)
	detach (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)
	notify (ilCtrlEvent $event, ?string $data)

Protected Member Functions
	initObserverGroup (string $group)

Protected Attributes
array	$observer_groups = []

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns AutoloadingIssuesInspection

Definition at line 26 of file class.ilCtrlSubject.php.

Constructor & Destructor Documentation

__construct()

ilCtrlSubject::__construct

(

)

Definition at line 33 of file class.ilCtrlSubject.php.

References ALL, and initObserverGroup().

    {
        $this->initObserverGroup((ilCtrlEvent::ALL)->value);
    }

Here is the call graph for this function:

Member Function Documentation

attach()

ilCtrlSubject::attach	(	ilCtrlObserver	$observer,
		ilCtrlEvent	$event
	)

Definition at line 38 of file class.ilCtrlSubject.php.

References initObserverGroup().

                                                                        : void
    {
        $this->initObserverGroup($event->value);

        $this->observer_groups[$event->value][] = $observer;
    }

Here is the call graph for this function:

detach()

ilCtrlSubject::detach	(	ilCtrlObserver	$observer,
		ilCtrlEvent	$event = ilCtrlEvent::ALL
	)

Definition at line 45 of file class.ilCtrlSubject.php.

References ilCtrlObserver\getId(), and initObserverGroup().

                                                                                         : void
    {
        $this->initObserverGroup($event->value);

        foreach ($this->observer_groups[$event->value] as $index => $attached_observer) {
            if ($attached_observer->getId() === $observer->getId()) {
                unset($this->observer_groups[$event->value][$index]);
            }
        }
    }

Here is the call graph for this function:

initObserverGroup()

ilCtrlSubject::initObserverGroup ( string  $group )

protected

Definition at line 70 of file class.ilCtrlSubject.php.

Referenced by __construct(), attach(), detach(), and notify().

                                                       : void
    {
        if (!isset($this->observer_groups[$group])) {
            $this->observer_groups[$group] = [];
        }
    }

Here is the caller graph for this function:

notify()

ilCtrlSubject::notify	(	ilCtrlEvent	$event,
		?string	$data
	)

Definition at line 56 of file class.ilCtrlSubject.php.

References ALL, and initObserverGroup().

                                                             : void
    {
        $this->initObserverGroup($event->value);

        $observers = array_merge(
            $this->observer_groups[(ilCtrlEvent::ALL)->value],
            $this->observer_groups[$event->value],
        );

        foreach ($observers as $interessted_observer) {
            $interessted_observer->update($event, $data);
        }
    }

Here is the call graph for this function:

Field Documentation

$observer_groups

array ilCtrlSubject::$observer_groups = []

protected

Definition at line 31 of file class.ilCtrlSubject.php.

---

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

• components/ILIAS/UICore/classes/Events/class.ilCtrlSubject.php