ilEventHandlingDefinitionProcessor Class Reference

Inheritance diagram for ilEventHandlingDefinitionProcessor:

Collaboration diagram for ilEventHandlingDefinitionProcessor:

Public Member Functions
	getData ()
	purge ()
	This methods is supposed to purge existing data in the provider of the component, so new components can be added to a clean slate. More...
	beginComponent (string $component, string $type)
	This method is called when parsing of component.xml for the given component starts. More...
	endComponent (string $component, string $type)
	This method is called when parsing of component.xml for the given component ends. More...
	beginTag (string $name, array $attributes)
	This is called when a tag starts in the context of the given component. More...
	endTag (string $name)
	This is called when a tag ends in the context of the given component. More...
	hasDataEntryForEvent ($event)

Protected Attributes
array	$data = []
string	$component

Detailed Description

Author

Klees

Definition at line 24 of file class.ilEventHandlingDefinitionProcessor.php.

Member Function Documentation

beginComponent()

ilEventHandlingDefinitionProcessor::beginComponent	(	string	$component,
		string	$type
	)

This method is called when parsing of component.xml for the given component starts.

This is supposed to reset any internal parsing state.

Implements ilComponentDefinitionProcessor.

Definition at line 39 of file class.ilEventHandlingDefinitionProcessor.php.

References $component.

                                                                   : void
    {
        $this->component = $type . "/" . $component;
    }

beginTag()

ilEventHandlingDefinitionProcessor::beginTag	(	string	$name,
		array	$attributes
	)

This is called when a tag starts in the context of the given component.

Parameters

string[]

$attributes

Implements ilComponentDefinitionProcessor.

Definition at line 49 of file class.ilEventHandlingDefinitionProcessor.php.

References $component, hasDataEntryForEvent(), and null.

                                                             : void
    {
        if ($name !== "event") {
            return;
        }

        $component = $attributes["component"] ?? null;
        if (!$component) {
            $component = $this->component;
        }

        $event = [
            "component" => $component,
            "type" => $attributes["type"],
            "type_specification" => $attributes["id"]
        ];

        // only add event to data if no such entry exists
        if (!$this->hasDataEntryForEvent($event)) {
            $this->data[] = $event;
        }
    }

Here is the call graph for this function:

endComponent()

ilEventHandlingDefinitionProcessor::endComponent	(	string	$component,
		string	$type
	)

This method is called when parsing of component.xml for the given component ends.

Implements ilComponentDefinitionProcessor.

Definition at line 44 of file class.ilEventHandlingDefinitionProcessor.php.

References null.

                                                                 : void
    {
        $this->component = null;
    }

endTag()

ilEventHandlingDefinitionProcessor::endTag

(

string

$name

)

This is called when a tag ends in the context of the given component.

Implements ilComponentDefinitionProcessor.

Definition at line 72 of file class.ilEventHandlingDefinitionProcessor.php.

                                        : void
    {
    }

getData()

ilEventHandlingDefinitionProcessor::getData

(

)

Definition at line 29 of file class.ilEventHandlingDefinitionProcessor.php.

References $data.

                             : array
    {
        return $this->data;
    }

hasDataEntryForEvent()

ilEventHandlingDefinitionProcessor::hasDataEntryForEvent

(

$event

)

Definition at line 76 of file class.ilEventHandlingDefinitionProcessor.php.

Referenced by beginTag().

                                                : bool
    {
        return in_array($event, $this->data, true);
    }

Here is the caller graph for this function:

purge()

ilEventHandlingDefinitionProcessor::purge

(

)

This methods is supposed to purge existing data in the provider of the component, so new components can be added to a clean slate.

Implements ilComponentDefinitionProcessor.

Definition at line 34 of file class.ilEventHandlingDefinitionProcessor.php.

                           : void
    {
        $this->data = [];
    }

Field Documentation

$component

string ilEventHandlingDefinitionProcessor::$component

protected

Definition at line 27 of file class.ilEventHandlingDefinitionProcessor.php.

Referenced by beginComponent(), and beginTag().

$data

array ilEventHandlingDefinitionProcessor::$data = []

protected

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

Referenced by getData().

---

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

• components/ILIAS/EventHandling/classes/Setup/class.ilEventHandlingDefinitionProcessor.php