ilBadgeDefinitionProcessor Class Reference

Inheritance diagram for ilBadgeDefinitionProcessor:

Collaboration diagram for ilBadgeDefinitionProcessor:

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
bool	$has_badges = false

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBadgeDefinitionProcessor::__construct

(

\ilDBInterface

$db

)

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

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

beginComponent()

ilBadgeDefinitionProcessor::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 38 of file class.ilBadgeDefinitionProcessor.php.

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

beginTag()

ilBadgeDefinitionProcessor::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 50 of file class.ilBadgeDefinitionProcessor.php.

References ilBadgeHandler\updateFromXML().

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

        if ($name !== 'badges') {
            return;
        }

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

        ilBadgeHandler::updateFromXML($this->component_id);
        $this->has_badges = true;
    }

Here is the call graph for this function:

endComponent()

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

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

endTag()

ilBadgeDefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 71 of file class.ilBadgeDefinitionProcessor.php.

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

purge()

ilBadgeDefinitionProcessor::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 32 of file class.ilBadgeDefinitionProcessor.php.

References ilBadgeHandler\getInstance().

                           : void
    {
        $bh = ilBadgeHandler::getInstance();
        $bh->setComponents(null);
    }

Here is the call graph for this function:

Field Documentation

$component_id

string ilBadgeDefinitionProcessor::$component_id

protected

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

$db

ilDBInterface ilBadgeDefinitionProcessor::$db

protected

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

Referenced by __construct().

$has_badges

bool ilBadgeDefinitionProcessor::$has_badges = false

protected

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

---

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

• Services/Badge/classes/Setup/class.ilBadgeDefinitionProcessor.php