UI Filters (Implementation)

Services/Init/classes/class.ilInitialisation.php

@@ -1552,7 +1552,10 @@ protected static function initUIFramework(\ILIAS\DI\Container $c) {
 			return new ILIAS\UI\Implementation\Component\Input\Field\Factory($c["ui.signal_generator"]);
 		};
 		$c["ui.factory.input.container"] = function($c) {
-			return new ILIAS\UI\Implementation\Component\Input\Container\Factory();
+			return new ILIAS\UI\Implementation\Component\Input\Container\Factory(
+				$c["ui.signal_generator"],
+				$c["ui.factory.input.field"]
+			);
 		};
 		$c["ui.factory.panel.listing"] = function($c) {
 			return new ILIAS\UI\Implementation\Component\Panel\Listing\Factory();
@@ -1579,6 +1582,12 @@ protected static function initUIFramework(\ILIAS\DI\Container $c) {
 							, $c["ui.template_factory"]
 							, $c["lng"]
 							, $c["ui.javascript_binding"]
+							),
+						  new ILIAS\UI\Implementation\Component\Input\Field\FieldRendererFactory
+						  	($c["ui.factory"]
+						  	, $c["ui.template_factory"]
+						  	, $c["lng"]
+						  	, $c["ui.javascript_binding"]
 							)
 						)
 					)

Services/UI/README.md

@@ -0,0 +1,46 @@
+# UI Filter Service
+
+The filter service wraps the KS element of Standard Input Filters. It's main purpose is to manage the state of the filter and it's inputs in the user session.
+
+The basics methods are `$DIC->uiService()->filter()->standard()` to get a filter instance and `$DIC->uiService()->filter()->getData($filter)` to retrieve the data from the filter.
+
+This service is most probably a temporary solution until session and similar  dependencies are handled differently by the UI framework.
+
+```
+
+class fooGUI {
+
+	function showListAndFilter() {
+
+		//Step 0: Declare dependencies
+		global $DIC;
+		$ui = $DIC->ui()->factory();
+		$renderer = $DIC->ui()->renderer();
+
+		//Step 1: Define some input fields to plug into the filter.
+		$title_input = $ui->input()->field()->text("Title");
+		$select = $ui->input()->field()->select("Selection", ["one" => "One", "two" => "Two", "three" => "Three"]);
+		$with_def = $ui->input()->field()->text("With Default")->withValue("Def.Value");
+		$init_hide = $ui->input()->field()->text("Hidden initially");
+
+		//Step 2: Define the filter and attach the inputs.
+		$action = $DIC->ctrl()->getLinkTargetByClass("ilsystemstyledocumentationgui", "entries", "", true);
+		$filter = $DIC->uiService()->filter()->standard("filter_ID", $action, [
+			"title" => $title_input,
+			"select" => $select,
+			"with_def" => $with_def,
+			"init_hide" => $init_hide,
+		],
+			[true, true, true, false], true, true);
+
+		//Step 3: Get filter data
+		$filter_data = $DIC->uiService()->filter()->getData($filter);
+
+		//Step 4: Render the filter
+		return $renderer->render($filter)."Filter Data: ".print_r($filter_data, true);	
+	}
+
+}
+
+
+```

Services/UI/classes/class.ilUIFilterRequestAdapter.php

@@ -0,0 +1,98 @@
+<?php
+
+/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */
+
+use \ILIAS\UI\Component\Input\Container\Filter;
+use \Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * Request adapter for filter
+ *
+ * @author [email protected]
+ * @ingroup ServicesUI
+ */
+class ilUIFilterRequestAdapter
+{
+	const CMD_PARAMETER = "cmdFilter";
+	const RENDER_INPUT_BASE = "__filter_status_";
+
+	/**
+	 * @var ServerRequestInterface
+	 */
+	protected $request;
+
+	/**
+	 * query params
+	 * @var array
+	 */
+	protected $params;
+
+	/**
+	 * post data
+	 * @var array|null
+	 */
+	protected $post;
+
+	/**
+	 * Constructor
+	 */
+	public function __construct(ServerRequestInterface $request)
+	{
+		$this->request = $request;
+		$this->params = $this->request->getQueryParams();
+		$this->post = $this->request->getParsedBody();
+	}
+
+	/**
+	 * Get filter command
+	 * @return string
+	 */
+	public function getFilterCmd(): string
+	{
+		if (isset($this->params[self::CMD_PARAMETER]))
+		{
+			return (string) $this->params[self::CMD_PARAMETER];
+		}
+		return "";
+	}
+
+	/**
+	 * Has an input field been rendered in current post request?
+	 *
+	 * @param $input_id
+	 * @return bool
+	 */
+	public function isInputRendered($input_id): bool
+	{
+		if (isset($this->params[self::RENDER_INPUT_BASE . $input_id]) &&
+			$this->params[self::RENDER_INPUT_BASE . $input_id] === "1")
+		{
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Get filter with request data
+	 *
+	 * @param Filter\Standard $filter
+	 * @return Filter\Standard
+	 */
+	public function getFilterWithRequest(Filter\Standard $filter): Filter\Standard
+	{
+		return $filter->withRequest($this->request);
+	}
+
+	/**
+	 * Get action for filter command
+	 *
+	 * @param string $base_action
+	 * @param string $filter_cmd
+	 * @return string
+	 */
+	public function getAction(string $base_action, string $filter_cmd): string
+	{
+		return $base_action."&".self::CMD_PARAMETER."=".$filter_cmd;
+	}
+
+}