ilMDVocabulariesGUI Class Reference

ilMDVocabulariesGUI: ilMDVocabularyUploadHandlerGUI More...

Collaboration diagram for ilMDVocabulariesGUI:

Public Member Functions
	__construct (ilObjMDSettingsGUI $parent_obj_gui)
	executeCommand ()
	showVocabularies ()
	tableAction ()
	importVocabulary ()

Data Fields
	$key = $vocabs_id_token->getName()
	$vocab = $this->vocab_manager->getVocabulary($vocab_id)
	$value_items = []
	$link = $this->ctrl->getLinkTarget($this, 'deleteVocabulary')
	$modal
	exit
	$values

Protected Member Functions
	deleteVocabulary ()
	activateVocabulary (string $vocab_id)
	deactivateVocabulary (string $vocab_id)
	allowCustomInputForVocabulary (string $vocab_id)
	disallowCustomInputForVocabulary (string $vocab_id)
	getTable ()
	getImportModal ()
	getImportButton (Signal $signal)
	fetchTableAction ()
	fetchVocabID ()
	getTableURLBuilderAndParameters ()

Protected Attributes
const int	MAX_CONFIRMATION_VALUES = 5
ilCtrl	$ctrl
HTTP	$http
Filesystem	$temp_files
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilToolbarGUI	$toolbar
UIFactory	$ui_factory
UIRenderer	$ui_renderer
ilObjMDSettingsGUI	$parent_obj_gui
ilMDSettingsAccessService	$access_service
Refinery	$refinery
VocabManager	$vocab_manager
Presentation	$presentation
Importer	$importer

Detailed Description

ilMDVocabulariesGUI: ilMDVocabularyUploadHandlerGUI

Definition at line 44 of file class.ilMDVocabulariesGUI.php.

Constructor & Destructor Documentation

__construct()

ilMDVocabulariesGUI::__construct

(

ilObjMDSettingsGUI

$parent_obj_gui

)

Definition at line 64 of file class.ilMDVocabulariesGUI.php.

References $DIC, $parent_obj_gui, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $services = new InternalServices($DIC);

        $this->vocab_manager = $services->vocabularies()->manager();
        $this->presentation = new Presentation(
            $services->presentation()->elements(),
            $services->presentation()->utilities(),
            $services->vocabularies()->presentation(),
            $services->vocabularies()->slotHandler(),
            $services->structure()->structure(),
            $services->paths()->navigatorFactory(),
            $services->paths()->pathFactory()
        );
        $this->importer = new Importer(
            $services->paths()->pathFactory(),
            $this->vocab_manager->controlledVocabularyCreator(),
            $services->vocabularies()->slotHandler()
        );

        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->temp_files = $DIC->filesystem()->temp();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->toolbar = $DIC->toolbar();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->refinery = $DIC->refinery();

        $this->parent_obj_gui = $parent_obj_gui;
        $this->access_service = new ilMDSettingsAccessService(
            $this->parent_obj_gui->getRefId(),
            $DIC->access()
        );

        $this->lng->loadLanguageModule("meta");
    }

Here is the call graph for this function:

Member Function Documentation

activateVocabulary()

ilMDVocabulariesGUI::activateVocabulary ( string  $vocab_id )

protected

Definition at line 287 of file class.ilMDVocabulariesGUI.php.

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

Referenced by tableAction().

                                                           : void
    {
        $this->vocab_manager->actions()->activate(
            $this->vocab_manager->getVocabulary($vocab_id)
        );
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('md_vocab_update_successful'),
            true
        );
        $this->ctrl->redirect($this, 'showVocabularies');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

allowCustomInputForVocabulary()

ilMDVocabulariesGUI::allowCustomInputForVocabulary ( string  $vocab_id )

protected

Definition at line 313 of file class.ilMDVocabulariesGUI.php.

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

Referenced by tableAction().

                                                                      : void
    {
        $this->vocab_manager->actions()->allowCustomInput(
            $this->vocab_manager->getVocabulary($vocab_id)
        );
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('md_vocab_update_successful'),
            true
        );
        $this->ctrl->redirect($this, 'showVocabularies');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deactivateVocabulary()

