UI: fix backwards compatibility for Data/Table backport

The method isClientSideValueOk changing from protected to public made plugins break that implemented their own inputs. When switching back the method to public, unit tests fail, indicating that we cross class hierarchies when calling the method. This was due to the fact that we indeed had two different methods isClientSideValueOk, one from the original input hierarchy, one from a trait for groups. These are reconciled now and thus the method can be protected again.
ILIAS-eLearning · May 16, 2024 · f82125c · f82125c
1 parent cc5131a
commit f82125c
Show file tree

Hide file tree

Showing 23 changed files with 36 additions and 22 deletions.
diff --git a/src/UI/Implementation/Component/Input/Field/Checkbox.php b/src/UI/Implementation/Component/Input/Field/Checkbox.php
@@ -51,7 +51,7 @@ protected function getConstraintForRequirement(): ?Constraint
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if ($value == "checked" || $value === "" || is_bool($value)) {
             return true;

diff --git a/src/UI/Implementation/Component/Input/Field/DateTime.php b/src/UI/Implementation/Component/Input/Field/DateTime.php
@@ -174,7 +174,7 @@ public function getTimeOnly(): bool
         return $this->with_time_only;
     }
 
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return is_string($value);
     }

diff --git a/src/UI/Implementation/Component/Input/Field/Duration.php b/src/UI/Implementation/Component/Input/Field/Duration.php
@@ -276,7 +276,7 @@ public function getTimezone(): ?string
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return true;
     }

diff --git a/src/UI/Implementation/Component/Input/Field/File.php b/src/UI/Implementation/Component/Input/Field/File.php
@@ -195,7 +195,7 @@ function ($txt, $value) {
         );
     }
 
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if (!is_array($value)) {
             return false;

diff --git a/src/UI/Implementation/Component/Input/Field/Group.php b/src/UI/Implementation/Component/Input/Field/Group.php
@@ -154,4 +154,10 @@ protected function getDataFactory(): DataFactory
     {
         return $this->data_factory;
     }
+
+    /** ATTENTION: @see GroupInternals::_isClientSideValueOk() */
+    protected function isClientSideValueOk($value): bool
+    {
+        return $this->_isClientSideValueOk($value);
+    }
 }
diff --git a/src/UI/Implementation/Component/Input/Field/Hidden.php b/src/UI/Implementation/Component/Input/Field/Hidden.php
@@ -46,7 +46,7 @@ protected function getConstraintForRequirement(): ?Constraint
         return null;
     }
 
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return true;
     }

diff --git a/src/UI/Implementation/Component/Input/Field/Link.php b/src/UI/Implementation/Component/Input/Field/Link.php
@@ -85,7 +85,7 @@ protected function addTransformation(): void
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return true;
     }

diff --git a/src/UI/Implementation/Component/Input/Field/MultiSelect.php b/src/UI/Implementation/Component/Input/Field/MultiSelect.php
@@ -61,7 +61,7 @@ public function getOptions(): array
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if (is_null($value)) {
             return true;

diff --git a/src/UI/Implementation/Component/Input/Field/Numeric.php b/src/UI/Implementation/Component/Input/Field/Numeric.php
@@ -57,7 +57,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return is_numeric($value) || $value === "" || $value === null;
     }

diff --git a/src/UI/Implementation/Component/Input/Field/OptionalGroup.php b/src/UI/Implementation/Component/Input/Field/OptionalGroup.php
@@ -51,7 +51,7 @@ protected function getConstraintForRequirement(): ?Constraint
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if ($value === null) {
             return true;

diff --git a/src/UI/Implementation/Component/Input/Field/Password.php b/src/UI/Implementation/Component/Input/Field/Password.php
@@ -61,7 +61,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return is_string($value);
     }

diff --git a/src/UI/Implementation/Component/Input/Field/Radio.php b/src/UI/Implementation/Component/Input/Field/Radio.php
@@ -49,7 +49,7 @@ class Radio extends FormInput implements C\Input\Field\Radio
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return ($value === '' || array_key_exists($value, $this->getOptions()));
     }

