Filter administration for containers. More...

Collaboration diagram for ilContainerFilterAdminGUI:

Public Member Functions
	__construct (ilContainerGUI $container_gui)

	executeCommand ()

Protected Member Functions
	selectFields ()

	getFieldSelectionForm ()

	saveFields ()

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$main_tpl

ilToolbarGUI	$toolbar

ILIAS DI UIServices	$ui

ilContainerFilterService	$container_filter_service

int	$ref_id

ilContainerGUI	$container_gui

ServerRequestInterface	$request

Detailed Description

Filter administration for containers.

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

Definition at line 27 of file class.ilContainerFilterAdminGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerFilterAdminGUI::__construct ( ilContainerGUI $container_gui )

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->container_gui = $container_gui;
        $this->ref_id = $this->container_gui->getObject()->getRefId();
        $this->toolbar = $DIC["ilToolbar"];
        $this->ui = $DIC->ui();
        $this->request = $DIC->http()->request();
        // not sure if this should go to dic someday, currently this is not an internal API
        $this->container_filter_service = new ilContainerFilterService();
    }

References $container_gui, $DIC, ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilContainerFilterAdminGUI::executeCommand ( )

Definition at line 55 of file class.ilContainerFilterAdminGUI.php.

                                    : void
    {
        $ctrl = $this->ctrl;
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("show");
 
        switch ($next_class) {
            default:
                if (in_array($cmd, ["show", "selectFields", "saveFields"])) {
                    $this->$cmd();
                }
        }
    }

References $ctrl, ilCtrl\getCmd(), and ilCtrl\getNextClass().

Here is the call graph for this function:

◆ getFieldSelectionForm()

ilContainerFilterAdminGUI::getFieldSelectionForm ( )

protected

Definition at line 117 of file class.ilContainerFilterAdminGUI.php.

                                              : Standard
    {
        $ui = $this->ui;
        $f = $ui->factory();
        $ctrl = $this->ctrl;
        $lng = $this->lng;
 
        $adv = $this->container_filter_service->advancedMetadata();
        $service = $this->container_filter_service;
 
 
        $fields[] = [];
 
 
        // current filter set
        $current_filters = $service->data()->getFilterSetForRefId($this->ref_id);
 
        // standar set
        $selected = [];
        $options = [];
        foreach ($service->standardSet()->getFields() as $field) {
            $options[$field->getFieldId()] = $service->util()->getContainerFieldTitle($field->getRecordSetId(), $field->getFieldId());
            if ($current_filters->has(0, $field->getFieldId())) {
                $selected[] = $field->getFieldId();
            }
        }
 
        $fields[0] = $f->input()->field()->multiSelect($lng->txt("cont_std_record_title"), $options)
            ->withRequired(false)
            ->withValue($selected);
 
        // ADV MD record sets
        foreach ($adv->getAvailableRecordSets() as $rs) {
            $options = [];
            $selected = [];
            foreach ($adv->getFields($rs->getRecordId()) as $fl) {
                $options[$fl->getFieldId()] = $fl->getTitle();
                if ($current_filters->has($rs->getRecordId(), $fl->getFieldId())) {
                    $selected[] = $fl->getFieldId();
                }
            }
            $fields[$rs->getRecordId()] = $f->input()->field()->multiSelect($rs->getTitle(), $options, $rs->getDescription())
                ->withRequired(false)
                ->withValue($selected);
        }
 
        // Standard filter fields
        $section1 = $f->input()->field()->section($fields, $lng->txt("cont_filter_fields"), "");
 
        $form_action = $ctrl->getLinkTarget($this, "saveFields", "", false, false);
        return $f->input()->container()->form()->standard($form_action, ["sec" => $section1]);
    }

References $container_filter_service, $ctrl, Vendor\Package\$f, $lng, $service, $ui, ilCtrl\getLinkTarget(), and ilLanguage\txt().

Referenced by saveFields(), and selectFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveFields()

ilContainerFilterAdminGUI::saveFields ( )

protected

Definition at line 170 of file class.ilContainerFilterAdminGUI.php.

                                   : void
    {
        $request = $this->request;
        $service = $this->container_filter_service;
        $form = $this->getFieldSelectionForm();
        $lng = $this->lng;
        $ctrl = $this->ctrl;
 
        $fields = [];
        if ($request->getMethod() === "POST") {
            $form = $form->withRequest($request);
            $data = $form->getData();
 
            // ADV MD record sets
            if (is_array($data["sec"])) {
                foreach ($data["sec"] as $rec_id => $ids) {
                    if (is_array($ids)) {
                        foreach ($ids as $field_id) {
                            $fields[] = $service->field($rec_id, $field_id);
                        }
                    }
                }
            }
            $this->main_tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
            $service->data()->saveFilterSetForRefId($this->ref_id, $service->set($fields));
        }
        $ctrl->redirect($this, "");
    }

References $container_filter_service, $ctrl, $data, $lng, $request, $service, getFieldSelectionForm(), ilCtrl\redirect(), and ilLanguage\txt().

Here is the call graph for this function:

◆ selectFields()

ilContainerFilterAdminGUI::selectFields ( )

protected

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

                                     : void
    {
        $main_tpl = $this->main_tpl;
        $ui = $this->ui;
        $r = $ui->renderer();
        $form = $this->getFieldSelectionForm();
        $main_tpl->setContent($r->render($form));
    }