ilComponentInfoDefinitionProcessor Class Reference

Inheritance diagram for ilComponentInfoDefinitionProcessor:

Collaboration diagram for ilComponentInfoDefinitionProcessor:

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...

Protected Attributes
array	$data = []
array	$slots = []
string	$component_id
string	$component
string	$type

Detailed Description

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

Member Function Documentation

beginComponent()

ilComponentInfoDefinitionProcessor::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 40 of file class.ilComponentInfoDefinitionProcessor.php.

References $component, and $type.

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

beginTag()

ilComponentInfoDefinitionProcessor::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 54 of file class.ilComponentInfoDefinitionProcessor.php.

References $component, $component_id, $id, and $type.

                                                             : void
    {
        if ($name === "module") {
            $type = "Modules";
        } elseif ($name === "service") {
            $type = "Services";
        } elseif ($name === "pluginslot") {
            $type = null;
        } else {
            return;
        }

        if (!isset($attributes["id"])) {
            throw new \InvalidArgumentException(
                "Expected attribute 'id' for tag '$name' in $this->component"
            );
        }

        $id = $attributes["id"];
        if (!is_null($type)) {
            if ($type !== $this->type) {
                throw new \InvalidArgumentException(
                    "Type $this->type and tag don't match for component $this->component"
                );
            }
            if (isset($this->data[$id])) {
                throw new \LogicException(
                    "In $this->type/$this->component: Id '$id' for component is used twice. First occurence was in {$this->data[$id][0]}/{$this->data[$id][1]}."
                );
            }
            $this->component_id = $id;
            $this->data[$id] = [$this->type, $this->component, []];
        } else {
            if (!isset($attributes["name"])) {
                throw new \InvalidArgumentException(
                    "Expected attribute 'name' for tag '$name' in $this->component"
                );
            }
            if (isset($this->slots[$id])) {
                throw new \LogicException(
                    "In $this->type/$this->component: Id '$id' for plugin slot is used twice. First occurence was in {$this->slots[$id][0]}/{$this->slots[$id][1]}."
                );
            }
            $this->slots[$id] = [$this->type, $this->component];
            $this->data[$this->component_id][2][] = [$id, $attributes["name"]];
        }
    }

endComponent()

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

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

Implements ilComponentDefinitionProcessor.

Definition at line 47 of file class.ilComponentInfoDefinitionProcessor.php.

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

endTag()

ilComponentInfoDefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 102 of file class.ilComponentInfoDefinitionProcessor.php.

                                        : void
    {
    }

getData()

ilComponentInfoDefinitionProcessor::getData

(

)

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

References $data.

                             : array
    {
        return $this->data;
    }

purge()

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

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

Field Documentation

$component

string ilComponentInfoDefinitionProcessor::$component

protected

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

Referenced by beginComponent(), and beginTag().

$component_id

string ilComponentInfoDefinitionProcessor::$component_id

protected

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

Referenced by beginTag().

$data

array ilComponentInfoDefinitionProcessor::$data = []

protected

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

Referenced by getData().

$slots

array ilComponentInfoDefinitionProcessor::$slots = []

protected

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

$type

string ilComponentInfoDefinitionProcessor::$type

protected

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

Referenced by beginComponent(), and beginTag().

---

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

• Services/Component/classes/Setup/class.ilComponentInfoDefinitionProcessor.php