Filter service. More...

Collaboration diagram for ilUIFilterService:

Public Member Functions
	__construct (ilUIService $service, ilUIServiceDependencies $deps)
	Constructor. More...

	standard (string $filter_id, string $base_action, array $inputs, array $is_input_initially_rendered, bool $is_activated=false, bool $is_expanded=false)
	Get standard filter instance. More...

	getData (Filter\Standard $filter)
	Get data. More...

Data Fields
const	CMD_TOGGLE_ON = "toggleOn"

const	CMD_TOGGLE_OFF = "toggleOff"

const	CMD_EXPAND = "expand"

const	CMD_COLLAPSE = "collapse"

const	CMD_APPLY = "apply"

const	CMD_RESET = "reset"

Protected Member Functions
	writeFilterStatusToSession ($filter_id, $inputs)
	Write filter status to session (filter activated/expanded, inputs being rendered or not) More...

	handleRendering ($filter_id, $inputs)
	Handle rendering of inputs to session. More...

	handleReset (string $filter_id)
	Handle reset command. More...

	handleApplyAndToggle (string $filter_id, Filter\Standard $filter)
	Handle apply and toggle commands. More...

Protected Attributes
	$service

	$ui

	$session

	$request

Detailed Description

Filter service.

Wraps around KS filter container.

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

Definition at line 15 of file class.ilUIFilterService.php.

Constructor & Destructor Documentation

◆ __construct()

ilUIFilterService::__construct	(	ilUIService	$service,
		ilUIServiceDependencies	$deps
	)

Constructor.

Parameters

ilUIService	$service
ilUIServiceDependencies	$deps

Definition at line 51 of file class.ilUIFilterService.php.

    {
        $this->service = $service;
        $this->session = $deps->getSession();
        $this->request = $deps->getRequest();
        $this->ui = $deps->ui();
    }

References $service, ilUIServiceDependencies\getRequest(), ilUIServiceDependencies\getSession(), ilUIServiceDependencies\ui(), and ui().

Here is the call graph for this function:

Member Function Documentation

◆ getData()

ilUIFilterService::getData ( Filter\Standard $filter )

Get data.

Parameters

Filter\Standard $filter

Returns: array|null

Definition at line 145 of file class.ilUIFilterService.php.

                                                     : ?array
    {
        $filter_data = null;
        if ($filter->isActivated()) {
            foreach ($filter->getInputs() as $k => $i) {
                $filter_data[$k] = $i->getValue();
            }
        }
        return $filter_data;
    }

References $i.

◆ handleApplyAndToggle()

ilUIFilterService::handleApplyAndToggle	(	string	$filter_id,
		Filter\Standard	$filter
	)

protected

Handle apply and toggle commands.

Parameters

string	$filter_id
Filter\Standard	$filter

Returns: Filter\Standard

Definition at line 225 of file class.ilUIFilterService.php.

                                                                                        : Filter\Standard
    {
        if ((in_array(
            $this->request->getFilterCmd(),
            [self::CMD_APPLY, self::CMD_TOGGLE_ON, self::CMD_TOGGLE_OFF]
        ))) {
            $filter = $this->request->getFilterWithRequest($filter);
 
            // always expand the filter, when it is activated with empty input values
            if ($this->request->getFilterCmd() == self::CMD_TOGGLE_ON) {
                $result = $filter->getData();
                $expand = true;
                foreach ($result as $k => $v) {
                    if (!empty($v) || $v === 0 || $v === "0") {
                        $expand = false;
                    }
                }
                if ($expand) {
                    $this->session->writeExpanded($filter_id, true);
                    $filter = $filter->withExpanded();
                }
            }
 
            foreach ($filter->getInputs() as $input_id => $i) {
                $this->session->writeValue($filter_id, $input_id, $i->getValue());
            }
        }
        return $filter;
    }

References $i, and $result.

◆ handleRendering()

ilUIFilterService::handleRendering	(	$filter_id,
		$inputs
	)

protected

Handle rendering of inputs to session.

Parameters

string	$filter_id
array	$inputs

Definition at line 193 of file class.ilUIFilterService.php.

    {
        foreach ($inputs as $input_id => $i) {
            if ($this->request->isInputRendered($input_id)) {
                $this->session->writeRendered($filter_id, $input_id, true);
            } else {
                $this->session->writeRendered($filter_id, $input_id, false);
            }
        }
    }

