ilUIFilterRequestAdapter Class Reference

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 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

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 33 of file class.ilUIFilterRequestAdapter.php.

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

References $request.

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
bool	$non_asynch

Returns

string

Definition at line 85 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 43 of file class.ilUIFilterRequestAdapter.php.

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

References CMD_PARAMETER.

getFilterWithRequest()

ilUIFilterRequestAdapter::getFilterWithRequest

(

Filter\Standard

$filter

)

Get filter with request data.

Parameters

Filter\Standard

$filter

Returns

Filter\Standard

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

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

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

Here is the call graph for this function:

isInputRendered()

ilUIFilterRequestAdapter::isInputRendered

(

$input_id

)

Has an input field been rendered in current request?

Parameters

$input_id

Returns

bool

Definition at line 57 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;
    }

Field Documentation

$params

ilUIFilterRequestAdapter::$params

protected

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

$request

ilUIFilterRequestAdapter::$request

protected

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

Referenced by __construct().

CMD_PARAMETER

const ilUIFilterRequestAdapter::CMD_PARAMETER = "cmdFilter"

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

Referenced by getFilterCmd().

RENDER_INPUT_BASE

const ilUIFilterRequestAdapter::RENDER_INPUT_BASE = "__filter_status_"

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

---

The documentation for this class was generated from the following file:

• Services/UI/classes/class.ilUIFilterRequestAdapter.php