Inheritance diagram for ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest:

Collaboration diagram for ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest:

Public Member Functions
	getMockNavigatorFactory (string $expected_path='', string $expected_start_element_name='', ?ElementInterface $returned_element=null)

	getMockHandler (string $expected_path='', array $identifiers=[], array $condition_paths_by_identifer=[], array $condition_values_by_identifer=[])

	testSlotsForElementWithoutCondition (string $element_name, array $expected_identifiers)

	testSlotForElement (string $element_name, array $all_identifiers, ?Identifier $matching_identifier)

	testPotentialSlotForElementByCondition (string $element_name, string $element_in_condition_name, string $condition_value, array $all_identifiers, array $condition_paths_by_identifer, array $condition_values_by_identifer, ?Identifier $matching_identifier)

	testFindElementOfCondition (string $element_name, array $all_elements, Identifier $identifier, bool $conditional, ?ElementInterface $navigator_returns_element, ?string $expected_element_name)

Static Public Member Functions
static	slotsForElementWithoutConditionProvider ()

static	slotsForElementProvider ()

static	potentialSlotForElementByConditionProvider ()

static	findElementOfConditionProvider ()

Protected Member Functions
	getMockConditionChecker (string $element_name='', ?Identifier $fits_slot=null)

	getMockPathFactory ()

Static Protected Member Functions
static	getMockElement (string $name)

Detailed Description

Definition at line 43 of file ElementHelperTest.php.

Member Function Documentation

◆ findElementOfConditionProvider()

static ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::findElementOfConditionProvider ( )

static

Definition at line 424 of file ElementHelperTest.php.

References null.

                                                            : array
     {
         $el1 = self::getMockElement('el1');
         $el2 = self::getMockElement('el2');
         $el3 = self::getMockElement('el3');
         $other_element = self::getMockElement('other_element');
         return [
             [
                 'some element',
                 [$el1, $el2, $el3],
                 Identifier::EDUCATIONAL_CONTEXT,
                 false,
                 $el1,
                 null
             ],
             [
                 'some element',
                 [$el1, $el2, $el3],
                 Identifier::EDUCATIONAL_CONTEXT,
                 true,
                 null,
                 null
             ],
             [
                 'some element',
                 [$el1, $el2, $el3],
                 Identifier::EDUCATIONAL_CONTEXT,
                 true,
                 $other_element,
                 null
             ],
             [
                 'some element',
                 [$el1, $el2, $el3],
                 Identifier::EDUCATIONAL_CONTEXT,
                 true,
                 $el2,
                 'el2'
             ],
         ];
     }

◆ getMockConditionChecker()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::getMockConditionChecker	(	string	$element_name = `''`,
		?Identifier	$fits_slot = `null`
	)

protected

Definition at line 70 of file ElementHelperTest.php.

References ILIAS\__construct(), and ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition().

