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
Table	$table

Private Member Functions
	saveFieldIdsInRequest ()

	getFieldFromRequest ()

Private Attributes
Services	$http

ilCtrl	$ctrl

ilTabsGUI	$tabs

ilLanguage	$lng

ilAccessHandler	$access

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.

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

     {
         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'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilBiblAdminFieldGUI::applyFilter ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ checkPermissionAndFail()

ilBiblAdminFieldGUI::checkPermissionAndFail ( string $permission )

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

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

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

Here is the call graph for this function:

◆ checkPermissionBoolAndReturn()

ilBiblAdminFieldGUI::checkPermissionBoolAndReturn ( string $permission )

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

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

Referenced by checkPermissionAndFail(), and performCommand().

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

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.

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

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

Here is the call graph for this function:

◆ getFieldFromRequest()

ilBiblAdminFieldGUI::getFieldFromRequest ( )

private

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

References getFieldIdFromRequest().

Referenced by executeCommand().

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

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.

References ILIAS\FileDelivery\http().

Referenced by getFieldFromRequest(), and saveFieldIdsInRequest().

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

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.

References setSubTabs().

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

Here is the call graph for this function:

◆ performCommand()

ilBiblAdminFieldGUI::performCommand ( )

protected

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilBiblAdminFieldGUI::resetFilter ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ save()

ilBiblAdminFieldGUI::save ( )

protected

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

References saveOrdering().

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

Here is the call graph for this function:

◆ saveFieldIdsInRequest()

ilBiblAdminFieldGUI::saveFieldIdsInRequest ( )

private

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

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

Referenced by executeCommand().

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

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.

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

Referenced by save().

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

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.

References CMD_STANDARD, ILIAS\Repository\ctrl(), ilBiblTypeFactoryInterface\DATA_TYPE_BIBTEX, ilBiblTypeFactoryInterface\DATA_TYPE_RIS, ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by index().

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