Collaboration diagram for ilDidacticTemplateSettingsTableFilter:

Public Member Functions
	__construct (string $target_url)

	init ()
	Init Filter. More...

	render ()

	filter (array $settings)

Protected Member Functions
	isFiltered (ilDidacticTemplateSetting $setting)

	getFilterValue (string $name)

	loadFilterValues ()

Protected Attributes
const	FILTER_ID = 'otpl_templates_table'

const	FILTER_NAME_ICON = 'icon'

const	FILTER_NAME_TITLE = 'title'

const	FILTER_NAME_TYPE = 'type'

const	FILTER_NAME_SCOPE = 'scope'

const	FILTER_NAME_ACTIVE = 'active'

const	FILTER_ON = 1

const	FILTER_OFF = 2

const	FILTER_GLOBAL = 1

const	FILTER_LOCAL = 2

Private Attributes
array	$input_activation_config

ilLanguage	$lng

Factory	$ui_factory

Renderer	$ui_renderer

ilUIService	$ui_service

string	$target_url

ILIAS UI Component Input Container Filter Filter	$filter = null

array	$filter_values = []

Detailed Description

Definition at line 8 of file class.ilDidacticTemplateSettingsTableFilter.php.

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateSettingsTableFilter::__construct ( string $target_url )

Definition at line 43 of file class.ilDidacticTemplateSettingsTableFilter.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ui_service = $DIC->uiService();
 
        $this->target_url = $target_url;
    }

References $DIC, $target_url, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ filter()

ilDidacticTemplateSettingsTableFilter::filter ( array $settings )

Parameters

ilDidacticTemplateSetting[] $settings

Returns: ilDidacticTemplateSetting[]

Definition at line 121 of file class.ilDidacticTemplateSettingsTableFilter.php.

                                           : array
    {
        $this->loadFilterValues();
 
        $filtered = [];
        foreach ($settings as $setting) {
            if ($this->isFiltered($setting)) {
                continue;
            }
            $filtered[] = $setting;
        }
 
        return $filtered;
    }

References ILIAS\LTI\ToolProvider\$settings, isFiltered(), and loadFilterValues().

Referenced by init(), isFiltered(), loadFilterValues(), ilDidacticTemplateSettingsTableGUI\parse(), and render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterValue()

ilDidacticTemplateSettingsTableFilter::getFilterValue ( string $name )

protected

Definition at line 195 of file class.ilDidacticTemplateSettingsTableFilter.php.

    {
        return $this->filter_values[$name] ?? null;
    }

References $name.

Referenced by isFiltered().

Here is the caller graph for this function:

◆ init()

ilDidacticTemplateSettingsTableFilter::init ( )

Init Filter.

Definition at line 58 of file class.ilDidacticTemplateSettingsTableFilter.php.

                          : void
    {
        $inputs[self::FILTER_NAME_ICON] = $this->ui_factory->input()->field()->select(
            $this->lng->txt('icon'),
            [
                self::FILTER_ON => $this->lng->txt('didactic_filter_with_icon'),
                self::FILTER_OFF => $this->lng->txt('didactic_filter_without_icon')
            ]
        );
 
        $inputs[self::FILTER_NAME_TITLE] = $this->ui_factory->input()->field()->text(
            $this->lng->txt('title')
        );
 
        $options = [];
        foreach (ilDidacticTemplateSettings::lookupAssignedObjectTypes() as $type) {
            $options[$type] = $this->lng->txt('objs_' . $type);
        }
        asort($options);
        $inputs[self::FILTER_NAME_TYPE] = $this->ui_factory->input()->field()->select(
            $this->lng->txt('type'),
            $options
        );
 
        $inputs[self::FILTER_NAME_SCOPE] = $this->ui_factory->input()->field()->select(
            $this->lng->txt('didactic_scope'),
            [
                self::FILTER_GLOBAL => $this->lng->txt('didactic_global'),
                self::FILTER_LOCAL => $this->lng->txt('didactic_local')
            ]
        );
 
        $inputs[self::FILTER_NAME_ACTIVE] = $this->ui_factory->input()->field()->select(
            $this->lng->txt('status'),
            [
                self::FILTER_ON => $this->lng->txt('active'),
                self::FILTER_OFF => $this->lng->txt('inactive')
            ]
        );
 
        $this->filter = $this->ui_service->filter()->standard(
            self::FILTER_ID,
            $this->target_url,
            $inputs,
            $this->input_activation_config,
            true,
            true
        );
    }

