This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilBiblFieldFilterGUI:

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

	renderInterruptiveModal ()

	executeCommand ()

	index ()

	edit ()

	update ()

	delete ()

	cancel ()
	cancel More...

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'

const	CMD_TRANSLATE = 'translate'

Protected Member Functions
	performCommand ()

	add ()

	create ()

	initEditForm ()

	applyFilter ()

	resetFilter ()

Protected Attributes
ilBiblFactoryFacade	$facade

Private Member Functions
	getFieldFilterFromRequest ()

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 25 of file class.ilBiblFieldFilterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblFieldFilterGUI::__construct ( ilBiblFactoryFacade $facade )

ilBiblFieldFilterGUI constructor.

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

References $DIC, and $facade.

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->facade = $facade;
     }

Member Function Documentation

◆ add()

ilBiblFieldFilterGUI::add ( )

protected

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

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

◆ applyFilter()

ilBiblFieldFilterGUI::applyFilter ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ cancel()

ilBiblFieldFilterGUI::cancel ( )

cancel

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ create()

ilBiblFieldFilterGUI::create ( )

protected

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

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

                                : 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->tpl()->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ delete()

ilBiblFieldFilterGUI::delete ( )

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

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

                             : void
     {
         global $DIC;
         $items = $this->http()->request()->getParsedBody()['interruptive_items'];
         if (is_array($items)) {
             foreach ($items as $filter_id) {
                 $il_bibl_field = $this->facade->filterFactory()->findById($filter_id);
                 $il_bibl_field->delete();
             }
         }
         $this->main_tpl->setOnScreenMessage('success', $DIC->language()->txt('filter_deleted'), true);
         $this->ctrl()->redirect($this, self::CMD_STANDARD);
     }

Here is the call graph for this function:

◆ edit()

ilBiblFieldFilterGUI::edit ( )

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

References initEditForm().

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

Here is the call graph for this function:

◆ executeCommand()

ilBiblFieldFilterGUI::executeCommand ( )

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

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

                                     : void
     {
         $nextClass = $this->ctrl()->getNextClass();
         switch ($nextClass) {
             default:
                 $this->tabs()->activateTab(ilObjBibliographicGUI::TAB_SETTINGS);
                 $this->performCommand();
         }
     }

Here is the call graph for this function:

◆ getFieldFilterFromRequest()

ilBiblFieldFilterGUI::getFieldFilterFromRequest ( )

private

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

References ILIAS\FileDelivery\http().

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

                                                 : \ilBiblFieldFilterInterface
     {
         $field = $this->http()->request()->getQueryParams()[self::FILTER_ID];
 
         return $this->facade->filterFactory()->findById($field);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilBiblFieldFilterGUI::index ( )

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

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

                            : 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()->addText($this->dic()->ui()->renderer()->render([$button]));
         }
 
         $table = new ilBiblFieldFilterTableGUI($this, $this->facade);
         $this->tpl()->setContent($table->getHTML());
     }

Here is the call graph for this function:

◆ initEditForm()

ilBiblFieldFilterGUI::initEditForm ( )

protected

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

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

Referenced by edit().

                                      : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performCommand()

ilBiblFieldFilterGUI::performCommand ( )

protected

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

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

Referenced by executeCommand().

                                        : void
     {
         $cmd = $this->ctrl()->getCmd(self::CMD_STANDARD);
         switch ($cmd) {
             case self::CMD_STANDARD:
             case self::CMD_ADD:
             case self::CMD_EDIT:
             case self::CMD_UPDATE:
             case self::CMD_CREATE:
             case self::CMD_DELETE:
             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;
                 }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderInterruptiveModal()

ilBiblFieldFilterGUI::renderInterruptiveModal ( )

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

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

                                              : 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;
     }

Here is the call graph for this function:

◆ resetFilter()

ilBiblFieldFilterGUI::resetFilter ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ update()

ilBiblFieldFilterGUI::update ( )

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

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

                             : 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->tpl()->setContent($form->getHTML());
     }