Referenced by ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testFindElementOfCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testPotentialSlotForElementByCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotForElement(), and ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotsForElementWithoutCondition().

      : ConditionCheckerInterface {
         return new class ($element_name, $fits_slot) extends NullConditionChecker {
             public function __construct(
                 protected string $element_name,
                 protected ?Identifier $fits_slot
             ) {
             }
 
             public function doesElementFitSlot(
                 ElementInterface $element,
                 SlotIdentifier $slot,
                 bool $ignore_markers = true
             ): bool {
                 if ($element->getDefinition()->name() !== $this->element_name) {
                     return false;
                 }
                 if ($slot !== $this->fits_slot) {
                     return false;
                 }
                 return true;
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMockElement()

static ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::getMockElement ( string $name )

staticprotected

Definition at line 45 of file ElementHelperTest.php.

References ILIAS\__construct().

                                                           : ElementInterface
     {
         return new class ($name) extends NullElement {
             public function __construct(
                 protected string $name
             ) {
             }
 
             public function getDefinition(): DefinitionInterface
             {
                 return new class ($this->name) extends NullDefinition {
                     public function __construct(
                         protected string $name
                     ) {
                     }
 
                     public function name(): string
                     {
                         return $this->name;
                     }
                 };
             }
         };
     }

Here is the call graph for this function:

◆ getMockHandler()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::getMockHandler	(	string	$expected_path = `''`,
		array	$identifiers = `[]`,
		array	$condition_paths_by_identifer = `[]`,
		array	$condition_values_by_identifer = `[]`
	)

Definition at line 183 of file ElementHelperTest.php.

References ILIAS\__construct(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\Data\Description\NULL, null, ILIAS\Export\ImportHandler\File\XML\Manifest\toString, and ILIAS\MetaData\Paths\PathInterface\toString().

Referenced by ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testFindElementOfCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testPotentialSlotForElementByCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotForElement(), and ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotsForElementWithoutCondition().

      : HandlerInterface {
         return new class ($expected_path, $identifiers, $condition_paths_by_identifer, $condition_values_by_identifer) extends NullHandler {
             public function __construct(
                 protected string $expected_path,
                 protected array $identifiers,
                 protected array $condition_paths_by_identifer,
                 protected array $condition_values_by_identifer
             ) {
             }
 
             public function allSlotsForPath(PathInterface $path_to_element): \Generator
             {
                 if ($path_to_element->toString() !== $this->expected_path) {
                     throw new \Exception('wrong path');
                 }
                 yield from $this->identifiers;
             }
 
             public function identiferFromPathAndCondition(
                 PathInterface $path_to_element,
                 ?PathInterface $path_to_condition,
                 ?string $condition_value
             ): Identifier {
                 if ($path_to_element->toString() !== $this->expected_path) {
                     throw new \Exception('wrong path');
                 }
                 foreach ($this->identifiers as $identifier) {
                     if (
                         ($this->condition_paths_by_identifer[$identifier->value] ?? null) !== $path_to_condition->toString() ||
                         ($this->condition_values_by_identifer[$identifier->value] ?? null) !== $condition_value
                     ) {
                         continue;
                     }
                     return $identifier;
                 };
                 return Identifier::NULL;
             }
 
             public function isSlotConditional(Identifier $identifier): bool
             {
                 return isset($this->condition_paths_by_identifer[$identifier->value]) &&
                     isset($this->condition_values_by_identifer[$identifier->value]);
             }
 
             public function conditionForSlot(Identifier $identifier): ?ConditionInterface
             {
                 $condition_path = $this->condition_paths_by_identifer[$identifier->value] ?? null;
                 if ($condition_path === null) {
                     return null;
                 }
                 // sometimes null
                 return new class ($condition_path) extends NullCondition {
                     public function __construct(
                         protected string $condition_path
                     ) {
                     }
 
                     public function path(): PathInterface
                     {
                         return new class ($this->condition_path) extends NullPath {
                             public function __construct(
                                 protected string $string
                             ) {
                             }
 
                             public function toString(): string
                             {
                                 return $this->string;
                             }
                         };
                     }
                 };
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMockNavigatorFactory()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::getMockNavigatorFactory	(	string	$expected_path = `''`,
		string	$expected_start_element_name = `''`,
		?ElementInterface	$returned_element = `null`
	)

Definition at line 147 of file ElementHelperTest.php.

References $path, ILIAS\__construct(), ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition(), and ILIAS\MetaData\Paths\PathInterface\toString().

Referenced by ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testFindElementOfCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testPotentialSlotForElementByCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotForElement(), and ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotsForElementWithoutCondition().

      : NavigatorFactoryInterface {
         return new class ($expected_path, $expected_start_element_name, $returned_element) extends NullNavigatorFactory {
             public function __construct(
                 protected string $expected_path,
                 protected string $expected_start_element_name,
                 protected ?ElementInterface $expected_element
             ) {
             }
 
             public function navigator(PathInterface $path, ElementInterface $start_element): NavigatorInterface
             {
                 if (
                     $path->toString() !== $this->expected_path &&
                     $start_element->getDefinition()->name() !== $this->expected_start_element_name
                 ) {
                     throw new \Exception('wrong path or element name');
                 }
                 return new class ($this->expected_element) extends NullNavigator {
                     public function __construct(
                         protected ?ElementInterface $leads_to
                     ) {
                     }
 
                     public function lastElementAtFinalStep(): ?ElementInterface
                     {
                         return $this->leads_to;
                     }
                 };
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMockPathFactory()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::getMockPathFactory ( )

protected

Definition at line 97 of file ElementHelperTest.php.

References ILIAS\__construct(), ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition(), and ILIAS\Export\ImportHandler\File\XML\Manifest\toString.

Referenced by ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testFindElementOfCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testPotentialSlotForElementByCondition(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotForElement(), and ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\testSlotsForElementWithoutCondition().

                                            : PathFactoryInterface
     {
         return new class () extends NullPathFactory {
             public function toElement(
                 BaseElementInterface $to,
                 bool $leads_to_exactly_one = false
             ): PathInterface {
                 $string = '';
                 if ($leads_to_exactly_one) {
                     $string = 'exactly ';
                 }
                 $string .= 'to ' . $to->getDefinition()->name();
                 return new class ($string) extends NullPath {
                     public function __construct(
                         protected string $string
                     ) {
                     }
 
                     public function toString(): string
                     {
                         return $this->string;
                     }
                 };
             }
 
             public function betweenElements(
                 BaseElementInterface $from,
                 BaseElementInterface $to,
                 bool $leads_to_exactly_one = false
             ): PathInterface {
                 $string = '';
                 if ($leads_to_exactly_one) {
                     $string = 'exactly ';
                 }
                 $string .= 'from ' . $from->getDefinition()->name() . ' to ' . $to->getDefinition()->name();
                 return new class ($string) extends NullPath {
                     public function __construct(
                         protected string $string
                     ) {
                     }
 
                     public function toString(): string
                     {
                         return $this->string;
                     }
                 };
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ potentialSlotForElementByConditionProvider()

static ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::potentialSlotForElementByConditionProvider ( )

static

Definition at line 336 of file ElementHelperTest.php.

References null.

                                                                        : array
     {
         return [
             [
                 'some element',
                 'element in condition',
                 'condition value',
                 [],
                 [],
                 [],
                 null
             ],
             [
                 'some element',
                 'element in condition',
                 'condition value',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 [],
                 [],
                 null
             ],
             [
                 'some element',
                 'element in condition',
                 'condition value',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 [Identifier::GENERAL_STRUCTURE->value => 'from some element to element in condition'],
                 [Identifier::GENERAL_STRUCTURE->value => 'condition value'],
                 Identifier::GENERAL_STRUCTURE
             ],
             [
                 'some element',
                 'element in condition',
                 'wrong value',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 [Identifier::GENERAL_STRUCTURE->value => 'from some element to element in condition'],
                 [Identifier::GENERAL_STRUCTURE->value => 'condition value'],
                 null
             ],
             [
                 'some element',
                 'wrong element in condition',
                 'condition value',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 [Identifier::GENERAL_STRUCTURE->value => 'from some element to element in condition'],
                 [Identifier::GENERAL_STRUCTURE->value => 'condition value'],
                 null
             ],
             [
                 'some element',
                 'element in condition',
                 'condition value',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 [Identifier::GENERAL_STRUCTURE->value => 'from some element to element in condition', Identifier::LIFECYCLE_STATUS->value => 'different path'],
                 [Identifier::GENERAL_STRUCTURE->value => 'condition value', Identifier::LIFECYCLE_STATUS->value => 'different value'],
                 Identifier::GENERAL_STRUCTURE
             ]
         ];
     }

◆ slotsForElementProvider()

static ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::slotsForElementProvider ( )

static

Definition at line 296 of file ElementHelperTest.php.

References null.

                                                     : array
     {
         return [
             [
                 'some element',
                 [],
                 null
             ],
             [
                 'some element',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 null
             ],
             [
                 'some element',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS],
                 Identifier::GENERAL_STRUCTURE
             ]
         ];
     }

◆ slotsForElementWithoutConditionProvider()

static ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::slotsForElementWithoutConditionProvider ( )

static

Definition at line 264 of file ElementHelperTest.php.

                                                                     : array
     {
         return [
             [
                 'some element',
                 []
             ],
             [
                 'some element',
                 [Identifier::EDUCATIONAL_CONTEXT, Identifier::GENERAL_STRUCTURE, Identifier::LIFECYCLE_STATUS]
             ]
         ];
     }

◆ testFindElementOfCondition()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::testFindElementOfCondition	(	string	$element_name,
		array	$all_elements,
		Identifier	$identifier,
		bool	$conditional,
		?ElementInterface	$navigator_returns_element,
		?string	$expected_element_name
	)

Definition at line 467 of file ElementHelperTest.php.

References ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockConditionChecker(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockHandler(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockNavigatorFactory(), and ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockPathFactory().

      : void {
         $condition_paths_by_identifer = [];
         $condition_values_by_identifer = [];
         if ($conditional) {
             $condition_paths_by_identifer[$identifier->value] = 'some path';
             $condition_values_by_identifer[$identifier->value] = 'some value';
         }
         $helper = new ElementHelper(
             $this->getMockHandler('', [$identifier], $condition_paths_by_identifer, $condition_values_by_identifer),
             $this->getMockPathFactory(),
             $this->getMockNavigatorFactory('some path', $element_name, $navigator_returns_element),
             $this->getMockConditionChecker()
         );
 
         $found = $helper->findElementOfCondition(
             $identifier,
             self::getMockElement($element_name),
             ...$all_elements
         );
 
         $this->assertSame($expected_element_name, $found?->getDefinition()?->name());
     }

Here is the call graph for this function:

◆ testPotentialSlotForElementByCondition()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::testPotentialSlotForElementByCondition	(	string	$element_name,
		string	$element_in_condition_name,
		string	$condition_value,
		array	$all_identifiers,
		array	$condition_paths_by_identifer,
		array	$condition_values_by_identifer,
		?Identifier	$matching_identifier
	)

Definition at line 397 of file ElementHelperTest.php.

References ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockConditionChecker(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockHandler(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockNavigatorFactory(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockPathFactory(), and ILIAS\Data\Description\NULL.

      : void {
         $helper = new ElementHelper(
             $this->getMockHandler('to ' . $element_name, $all_identifiers, $condition_paths_by_identifer, $condition_values_by_identifer),
             $this->getMockPathFactory(),
             $this->getMockNavigatorFactory(),
             $this->getMockConditionChecker()
         );
         $element = self::getMockElement($element_name);
         $element_in_condition = self::getMockElement($element_in_condition_name);
 
         $actual_identifier = $helper->potentialSlotForElementByCondition(
             $element,
             $element_in_condition,
             $condition_value
         );
 
         $this->assertSame($matching_identifier ?? Identifier::NULL, $actual_identifier);
     }

Here is the call graph for this function:

◆ testSlotForElement()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::testSlotForElement	(	string	$element_name,
		array	$all_identifiers,
		?Identifier	$matching_identifier
	)

Definition at line 318 of file ElementHelperTest.php.

References ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockConditionChecker(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockHandler(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockNavigatorFactory(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockPathFactory(), and ILIAS\Data\Description\NULL.

      : void {
         $helper = new ElementHelper(
             $this->getMockHandler('to ' . $element_name, $all_identifiers),
             $this->getMockPathFactory(),
             $this->getMockNavigatorFactory(),
             $this->getMockConditionChecker($element_name, $matching_identifier)
         );
         $element = self::getMockElement($element_name);
 
         $actual_identifier = $helper->slotForElement($element);
 
         $this->assertSame($matching_identifier ?? Identifier::NULL, $actual_identifier);
     }

Here is the call graph for this function:

◆ testSlotsForElementWithoutCondition()

ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest::testSlotsForElementWithoutCondition	(	string	$element_name,
		array	$expected_identifiers
	)

Definition at line 279 of file ElementHelperTest.php.

References ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockConditionChecker(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockHandler(), ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockNavigatorFactory(), and ILIAS\MetaData\Vocabularies\Slots\ElementHelperTest\getMockPathFactory().

      : void {
         $helper = new ElementHelper(
             $this->getMockHandler('to ' . $element_name, $expected_identifiers),
             $this->getMockPathFactory(),
             $this->getMockNavigatorFactory(),
             $this->getMockConditionChecker()
         );
         $element = self::getMockElement($element_name);
 
         $actual_identifiers = iterator_to_array($helper->slotsForElementWithoutCondition($element));
 
         $this->assertSame($expected_identifiers, $actual_identifiers);
     }

Here is the call graph for this function:

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

components/ILIAS/MetaData/tests/Vocabularies/Slots/ElementHelperTest.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ findElementOfConditionProvider()

◆ getMockConditionChecker()

◆ getMockElement()

◆ getMockHandler()

◆ getMockNavigatorFactory()

◆ getMockPathFactory()

◆ potentialSlotForElementByConditionProvider()

◆ slotsForElementProvider()

◆ slotsForElementWithoutConditionProvider()

◆ testFindElementOfCondition()

◆ testPotentialSlotForElementByCondition()

◆ testSlotForElement()

◆ testSlotsForElementWithoutCondition()