Request adapter for filter. More...

Collaboration diagram for ilUIFilterRequestAdapter:

Public Member Functions
	__construct (ServerRequestInterface $request)
	Constructor. More...

	getFilterCmd ()
	Get filter command. More...

	isInputRendered ($input_id)
	Has an input field been rendered in current post request? More...

	getFilterWithRequest (Filter\Standard $filter)
	Get filter with request data. More...

	getAction (string $base_action, string $filter_cmd, $non_asynch=false)
	Get action for filter command. More...

Data Fields
const	CMD_PARAMETER = "cmdFilter"

const	RENDER_INPUT_BASE = "__filter_status_"

Protected Attributes
	$request

	$params

	$post

Detailed Description

Request adapter for filter.

Author: killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 14 of file class.ilUIFilterRequestAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

ilUIFilterRequestAdapter::__construct ( ServerRequestInterface $request )

Constructor.

Definition at line 39 of file class.ilUIFilterRequestAdapter.php.

References $request.

     {
         $this->request = $request;
         $this->params = $this->request->getQueryParams();
         $this->post = $this->request->getParsedBody();
     }

Member Function Documentation

◆ getAction()

ilUIFilterRequestAdapter::getAction	(	string	$base_action,
		string	$filter_cmd,
			$non_asynch = `false`
	)

Get action for filter command.

Parameters

string	$base_action
string	$filter_cmd

Returns: string

Definition at line 91 of file class.ilUIFilterRequestAdapter.php.

                                                                                             : string
     {
         if ($non_asynch) {
             $base_action = str_replace("cmdMode=asynch", "", $base_action);
         }
         return $base_action . "&" . self::CMD_PARAMETER . "=" . $filter_cmd;
     }

◆ getFilterCmd()

ilUIFilterRequestAdapter::getFilterCmd ( )

Get filter command.

Returns: string

Definition at line 50 of file class.ilUIFilterRequestAdapter.php.

                                    : string
     {
         if (isset($this->params[self::CMD_PARAMETER])) {
             return (string) $this->params[self::CMD_PARAMETER];
         }
         return "";
     }

◆ getFilterWithRequest()

ilUIFilterRequestAdapter::getFilterWithRequest ( Filter\Standard $filter )

Get filter with request data.

Parameters

Filter\Standard $filter

Returns: Filter

Definition at line 79 of file class.ilUIFilterRequestAdapter.php.

References ILIAS\UI\Component\Input\Container\Filter\Filter\withRequest().

                                                                   : Filter\Standard
     {
         return $filter->withRequest($this->request);
     }

Here is the call graph for this function:

◆ isInputRendered()

ilUIFilterRequestAdapter::isInputRendered ( $input_id )

Has an input field been rendered in current post request?

Parameters

$input_id

Returns: bool

Definition at line 64 of file class.ilUIFilterRequestAdapter.php.

                                                : bool
     {
         if (isset($this->params[self::RENDER_INPUT_BASE . $input_id]) &&
             $this->params[self::RENDER_INPUT_BASE . $input_id] === "1") {
             return true;
         }
         return false;
     }