ilMDVocabulariesGUI::deactivateVocabulary ( string  $vocab_id )

protected

Definition at line 300 of file class.ilMDVocabulariesGUI.php.

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

Referenced by tableAction().

                                                             : void
    {
        $this->vocab_manager->actions()->deactivate(
            $this->vocab_manager->getVocabulary($vocab_id)
        );
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('md_vocab_update_successful'),
            true
        );
        $this->ctrl->redirect($this, 'showVocabularies');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteVocabulary()

ilMDVocabulariesGUI::deleteVocabulary ( )

protected

Definition at line 271 of file class.ilMDVocabulariesGUI.php.

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

                                         : void
    {
        $vocab_id = $this->fetchVocabID();
        if ($vocab_id !== '') {
            $this->vocab_manager->actions()->delete(
                $this->vocab_manager->getVocabulary($vocab_id)
            );
        }
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('md_vocab_deletion_successful'),
            true
        );
        $this->ctrl->redirect($this, 'showVocabularies');
    }

Here is the call graph for this function:

disallowCustomInputForVocabulary()

ilMDVocabulariesGUI::disallowCustomInputForVocabulary ( string  $vocab_id )

protected

Definition at line 326 of file class.ilMDVocabulariesGUI.php.

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

Referenced by tableAction().

                                                                         : void
    {
        $this->vocab_manager->actions()->disallowCustomInput(
            $this->vocab_manager->getVocabulary($vocab_id)
        );
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('md_vocab_update_successful'),
            true
        );
        $this->ctrl->redirect($this, 'showVocabularies');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilMDVocabulariesGUI::executeCommand

(

)

