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

Collaboration diagram for ilOrgUnitSimpleImportGUI:

Public Member Functions
	__construct (ilObjectGUI $parent_gui)

	executeCommand ()

	chooseImport ()

	importScreen ()

	startImport ()

	displayImportResults ($importer)

Protected Member Functions
	initForm ($submit_action)

Protected Attributes
ilTabsGUI	$tabs_gui

ilToolbarGUI	$toolbar

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilObjectGUI	$parent_gui

object	$parent_object

ilLanguage	$lng

ilAccessHandler	$ilAccess

ILIAS DI LoggingServices	$ilLog

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 ilOrgUnitSimpleImportGUI

Author: Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 25 of file class.ilOrgUnitSimpleImportGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitSimpleImportGUI::__construct ( ilObjectGUI $parent_gui )

Definition at line 37 of file class.ilOrgUnitSimpleImportGUI.php.

References $DIC, $parent_gui, ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ilObjOrgUnit\getRootOrgRefId(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->ctrl = $DIC->ctrl();
         $this->parent_gui = $parent_gui;
         $this->parent_object = $parent_gui->getObject();
         $this->tabs_gui = $DIC->tabs();
         $this->toolbar = $DIC->toolbar();
         $this->lng = $DIC->language();
         $this->ilAccess = $DIC->access();
         $this->lng->loadLanguageModule('user');
         $this->ilLog = $DIC->logger();
 
         $this->may_create_orgus = $this->ilAccess->checkAccess("create_orgu", "", $this->parent_gui->getRefId(), 'orgu');
         $this->is_top_level_orgu = ($this->parent_object->getRefId() == ilObjOrgUnit::getRootOrgRefId());
 
         if (!$this->may_create_orgus) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ chooseImport()

ilOrgUnitSimpleImportGUI::chooseImport ( )

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

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

Referenced by executeCommand().

     {
         if (!$this->may_create_orgus || !$this->is_top_level_orgu) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_perm_edit"));
             $this->ctrl->redirectByClass('ilinfoscreengui', '');
         }
 
         $this->tabs_gui->setTabActive('view_content');
         $this->tabs_gui->removeSubTab("page_editor");
         $this->tabs_gui->removeSubTab("ordering"); // Mantis 0014728
 
         if ($this->may_create_orgus && $this->is_top_level_orgu) {
             $this->toolbar->addButton(
                 $this->lng->txt("simple_import"),
                 $this->ctrl->getLinkTargetByClass("ilOrgUnitSimpleImportGUI", "importScreen")
             );
             $this->toolbar->addButton(
                 $this->lng->txt("simple_user_import"),
                 $this->ctrl->getLinkTargetByClass("ilOrgUnitSimpleUserImportGUI", "userImportScreen")
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayImportResults()

ilOrgUnitSimpleImportGUI::displayImportResults ( $importer )

Parameters

$importer ilOrgUnitImporter

Definition at line 175 of file class.ilOrgUnitSimpleImportGUI.php.

References ILIAS\Repository\lng().

Referenced by startImport().

     {
         if (!$importer->hasErrors() && !$importer->hasWarnings()) {
             $stats = $importer->getStats();
             $this->tpl->setOnScreenMessage(
                 'success',
                 sprintf($this->lng->txt("import_successful"), $stats["created"], $stats["updated"], $stats["deleted"]),
                 true
             );
         }
         if ($importer->hasWarnings()) {
             $msg = $this->lng->txt("import_terminated_with_warnings") . " <br/>";
             foreach ($importer->getWarnings() as $warning) {
                 $msg .= "-" . $this->lng->txt($warning["lang_var"]) . " (Import ID: " . $warning["import_id"] . ")<br />";
             }
             $this->tpl->setOnScreenMessage('info', $msg, true);
         }
         if ($importer->hasErrors()) {
             $msg = $this->lng->txt("import_terminated_with_errors") . "<br/>";
             foreach ($importer->getErrors() as $warning) {
                 $msg .= "- " . $this->lng->txt($warning["lang_var"]) . " (Import ID: " . $warning["import_id"] . ")<br />";
             }
             $this->tpl->setOnScreenMessage('failure', $msg, true);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilOrgUnitSimpleImportGUI::executeCommand ( )

Returns: bool

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

References chooseImport(), ILIAS\Repository\ctrl(), importScreen(), ILIAS\Repository\lng(), and startImport().

     {
         $cmd = $this->ctrl->getCmd();
 
         switch ($cmd) {
             case 'chooseImport':
                 $this->chooseImport();
                 break;
             case 'importScreen':
                 $this->tabs_gui->clearTargets();
                 $this->tabs_gui->setBackTarget(
                     $this->lng->txt("back"),
                     $this->ctrl->getLinkTarget($this, 'chooseImport')
                 );
                 $this->importScreen();
                 break;
             case 'startImport':
                 $this->tabs_gui->clearTargets();
                 $this->tabs_gui->setBackTarget(
                     $this->lng->txt("back"),
                     $this->ctrl->getLinkTarget($this, 'chooseImport')
                 );
                 $this->startImport();
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ importScreen()

ilOrgUnitSimpleImportGUI::importScreen ( )

Definition at line 114 of file class.ilOrgUnitSimpleImportGUI.php.

References initForm().

Referenced by executeCommand().

     {
         $form = $this->initForm("startImport");
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

ilOrgUnitSimpleImportGUI::initForm ( $submit_action )

protected

Definition at line 120 of file class.ilOrgUnitSimpleImportGUI.php.

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

Referenced by importScreen(), and startImport().

     {
         $form = new ilPropertyFormGUI();
         $input = new ilFileInputGUI($this->lng->txt("import_xml_file"), "import_file");
         $input->setRequired(true);
         $input->setSuffixes(array('zip', 'xml'));
         $form->addItem($input);
         $form->setFormAction($this->ctrl->getFormAction($this));
         $form->addCommandButton($submit_action, $this->lng->txt("import"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startImport()

ilOrgUnitSimpleImportGUI::startImport ( )

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

References Vendor\Package\$e, $res, ILIAS\Repository\ctrl(), displayImportResults(), initForm(), ILIAS\Repository\lng(), and ilLog\write().

Referenced by executeCommand().

     {
         $form = $this->initForm("startImport");
         if (!$form->checkInput()) {
             $this->tpl->setContent($form->getHTML());
         } else {
             $file = $form->getInput("import_file");
             $importer = new ilOrgUnitSimpleImport();
             try {
                 $file_path = $file["tmp_name"];
                 $file_type = pathinfo($file["name"], PATHINFO_EXTENSION);
                 $file_name = pathinfo($file["name"], PATHINFO_FILENAME);
 
                 if ($file_type == "zip") {
                     $extract_path = $file_path . '_extracted/';
                     $extracted_file = $extract_path . $file_name . '/manifest.xml';
 
                     $zip = new ZipArchive();
                     $res = $zip->open($file_path);
                     if ($res === true) {
                         $zip->extractTo($extract_path);
                         $zip->close();
 
                         if (file_exists($extracted_file)) {
                             $file_path = $extracted_file;
                         }
                     }
                 }
 
                 $importer->simpleImport($file_path);
             } catch (Exception $e) {
                 $this->ilLog->write($e->getMessage() . " - " . $e->getTraceAsString());
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt("import_failed"), true);
                 $this->ctrl->redirect($this, "render");
             }
             $this->displayImportResults($importer);
         }
     }