References $i.

◆ handleReset()

ilUIFilterService::handleReset ( string $filter_id )

protected

Handle reset command.

Parameters

string $filter_id

Definition at line 209 of file class.ilUIFilterService.php.

    {
        // clear session, if reset is pressed
        if ($this->request->getFilterCmd() == self::CMD_RESET) {
            $this->session->reset($filter_id);
        }
    }

◆ standard()

ilUIFilterService::standard	(	string	$filter_id,
		string	$base_action,
		array	$inputs,
		array	$is_input_initially_rendered,
		bool	$is_activated = `false`,
		bool	$is_expanded = `false`
	)

Get standard filter instance.

Parameters

string	$filter_id
string	$base_action
FilterInput[]	$inputs
bool[]	$is_input_initially_rendered
bool	$is_activated
bool	$is_expanded

Returns: Filter\Standard

Definition at line 71 of file class.ilUIFilterService.php.

      : Filter\Standard {
        $ui = $this->ui->factory();
 
        // write expand, activation, rendered inputs info to session
        $this->writeFilterStatusToSession($filter_id, $inputs);
 
        // handle the reset command
        $this->handleReset($filter_id);
 
        // determine activation/expand status
        $is_activated = $this->session->isActivated($filter_id, $is_activated);
        $is_expanded = $this->session->isExpanded($filter_id, $is_expanded);
 
        // put data from session into filter
        $inputs_with_session_data = [];
        $is_input_initially_rendered_with_session = [];
 
        if (count($inputs) != count($is_input_initially_rendered)) {
            throw new \ArgumentCountError(
                "Inputs and boolean values for initial rendering must be arrays of same size."
            );
        }
 
        foreach ($inputs as $input_id => $i) {
            // rendering information
            $rendered =
                $this->session->isRendered($filter_id, $input_id, current($is_input_initially_rendered));
            $is_input_initially_rendered_with_session[] = $rendered;
            next($is_input_initially_rendered);
 
            // values
            $val = $this->session->getValue($filter_id, $input_id);
            if (!is_null($val)) {
                try {
                    $i = $i->withValue($val);
                } catch (InvalidArgumentException $e) {
                }
            }
            $inputs_with_session_data[$input_id] = $i;
        }
 
        // get the filter
        $filter = $ui->input()->container()->filter()->standard(
            $this->request->getAction($base_action, self::CMD_TOGGLE_ON, true),
            $this->request->getAction($base_action, self::CMD_TOGGLE_OFF, true),
            $this->request->getAction($base_action, self::CMD_EXPAND),
            $this->request->getAction($base_action, self::CMD_COLLAPSE),
            $this->request->getAction($base_action, self::CMD_APPLY, true),
            $this->request->getAction($base_action, self::CMD_RESET, true),
            $inputs_with_session_data,
            $is_input_initially_rendered_with_session,
            $is_activated,
            $is_expanded
        );
 
        // handle apply and toggle commands
        $filter = $this->handleApplyAndToggle($filter_id, $filter);
 
        return $filter;
    }

◆ writeFilterStatusToSession()

ilUIFilterService::writeFilterStatusToSession	(	$filter_id,
		$inputs
	)

protected

Write filter status to session (filter activated/expanded, inputs being rendered or not)

Parameters

string	$filter_id
array	$inputs

Definition at line 161 of file class.ilUIFilterService.php.

    {
        if ($this->request->getFilterCmd() == self::CMD_TOGGLE_ON) {
            $this->handleRendering($filter_id, $inputs);
            $this->session->writeActivated($filter_id, true);
        }
 
        if ($this->request->getFilterCmd() == self::CMD_TOGGLE_OFF) {
            $this->handleRendering($filter_id, $inputs);
            $this->session->writeActivated($filter_id, false);
        }
 
        if ($this->request->getFilterCmd() == self::CMD_EXPAND) {
            $this->session->writeExpanded($filter_id, true);
        }
 
        if ($this->request->getFilterCmd() == self::CMD_COLLAPSE) {
            $this->session->writeExpanded($filter_id, false);
        }
 
        if ($this->request->getFilterCmd() == self::CMD_APPLY) {
            $this->handleRendering($filter_id, $inputs);
            // always activate the filter when it is applied
            $this->session->writeActivated($filter_id, true);
        }
    }