From 925ac8ee490da9537aedc46b3eba1143dd13c408 Mon Sep 17 00:00:00 2001
From: Christoph Ludolf <ludolf@leifos.de>
Date: Thu, 14 Nov 2024 14:32:58 +0100
Subject: [PATCH] Tracking: fill interfaces, add info objects

---
 .../Info/CombinedInfoInterface.php            | 31 +++++++++++++++++++
 .../CombinedInfoIteratorInterface.php         | 10 ++++--
 .../Info/Iterator/LPInfoIteratorInterface.php | 10 ++++--
 .../Iterator/ObjectInfoIteratorInterface.php  | 10 ++++--
 ...ratorInterface.php => LPInfoInterface.php} | 11 ++++---
 .../Info/ObjectInfoInterface.php              | 30 ++++++++++++++++++
 .../DataRetrieval/Info/ViewInfoInterface.php  |  9 ++++++
 .../PropertyListBuilderInterface.php          |  5 +++
 .../PropertyListFactoryInterface.php          |  3 ++
 .../PropertyList/PropertyListInterface.php    | 16 +++++++++-
 .../Tracking/classes/View/ViewInterface.php   |  9 ++++++
 11 files changed, 133 insertions(+), 11 deletions(-)
 create mode 100644 components/ILIAS/Tracking/classes/View/DataRetrieval/Info/CombinedInfoInterface.php
 rename components/ILIAS/Tracking/classes/View/DataRetrieval/Info/{Iterator/IteratorInterface.php => LPInfoInterface.php} (74%)
 create mode 100644 components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ObjectInfoInterface.php

diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/CombinedInfoInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/CombinedInfoInterface.php
new file mode 100644
index 000000000000..c814f161e735
--- /dev/null
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/CombinedInfoInterface.php
@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * This file is part of ILIAS, a powerful learning management system
+ * published by ILIAS open source e-Learning e.V.
+ *
+ * ILIAS is licensed with the GPL-3.0,
+ * see https://www.gnu.org/licenses/gpl-3.0.en.html
+ * You should have received a copy of said license along with the
+ * source code, too.
+ *
+ * If this is not the case or you just want to try ILIAS, you'll find
+ * us at:
+ * https://www.ilias.de
+ * https://github.com/ILIAS-eLearning
+ *
+ *********************************************************************/
+
+declare(strict_types=0);
+
+namespace ILIAS\Tracking\View\DataRetrieval\Info;
+
+use ILIAS\Tracking\View\DataRetrieval\Info\LPInfoInterface;
+use ILIAS\Tracking\View\DataRetrieval\Info\ObjectInfoInterface;
+
+interface CombinedInfoInterface
+{
+    public function getLPInfo(): LPInfoInterface;
+
+    public function getObjectInfo(): ObjectInfoInterface;
+}
diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/CombinedInfoIteratorInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/CombinedInfoIteratorInterface.php
index 4cc4be67268a..7a5ee14d1997 100644
--- a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/CombinedInfoIteratorInterface.php
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/CombinedInfoIteratorInterface.php
@@ -20,8 +20,14 @@
 
 namespace ILIAS\Tracking\View\DataRetrieval\Info\Iterator;
 
-use ILIAS\Tracking\View\DataRetrieval\Info\Iterator\IteratorInterface as InfoIteratorInterface;
+use Iterator;
+use ILIAS\Tracking\View\DataRetrieval\Info\CombinedInfoInterface;
 
-interface CombinedInfoIteratorInterface extends InfoIteratorInterface
+interface CombinedInfoIteratorInterface extends Iterator
 {
+    public function current(): CombinedInfoInterface;
+    public function key(): int;
+    public function valid(): bool;
+    public function rewind(): void;
+    public function next(): void;
 }
diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/LPInfoIteratorInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/LPInfoIteratorInterface.php
index 2bdd2b3ac291..6c3af5a92281 100644
--- a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/LPInfoIteratorInterface.php
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/LPInfoIteratorInterface.php
@@ -20,8 +20,14 @@
 
 namespace ILIAS\Tracking\View\DataRetrieval\Info\Iterator;
 
-use ILIAS\Tracking\View\DataRetrieval\Info\Iterator\IteratorInterface as InfoIteratorInterface;
+use Iterator;
+use ILIAS\Tracking\View\DataRetrieval\Info\LPInfoInterface;
 
-interface LPInfoIteratorInterface extends InfoIteratorInterface
+interface LPInfoIteratorInterface extends Iterator
 {
+    public function current(): LPInfoInterface;
+    public function key(): int;
+    public function valid(): bool;
+    public function rewind(): void;
+    public function next(): void;
 }
diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/ObjectInfoIteratorInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/ObjectInfoIteratorInterface.php
index 0b08c3be1a7f..87bb2ff367ba 100644
--- a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/ObjectInfoIteratorInterface.php
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/ObjectInfoIteratorInterface.php
@@ -20,8 +20,14 @@
 
 namespace ILIAS\Tracking\View\DataRetrieval\Info\Iterator;
 
-use ILIAS\Tracking\View\DataRetrieval\Info\Iterator\IteratorInterface as InfoIteratorInterface;
+use ILIAS\Tracking\View\DataRetrieval\Info\ObjectInfoInterface;
+use Iterator;
 
-interface ObjectInfoIteratorInterface extends InfoIteratorInterface
+interface ObjectInfoIteratorInterface extends Iterator
 {
+    public function current(): ObjectInfoInterface;
+    public function key(): int;
+    public function valid(): bool;
+    public function rewind(): void;
+    public function next(): void;
 }
diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/IteratorInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/LPInfoInterface.php
similarity index 74%
rename from components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/IteratorInterface.php
rename to components/ILIAS/Tracking/classes/View/DataRetrieval/Info/LPInfoInterface.php
index 00cc93a9eab9..1a9ecaf23595 100644
--- a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/Iterator/IteratorInterface.php
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/LPInfoInterface.php
@@ -18,10 +18,13 @@
 
 declare(strict_types=0);
 
-namespace ILIAS\Tracking\View\DataRetrieval\Info\Iterator;
+namespace ILIAS\Tracking\View\DataRetrieval\Info;
 
-use Iterator;
-
-interface IteratorInterface extends Iterator
+interface LPInfoInterface
 {
+    public function getUserId(): int;
+
+    public function getObjectId(): int;
+
+    public function getLPStatus(): int;
 }
diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ObjectInfoInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ObjectInfoInterface.php
new file mode 100644
index 000000000000..da7b3128486a
--- /dev/null
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ObjectInfoInterface.php
@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * This file is part of ILIAS, a powerful learning management system
+ * published by ILIAS open source e-Learning e.V.
+ *
+ * ILIAS is licensed with the GPL-3.0,
+ * see https://www.gnu.org/licenses/gpl-3.0.en.html
+ * You should have received a copy of said license along with the
+ * source code, too.
+ *
+ * If this is not the case or you just want to try ILIAS, you'll find
+ * us at:
+ * https://www.ilias.de
+ * https://github.com/ILIAS-eLearning
+ *
+ *********************************************************************/
+
+declare(strict_types=0);
+
+namespace ILIAS\Tracking\View\DataRetrieval\Info;
+
+interface ObjectInfoInterface
+{
+    public function getObjectId(): int;
+
+    public function getTitle(): string;
+
+    public function getDescription(): string;
+}
diff --git a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ViewInfoInterface.php b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ViewInfoInterface.php
index bed2454bc3c5..41e8e1d2a5cd 100644
--- a/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ViewInfoInterface.php
+++ b/components/ILIAS/Tracking/classes/View/DataRetrieval/Info/ViewInfoInterface.php
@@ -20,6 +20,15 @@
 
 namespace ILIAS\Tracking\View\DataRetrieval\Info;
 
+use ILIAS\Tracking\View\DataRetrieval\Info\Iterator\ObjectInfoIteratorInterface;
+use ILIAS\Tracking\View\DataRetrieval\Info\Iterator\LPInfoIteratorInterface;
+use ILIAS\Tracking\View\DataRetrieval\Info\Iterator\CombinedInfoIteratorInterface;
+
 interface ViewInfoInterface
 {
+    public function objectIterator(): ObjectInfoIteratorInterface;
+
+    public function lpInfoIterator(): LPInfoIteratorInterface;
+
+    public function combinedInfoIterator(): CombinedInfoIteratorInterface;
 }
diff --git a/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListBuilderInterface.php b/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListBuilderInterface.php
index d1b5e52ddfa9..b45462deeec9 100644
--- a/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListBuilderInterface.php
+++ b/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListBuilderInterface.php
@@ -20,6 +20,11 @@
 
 namespace ILIAS\Tracking\View\PropertyList;
 
+use ILIAS\Tracking\View\PropertyList\PropertyListInterface;
+
 interface PropertyListBuilderInterface
 {
+    public function withProperty(string $key, string $value): self;
+
+    public function getList(): PropertyListInterface;
 }
diff --git a/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListFactoryInterface.php b/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListFactoryInterface.php
index f6fadee0075b..e79d57855bac 100644
--- a/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListFactoryInterface.php
+++ b/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListFactoryInterface.php
@@ -20,6 +20,9 @@
 
 namespace ILIAS\Tracking\View\PropertyList;
 
+use ILIAS\Tracking\View\PropertyList\PropertyListBuilderInterface;
+
 interface PropertyListFactoryInterface
 {
+    public function builder(): PropertyListBuilderInterface;
 }
diff --git a/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListInterface.php b/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListInterface.php
index 1bda78b95a6e..762b55773674 100644
--- a/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListInterface.php
+++ b/components/ILIAS/Tracking/classes/View/PropertyList/PropertyListInterface.php
@@ -20,6 +20,20 @@
 
 namespace ILIAS\Tracking\View\PropertyList;
 
-interface PropertyListInterface
+use Countable;
+use Iterator;
+
+interface PropertyListInterface extends Countable, Iterator
 {
+    public function next(): void;
+
+    public function rewind(): void;
+
+    public function valid(): bool;
+
+    public function key(): string;
+
+    public function current(): string;
+
+    public function count(): int;
 }
diff --git a/components/ILIAS/Tracking/classes/View/ViewInterface.php b/components/ILIAS/Tracking/classes/View/ViewInterface.php
index f47e2a054d40..d1d1a107c79b 100644
--- a/components/ILIAS/Tracking/classes/View/ViewInterface.php
+++ b/components/ILIAS/Tracking/classes/View/ViewInterface.php
@@ -20,6 +20,15 @@
 
 namespace ILIAS\Tracking\View;
 
+use ILIAS\Tracking\View\PropertyList\PropertyListFactoryInterface;
+use ILIAS\Tracking\View\DataRetrieval\DataRetrievalInterface;
+use ILIAS\Tracking\View\Renderer\RendererInterface;
+
 interface ViewInterface
 {
+    public function dataRetrieval(): DataRetrievalInterface;
+
+    public function propertyList(): PropertyListFactoryInterface;
+
+    public function renderer(): RendererInterface;
 }