ILIAS\MetaData\Elements\Structure\StructureElement Class Reference

Inheritance diagram for ILIAS\MetaData\Elements\Structure\StructureElement:

Collaboration diagram for ILIAS\MetaData\Elements\Structure\StructureElement:

Public Member Functions
	__construct (bool $is_root, DefinitionInterface $definition, StructureElement ... $sub_elements)
	getMDID ()
	getSuperElement ()
	getSubElements ()
	getSubElement (string $name)
	Return the first sub-element with the given name, if one exists. More...
Public Member Functions inherited from ILIAS\MetaData\Elements\Base\BaseElement
	__construct (int|NoID $md_id, DefinitionInterface $definition, BaseElement ... $sub_elements)
	__clone ()
	getMDID ()
	getSubElements ()
	getSuperElement ()
	isRoot ()
	getDefinition ()
	Defining properties of the metadata element. More...
	getMDID ()
	getDefinition ()
	Defining properties of the metadata element. More...
	getSubElements ()
	getSuperElement ()
	isRoot ()
	getMDID ()
	getSubElements ()
	getSubElement (string $name)
	Return the first sub-element with the given name, if one exists. More...
	getSuperElement ()

Protected Member Functions
	checkSubElement (BaseElement $element)
Protected Member Functions inherited from ILIAS\MetaData\Elements\Base\BaseElement
	addSubElement (BaseElement $sub_element)
	orderSubElements (string ... $names_in_order)
	setSuperElement (?BaseElement $super_element)

Detailed Description

Definition at line 28 of file StructureElement.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Elements\Structure\StructureElement::__construct	(	bool	$is_root,
		DefinitionInterface	$definition,
		StructureElement ...	$sub_elements
	)

Definition at line 30 of file StructureElement.php.

      {
        parent::__construct(
            $is_root ? NoID::ROOT : NoID::STRUCTURE,
            $definition,
            ...$sub_elements
        );
    }

References ILIAS\MetaData\Elements\Base\BaseElement\$definition, ILIAS\MetaData\Elements\Base\BaseElement\$sub_elements, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\MetaData\Elements\STRUCTURE.

Here is the call graph for this function:

Member Function Documentation

checkSubElement()

ILIAS\MetaData\Elements\Structure\StructureElement::checkSubElement ( BaseElement  $element )

protected

Exceptions

ilMDElementsException

Definition at line 90 of file StructureElement.php.

                                                            : void
    {
        if (!($element instanceof StructureElement)) {
            throw new \ilMDElementsException(
                'Metadata element has invalid sub-element.'
            );
        }
    }

Referenced by ILIAS\MetaData\Elements\Structure\StructureElement\getSubElement(), and ILIAS\MetaData\Elements\Structure\StructureElement\getSubElements().

Here is the caller graph for this function:

getMDID()

ILIAS\MetaData\Elements\Structure\StructureElement::getMDID

(

)

Reimplemented from ILIAS\MetaData\Elements\Base\BaseElement.

Definition at line 42 of file StructureElement.php.

                             : NoID
    {
        $mdid = parent::getMDID();
        if ($mdid !== NoID::STRUCTURE && $mdid !== NoID::ROOT) {
            throw new \ilMDElementsException(
                'Structure metadata elements can not have IDs.'
            );
        }
        return $mdid;
    }

References ILIAS\MetaData\Elements\STRUCTURE.

getSubElement()

ILIAS\MetaData\Elements\Structure\StructureElement::getSubElement

(

string

$name

)

Return the first sub-element with the given name, if one exists.

Implements ILIAS\MetaData\Elements\Structure\StructureElementInterface.

Definition at line 75 of file StructureElement.php.

                                               : ?StructureElementInterface
    {
        foreach ($this->getSubElements() as $sub_element) {
            $sub_name = $sub_element->getDefinition()->name();
            if (strtolower($sub_name) === strtolower($name)) {
                $this->checkSubElement($sub_element);
                return $sub_element;
            }
        }
        return null;
    }

References ILIAS\MetaData\Elements\Structure\StructureElement\checkSubElement(), ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition(), and ILIAS\MetaData\Elements\Structure\StructureElement\getSubElements().

Here is the call graph for this function:

getSubElements()

ILIAS\MetaData\Elements\Structure\StructureElement::getSubElements

(

)

Returns

StructureElement[]

Reimplemented from ILIAS\MetaData\Elements\Base\BaseElement.

Definition at line 67 of file StructureElement.php.

                                    : \Generator
    {
        foreach (parent::getSubElements() as $sub_element) {
            $this->checkSubElement($sub_element);
            yield $sub_element;
        }
    }

References ILIAS\MetaData\Elements\Structure\StructureElement\checkSubElement().

Referenced by ILIAS\MetaData\Elements\Structure\StructureElement\getSubElement().

Here is the call graph for this function:

Here is the caller graph for this function:

getSuperElement()

ILIAS\MetaData\Elements\Structure\StructureElement::getSuperElement

(

)

Reimplemented from ILIAS\MetaData\Elements\Base\BaseElement.

Definition at line 53 of file StructureElement.php.

                                     : ?StructureElement
    {
        $super = parent::getSuperElement();
        if (!isset($super) || ($super instanceof StructureElement)) {
            return $super;
        }
        throw new \ilMDElementsException(
            'Metadata element has invalid super-element.'
        );
    }

---

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

• components/ILIAS/MetaData/classes/Elements/Structure/StructureElement.php