Collaboration diagram for ilBiblFieldFilterGUI:

Public Member Functions
	__construct (protected \ilBiblFactoryFacade $facade)
	ilBiblFieldFilterGUI constructor. More...

	renderInterruptiveModal ()

	executeCommand ()

	index ()

	edit ()

	update ()

	delete ()

	cancel ()
	cancel More...

	checkPermissionAndFail (string $permission)

	checkPermissionBoolAndReturn (string $permission)

Data Fields
const	FILTER_ID = 'filter_id'

const	CMD_STANDARD = 'index'

const	CMD_ADD = 'add'

const	CMD_CREATE = 'create'

const	CMD_CANCEL = 'cancel'

const	CMD_EDIT = 'edit'

const	CMD_UPDATE = 'update'

const	CMD_DELETE = 'delete'

const	CMD_RENDER_INTERRUPTIVE = 'renderInterruptiveModal'

const	CMD_APPLY_FILTER = 'applyFilter'

const	CMD_RESET_FILTER = 'resetFilter'

Protected Member Functions
	performCommand ()

	getFieldIdFromRequest ()

	add ()

	create ()

	initEditForm ()

	applyFilter ()

	resetFilter ()

Protected Attributes
Table	$table

ilGlobalTemplateInterface	$main_tpl

Private Member Functions
	saveFieldIdsInRequest ()

	getFieldFromRequest ()

	getFieldFilterFromRequest ()

Private Attributes
Services	$http

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs

ilAccessHandler	$access

Detailed Description

Class ilBiblFieldFilterGUI.

Author: Benjamin Seglias bs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 29 of file class.ilBiblFieldFilterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblFieldFilterGUI::__construct ( protected \ilBiblFactoryFacade $facade )