diff --git a/src/UI/Implementation/Component/Input/Field/Select.php b/src/UI/Implementation/Component/Input/Field/Select.php
@@ -61,7 +61,7 @@ public function getOptions(): array
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return in_array($value, array_keys($this->options)) || $value == "";
     }

diff --git a/src/UI/Implementation/Component/Input/Field/SwitchableGroup.php b/src/UI/Implementation/Component/Input/Field/SwitchableGroup.php
@@ -68,7 +68,7 @@ protected function getConstraintForRequirement(): ?Constraint
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if (!is_string($value) && !is_int($value)) {
             return false;

diff --git a/src/UI/Implementation/Component/Input/Field/Tag.php b/src/UI/Implementation/Component/Input/Field/Tag.php
@@ -132,7 +132,7 @@ protected function getConstraintForRequirement(): ?Constraint
     /**
      * @inheritDoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if ($this->getMaxTags() > 0) {
             $max_tags = $this->getMaxTags();

diff --git a/src/UI/Implementation/Component/Input/Field/Text.php b/src/UI/Implementation/Component/Input/Field/Text.php
@@ -70,7 +70,7 @@ public function getMaxLength(): ?int
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if (!is_string($value)) {
             return false;

diff --git a/src/UI/Implementation/Component/Input/Field/Textarea.php b/src/UI/Implementation/Component/Input/Field/Textarea.php
@@ -103,7 +103,7 @@ public function getMinLimit(): ?int
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return is_string($value);
     }

diff --git a/src/UI/Implementation/Component/Input/Field/Url.php b/src/UI/Implementation/Component/Input/Field/Url.php
@@ -97,7 +97,7 @@ public static function getURIChecker(): Closure
     /**
      * @inheritdoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         if (is_string($value) && trim($value) === "") {
             return true;

diff --git a/src/UI/Implementation/Component/Input/Group.php b/src/UI/Implementation/Component/Input/Group.php
@@ -121,9 +121,11 @@ protected function nameInputs(NameSource $source, string $parent_name): array
     }
 
     /**
-     * @inheritdoc
+     * ATTENTION: This is not the same as @see Input::isClientSideValueOk(),
+     * even if it had the same name. These are different symbols, as this trait
+     * is not in the hierarchy that defines the original isClientSideValueOk.
      */
-    public function isClientSideValueOk($value): bool
+    protected function _isClientSideValueOk($value): bool
     {
         if (!is_array($value)) {
             return false;

diff --git a/src/UI/Implementation/Component/Input/Input.php b/src/UI/Implementation/Component/Input/Input.php
@@ -116,7 +116,7 @@ public function withValue($value): self
      *
      * @param mixed $value
      */
-    abstract public function isClientSideValueOk($value): bool;
+    abstract protected function isClientSideValueOk($value): bool;
 
     /**
      * The error of the input as used in HTML.

diff --git a/src/UI/Implementation/Component/Input/ViewControl/FieldSelection.php b/src/UI/Implementation/Component/Input/ViewControl/FieldSelection.php
@@ -45,7 +45,7 @@ public function __construct(
         $this->internal_selection_signal = $signal_generator->create();
     }
 
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return is_null($value) || is_array($value);
     }

diff --git a/src/UI/Implementation/Component/Input/ViewControl/Group.php b/src/UI/Implementation/Component/Input/ViewControl/Group.php
@@ -98,4 +98,10 @@ protected function getDataFactory(): DataFactory
     {
         return $this->data_factory;
     }
+
+    /** ATTENTION: @see GroupInternals::_isClientSideValueOk() */
+    protected function isClientSideValueOk($value): bool
+    {
+        return $this->_isClientSideValueOk($value);
+    }
 }
diff --git a/src/UI/Implementation/Component/Input/ViewControl/GroupDecorator.php b/src/UI/Implementation/Component/Input/ViewControl/GroupDecorator.php
@@ -92,7 +92,7 @@ public function getContent(): Result
     /**
      * @inheritDoc
      */
-    public function isClientSideValueOk($value): bool
+    protected function isClientSideValueOk($value): bool
     {
         return $this->input_group->isClientSideValueOk($value);
     }