Inheritance diagram for ILIAS\MetaData\Elements\Base\BaseElement:

Collaboration diagram for ILIAS\MetaData\Elements\Base\BaseElement:

Public Member Functions
	__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 ()

Protected Member Functions
	addSubElement (BaseElement $sub_element)

	orderSubElements (string ... $names_in_order)

	setSuperElement (?BaseElement $super_element)

Private Attributes
array	$sub_elements = []

BaseElement	$super_element = null

DefinitionInterface	$definition

int NoID	$md_id

Detailed Description

Definition at line 27 of file BaseElement.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Elements\Base\BaseElement::__construct	(	int\|NoID	$md_id,
		DefinitionInterface	$definition,
		BaseElement ...	$sub_elements
	)

Definition at line 37 of file BaseElement.php.

      {
        foreach ($sub_elements as $sub_element) {
            $this->addSubElement($sub_element);
        }
        $this->definition = $definition;
        $this->md_id = $md_id;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\$definition, ILIAS\MetaData\Elements\Base\BaseElement\$md_id, ILIAS\MetaData\Elements\Base\BaseElement\$sub_elements, and ILIAS\MetaData\Elements\Base\BaseElement\addSubElement().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ILIAS\MetaData\Elements\Base\BaseElement::__clone ( )

Definition at line 49 of file BaseElement.php.

    {
        if (!is_null($this->super_element)) {
            $this->setSuperElement(null);
        }
        $map = function (BaseElement $arg) {
            $arg = clone $arg;
            $arg->setSuperElement($this);
            return $arg;
        };
        $this->sub_elements = array_map(
            $map,
            $this->sub_elements
        );
    }

References ILIAS\MetaData\Elements\Base\BaseElement\setSuperElement().

Here is the call graph for this function:

◆ addSubElement()

ILIAS\MetaData\Elements\Base\BaseElement::addSubElement ( BaseElement $sub_element )

protected

Definition at line 78 of file BaseElement.php.

                                                              : void
    {
        $sub_element->setSuperElement($this);
        $this->sub_elements[] = $sub_element;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\setSuperElement().

Referenced by ILIAS\MetaData\Elements\Base\BaseElement\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefinition()

ILIAS\MetaData\Elements\Base\BaseElement::getDefinition ( )

Defining properties of the metadata element.

Implements ILIAS\MetaData\Elements\Base\BaseElementInterface.

Definition at line 122 of file BaseElement.php.

                                   : DefinitionInterface
    {
        return $this->definition;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\$definition.

◆ getMDID()

ILIAS\MetaData\Elements\Base\BaseElement::getMDID ( )

Implements ILIAS\MetaData\Elements\Base\BaseElementInterface.

Reimplemented in ILIAS\MetaData\Elements\Structure\StructureElement.

Definition at line 65 of file BaseElement.php.

                             : int|NoID
    {
        return $this->md_id;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\$md_id.

Referenced by ILIAS\MetaData\Elements\Base\BaseElement\isRoot(), and ILIAS\MetaData\Elements\Element\isScaffold().

Here is the caller graph for this function:

◆ getSubElements()

ILIAS\MetaData\Elements\Base\BaseElement::getSubElements ( )

Returns: BaseElement[]

Implements ILIAS\MetaData\Elements\Base\BaseElementInterface.

Reimplemented in ILIAS\MetaData\Elements\Element, and ILIAS\MetaData\Elements\Structure\StructureElement.

Definition at line 73 of file BaseElement.php.

                                    : \Generator
    {
        yield from $this->sub_elements;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\$sub_elements, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Here is the call graph for this function:

◆ getSuperElement()

ILIAS\MetaData\Elements\Base\BaseElement::getSuperElement ( )

Implements ILIAS\MetaData\Elements\Base\BaseElementInterface.

Reimplemented in ILIAS\MetaData\Elements\Element, and ILIAS\MetaData\Elements\Structure\StructureElement.

Definition at line 102 of file BaseElement.php.

                                     : ?BaseElement
    {
        return $this->super_element;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\$super_element.

◆ isRoot()

ILIAS\MetaData\Elements\Base\BaseElement::isRoot ( )

Implements ILIAS\MetaData\Elements\Base\BaseElementInterface.

Definition at line 117 of file BaseElement.php.

                            : bool
    {
        return $this->getMDID() === NoID::ROOT;
    }

References ILIAS\MetaData\Elements\Base\BaseElement\getMDID().

Referenced by ILIAS\MetaData\Elements\Base\BaseElement\setSuperElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ orderSubElements()

ILIAS\MetaData\Elements\Base\BaseElement::orderSubElements ( string ... $names_in_order )

protected

Definition at line 84 of file BaseElement.php.

                                                                  : void
    {
        $sub_elements_by_name = [];
        foreach ($this->sub_elements as $sub_element) {
            $sub_elements_by_name[$sub_element->getDefinition()->name()][] = $sub_element;
        }
 
        $reordered_sub_elements = [];
        foreach ($names_in_order as $name) {
            $reordered_sub_elements = array_merge(
                $reordered_sub_elements,
                $sub_elements_by_name[$name] ?? []
            );
        }
 
        $this->sub_elements = $reordered_sub_elements;
    }

◆ setSuperElement()

ILIAS\MetaData\Elements\Base\BaseElement::setSuperElement ( ?BaseElement $super_element )

protected

Definition at line 107 of file BaseElement.php.

                                                                   : void
    {
        if ($this->isRoot()) {
            throw new \ilMDElementsException(
                'Metadata root can not have a super element.'
            );
        }
        $this->super_element = $super_element;
    }