ks filter: FilterInput interface

src/UI/Component/Input/Field/FilterInput.php

@@ -0,0 +1,33 @@
+<?php
+
+/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */
+
+namespace ILIAS\UI\Component\Input\Field;
+
+/**
+ * This interface must be implemented by all Inputs that support
+ * Filter Containers.
+ *
+ * These inputs need to implement an additional rendering in the
+ * FilterContextRenderer and provide an additional method that allows
+ * the Filter to show the current selected values within the Filter component.
+ *
+ * @author [email protected]
+ */
+interface FilterInput extends Input {
+
+	/**
+	 * Get update code
+	 *
+	 * This method has to return JS code that calls
+	 * il.UI.filter.handleChange(event, '$id', string_value);
+	 * - initially "onload" and
+	 * - on every input change.
+	 * It must pass a readable string representation of its value in parameter 'string_value'.
+	 *
+	 * @param \Closure $binder
+	 * @return string
+	 */
+	public function getUpdateOnLoadCode(): \Closure;
+
+}

src/UI/Component/Input/Field/Text.php

@@ -7,6 +7,6 @@
 /**
  * This describes text inputs.
  */
-interface Text extends Input {
+interface Text extends FilterInput {
 
 }

src/UI/Implementation/Component/Input/Container/Filter/Filter.php

@@ -101,7 +101,7 @@ public function __construct($toggle_action_on, $toggle_action_off, $expand_actio
 		if (count($inputs) != count($is_input_rendered)) {
 			throw new \ArgumentCountError("Inputs and boolean values must be arrays of same size.");
 		} else {
-			$classes = [CI\Input\Field\Input::class];
+			$classes = ['\ILIAS\UI\Component\Input\Field\FilterInput'];
 			$this->checkArgListElements("input", $inputs, $classes);
 
 			// @todo: how to manage this dependency?

src/UI/Implementation/Component/Input/Field/FilterContextRenderer.php

@@ -188,12 +188,7 @@ protected function renderInputField(Template $tpl, Input $input) {
 					$tpl->parseCurrentBlock();
 				}
 
-				$input = $input->withAdditionalOnLoadCode(function ($id) {
-					$code = "$('#$id').on('input', function(event) {
-							il.UI.filter.handleChange(event, '$id', $('#$id').val());
-						});";
-					return $code;
-				});
+				$input = $input->withAdditionalOnLoadCode($input->getUpdateOnLoadCode());
 				$this->maybeRenderId($input, $tpl);
 				break;
 		}

src/UI/Implementation/Component/Input/Field/Text.php

@@ -29,4 +29,17 @@ protected function isClientSideValueOk($value) {
 	protected function getConstraintForRequirement() {
 		return $this->validation_factory->hasMinLength(1);
 	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function getUpdateOnLoadCode(): \Closure
+	{
+		return function ($id) {
+			$code = "$('#$id').on('input', function(event) {
+				il.UI.filter.handleChange(event, '$id', $('#$id').val());
+			});";
+			return $code;
+		};
+	}
 }