Class ilTermsOfServiceAppEventListener. More...

Inheritance diagram for ilTermsOfServiceAppEventListener:

Collaboration diagram for ilTermsOfServiceAppEventListener:

Public Member Functions
	__construct (ilTermsOfServiceHelper $helper)
	ilTermsOfServiceAppEventListener constructor. More...

	withComponent (string $component)

	withEvent (string $event)

	withParameters (array $parameters)

	handle ()

Static Public Member Functions

static handleEvent ($a_component, $a_event, $a_parameter)

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "Modules/Forum" or "Services/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
array	$a_parameter	parameter array (assoc), array("name" => ..., "phone_office" => ...)

More...

static handleEvent ($a_component, $a_event, $a_parameter)

Handle an event in a listener. More...

Protected Member Functions
	isUserDeletionEvent ()

Protected Attributes
	$helper

	$component = ''

	$event = ''

	$parameters = []

Detailed Description

Class ilTermsOfServiceAppEventListener.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 8 of file class.ilTermsOfServiceAppEventListener.php.

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceAppEventListener::__construct ( ilTermsOfServiceHelper $helper )

ilTermsOfServiceAppEventListener constructor.

Parameters

ilTermsOfServiceHelper $helper

Reimplemented in ilTestableTermsOfServiceAppEventListener.

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

    {
        $this->helper = $helper;
    }

References $helper.

Member Function Documentation

◆ handle()

ilTermsOfServiceAppEventListener::handle ( )

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

Definition at line 84 of file class.ilTermsOfServiceAppEventListener.php.

                             : void
    {
        if ($this->isUserDeletionEvent()) {
            $this->helper->deleteAcceptanceHistoryByUser($this->parameters['usr_id']);
        }
    }

References isUserDeletionEvent().

Here is the call graph for this function:

◆ handleEvent()

static ilTermsOfServiceAppEventListener::handleEvent	(	$a_component,
		$a_event,
		$a_parameter
	)

static

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "Modules/Forum" or "Services/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
array	$a_parameter	parameter array (assoc), array("name" => ..., "phone_office" => ...)

Implements ilAppEventListener.

Definition at line 94 of file class.ilTermsOfServiceAppEventListener.php.

                                                                             : void
    {
        $listener = new static(new ilTermsOfServiceHelper());
        $listener
            ->withComponent($a_component)
            ->withEvent($a_event)
            ->withParameters($a_parameter)
            ->handle();
    }

Referenced by ilTermsOfServiceAppEventListenerTest\testStaticEventListeningWorksAsExpected().

Here is the caller graph for this function:

◆ isUserDeletionEvent()

ilTermsOfServiceAppEventListener::isUserDeletionEvent ( )

protected

Returns: bool

Definition at line 73 of file class.ilTermsOfServiceAppEventListener.php.

                                             : bool
    {
        return (
            'Services/User' === $this->component &&
            'deleteUser' === $this->event
        );
    }

Referenced by handle().

Here is the caller graph for this function:

◆ withComponent()

ilTermsOfServiceAppEventListener::withComponent ( string $component )

Parameters

string $component

Returns: ilTermsOfServiceAppEventListener

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

                                                     : self
    {
        $clone = clone $this;
 
        $clone->component = $component;
 
        return $clone;
    }

References $component.

◆ withEvent()

ilTermsOfServiceAppEventListener::withEvent ( string $event )

Parameters

string $event

Returns: ilTermsOfServiceAppEventListener

Definition at line 48 of file class.ilTermsOfServiceAppEventListener.php.

                                             : self
    {
        $clone = clone $this;
 
        $clone->event = $event;
 
        return $clone;
    }

References $event.

◆ withParameters()

ilTermsOfServiceAppEventListener::withParameters ( array $parameters )

Parameters

array $parameters

Returns: ilTermsOfServiceAppEventListener

Definition at line 61 of file class.ilTermsOfServiceAppEventListener.php.

                                                      : self
    {
        $clone = clone $this;
 
        $clone->parameters = $parameters;
 
        return $clone;
    }