ilSystemCheckDefinitionProcessor 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 ilSystemCheckDefinitionProcessor:

Collaboration diagram for ilSystemCheckDefinitionProcessor:

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

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

Definition at line 20 of file class.ilSystemCheckDefinitionProcessor.php.

Constructor & Destructor Documentation

__construct()

ilSystemCheckDefinitionProcessor::__construct

(

\ilDBInterface

$db

)

Definition at line 25 of file class.ilSystemCheckDefinitionProcessor.php.

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

beginComponent()

ilSystemCheckDefinitionProcessor::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 34 of file class.ilSystemCheckDefinitionProcessor.php.

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

beginTag()

ilSystemCheckDefinitionProcessor::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 44 of file class.ilSystemCheckDefinitionProcessor.php.

References ilSCGroups\getInstance(), and ilSCTasks\getInstanceByGroupId().

                                                             : void
    {
        if ($name === "module" || $name === "service") {
            $this->component_id = $attributes["id"] ?? null;
            return;
        }
        if ($name !== "systemcheck" || $name !== "systemcheck_task") {
            return;
        }
        if ($this->component_id === null) {
            throw new \RuntimeException(
                "Found $name-tag outside of module or service."
            );
        }

        if ($name === "systemcheck") {
            ilSCGroups::getInstance()->updateFromComponentDefinition($this->component_id);
        }
        if ($name === "systemcheck_task") {
            $group_id = ilSCGroups::getInstance()->lookupGroupByComponentId($this->component_id);
            $tasks = ilSCTasks::getInstanceByGroupId($group_id);
            $tasks->updateFromComponentDefinition((string) ($attributes['identifier'] ?? ''));
        }
    }

Here is the call graph for this function:

endComponent()

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

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

Implements ilComponentDefinitionProcessor.

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

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

endTag()

ilSystemCheckDefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 69 of file class.ilSystemCheckDefinitionProcessor.php.

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

purge()

ilSystemCheckDefinitionProcessor::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 30 of file class.ilSystemCheckDefinitionProcessor.php.

                           : void
    {
    }

Field Documentation

$component_id

string ilSystemCheckDefinitionProcessor::$component_id

protected

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

$db

ilDBInterface ilSystemCheckDefinitionProcessor::$db

protected

Definition at line 22 of file class.ilSystemCheckDefinitionProcessor.php.

Referenced by __construct().

---

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

• Services/SystemCheck/classes/Setup/class.ilSystemCheckDefinitionProcessor.php