ilTermDefinitionBulkCreationGUI Class Reference

Collaboration diagram for ilTermDefinitionBulkCreationGUI:

Public Member Functions
	__construct (InternalDomainService $domain, InternalGUIService $gui, ilObjGlossary $glossary)
	executeCommand ()
	modifyToolbar (ilToolbarGUI $toolbar)

Protected Member Functions
	showCreationForm ()
	getCreationForm ()
	showConfirmationScreen ()
	renderConfirmation (string $data, string $language)
	createTermDefinitionPairs ()

Protected Attributes
InternalDomainService	$domain
InternalGUIService	$gui
ilObjGlossary	$glossary
ILIAS Glossary Term TermManager	$term_manager

Detailed Description

Author

Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

Definition at line 27 of file class.ilTermDefinitionBulkCreationGUI.php.

Constructor & Destructor Documentation

__construct()

ilTermDefinitionBulkCreationGUI::__construct	(	InternalDomainService	$domain,
		InternalGUIService	$gui,
		ilObjGlossary	$glossary
	)

Definition at line 34 of file class.ilTermDefinitionBulkCreationGUI.php.

References $domain, $glossary, $gui, $lng, and ILIAS\Glossary\InternalDomainService\term().

      {
        $this->glossary = $glossary;
        $this->domain = $domain;
        $this->gui = $gui;
        $lng = $domain->lng();
        $lng->loadLanguageModule("glo");
        $this->term_manager = $domain
            ->term($glossary);
    }

Here is the call graph for this function:

Member Function Documentation

createTermDefinitionPairs()

ilTermDefinitionBulkCreationGUI::createTermDefinitionPairs ( )

protected

Definition at line 186 of file class.ilTermDefinitionBulkCreationGUI.php.

References $data, and $lng.

                                                  : void
    {
        $main_tpl = $this->gui->mainTemplate();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $request = $this->gui->editing()->request();

        $data = $request->getBulkCreationData();
        $language = $request->getTermLanguage();
        $this->term_manager->createTermDefinitionPairsFromBulkInputString($data, $language);
        $main_tpl->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
        $ctrl->returnToParent($this);
    }

executeCommand()

ilTermDefinitionBulkCreationGUI::executeCommand

(

)

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

                                    : void
    {
        $ctrl = $this->gui->ctrl();

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("showCreationForm");

        switch ($next_class) {
            default:
                if (in_array($cmd, [
                    "showCreationForm",
                    "showConfirmationScreen",
                    "createTermDefinitionPairs"
                ])) {
                    $this->$cmd();
                }
        }
    }

getCreationForm()

ilTermDefinitionBulkCreationGUI::getCreationForm ( )

protected

Definition at line 96 of file class.ilTermDefinitionBulkCreationGUI.php.

References $lng.

Referenced by showConfirmationScreen(), and showCreationForm().

                                        : \ILIAS\Repository\Form\FormAdapterGUI
    {
        $lng = $this->domain->lng();
        $user = $this->domain->user();
        $form = $this
            ->gui
            ->form(self::class, "showConfirmationScreen", $lng->txt("glo_save_and_continue"))
            ->asyncModal()
            //->section("creation", $lng->txt("glo_bulk_data"))
            ->textarea(
                "bulk_data",
                $lng->txt("glo_term_definition_pairs"),
                $lng->txt("glo_term_definition_pairs_info"),
            )
            ->required();

        $session_lang = $this->term_manager->getSessionLang();
        if ($session_lang != "") {
            $s_lang = $session_lang;
        } else {
            $s_lang = $user->getLanguage();
        }
        $form->select(
            "term_language",
            $lng->txt("language"),
            $this->domain->metadata()->getLOMLanguagesForSelectInputs(),
            "",
            $s_lang
        )
             ->required();

        return $form;
    }

Here is the caller graph for this function:

modifyToolbar()

ilTermDefinitionBulkCreationGUI::modifyToolbar

(

ilToolbarGUI

$toolbar

)

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

