ILIAS\MetaData\Structure\LOMStructureInitiator Class Reference

Collaboration diagram for ILIAS\MetaData\Structure\LOMStructureInitiator:

Public Member Functions
	__construct (ReaderFactoryInterface $reader_factory, StructureFactory $structure_factory)
	set ()

Protected Member Functions
	getStructureRoot ()
	getSubElements (int $depth, ReaderInterface ... $readers)

Protected Attributes
ReaderFactoryInterface	$reader_factory
StructureFactory	$structure_factory

Detailed Description

Definition at line 34 of file LOMStructureInitiator.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Structure\LOMStructureInitiator::__construct	(	ReaderFactoryInterface	$reader_factory,
		StructureFactory	$structure_factory
	)

Definition at line 39 of file LOMStructureInitiator.php.

References ILIAS\MetaData\Structure\LOMStructureInitiator\$reader_factory, and ILIAS\MetaData\Structure\LOMStructureInitiator\$structure_factory.

      {
        $this->reader_factory = $reader_factory;
        $this->structure_factory = $structure_factory;
    }

Member Function Documentation

getStructureRoot()

ILIAS\MetaData\Structure\LOMStructureInitiator::getStructureRoot ( )

protected

Definition at line 54 of file LOMStructureInitiator.php.

Referenced by ILIAS\MetaData\Structure\LOMStructureInitiator\set().

                                         : StructureElementInterface
    {
        $reader = $this->reader_factory->reader();
        return $this->structure_factory->root(
            $reader->definition(),
            ...$this->getSubElements(0, ...$reader->subDefinitions())
        );
    }

Here is the caller graph for this function:

getSubElements()

ILIAS\MetaData\Structure\LOMStructureInitiator::getSubElements ( int  $depth, ReaderInterface ...  $readers  )

protected

Returns

StructureElement[]

Definition at line 66 of file LOMStructureInitiator.php.

     : \Generator {
        if ($depth > 20) {
            throw new \ilMDStructureException('LOM Structure is nested to deep.');
        }
        foreach ($readers as $reader) {
            yield $this->structure_factory->structure(
                $reader->definition(),
                ...$this->getSubElements($depth + 1, ...$reader->subDefinitions())
            );
        }
    }

set()

ILIAS\MetaData\Structure\LOMStructureInitiator::set

(

)

Definition at line 47 of file LOMStructureInitiator.php.

References ILIAS\MetaData\Structure\LOMStructureInitiator\getStructureRoot().

                         : StructureSetInterface
    {
        return $this->structure_factory->set(
            $this->getStructureRoot()
        );
    }

Here is the call graph for this function:

Field Documentation

$reader_factory

ReaderFactoryInterface ILIAS\MetaData\Structure\LOMStructureInitiator::$reader_factory

protected

Definition at line 36 of file LOMStructureInitiator.php.

Referenced by ILIAS\MetaData\Structure\LOMStructureInitiator\__construct().

$structure_factory

StructureFactory ILIAS\MetaData\Structure\LOMStructureInitiator::$structure_factory

protected

Definition at line 37 of file LOMStructureInitiator.php.

Referenced by ILIAS\MetaData\Structure\LOMStructureInitiator\__construct().

---

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

• components/ILIAS/MetaData/classes/Structure/LOMStructureInitiator.php