Collaboration diagram for ilOrgUnitSimpleImportGUI:

Public Member Functions
	__construct ($parent_gui)

	executeCommand ()

	chooseImport ()

	importScreen ()

	startImport ()

	displayImportResults ($importer)

Protected Member Functions
	initForm ($submit_action)

Protected Attributes
	$tabs_gui

	$toolbar

	$ctrl

	$tpl

	$parent_object

	$lng

	$ilAccess

Detailed Description

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 10 of file class.ilOrgUnitSimpleImportGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitSimpleImportGUI::__construct ( $parent_gui )

Parameters

$parent_gui

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

References $DIC, $ilAccess, $ilCtrl, $ilLog, $lng, $tpl, and ilUtil\sendFailure().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $ilCtrl = $DIC['ilCtrl'];
         $ilTabs = $DIC['ilTabs'];
         $ilToolbar = $DIC['ilToolbar'];
         $lng = $DIC['lng'];
         $ilAccess = $DIC['ilAccess'];
         $ilLog = $DIC['ilLog'];
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->parent_gui = $parent_gui;
         $this->parent_object = $parent_gui->object;
         $this->tabs_gui = $this->parent_gui->tabs_gui;
         $this->toolbar = $ilToolbar;
         $this->lng = $lng;
         $this->ilAccess = $ilAccess;
         $this->lng->loadLanguageModule('user');
         $this->ilLog = $ilLog;
         if (!$this->ilAccess->checkaccess("write", "", $this->parent_gui->object->getRefId())) {
             ilUtil::sendFailure($this->lng->txt("permission_denied"), true);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ chooseImport()

ilOrgUnitSimpleImportGUI::chooseImport ( )

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

References $_GET, ilAccess\checkAccess(), ilObjOrgUnit\getRootOrgRefId(), and ilUtil\sendFailure().

Referenced by executeCommand().

     {
         if (!$this->ilAccess->checkAccess("write", "", $_GET["ref_id"]) or !$this->parent_object->getRefId() == ilObjOrgUnit::getRootOrgRefId()) {
             ilUtil::sendFailure($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->ilAccess->checkAccess("write", "", $_GET["ref_id"]) and $this->parent_object->getRefId() == ilObjOrgUnit::getRootOrgRefId()) {
             $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 181 of file class.ilOrgUnitSimpleImportGUI.php.

References ilUtil\sendFailure(), and ilUtil\sendInfo().

Referenced by startImport().

     {
         if (!$importer->hasErrors() && !$importer->hasWarnings()) {
             $stats = $importer->getStats();
             ilUtil::sendSuccess(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 />";
             }
             ilUtil::sendInfo($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 />";
             }
             ilUtil::sendFailure($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 75 of file class.ilOrgUnitSimpleImportGUI.php.

References chooseImport(), importScreen(), 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 117 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 124 of file class.ilOrgUnitSimpleImportGUI.php.

References 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 138 of file class.ilOrgUnitSimpleImportGUI.php.

References Vendor\Package\$e, $res, displayImportResults(), initForm(), ilUtil\sendFailure(), 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());
                 ilUtil::sendFailure($this->lng->txt("import_failed"), true);
                 $this->ctrl->redirect($this, "render");
             }
             $this->displayImportResults($importer);
         }
     }