ILIAS\MetaData\Elements\Element Class Reference

Inheritance diagram for ILIAS\MetaData\Elements\Element:

Collaboration diagram for ILIAS\MetaData\Elements\Element:

Public Member Functions
	__construct (NoID|int $md_id, DefinitionInterface $definition, DataInterface $data, Element ... $sub_elements)
	getData ()
	isScaffold ()
	getSuperElement ()
	getSubElements ()
	isMarked ()
	Elements can be marked to be created, updated or deleted. More...
	getMarker ()
	mark (MarkerFactoryInterface $factory, Action $action, string $data_value='')
	unmark ()
	Removes markers from this element, and recursively from all sub-elements. More...
	addScaffoldsToSubElements (ScaffoldProviderInterface $scaffold_provider)
	Scaffolds are used to mark where elements could potentially be created. More...
	addScaffoldToSubElements (ScaffoldProviderInterface $scaffold_provider, string $name)
	If possible, adds a scaffold with the given name to this element's sub-elements, and returns it. 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...
Public Member Functions inherited from ILIAS\MetaData\Elements\Markers\MarkableInterface
	mark (MarkerFactoryInterface $factory, Action $action, string $data_value='')
	Leaves a trail of markers from this element up to the root element, or up to the first already marked element. More...

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

Private Attributes
MarkerInterface	$marker = null
DataInterface	$data

Detailed Description

Definition at line 34 of file Element.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Elements\Element::__construct	(	NoID|int	$md_id,
		DefinitionInterface	$definition,
		DataInterface	$data,
		Element ...	$sub_elements
	)

Definition at line 39 of file Element.php.

References ILIAS\MetaData\Elements\Element\$data, and ILIAS\GlobalScreen\Provider\__construct().

      {
        $this->data = $data;
        parent::__construct($md_id, $definition, ...$sub_elements);
    }

Here is the call graph for this function:

Member Function Documentation

addScaffoldsToSubElements()

ILIAS\MetaData\Elements\Element::addScaffoldsToSubElements

(

ScaffoldProviderInterface

$scaffold_provider

)

Scaffolds are used to mark where elements could potentially be created.

Adds all possible scaffolds to this element's sub-elements. Scaffolds are added such that the order of elements as suggested by the structure is preserved.

Implements ILIAS\MetaData\Elements\Scaffolds\ScaffoldableInterface.

Definition at line 128 of file Element.php.

References ILIAS\MetaData\Elements\Base\BaseElement\addSubElement(), ILIAS\MetaData\Manipulator\ScaffoldProvider\ScaffoldProviderInterface\getPossibleSubElementNamesForElementInOrder(), ILIAS\MetaData\Manipulator\ScaffoldProvider\ScaffoldProviderInterface\getScaffoldsForElement(), and ILIAS\MetaData\Elements\Base\BaseElement\orderSubElements().

     : void {
        foreach ($scaffold_provider->getScaffoldsForElement($this) as $scaffold) {
            if ($scaffold->getSubElements()->current() !== null) {
                throw new \ilMDElementsException('Can only add scaffolds with no sub-elements.');
            }
            $this->addSubElement($scaffold);
            $this->orderSubElements(...$scaffold_provider->getPossibleSubElementNamesForElementInOrder($this));
        }
    }

Here is the call graph for this function:

addScaffoldToSubElements()

ILIAS\MetaData\Elements\Element::addScaffoldToSubElements	(	ScaffoldProviderInterface	$scaffold_provider,
		string	$name
	)

If possible, adds a scaffold with the given name to this element's sub-elements, and returns it.

Scaffolds are added such that the order of elements as suggested by the structure is preserved.

Returns

ElementInterface[]

Implements ILIAS\MetaData\Elements\Scaffolds\ScaffoldableInterface.

Definition at line 140 of file Element.php.

References ILIAS\MetaData\Elements\Base\BaseElement\addSubElement(), ILIAS\MetaData\Manipulator\ScaffoldProvider\ScaffoldProviderInterface\getPossibleSubElementNamesForElementInOrder(), ILIAS\MetaData\Manipulator\ScaffoldProvider\ScaffoldProviderInterface\getScaffoldsForElement(), and ILIAS\MetaData\Elements\Base\BaseElement\orderSubElements().

     : ?ElementInterface {
        foreach ($scaffold_provider->getScaffoldsForElement($this) as $scaffold) {
            if (strtolower($scaffold->getDefinition()->name()) === strtolower($name)) {
                if ($scaffold->getSubElements()->current() !== null) {
                    throw new \ilMDElementsException('Can only add scaffolds with no sub-elements.');
                }
                $this->addSubElement($scaffold);
                $this->orderSubElements(...$scaffold_provider->getPossibleSubElementNamesForElementInOrder($this));
                return $scaffold;
            }
        }
        return null;
    }

