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...
	getMDID ()
	getDefinition ()
	Defining properties of the metadata element. More...
	getSubElements ()
	getSuperElement ()
	isRoot ()
	getSubElements ()
	getSuperElement ()
	isScaffold ()
	getData ()
	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\Markers\MarkableInterface
	isMarked ()
	Elements can be marked to be created, updated or deleted. More...
	getMarker ()
	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...
	unmark ()
	Removes markers from this element, and recursively from all sub-elements. 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.

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

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

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.

     : 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));
        }
    }

References ILIAS\MetaData\Manipulator\ScaffoldProvider\ScaffoldProviderInterface\getPossibleSubElementNamesForElementInOrder().

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.

     : ?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;
    }

References ILIAS\MetaData\Manipulator\ScaffoldProvider\ScaffoldProviderInterface\getPossibleSubElementNamesForElementInOrder().

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.

                             : DataInterface
    {
        return $this->data;
    }

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

getMarker()

ILIAS\MetaData\Elements\Element::getMarker

(

)

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 90 of file Element.php.

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

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

getSubElements()

ILIAS\MetaData\Elements\Element::getSubElements

(

)

Returns

Element[]

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

Definition at line 73 of file Element.php.

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

getSuperElement()

ILIAS\MetaData\Elements\Element::getSuperElement

(

)

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

Definition at line 59 of file Element.php.

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

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.

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

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

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.

     : 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();
        }
    }

setMarker()

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

protected

Definition at line 123 of file Element.php.

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

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.

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

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().

---

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

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