Definition at line 105 of file class.ilMDVocabulariesGUI.php.

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        if (
            !$this->access_service->hasCurrentUserVisibleAccess() ||
            !$this->access_service->hasCurrentUserReadAccess()
        ) {
            throw new ilPermissionException($this->lng->txt('no_permission'));
        }

        switch ($next_class) {
            case strtolower(ilMDVocabularyUploadHandlerGUI::class):
                $handler = new ilMDVocabularyUploadHandlerGUI();
                $this->ctrl->forwardCommand($handler);

                // no break
            default:
                if (!$cmd || $cmd === 'view') {
                    $cmd = 'showVocabularies';
                }

                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

fetchTableAction()

ilMDVocabulariesGUI::fetchTableAction ( )

protected

Definition at line 441 of file class.ilMDVocabulariesGUI.php.

References $key, getTableURLBuilderAndParameters(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by tableAction().

                                         : string
    {
        list($url_builder, $action_parameter_token, $vocabs_id_token) = $this->getTableURLBuilderAndParameters();
        $key = $action_parameter_token->getName();
        if ($this->http->wrapper()->query()->has($key)) {
            return $this->http->wrapper()->query()->retrieve(
                $key,
                $this->refinery->identity()
            );
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchVocabID()

ilMDVocabulariesGUI::fetchVocabID ( )

protected

Definition at line 454 of file class.ilMDVocabulariesGUI.php.

References $key, getTableURLBuilderAndParameters(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by deleteVocabulary(), and tableAction().

                                     : string
    {
        list($url_builder, $action_parameter_token, $vocabs_id_token) = $this->getTableURLBuilderAndParameters();
        $key = $vocabs_id_token->getName();
        if ($this->http->wrapper()->query()->has($key)) {
            return $this->http->wrapper()->query()->retrieve(
                $key,
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            )[0] ?? '';
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImportButton()

ilMDVocabulariesGUI::getImportButton ( Signal  $signal )

protected

Definition at line 433 of file class.ilMDVocabulariesGUI.php.

References ILIAS\Repository\lng().

Referenced by showVocabularies().

                                                      : Button
    {
        return $this->ui_factory->button()->standard(
            $this->lng->txt('md_import_vocab'),
            $signal
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImportModal()

ilMDVocabulariesGUI::getImportModal ( )

protected

Definition at line 418 of file class.ilMDVocabulariesGUI.php.

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

Referenced by importVocabulary(), and showVocabularies().

                                       : RoundtripModal
    {
        $file_input = $this->ui_factory->input()->field()->file(
            new ilMDVocabularyUploadHandlerGUI(),
            $this->lng->txt('md_import_file_vocab')
        )->withAcceptedMimeTypes([MimeType::TEXT__XML])->withMaxFiles(1);

        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('md_import_vocab_modal'),
            null,
            ['file' => $file_input],
            $this->ctrl->getLinkTarget($this, 'importVocabulary')
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTable()

ilMDVocabulariesGUI::getTable ( )

protected

Definition at line 357 of file class.ilMDVocabulariesGUI.php.

References getTableURLBuilderAndParameters(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by showVocabularies().

                                 : DataTable
    {
        $column_factory = $this->ui_factory->table()->column();
        $columns = [
            'element' => $column_factory->text($this->lng->txt('md_vocab_element_column'))->withIsSortable(false),
            'type' => $column_factory->status($this->lng->txt('md_vocab_type_column'))->withIsSortable(false),
            'source' => $column_factory->text($this->lng->txt('md_vocab_source_column'))->withIsSortable(false),
            'preview' => $column_factory->text($this->lng->txt('md_vocab_preview_column'))->withIsSortable(false),
            'active' => $column_factory->statusIcon($this->lng->txt('md_vocab_active_column'))->withIsSortable(false),
            'custom_input' => $column_factory->statusIcon($this->lng->txt('md_vocab_custom_input_column'))->withIsSortable(false)
        ];

        list($url_builder, $action_parameter_token, $row_id_token) = $this->getTableURLBuilderAndParameters();
        $actions_factory = $this->ui_factory->table()->action();
        $actions = [];

        if ($this->access_service->hasCurrentUserWriteAccess()) {
            $actions ['delete'] = $actions_factory->single(
                $this->lng->txt('md_vocab_delete_action'),
                $url_builder->withParameter($action_parameter_token, 'delete'),
                $row_id_token
            )->withAsync(true);
            $actions['activate'] = $actions_factory->single(
                $this->lng->txt('md_vocab_activate_action'),
                $url_builder->withParameter($action_parameter_token, 'activate'),
                $row_id_token
            );
            $actions['deactivate'] = $actions_factory->single(
                $this->lng->txt('md_vocab_deactivate_action'),
                $url_builder->withParameter($action_parameter_token, 'deactivate'),
                $row_id_token
            );
            $actions['allow_custom_input'] = $actions_factory->single(
                $this->lng->txt('md_vocab_allow_custom_input_action'),
                $url_builder->withParameter($action_parameter_token, 'allow_custom_input'),
                $row_id_token
            );
            $actions['disallow_custom_input'] = $actions_factory->single(
                $this->lng->txt('md_vocab_disallow_custom_input_action'),
                $url_builder->withParameter($action_parameter_token, 'disallow_custom_input'),
                $row_id_token
            );
        }

        $actions['show_all'] = $actions_factory->single(
            $this->lng->txt('md_vocab_show_all_action'),
            $url_builder->withParameter($action_parameter_token, 'show_all'),
            $row_id_token
        )->withAsync(true);

        return $this->ui_factory->table()->data(
            new DataRetrieval(
                $this->vocab_manager,
                $this->presentation,
                $this->ui_factory
            ),
            $this->lng->txt('md_vocab_table_title'),
            $columns,
        )->withActions($actions)->withRequest($this->http->request());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTableURLBuilderAndParameters()

ilMDVocabulariesGUI::getTableURLBuilderAndParameters ( )

protected

Definition at line 467 of file class.ilMDVocabulariesGUI.php.

References ILIAS\Repository\ctrl().

Referenced by fetchTableAction(), fetchVocabID(), getTable(), and importVocabulary().

                                                        : array
    {
        $url_builder = new URLBuilder(new URI(
            rtrim(ILIAS_HTTP_PATH, '/') . '/' . $this->ctrl->getLinkTarget($this, 'tableAction')
        ));
        return $url_builder->acquireParameters(
            ['metadata', 'vocab'],
            'table_action',
            'ids'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importVocabulary()

ilMDVocabulariesGUI::importVocabulary

(

)

Definition at line 190 of file class.ilMDVocabulariesGUI.php.

References $modal, ILIAS\Repository\ctrl(), getImportModal(), getTableURLBuilderAndParameters(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and null.

                                      : void
    {
        if (!$this->access_service->hasCurrentUserWriteAccess()) {
            $this->ctrl->redirect($this, 'showVocabularies');
        }

        $message_type = 'failure';
        $message_text = $this->lng->txt('md_vocab_import_upload_failed');

        $modal = $this->getImportModal()->withRequest($this->http->request());

        $upload_folder = null;
        if ($modal->getData()) {
            $upload_folder = (string) ($modal->getData()['file'][0] ?? null);
            if (!$this->temp_files->hasDir($upload_folder)) {
                $upload_folder = null;
            }
        }

        $file_content = null;
        if (!is_null($upload_folder)) {
            $files = $files = $this->temp_files->listContents($upload_folder);
            if (count($files) === 1 && ($files[0] ?? null)?->isFile()) {
                $file_content = $this->temp_files->read($files[0]->getPath());
            }
            $this->temp_files->deleteDir($upload_folder);
        }

        if (!is_null($file_content)) {
            $result = $this->importer->import($file_content);

            if ($result->wasSuccessful()) {
                $message_type = 'success';
                $message_text = $this->lng->txt('md_vocab_import_successful');
            } else {
                $message_type = 'failure';
                $message_text = sprintf(
                    $this->lng->txt('md_vocab_import_invalid'),
                    implode("<br/>", $result->getErrors())
                );
            }
        }

        $this->tpl->setOnScreenMessage($message_type, $message_text, true);
        $this->ctrl->redirect($this, 'showVocabularies');
    }

    #[NoReturn] protected function confirmDeleteVocabulary(string $vocab_id): void
    {
        list($url_builder, $action_parameter_token, $vocabs_id_token) = $this->getTableURLBuilderAndParameters();
        $key = $vocabs_id_token->getName();

        $vocab = $this->vocab_manager->getVocabulary($vocab_id);
        $value_items = [];
        foreach ($this->presentation->makeValuesPresentable(
            $vocab,
            self::MAX_CONFIRMATION_VALUES
        ) as $value) {
            $value_items[] = $this->ui_factory->modal()->interruptiveItem()->standard(
                '',
                $value,
            );
        }

Here is the call graph for this function:

showVocabularies()

ilMDVocabulariesGUI::showVocabularies

(

)

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

References getImportButton(), getImportModal(), getTable(), and ILIAS\Repository\toolbar().

                                      : void
    {
        $content = [];

        if ($this->access_service->hasCurrentUserWriteAccess()) {
            $import_modal = $this->getImportModal();
            $this->toolbar->addComponent($this->getImportButton($import_modal->getShowSignal()));
            $content[] = $import_modal;
        }

        $content[] = $this->getTable();

        $this->tpl->setContent($this->ui_renderer->render($content));
    }

Here is the call graph for this function:

tableAction()

ilMDVocabulariesGUI::tableAction

(

)

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

References activateVocabulary(), allowCustomInputForVocabulary(), ILIAS\Repository\ctrl(), deactivateVocabulary(), disallowCustomInputForVocabulary(), fetchTableAction(), and fetchVocabID().

                                 : void
    {
        $action = $this->fetchTableAction();
        $vocab_id = $this->fetchVocabID();

        if (
            $vocab_id === '' ||
            ($action !== 'show_all' && !$this->access_service->hasCurrentUserWriteAccess())
        ) {
            $this->ctrl->redirect($this, 'showVocabularies');
        }

        switch ($action) {
            case 'delete':
                $this->confirmDeleteVocabulary($vocab_id);
                return;

            case 'activate':
                $this->activateVocabulary($vocab_id);
                return;

            case 'deactivate':
                $this->deactivateVocabulary($vocab_id);
                return;

            case 'allow_custom_input':
                $this->allowCustomInputForVocabulary($vocab_id);
                return;

            case 'disallow_custom_input':
                $this->disallowCustomInputForVocabulary($vocab_id);
                return;

            case 'show_all':
                $this->showAllValuesModalForVocabulary($vocab_id);
                return;

            default:
                $this->ctrl->redirect($this, 'showVocabularies');
        }
    }

Here is the call graph for this function:

Field Documentation

$access_service

ilMDSettingsAccessService ilMDVocabulariesGUI::$access_service

protected

Definition at line 57 of file class.ilMDVocabulariesGUI.php.

$ctrl

ilCtrl ilMDVocabulariesGUI::$ctrl

protected

Definition at line 48 of file class.ilMDVocabulariesGUI.php.

$http

HTTP ilMDVocabulariesGUI::$http

protected

Definition at line 49 of file class.ilMDVocabulariesGUI.php.

$importer

Importer ilMDVocabulariesGUI::$importer

protected

Definition at line 62 of file class.ilMDVocabulariesGUI.php.

$key

ilMDVocabulariesGUI::$key = $vocabs_id_token->getName()

Definition at line 240 of file class.ilMDVocabulariesGUI.php.

Referenced by fetchTableAction(), and fetchVocabID().

$link

ilMDVocabulariesGUI::$link = $this->ctrl->getLinkTarget($this, 'deleteVocabulary')

Definition at line 255 of file class.ilMDVocabulariesGUI.php.

$lng

ilLanguage ilMDVocabulariesGUI::$lng

protected

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

$modal

ilMDVocabulariesGUI::$modal

Initial value:

= $this->ui_factory->modal()->interruptive(
            $this->presentation->txt('md_vocab_delete_confirmation_title'),
            $this->presentation->txtFill(
                'md_vocab_delete_confirmation_text',
                $this->presentation->makeSlotPresentable($vocab->slot()),
                $vocab->source()
            ),
            $link
        )->withAffectedItems($value_items)

Definition at line 258 of file class.ilMDVocabulariesGUI.php.

Referenced by importVocabulary().

$parent_obj_gui

ilObjMDSettingsGUI ilMDVocabulariesGUI::$parent_obj_gui

protected

Definition at line 56 of file class.ilMDVocabulariesGUI.php.

Referenced by __construct().

$presentation

Presentation ilMDVocabulariesGUI::$presentation

protected

Definition at line 61 of file class.ilMDVocabulariesGUI.php.

$refinery

Refinery ilMDVocabulariesGUI::$refinery

protected

Definition at line 58 of file class.ilMDVocabulariesGUI.php.

$temp_files

Filesystem ilMDVocabulariesGUI::$temp_files

protected

Definition at line 50 of file class.ilMDVocabulariesGUI.php.

$toolbar

ilToolbarGUI ilMDVocabulariesGUI::$toolbar

protected

Definition at line 53 of file class.ilMDVocabulariesGUI.php.

$tpl

ilGlobalTemplateInterface ilMDVocabulariesGUI::$tpl

protected

Definition at line 51 of file class.ilMDVocabulariesGUI.php.

$ui_factory

UIFactory ilMDVocabulariesGUI::$ui_factory

protected

Definition at line 54 of file class.ilMDVocabulariesGUI.php.

$ui_renderer

UIRenderer ilMDVocabulariesGUI::$ui_renderer

protected

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

$value_items

ilMDVocabulariesGUI::$value_items = []

Definition at line 243 of file class.ilMDVocabulariesGUI.php.

$values

ilMDVocabulariesGUI::$values

Initial value:

= $this->ui_factory->listing()->unordered(
            $this->presentation->makeValuesPresentable($vocab)
        )

Definition at line 342 of file class.ilMDVocabulariesGUI.php.

$vocab

ilMDVocabulariesGUI::$vocab = $this->vocab_manager->getVocabulary($vocab_id)

Definition at line 242 of file class.ilMDVocabulariesGUI.php.

Referenced by disallowCustomInputForVocabulary().

$vocab_manager

VocabManager ilMDVocabulariesGUI::$vocab_manager

protected

Definition at line 60 of file class.ilMDVocabulariesGUI.php.

exit

ilMDVocabulariesGUI::exit

Definition at line 267 of file class.ilMDVocabulariesGUI.php.

MAX_CONFIRMATION_VALUES

const int ilMDVocabulariesGUI::MAX_CONFIRMATION_VALUES = 5

protected

Definition at line 46 of file class.ilMDVocabulariesGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/MetaData/classes/Settings/Vocabularies/class.ilMDVocabulariesGUI.php