Inheritance diagram for ilBiblAdminFieldGUI:

Collaboration diagram for ilBiblAdminFieldGUI:

Public Member Functions
	__construct (protected \ilBiblAdminFactoryFacadeInterface $facade)
	ilBiblAdminFieldGUI constructor. More...

	executeCommand ()

	checkPermissionAndFail (string $permission)

	checkPermissionBoolAndReturn (string $permission)

Data Fields
const	SUBTAB_RIS = 'subtab_ris'

const	SUBTAB_BIBTEX = 'subtab_bibtex'

const	FIELD_IDENTIFIER = 'field_id'

const	DATA_TYPE = 'data_type'

const	CMD_STANDARD = 'index'

const	CMD_CANCEL = 'cancel'

const	CMD_EDIT = 'edit'

const	CMD_UPDATE = 'update'

const	CMD_SAVE_ORDERING = 'saveOrdering'

const	CMD_APPLY_FILTER = 'applyFilter'

const	CMD_RESET_FILTER = 'resetFilter'

const	CMD_SAVE = 'save'

Protected Member Functions
	performCommand ()

	saveOrdering ()

	getFieldIdFromRequest ()

	index ()

	setSubTabs ()

	save ()

	applyFilter ()

	resetFilter ()

Protected Attributes
ilAccessHandler	$access

Table	$table

Private Member Functions
	saveFieldIdsInRequest ()

	getFieldFromRequest ()

Private Attributes
Services	$http

ilCtrl	$ctrl

ilTabsGUI	$tabs

ilLanguage	$lng

ilGlobalTemplateInterface	$main_tpl

Detailed Description

Class ilBiblAdminFieldGUI.

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 27 of file class.ilBiblAdminFieldGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblAdminFieldGUI::__construct ( protected \ilBiblAdminFactoryFacadeInterface $facade )

ilBiblAdminFieldGUI constructor.

Definition at line 52 of file class.ilBiblAdminFieldGUI.php.

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

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

◆ applyFilter()

ilBiblAdminFieldGUI::applyFilter ( )

protected

Definition at line 196 of file class.ilBiblAdminFieldGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ checkPermissionAndFail()

ilBiblAdminFieldGUI::checkPermissionAndFail ( string $permission )

Definition at line 211 of file class.ilBiblAdminFieldGUI.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()

ilBiblAdminFieldGUI::checkPermissionBoolAndReturn ( string $permission )

Definition at line 218 of file class.ilBiblAdminFieldGUI.php.

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

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

Referenced by ILIAS\Bibliographic\Field\Table\__construct(), checkPermissionAndFail(), and performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBiblAdminFieldGUI::executeCommand ( )

Definition at line 67 of file class.ilBiblAdminFieldGUI.php.

                                    : void
    {
        $this->saveFieldIdsInRequest();
        $next_class = $this->ctrl->getNextClass();
        $this->tabs->activateTab(ilObjBibliographicAdminGUI::TAB_FIELDS);
        switch ($next_class) {
            case strtolower(ilBiblTranslationGUI::class):
                $this->tabs->clearTargets();
                $target = $this->ctrl->getLinkTarget($this);
                $this->tabs->setBackTarget($this->lng->txt('back'), $target);
 
                $field = $this->getFieldFromRequest();
                if ($field === null) {
                    throw new ilException("Field not found");
                }
                $gui = new ilBiblTranslationGUI($this->facade, $field);
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                $this->performCommand();
        }
    }

References ILIAS\Repository\ctrl(), getFieldFromRequest(), ILIAS\Repository\lng(), performCommand(), saveFieldIdsInRequest(), ilObjBibliographicAdminGUI\TAB_FIELDS, and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ getFieldFromRequest()

ilBiblAdminFieldGUI::getFieldFromRequest ( )

private

Definition at line 140 of file class.ilBiblAdminFieldGUI.php.

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

References getFieldIdFromRequest().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldIdFromRequest()

ilBiblAdminFieldGUI::getFieldIdFromRequest ( )

protected

