ilOrgUnitSimpleUserImportGUI Class Reference

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

Collaboration diagram for ilOrgUnitSimpleUserImportGUI:

Public Member Functions
	__construct (object $parent_gui)
	executeCommand ()
	userImportScreen ()
	startImport ()
	displayImportResults (ilOrgUnitImporter $importer)

Protected Attributes
ilTabsGUI	$tabs_gui
ilToolbarGUI	$toolbar
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
object	$parent_object
object	$parent_gui
ilLanguage	$lng
ilAccessHandler	$ilAccess
ILIAS DI LoggingServices	$ilLog

Private Member Functions
	initForm ()

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 ilOrgUnitSimpleUserImportGUI

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

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitSimpleUserImportGUI::__construct

(

object

$parent_gui

)

Definition at line 40 of file class.ilOrgUnitSimpleUserImportGUI.php.

References $DIC, $parent_gui, ILIAS\Repository\ctrl(), 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->ilLog = $DIC->logger();
        $this->ilAccess = $DIC->access();
        $this->lng->loadLanguageModule('user');
        if (!$this->ilAccess->checkaccess('write', '', $this->parent_gui->getObject()->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
        }
    }

Here is the call graph for this function:

Member Function Documentation

displayImportResults()

ilOrgUnitSimpleUserImportGUI::displayImportResults

(

ilOrgUnitImporter

$importer

)

Definition at line 117 of file class.ilOrgUnitSimpleUserImportGUI.php.

References ilOrgUnitImporter\getErrors(), ilOrgUnitImporter\getStats(), ilOrgUnitImporter\getWarnings(), ilOrgUnitImporter\hasErrors(), ilOrgUnitImporter\hasWarnings(), and ILIAS\Repository\lng().

Referenced by startImport().

                                                                     : void
    {
        if (!$importer->hasErrors() and !$importer->hasWarnings()) {
            $stats = $importer->getStats();
            $this->tpl->setOnScreenMessage(
                'success',
                sprintf($this->lng->txt('user_import_successful'), $stats['created'], $stats['removed']),
                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()

ilOrgUnitSimpleUserImportGUI::executeCommand

(

)

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

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

                                    : bool
    {
        $cmd = $this->ctrl->getCmd();

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTargetByClass('ilOrgUnitSimpleImportGUI', 'chooseImport')
        );

        switch ($cmd) {
            case 'userImportScreen':
                $this->userImportScreen();
                break;
            case 'startImport':
                $this->startImport();
                break;
        }

        return true;
    }

Here is the call graph for this function:

initForm()

ilOrgUnitSimpleUserImportGUI::initForm ( )

private

Definition at line 86 of file class.ilOrgUnitSimpleUserImportGUI.php.

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

Referenced by startImport(), and userImportScreen().

                               : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $input = new ilFileInputGUI($this->lng->txt('import_xml_file'), 'import_file');
        $input->setRequired(true);
        $form->addItem($input);
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->addCommandButton('startImport', $this->lng->txt('import'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

startImport()

ilOrgUnitSimpleUserImportGUI::startImport

(

)

Definition at line 98 of file class.ilOrgUnitSimpleUserImportGUI.php.

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

Referenced by executeCommand().

                                 : void
    {
        $form = $this->initForm();
        if (!$form->checkInput()) {
            $this->tpl->setContent($form->getHTML());
        } else {
            $file = $form->getInput('import_file');
            $importer = new ilOrgUnitSimpleUserImport();
            try {
                $importer->simpleUserImport($file['tmp_name']);
            } 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userImportScreen()

ilOrgUnitSimpleUserImportGUI::userImportScreen

(

)

Definition at line 80 of file class.ilOrgUnitSimpleUserImportGUI.php.

References initForm().

Referenced by executeCommand().

                                      : void
    {
        $form = $this->initForm();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilOrgUnitSimpleUserImportGUI::$ctrl

protected

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

$ilAccess

ilAccessHandler ilOrgUnitSimpleUserImportGUI::$ilAccess

protected

Definition at line 36 of file class.ilOrgUnitSimpleUserImportGUI.php.

$ilLog

ILIAS DI LoggingServices ilOrgUnitSimpleUserImportGUI::$ilLog

protected

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

$lng

ilLanguage ilOrgUnitSimpleUserImportGUI::$lng

protected

Definition at line 35 of file class.ilOrgUnitSimpleUserImportGUI.php.

$parent_gui

object ilOrgUnitSimpleUserImportGUI::$parent_gui

protected

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

Referenced by __construct().

$parent_object

object ilOrgUnitSimpleUserImportGUI::$parent_object

protected

Definition at line 33 of file class.ilOrgUnitSimpleUserImportGUI.php.

$tabs_gui

ilTabsGUI ilOrgUnitSimpleUserImportGUI::$tabs_gui

protected

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

$toolbar

ilToolbarGUI ilOrgUnitSimpleUserImportGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilOrgUnitSimpleUserImportGUI::$tpl

protected

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

---

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

• components/ILIAS/OrgUnit/classes/SimpleUserImport/class.ilOrgUnitSimpleUserImportGUI.php