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...

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

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

References $helper.

     {
         $this->helper = $helper;
     }

Member Function Documentation

◆ handle()

ilTermsOfServiceAppEventListener::handle ( )

Exceptions

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

References isUserDeletionEvent().

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

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.

Referenced by ilTermsOfServiceAppEventListenerTest\testStaticEventListeningWorksAsExpected().

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

Here is the caller graph for this function:

◆ isUserDeletionEvent()

ilTermsOfServiceAppEventListener::isUserDeletionEvent ( )

protected

Returns: bool

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

Referenced by handle().

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

Here is the caller graph for this function:

◆ withComponent()

ilTermsOfServiceAppEventListener::withComponent ( string $component )

Parameters

string $component

Returns

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

References $component.

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

◆ withEvent()

ilTermsOfServiceAppEventListener::withEvent ( string $event )

Parameters

string $event

Returns

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

References $event.

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

◆ withParameters()

ilTermsOfServiceAppEventListener::withParameters ( array $parameters )

Parameters

array $parameters

Returns

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

References $parameters.

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