ilBiblFieldFilterGUI constructor.

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

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->table = new Table(
            $this,
            $this->facade
        );
        $this->http = $DIC['http'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->tabs = $DIC['ilTabs'];
        $this->lng = $DIC['lng'];
        $this->access = $DIC['ilAccess'];
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilBiblFieldFilterGUI::add ( )

protected

Definition at line 174 of file class.ilBiblFieldFilterGUI.php.

                            : void
    {
        $ilBiblSettingsFilterFormGUI = new ilBiblFieldFilterFormGUI($this, new ilBiblFieldFilter(), $this->facade);
        $this->main_tpl->setContent($ilBiblSettingsFilterFormGUI->getHTML());
    }

◆ applyFilter()

ilBiblFieldFilterGUI::applyFilter ( )

protected

Definition at line 275 of file class.ilBiblFieldFilterGUI.php.

                                    : void
    {
        $table = new ilBiblFieldFilterTableGUI($this, $this->facade);
        $table->writeFilterToSession();
        $table->resetOffset();
        $this->ctrl->redirect($this, self::CMD_STANDARD);
    }

References $table, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cancel()

ilBiblFieldFilterGUI::cancel ( )

cancel

Definition at line 231 of file class.ilBiblFieldFilterGUI.php.

                            : void
    {
        $this->ctrl->redirect($this, self::CMD_STANDARD);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ checkPermissionAndFail()

ilBiblFieldFilterGUI::checkPermissionAndFail ( string $permission )

Definition at line 291 of file class.ilBiblFieldFilterGUI.php.

                                                              : void
    {
        if (!$this->checkPermissionBoolAndReturn($permission)) {
            throw new \ilObjectException($this->lng()->txt("permission_denied"));
        }
    }

References checkPermissionBoolAndReturn(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ checkPermissionBoolAndReturn()

ilBiblFieldFilterGUI::checkPermissionBoolAndReturn ( string $permission )

Definition at line 298 of file class.ilBiblFieldFilterGUI.php.

                                                                    : bool
    {
        return (bool) $this->access->checkAccess($permission, '', $this->http->request()->getQueryParams()['ref_id']);
    }

References ILIAS\Repository\access(), and ILIAS\FileDelivery\http().

Referenced by checkPermissionAndFail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilBiblFieldFilterGUI::create ( )

protected

Definition at line 180 of file class.ilBiblFieldFilterGUI.php.

                               : void
    {
        $this->tabs->activateTab(self::CMD_STANDARD);
        $il_bibl_field = new ilBiblFieldFilter();
        $il_bibl_field->setObjectId($this->facade->iliasObjId());
        $form = new ilBiblFieldFilterFormGUI($this, $il_bibl_field, $this->facade);
        if ($form->saveObject()) {
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('changes_saved'), true);
            $this->ctrl->redirect($this, self::CMD_STANDARD);
        }
        $form->setValuesByPost();
        $this->main_tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ delete()

ilBiblFieldFilterGUI::delete ( )

Definition at line 214 of file class.ilBiblFieldFilterGUI.php.

                            : void
    {
        $token = $this->table->getIdToken()->getName();
        $items = $this->http->request()->getQueryParams()[$token] ?? [];
 
        foreach ($items as $filter_id) {
            $il_bibl_field = $this->facade->filterFactory()->findById((int) $filter_id);
            $il_bibl_field->delete();
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('filter_deleted'), true);
        $this->ctrl->redirect($this, self::CMD_STANDARD);
    }

References $token, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ edit()

ilBiblFieldFilterGUI::edit ( )

Definition at line 194 of file class.ilBiblFieldFilterGUI.php.

                          : void
    {
        $ilBiblSettingsFilterFormGUI = $this->initEditForm();
        $this->main_tpl->setContent($ilBiblSettingsFilterFormGUI->getHTML());
    }

References initEditForm().

Here is the call graph for this function:

◆ executeCommand()

ilBiblFieldFilterGUI::executeCommand ( )

Definition at line 98 of file class.ilBiblFieldFilterGUI.php.

                                    : void
    {
        $this->saveFieldIdsInRequest();
        $next_class = $this->ctrl->getNextClass();
        $this->tabs->activateTab(ilObjBibliographicGUI::TAB_SETTINGS);
        $this->performCommand();
    }

References ILIAS\Repository\ctrl(), performCommand(), saveFieldIdsInRequest(), ilObjBibliographicGUI\TAB_SETTINGS, and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ getFieldFilterFromRequest()

ilBiblFieldFilterGUI::getFieldFilterFromRequest ( )

private

Definition at line 236 of file class.ilBiblFieldFilterGUI.php.

                                                : \ilBiblFieldFilterInterface
    {
        $table = new Table(
            $this,
            $this->facade
        );
 
        $token = $table->getIdToken()->getName();
        if (isset($this->http->request()->getQueryParams()[$token])) {
            $field_id = $this->http->request()->getQueryParams()[$token] ?? null;
            if (is_array($field_id)) {
                $field_id = $field_id[0];
            }
            return $this->facade->filterFactory()->findById($field_id ?? 0);
        }
 
        $field = $this->http->request()->getQueryParams()[self::FILTER_ID];
 
        return $this->facade->filterFactory()->findById($field);
    }

References $table, $token, FILTER_ID, ILIAS\Bibliographic\FieldFilter\Table\getIdToken(), and ILIAS\FileDelivery\http().

Referenced by initEditForm(), renderInterruptiveModal(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldFromRequest()

ilBiblFieldFilterGUI::getFieldFromRequest ( )

private

Definition at line 150 of file class.ilBiblFieldFilterGUI.php.

                                          : ilBiblFieldInterface
    {
        $field_id = $this->getFieldIdFromRequest();
 
        return $this->facade->fieldFactory()->findById($field_id); // get field from id from the factory
    }

References getFieldIdFromRequest().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldIdFromRequest()

ilBiblFieldFilterGUI::getFieldIdFromRequest ( )

protected

Definition at line 135 of file class.ilBiblFieldFilterGUI.php.

                                              : int
    {
        $query_params = $this->http->request()->getQueryParams(); // aka $_GET
        $name = $this->table->getIdToken()->getName(); // name of the query parameter from the table
        $field_ids = $query_params[$name] ?? []; // array of field ids
        return (int) (is_array($field_ids) ? end($field_ids) : $field_ids); // return the last field id
    }

References ILIAS\FileDelivery\http().

Referenced by getFieldFromRequest(), and saveFieldIdsInRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilBiblFieldFilterGUI::index ( )

Definition at line 157 of file class.ilBiblFieldFilterGUI.php.

                           : void
    {
        if ($this->access->checkAccess('write', "", $this->facade->iliasRefId())) {
            // mantis 0038219: added infobox to describe the filter functionality
            $infobox = $this->dic()->ui()->factory()->messageBox()->info($this->lng()->txt('msg_filter_info'));
            $this->tpl()->setVariable("MESSAGE", $this->dic()->ui()->renderer()->render($infobox));
 
            $button = $this->dic()->ui()->factory()->button()->primary(
                $this->lng->txt("add_filter"),
                $this->ctrl->getLinkTarget($this, self::CMD_ADD)
            );
            $this->toolbar()->addComponent($button);
        }
 
        $this->main_tpl->setContent($this->table->getHTML());
    }

References ILIAS\Repository\access(), ILIAS\Repository\lng(), renderer(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ initEditForm()

ilBiblFieldFilterGUI::initEditForm ( )

protected

Definition at line 257 of file class.ilBiblFieldFilterGUI.php.

                                     : ilBiblFieldFilterFormGUI
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTargetByClass(ilBiblFieldFilterGUI::class, ilBiblFieldFilterGUI::CMD_STANDARD)
        );
 
        $ilBiblSettingsFilterFormGUI = new ilBiblFieldFilterFormGUI(
            $this,
            $this->getFieldFilterFromRequest(),
            $this->facade
        );
        $ilBiblSettingsFilterFormGUI->fillForm();
 
        return $ilBiblSettingsFilterFormGUI;
    }

References CMD_STANDARD, getFieldFilterFromRequest(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by edit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performCommand()

ilBiblFieldFilterGUI::performCommand ( )

protected

Definition at line 106 of file class.ilBiblFieldFilterGUI.php.

                                       : void
    {
        $cmd = $this->ctrl->getCmd(self::CMD_STANDARD);
        switch ($cmd) {
            case self::CMD_EDIT:
            case self::CMD_DELETE:
                $field = $this->getFieldFromRequest();
                if ($field === null) {
                    throw new ilException("Field not found");
                }
                // no break
            case self::CMD_STANDARD:
            case self::CMD_ADD:
            case self::CMD_UPDATE:
            case self::CMD_CREATE:
            case self::CMD_CANCEL:
            case self::CMD_APPLY_FILTER:
            case self::CMD_RESET_FILTER:
            case self::CMD_RENDER_INTERRUPTIVE:
                if ($this->access->checkAccess('write', "", $this->facade->iliasRefId())) {
                    $this->{$cmd}();
                    break;
                } else {
                    $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("no_permission"), true);
                    break;
                }
        }
    }

References ILIAS\Repository\access(), CMD_ADD, CMD_APPLY_FILTER, CMD_CANCEL, CMD_CREATE, CMD_DELETE, CMD_EDIT, CMD_RENDER_INTERRUPTIVE, CMD_RESET_FILTER, CMD_STANDARD, CMD_UPDATE, ILIAS\Repository\ctrl(), getFieldFromRequest(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderInterruptiveModal()

ilBiblFieldFilterGUI::renderInterruptiveModal ( )

Definition at line 70 of file class.ilBiblFieldFilterGUI.php.

                                             : void
    {
        $f = $this->dic()->ui()->factory();
        $r = $this->dic()->ui()->renderer();
        $ilBiblFieldFilter = $this->getFieldFilterFromRequest();
        $form_action = $this->ctrl->getFormActionByClass(
            ilBiblFieldFilterGUI::class,
            ilBiblFieldFilterGUI::CMD_DELETE
        );
        $delete_modal = $f->modal()->interruptive(
            $this->lng->txt("delete"),
            $this->lng->txt('msg_confirm_delete_filter'),
            $form_action
        )->withAffectedItems(
            [
                $f->modal()->interruptiveItem()->standard(
                    (string) $ilBiblFieldFilter->getId(),
                    $this->facade->translationFactory()->translate(
                        $this->facade->fieldFactory()->findById($ilBiblFieldFilter->getFieldId())
                    )
                )
            ]
        );
 
        echo $r->render([$delete_modal]);
        exit;
    }

References Vendor\Package\$f, CMD_DELETE, ILIAS\Repository\ctrl(), exit, getFieldFilterFromRequest(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ resetFilter()

ilBiblFieldFilterGUI::resetFilter ( )

protected

Definition at line 283 of file class.ilBiblFieldFilterGUI.php.

                                    : void
    {
        $table = new ilBiblFieldFilterTableGUI($this, $this->facade);
        $table->resetFilter();
        $table->resetOffset();
        $this->ctrl->redirect($this, self::CMD_STANDARD);
    }

References $table, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ saveFieldIdsInRequest()

ilBiblFieldFilterGUI::saveFieldIdsInRequest ( )

private

Definition at line 143 of file class.ilBiblFieldFilterGUI.php.

                                            : void
    {
        $field_id = $this->getFieldIdFromRequest();
 
        $this->ctrl->setParameter($this, $this->table->getIdToken()->getName(), $field_id);
    }

References ILIAS\Repository\ctrl(), and getFieldIdFromRequest().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilBiblFieldFilterGUI::update ( )

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

                            : void
    {
        $il_bibl_field = $this->getFieldFilterFromRequest();
        $this->tabs->activateTab(self::CMD_STANDARD);
 
        $form = new ilBiblFieldFilterFormGUI($this, $il_bibl_field, $this->facade);
        if ($form->saveObject()) {
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('changes_saved'), true);
            $this->ctrl->redirect($this, self::CMD_STANDARD);
        }
        $form->setValuesByPost();
        $this->main_tpl->setContent($form->getHTML());
    }