References ILIAS\UI\Implementation\Component\Input\$inputs, $type, filter(), FILTER_NAME_ACTIVE, FILTER_NAME_ICON, FILTER_NAME_SCOPE, FILTER_NAME_TITLE, FILTER_NAME_TYPE, ILIAS\Repository\lng(), and ilDidacticTemplateSettings\lookupAssignedObjectTypes().

Here is the call graph for this function:

◆ isFiltered()

ilDidacticTemplateSettingsTableFilter::isFiltered ( ilDidacticTemplateSetting $setting )

protected

Definition at line 136 of file class.ilDidacticTemplateSettingsTableFilter.php.

                                                                     : bool
    {
        if (!$this->filter->isActivated()) {
            return false;
        }
 
        $value = (string) $this->getFilterValue(self::FILTER_NAME_ICON);
        if ($value) {
            if ($value === (string) self::FILTER_ON && $setting->getIconHandler()->getAbsolutePath() === '') {
                return true;
            }
            if ($value === (string) self::FILTER_OFF && $setting->getIconHandler()->getAbsolutePath() !== '') {
                return true;
            }
        }
 
        $value = (string) $this->getFilterValue(self::FILTER_NAME_TITLE);
        if ($value !== '') {
            $title_string = ($setting->getPresentationTitle() . ' ' . $setting->getPresentationDescription());
            $title_string .= (' ' . $setting->getInfo());
            if (ilStr::strIPos($title_string, $value) === false) {
                return true;
            }
        }
 
        $value = (string) $this->getFilterValue(self::FILTER_NAME_TYPE);
        if ($value !== '') {
            $assigned = $setting->getAssignments();
            if (!in_array($value, $assigned)) {
                return true;
            }
        }
 
        $value = (string) $this->getFilterValue(self::FILTER_NAME_SCOPE);
        if ($value) {
            $is_local = (bool) count($setting->getEffectiveFrom());
 
            print_r($setting->getEffectiveFrom());
            if ($value === (string) self::FILTER_GLOBAL && $is_local) {
                return true;
            }
            if ($value === (string) self::FILTER_LOCAL && !$is_local) {
                return true;
            }
        }
 
        $value = (string) $this->getFilterValue(self::FILTER_NAME_ACTIVE);
        if ($value) {
            if ($value === (string) self::FILTER_ON && !$setting->isEnabled()) {
                return true;
            }
            if ($value === (string) self::FILTER_OFF && $setting->isEnabled()) {
                return true;
            }
        }
 
        return false;
    }

References filter(), ilDidacticTemplateSetting\getAssignments(), ilDidacticTemplateSetting\getEffectiveFrom(), getFilterValue(), ilDidacticTemplateSetting\getIconHandler(), ilDidacticTemplateSetting\getInfo(), ilDidacticTemplateSetting\getPresentationDescription(), ilDidacticTemplateSetting\getPresentationTitle(), ilDidacticTemplateSetting\isEnabled(), and ilStr\strIPos().

Referenced by filter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFilterValues()

ilDidacticTemplateSettingsTableFilter::loadFilterValues ( )

protected

Definition at line 200 of file class.ilDidacticTemplateSettingsTableFilter.php.

                                         : void
    {
        foreach ($this->filter->getInputs() as $name => $input) {
            $this->filter_values[$name] = $input->getValue();
        }
    }

References $name, and filter().

Referenced by filter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilDidacticTemplateSettingsTableFilter::render ( )

Definition at line 108 of file class.ilDidacticTemplateSettingsTableFilter.php.

                            : string
    {
        return $this->ui_renderer->render(
            [
                $this->filter
            ]
        );
    }

References filter().

Here is the call graph for this function:

Field Documentation

◆ $filter

ILIAS UI Component Input Container Filter Filter ilDidacticTemplateSettingsTableFilter::$filter = null

private

Definition at line 36 of file class.ilDidacticTemplateSettingsTableFilter.php.

◆ $filter_values

array ilDidacticTemplateSettingsTableFilter::$filter_values = []

private

Definition at line 41 of file class.ilDidacticTemplateSettingsTableFilter.php.

◆ $input_activation_config

array ilDidacticTemplateSettingsTableFilter::$input_activation_config

private

Initial value:

= [
        self::FILTER_NAME_ICON => false,
        self::FILTER_NAME_TITLE => true,
        self::FILTER_NAME_TYPE => true,
        self::FILTER_NAME_SCOPE => false,
        self::FILTER_NAME_ACTIVE => true
    ]