Definition at line 125 of file class.ilBiblAdminFieldGUI.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()

ilBiblAdminFieldGUI::index ( )

protected

Definition at line 147 of file class.ilBiblAdminFieldGUI.php.

                              : void
    {
        $this->setSubTabs();
        //$table = new ilBiblAdminFieldTableGUI($this, $this->facade);
        //$this->tpl()->setContent($table->getHTML());
        $this->main_tpl->setContent($this->table->getHTML());
    }

References setSubTabs().

Here is the call graph for this function:

◆ performCommand()

ilBiblAdminFieldGUI::performCommand ( )

protected

Definition at line 91 of file class.ilBiblAdminFieldGUI.php.

                                       : void
    {
        $cmd = $this->ctrl->getCmd(self::CMD_STANDARD);
        switch ($cmd) {
            case self::CMD_STANDARD:
                if ($this->checkPermissionBoolAndReturn('read')) {
                    $this->{$cmd}();
                }
                break;
            case self::CMD_EDIT:
            case self::CMD_UPDATE:
            case self::CMD_SAVE:
            case self::CMD_SAVE_ORDERING:
            case self::CMD_APPLY_FILTER:
            case self::CMD_RESET_FILTER:
                if ($this->checkPermissionBoolAndReturn('write')) {
                    $this->{$cmd}();
                }
                break;
        }
    }

References checkPermissionBoolAndReturn(), CMD_APPLY_FILTER, CMD_EDIT, CMD_RESET_FILTER, CMD_SAVE, CMD_SAVE_ORDERING, CMD_STANDARD, CMD_UPDATE, and ILIAS\Repository\ctrl().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilBiblAdminFieldGUI::resetFilter ( )

protected

Definition at line 203 of file class.ilBiblAdminFieldGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ save()

ilBiblAdminFieldGUI::save ( )

protected

Definition at line 191 of file class.ilBiblAdminFieldGUI.php.

                             : void
    {
        $this->saveOrdering();
    }

References saveOrdering().

Here is the call graph for this function:

◆ saveFieldIdsInRequest()

ilBiblAdminFieldGUI::saveFieldIdsInRequest ( )

private

Definition at line 133 of file class.ilBiblAdminFieldGUI.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:

◆ saveOrdering()

ilBiblAdminFieldGUI::saveOrdering ( )

protected

Definition at line 113 of file class.ilBiblAdminFieldGUI.php.

                                     : void
    {
        foreach ($this->table->getOrdering() as $position => $field_id) {
            $field = $this->facade->fieldFactory()->findById($field_id);
            $field->setPosition($position);
            $field->store();
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('changes_successfully_saved'));
        $this->ctrl->redirect($this, self::CMD_STANDARD);
    }

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

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubTabs()

ilBiblAdminFieldGUI::setSubTabs ( )

protected

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

                                   : void
    {
        $this->tabs->addSubTab(
            self::SUBTAB_RIS,
            $this->lng->txt('ris'),
            $this->ctrl->getLinkTargetByClass(
                [
                    ilObjBibliographicAdminGUI::class,
                    ilBiblAdminRisFieldGUI::class,
                ],
                ilBiblAdminRisFieldGUI::CMD_STANDARD
            )
        );
        $this->tabs->activateSubTab(self::SUBTAB_RIS);
 
        $this->tabs->addSubTab(
            self::SUBTAB_BIBTEX,
            $this->lng->txt('bibtex'),
            $this->ctrl->getLinkTargetByClass(
                [
                    ilObjBibliographicAdminGUI::class,
                    ilBiblAdminBibtexFieldGUI::class,
                ],
                ilBiblAdminBibtexFieldGUI::CMD_STANDARD
            )
        );
        switch ($this->facade->type()->getId()) {
            case ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX:
                $this->tabs->activateSubTab(self::SUBTAB_BIBTEX);
                break;
            case ilBiblTypeFactoryInterface::DATA_TYPE_RIS:
                $this->tabs->activateSubTab(self::SUBTAB_RIS);
                break;
        }
    }