ILIAS\MetaData\Elements\NullElement Class Reference

Inheritance diagram for ILIAS\MetaData\Elements\NullElement:

Collaboration diagram for ILIAS\MetaData\Elements\NullElement:

Public Member Functions
	isScaffold ()
	getData ()
	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...
	getSubElements ()
	getSuperElement ()
Public Member Functions inherited from ILIAS\MetaData\Elements\Base\NullBaseElement
	getMDID ()
	getDefinition ()
	Defining properties of the metadata element. More...
	getSubElements ()
	getSuperElement ()
	isRoot ()
	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...

Detailed Description

Definition at line 32 of file NullElement.php.

Member Function Documentation

addScaffoldsToSubElements()

ILIAS\MetaData\Elements\NullElement::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 62 of file NullElement.php.

                                                                                           : void
    {
    }

addScaffoldToSubElements()

ILIAS\MetaData\Elements\NullElement::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 66 of file NullElement.php.

                                                                                                        : ?ElementInterface
    {
        return null;
    }

getData()

ILIAS\MetaData\Elements\NullElement::getData

(

)

Implements ILIAS\MetaData\Elements\ElementInterface.

Definition at line 39 of file NullElement.php.

                             : DataInterface
    {
        return new NullData();
    }

getMarker()

ILIAS\MetaData\Elements\NullElement::getMarker

(

)

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 49 of file NullElement.php.

                               : ?MarkerInterface
    {
        return new NullMarker();
    }

getSubElements()

ILIAS\MetaData\Elements\NullElement::getSubElements

(

)

Returns

BaseElementInterface[]

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

Definition at line 71 of file NullElement.php.

                                    : \Generator
    {
        yield from [];
    }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Here is the call graph for this function:

getSuperElement()

ILIAS\MetaData\Elements\NullElement::getSuperElement

(

)

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

Definition at line 76 of file NullElement.php.

                                     : ?ElementInterface
    {
        return null;
    }

isMarked()

ILIAS\MetaData\Elements\NullElement::isMarked

(

)

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

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 44 of file NullElement.php.

                              : bool
    {
        return false;
    }

isScaffold()

ILIAS\MetaData\Elements\NullElement::isScaffold

(

)

Implements ILIAS\MetaData\Elements\ElementInterface.

Definition at line 34 of file NullElement.php.

                                : bool
    {
        return false;
    }

mark()

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

Definition at line 54 of file NullElement.php.

                                                                                                  : void
    {
    }

unmark()

ILIAS\MetaData\Elements\NullElement::unmark

(

)

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

Implements ILIAS\MetaData\Elements\Markers\MarkableInterface.

Definition at line 58 of file NullElement.php.

                            : void
    {
    }

---

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

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