References $c, $components, $lng, and ilToolbarGUI\addComponent().

                                                        : void
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $components = $this
            ->gui
            ->modal($lng->txt("glo_bulk_creation"))
            ->getAsyncTriggerButtonComponents(
                $lng->txt("glo_bulk_creation"),
                $ctrl->getLinkTarget($this, "showCreationForm", "", true),
                false
            );
        foreach ($components as $type => $c) {
            if ($type === "signal") {
                continue;
            }
            $toolbar->addComponent($c);
        }
    }

Here is the call graph for this function:

renderConfirmation()

ilTermDefinitionBulkCreationGUI::renderConfirmation ( string  $data, string  $language  )

protected

Definition at line 149 of file class.ilTermDefinitionBulkCreationGUI.php.

References Vendor\Package\$f, $id, $lng, $r, ILIAS\Repository\event(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Referenced by showConfirmationScreen().

                                                                         : string
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $html_util = $this->gui->html();

        $conf_tpl = new ilTemplate("tpl.bulk_creation_confirmation.html", true, true, "components/ILIAS/Glossary");

        $button = $f->button()->standard(
            $lng->txt("glo_create_term_definition_pairs"),
            "#"
        )->withAdditionalOnLoadCode(static function (string $id) {
            return <<<EOT
            const glo_bulk_button = document.getElementById("$id");
            glo_bulk_button.addEventListener("click", (event) => {
                glo_bulk_button.closest(".c-modal").querySelector(".modal-body").querySelector("form").submit();
            });
EOT;
        });

        $mbox = $f->messageBox()->info(
            $lng->txt("glo_bulk_confirmation")
        )->withButtons([$button]);

        $ctrl->setParameter($this, "term_language", $language);
        $table = $this->domain->table()->getTermDefinitionBulkCreationTable($data, $this->glossary)->getComponent();

        $conf_tpl->setVariable("HIDDEN_VALUE", $html_util->escape($data));
        $conf_tpl->setVariable("ACTION", $ctrl->getFormAction($this, "createTermDefinitionPairs"));
        $conf_tpl->setVariable("MBOX", $r->render($mbox));
        $conf_tpl->setVariable("TABLE", $r->render($table));

        return $conf_tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showConfirmationScreen()

ilTermDefinitionBulkCreationGUI::showConfirmationScreen ( )

protected

Definition at line 130 of file class.ilTermDefinitionBulkCreationGUI.php.

References $lng, ILIAS\Repository\form(), getCreationForm(), ILIAS\UI\examples\MainControls\Slate\Legacy\legacy(), and renderConfirmation().

                                               : void
    {
        $form = $this->getCreationForm();
        $lng = $this->domain->lng();
        if (!$form->isValid()) {
            $this->gui->modal($lng->txt("glo_bulk_creation"))
                      ->form($form)
                      ->send();
        }

        $language = $form->getData("term_language");
        $this->gui->modal($lng->txt("glo_bulk_creation"))
                  ->legacy($this->renderConfirmation(
                      $form->getData("bulk_data"),
                      $language
                  ))
                  ->send();
    }

Here is the call graph for this function:

showCreationForm()

ilTermDefinitionBulkCreationGUI::showCreationForm ( )

protected

Definition at line 87 of file class.ilTermDefinitionBulkCreationGUI.php.

References $lng, ILIAS\Repository\form(), getCreationForm(), and send().

                                         : void
    {
        $lng = $this->domain->lng();
        $this->gui
            ->modal($lng->txt("glo_bulk_creation"))
            ->form($this->getCreationForm())
            ->send();
    }

Here is the call graph for this function:

Field Documentation

$domain

InternalDomainService ilTermDefinitionBulkCreationGUI::$domain

protected

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

Referenced by __construct().

$glossary

ilObjGlossary ilTermDefinitionBulkCreationGUI::$glossary

protected

Definition at line 31 of file class.ilTermDefinitionBulkCreationGUI.php.

Referenced by __construct().

$gui

InternalGUIService ilTermDefinitionBulkCreationGUI::$gui

protected

Definition at line 30 of file class.ilTermDefinitionBulkCreationGUI.php.

Referenced by __construct().

$term_manager

ILIAS Glossary Term TermManager ilTermDefinitionBulkCreationGUI::$term_manager

protected

Definition at line 32 of file class.ilTermDefinitionBulkCreationGUI.php.

---

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

• components/ILIAS/Glossary/Term/class.ilTermDefinitionBulkCreationGUI.php