ILIAS\MetaData\Structure\Definitions\LOMReader Class Reference

Inheritance diagram for ILIAS\MetaData\Structure\Definitions\LOMReader:

Collaboration diagram for ILIAS\MetaData\Structure\Definitions\LOMReader:

Public Member Functions
	__construct (int $depth=0, ?array $definition_array=null)
	definition ()
	subDefinitions ()

Protected Member Functions
	getDefinitionArray ()
	name ()
	unique ()
	dataType ()
	throwStructureException (string $error)

Protected Attributes
array	$definition_array
int	$depth = 0

Detailed Description

Definition at line 25 of file LOMReader.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Structure\Definitions\LOMReader::__construct	(	int	$depth = 0,
		?array	$definition_array = null
	)

Definition at line 30 of file LOMReader.php.

References ILIAS\MetaData\Structure\Definitions\LOMReader\$definition_array, ILIAS\MetaData\Structure\Definitions\LOMReader\$depth, and ILIAS\MetaData\Structure\Definitions\LOMReader\getDefinitionArray().

      {
        if ($this->depth > 20) {
            throw new \ilMDStructureException('LOM Structure is nested to deep.');
        }
        if (!is_null($definition_array)) {
            $this->definition_array = $definition_array;
            return;
        }
        $this->definition_array = $this->getDefinitionArray();
        $this->depth = $depth;
    }

Here is the call graph for this function:

Member Function Documentation

dataType()

ILIAS\MetaData\Structure\Definitions\LOMReader::dataType ( )

protected

Definition at line 90 of file LOMReader.php.

References ILIAS\MetaData\Structure\Definitions\LOMReader\throwStructureException().

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\definition().

                                 : Type
    {
        if (
            !isset($this->definition_array['type']) ||
            is_null($type = $this->definition_array['type'])
        ) {
            $this->throwStructureException('invalid data type');
        }
        return $type;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

definition()

ILIAS\MetaData\Structure\Definitions\LOMReader::definition

(

)

Implements ILIAS\MetaData\Structure\Definitions\ReaderInterface.

Definition at line 50 of file LOMReader.php.

References ILIAS\MetaData\Structure\Definitions\LOMReader\dataType(), ILIAS\MetaData\Structure\Definitions\LOMReader\name(), and ILIAS\MetaData\Structure\Definitions\LOMReader\unique().

                                : DefinitionInterface
    {
        return new Definition(
            $this->name(),
            $this->unique(),
            $this->dataType()
        );
    }

Here is the call graph for this function:

getDefinitionArray()

ILIAS\MetaData\Structure\Definitions\LOMReader::getDefinitionArray ( )

protected

Definition at line 45 of file LOMReader.php.

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\__construct().

                                           : array
    {
        return require(__DIR__ . "/../../../StructureDefinition/LOMStructure.php");
    }

Here is the caller graph for this function:

name()

ILIAS\MetaData\Structure\Definitions\LOMReader::name ( )

protected

Definition at line 74 of file LOMReader.php.

References ILIAS\MetaData\Structure\Definitions\LOMReader\throwStructureException().

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\definition().

                             : string
    {
        if (!isset($this->definition_array['name'])) {
            $this->throwStructureException('missing name');
        }
        return $this->definition_array['name'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

subDefinitions()

ILIAS\MetaData\Structure\Definitions\LOMReader::subDefinitions

(

)

Returns

LOMReader[]

Implements ILIAS\MetaData\Structure\Definitions\ReaderInterface.

Definition at line 62 of file LOMReader.php.

                                    : \Generator
    {
        $sub_definitions = $this->definition_array['sub'] ?? [];
        foreach ($this->definition_array['sub'] as $sub_definition) {
            $reader = new LOMReader(
                $this->depth + 1,
                $sub_definition
            );
            yield $reader;
        }
    }

throwStructureException()

ILIAS\MetaData\Structure\Definitions\LOMReader::throwStructureException ( string  $error )

protected

Definition at line 101 of file LOMReader.php.

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\dataType(), ILIAS\MetaData\Structure\Definitions\LOMReader\name(), and ILIAS\MetaData\Structure\Definitions\LOMReader\unique().

                                                             : void
    {
        throw new \ilMDStructureException(
            'LOM definition is invalid:' . $error
        );
    }

Here is the caller graph for this function:

unique()

ILIAS\MetaData\Structure\Definitions\LOMReader::unique ( )

protected

Definition at line 82 of file LOMReader.php.

References ILIAS\MetaData\Structure\Definitions\LOMReader\throwStructureException().

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\definition().

                               : bool
    {
        if (!isset($this->definition_array['unique'])) {
            $this->throwStructureException('missing unique');
        }
        return (bool) $this->definition_array['unique'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$definition_array

array ILIAS\MetaData\Structure\Definitions\LOMReader::$definition_array

protected

Definition at line 27 of file LOMReader.php.

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\__construct().

$depth

int ILIAS\MetaData\Structure\Definitions\LOMReader::$depth = 0

protected

Definition at line 28 of file LOMReader.php.

Referenced by ILIAS\MetaData\Structure\Definitions\LOMReader\__construct().

---

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

• components/ILIAS/MetaData/classes/Structure/Definitions/LOMReader.php