Here is the call graph for this function:

getData()

ILIAS\MetaData\Elements\Element::getData

(

)

Implements ILIAS\MetaData\Elements\ElementInterface.

Definition at line 49 of file Element.php.

References ILIAS\MetaData\Elements\Element\$data.

                             : DataInterface
    {
        return $this->data;
    }

getMarker()

ILIAS\MetaData\Elements\Element::getMarker

(

)

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 90 of file Element.php.

References ILIAS\MetaData\Elements\Element\$marker.

                               : ?MarkerInterface
    {
        return $this->marker;
    }

getSubElements()

ILIAS\MetaData\Elements\Element::getSubElements

(

)

Returns

Element[]

Implements ILIAS\MetaData\Elements\ElementInterface.

Definition at line 73 of file Element.php.

Referenced by ILIAS\MetaData\Elements\Element\unmark().

                                    : \Generator
    {
        foreach (parent::getSubElements() as $sub_element) {
            if (!($sub_element instanceof Element)) {
                throw new \ilMDElementsException(
                    'Metadata element has invalid sub-element.'
                );
            }
            yield $sub_element;
        }
    }

Here is the caller graph for this function:

getSuperElement()

ILIAS\MetaData\Elements\Element::getSuperElement

(

)

Implements ILIAS\MetaData\Elements\ElementInterface.

Definition at line 59 of file Element.php.

Referenced by ILIAS\MetaData\Elements\Element\mark().

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

Here is the caller graph for this function:

isMarked()

ILIAS\MetaData\Elements\Element::isMarked

(

)

Elements can be marked to be created, updated or deleted.

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 85 of file Element.php.

                              : bool
    {
        return isset($this->marker);
    }

isScaffold()

ILIAS\MetaData\Elements\Element::isScaffold

(

)

Implements ILIAS\MetaData\Elements\ElementInterface.

Definition at line 54 of file Element.php.

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

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

Here is the call graph for this function:

mark()

ILIAS\MetaData\Elements\Element::mark	(	MarkerFactoryInterface	$factory,
		Action	$action,
		string	$data_value = ''
	)

Definition at line 95 of file Element.php.

References ILIAS\MetaData\Elements\Element\getSuperElement(), ILIAS\MetaData\Elements\Markers\MarkerFactoryInterface\marker(), and ILIAS\MetaData\Elements\Element\setMarker().

     : void {
        $this->setMarker($factory->marker($action, $data_value));
        $curr_element = $this->getSuperElement();
        while ($curr_element) {
            if ($curr_element->isMarked()) {
                return;
            }
            $trail_action = Action::NEUTRAL;
            if ($curr_element->isScaffold() && $action === Action::CREATE_OR_UPDATE) {
                $trail_action = Action::CREATE_OR_UPDATE;
            }
            $curr_element->setMarker($factory->marker($trail_action));
            $curr_element = $curr_element->getSuperElement();
        }
    }

Here is the call graph for this function:

setMarker()

ILIAS\MetaData\Elements\Element::setMarker ( ?MarkerInterface  $marker )

protected

Definition at line 123 of file Element.php.

References ILIAS\MetaData\Elements\Element\$marker.

Referenced by ILIAS\MetaData\Elements\Element\mark(), and ILIAS\MetaData\Elements\Element\unmark().

                                                          : void
    {
        $this->marker = $marker;
    }

Here is the caller graph for this function:

unmark()

ILIAS\MetaData\Elements\Element::unmark

(

)

Removes markers from this element, and recursively from all sub-elements.

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 115 of file Element.php.

References ILIAS\MetaData\Elements\Element\getSubElements(), and ILIAS\MetaData\Elements\Element\setMarker().

                            : void
    {
        $this->setMarker(null);
        foreach ($this->getSubElements() as $sub_element) {
            $sub_element->unmark();
        }
    }

Here is the call graph for this function:

Field Documentation

$data

DataInterface ILIAS\MetaData\Elements\Element::$data

private

Definition at line 37 of file Element.php.

Referenced by ILIAS\MetaData\Elements\Element\__construct(), and ILIAS\MetaData\Elements\Element\getData().

$marker

MarkerInterface ILIAS\MetaData\Elements\Element::$marker = null

private

Definition at line 36 of file Element.php.

Referenced by ILIAS\MetaData\Elements\Element\getMarker(), and ILIAS\MetaData\Elements\Element\setMarker().

---

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

• components/ILIAS/MetaData/classes/Elements/Element.php