ilComponentDefinitionReader Class Reference

Collaboration diagram for ilComponentDefinitionReader:

Public Member Functions
	__construct (ilComponentDefinitionProcessor ... $processor)
	purge ()
	This methods is supposed to purge existing data in the registered processor. More...
	readComponentDefinitions ()
	This reads the component.xml of all components in the core and processes them with the provided processor. More...
	beginTag ($_, string $name, array $attributes)
	endTag ($_, string $name)

Protected Member Functions
	readFile (string $path)
	parseComponentXML (string $type, string $component, string $xml)
	getComponents ()
	getComponentInfo (string $type, string $name)
	getComponentPaths (string $root, string $name)

Protected Attributes
array	$processors

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilComponentDefinitionReader::__construct

(

ilComponentDefinitionProcessor ...

$processor

)

Definition at line 28 of file class.ilComponentDefinitionReader.php.

      {
        $this->processors = $processor;
    }

Member Function Documentation

beginTag()

ilComponentDefinitionReader::beginTag	(		$_,
		string	$name,
		array	$attributes
	)

Definition at line 96 of file class.ilComponentDefinitionReader.php.

Referenced by parseComponentXML().

                                                                 : void
    {
        foreach ($this->processors as $processor) {
            $processor->beginTag($name, $attributes);
        }
    }

Here is the caller graph for this function:

endTag()

ilComponentDefinitionReader::endTag	(		$_,
		string	$name
	)

Definition at line 103 of file class.ilComponentDefinitionReader.php.

Referenced by parseComponentXML().

                                            : void
    {
        foreach ($this->processors as $processor) {
            $processor->endTag($name);
        }
    }

Here is the caller graph for this function:

getComponentInfo()

ilComponentDefinitionReader::getComponentInfo ( string  $type, string  $name  )

protected

Returns

Iterator<array>

Definition at line 126 of file class.ilComponentDefinitionReader.php.

References $c, and getComponentPaths().

Referenced by getComponents().

                                                                   : \Iterator
    {
        $dir = __DIR__ . "/../../../../" . $type;
        foreach ($this->getComponentPaths($dir, $name) as $c) {
            yield [
                $type,
                $c,
                realpath($dir . "/" . $c . "/" . $name)
            ];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComponentPaths()

ilComponentDefinitionReader::getComponentPaths ( string  $root, string  $name  )

protected

Returns

Iterator<string>

Definition at line 141 of file class.ilComponentDefinitionReader.php.

Referenced by getComponentInfo().

                                                                    : \Iterator
    {
        $dir = opendir($root);
        while ($sub = readdir($dir)) {
            if ($sub === "." || $sub === "..") {
                continue;
            }
            if (!is_dir($root . "/" . $sub)) {
                continue;
            }
            if (!is_file($root . "/" . $sub . "/" . $name)) {
                continue;
            }
            yield $sub;
        }
    }

Here is the caller graph for this function:

getComponents()

ilComponentDefinitionReader::getComponents ( )

protected

Returns

Iterator<string>

Definition at line 113 of file class.ilComponentDefinitionReader.php.

References getComponentInfo().

Referenced by readComponentDefinitions().

                                      : \Iterator
    {
        foreach ($this->getComponentInfo("components/ILIAS", "module.xml") as $i) {
            yield $i;
        }
        foreach ($this->getComponentInfo("components/ILIAS", "service.xml") as $i) {
            yield $i;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseComponentXML()

ilComponentDefinitionReader::parseComponentXML ( string  $type, string  $component, string  $xml  )

protected

Definition at line 73 of file class.ilComponentDefinitionReader.php.

References beginTag(), endTag(), and null.

Referenced by readComponentDefinitions().

                                                                                      : void
    {
        $xml_parser = null;
        try {
            $xml_parser = xml_parser_create("UTF-8");
            xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, false);
            xml_set_element_handler($xml_parser, $this->beginTag(...), $this->endTag(...));
            if (!xml_parse($xml_parser, $xml)) {
                $code = xml_get_error_code($xml_parser);
                $line = xml_get_current_line_number($xml_parser);
                $col = xml_get_current_column_number($xml_parser);
                $msg = xml_error_string($code);
                throw new \InvalidArgumentException(
                    "Error $code component xml of $type/$component, on line $line in column $col: $msg"
                );
            }
        } finally {
            if ($xml_parser) {
                xml_parser_free($xml_parser);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

purge()

ilComponentDefinitionReader::purge

(

)

This methods is supposed to purge existing data in the registered processor.

Definition at line 38 of file class.ilComponentDefinitionReader.php.

                           : void
    {
        foreach ($this->processors as $p) {
            $p->purge();
        }
    }

readComponentDefinitions()

ilComponentDefinitionReader::readComponentDefinitions

(

)

This reads the component.xml of all components in the core and processes them with the provided processor.

Definition at line 49 of file class.ilComponentDefinitionReader.php.

References $path, getComponents(), parseComponentXML(), and readFile().

                                              : void
    {
        foreach ($this->getComponents() as [$type, $component, $path]) {
            $file = $this->readFile($path);
            foreach ($this->processors as $processor) {
                $processor->beginComponent($component, $type);
            }
            $this->parseComponentXML($type, $component, $file);
            foreach ($this->processors as $processor) {
                $processor->endComponent($component, $type);
            }
        }
    }

Here is the call graph for this function:

readFile()

ilComponentDefinitionReader::readFile ( string  $path )

protected

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

Referenced by readComponentDefinitions().

                                             : string
    {
        if (!file_exists($path)) {
            throw new \InvalidArgumentException(
                "Cannot find file $path."
            );
        }
        return file_get_contents($path);
    }

Here is the caller graph for this function:

Field Documentation

$processors

array ilComponentDefinitionReader::$processors

protected

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

---

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

• components/ILIAS/Component/classes/class.ilComponentDefinitionReader.php