ilEventDefinitionProcessor Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilEventDefinitionProcessor:

Collaboration diagram for ilEventDefinitionProcessor:

Public Member Functions
	__construct (ilDBInterface $db)
	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...

Protected Attributes
ilDBInterface	$db
string	$component

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too. If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Klees

Definition at line 21 of file class.ilEventDefinitionProcessor.php.

Constructor & Destructor Documentation

__construct()

ilEventDefinitionProcessor::__construct

(

ilDBInterface

$db

)

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

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

beginComponent()

ilEventDefinitionProcessor::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 36 of file class.ilEventDefinitionProcessor.php.

References $component.

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

beginTag()

ilEventDefinitionProcessor::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 46 of file class.ilEventDefinitionProcessor.php.

References $component.

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

        $component = $attributes["component"] ?? null;
        if (!$component) {
            $component = $this->component;
        }
        $q = "INSERT INTO il_event_handling (component, type, id) VALUES (" .
            $this->db->quote($component, "text") . "," .
            $this->db->quote($attributes["type"], "text") . "," .
            $this->db->quote($attributes["id"], "text") . ")";
        $this->db->manipulate($q);
    }

endComponent()

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

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

Implements ilComponentDefinitionProcessor.

Definition at line 41 of file class.ilEventDefinitionProcessor.php.

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

endTag()

ilEventDefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 63 of file class.ilEventDefinitionProcessor.php.

                                        : void
    {
    }

purge()

ilEventDefinitionProcessor::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 31 of file class.ilEventDefinitionProcessor.php.

                           : void
    {
        $this->db->manipulate("DELETE FROM il_event_handling WHERE component NOT LIKE 'Plugins/%'");
    }

Field Documentation

$component

string ilEventDefinitionProcessor::$component

protected

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

Referenced by beginComponent(), and beginTag().

$db

ilDBInterface ilEventDefinitionProcessor::$db

protected

Definition at line 23 of file class.ilEventDefinitionProcessor.php.

Referenced by __construct().

---

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

• Services/EventHandling/classes/Setup/class.ilEventDefinitionProcessor.php