ILIAS  trunk Revision v11.0_alpha-1702-gfd3ecb7f852
•All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
NavigatorInterface.php
Go to the documentation of this file.
1 <?php
2 
19 declare(strict_types=1);
20 
21 namespace ILIAS\MetaData\Paths\Navigator;
22 
23 use ILIAS\MetaData\Elements\ElementInterface;
24 
25 interface NavigatorInterface extends BaseNavigatorInterface
26 {
27  public function nextStep(): ?NavigatorInterface;
28 
29  public function previousStep(): ?NavigatorInterface;
30 
39  public function elementsAtFinalStep(): \Generator;
40 
46  public function lastElementAtFinalStep(): ?ElementInterface;
47 
56  public function elements(): \Generator;
57 
63  public function lastElement(): ?ElementInterface;
64 }
ILIAS\MetaData\Paths\Navigator\NavigatorInterface\lastElement
lastElement()
Returns only the first element at the current step, if one exists.
ILIAS\MetaData\Paths\Navigator\NavigatorInterface\elements
elements()
Returns the elements at the current step in the path.
ILIAS\MetaData\Paths\Navigator\NavigatorInterface\nextStep
nextStep()
Returns null if there is no next step.
ILIAS\MetaData\Paths\Navigator\NavigatorInterface\elementsAtFinalStep
elementsAtFinalStep()
Returns the elements at the end of the path.
ILIAS\MetaData\Paths\Navigator\NavigatorInterface\lastElementAtFinalStep
lastElementAtFinalStep()
Returns only the first element of those at the end of the path, if one exists.