ilLoggingDefinitionProcessor Class Reference

Inheritance diagram for ilLoggingDefinitionProcessor:

Collaboration diagram for ilLoggingDefinitionProcessor:

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_id

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLoggingDefinitionProcessor::__construct

(

ilDBInterface

$db

)

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

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

beginComponent()

ilLoggingDefinitionProcessor::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 35 of file class.ilLoggingDefinitionProcessor.php.

                                                                   : void
    {
        $this->component_id = '';
    }

beginTag()

ilLoggingDefinitionProcessor::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 45 of file class.ilLoggingDefinitionProcessor.php.

References ilLogComponentLevels\updateFromXML().

                                                             : void
    {
        if ($name === "module" || $name === "service") {
            $this->component_id = $attributes["id"] ?? '';
            return;
        }

        if ($name !== "logging") {
            return;
        }

        if ($this->component_id === '') {
            throw new \RuntimeException(
                "Found $name-tag outside of module or service in {$this->component_id}."
            );
        }
        ilLogComponentLevels::updateFromXML($this->component_id);
    }

Here is the call graph for this function:

endComponent()

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

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

Implements ilComponentDefinitionProcessor.

Definition at line 40 of file class.ilLoggingDefinitionProcessor.php.

                                                                 : void
    {
        $this->component_id = '';
    }

endTag()

ilLoggingDefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 64 of file class.ilLoggingDefinitionProcessor.php.

                                        : void
    {
        if ($name === "module" || $name === "service") {
            $this->component_id = '';
        }
    }

purge()

ilLoggingDefinitionProcessor::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.ilLoggingDefinitionProcessor.php.

                           : void
    {
    }

Field Documentation

$component_id

string ilLoggingDefinitionProcessor::$component_id

protected

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

$db

ilDBInterface ilLoggingDefinitionProcessor::$db

protected

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

Referenced by __construct().

---

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

• components/ILIAS/Logging/classes/Setup/class.ilLoggingDefinitionProcessor.php