ilOrgUnitSimpleUserImportGUI Class Reference

Class ilOrgUnitSimpleUserImportGUI. More...

Collaboration diagram for ilOrgUnitSimpleUserImportGUI:

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

Protected Member Functions
	testImport ()
	FSX Can be deleted; Just for a single Test of a UserImport More...
	initForm ()

Protected Attributes
	$tabs_gui
	$toolbar
	$ctrl
	$tpl
	$parent_object
	$lng
	$ilAccess

Detailed Description

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 11 of file class.ilOrgUnitSimpleUserImportGUI.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitSimpleUserImportGUI::__construct

(

$parent_gui

)

Parameters

$parent_gui

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

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

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];
        $log = $DIC['log'];
        $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->ilLog = $log;
        $this->ilAccess = $ilAccess;
        $this->lng->loadLanguageModule('user');
        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

displayImportResults()

ilOrgUnitSimpleUserImportGUI::displayImportResults

(

$importer

)

Parameters

$importer

ilOrgUnitImporter

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

References $stats, $warning, ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\sendSuccess().

Referenced by startImport().

    {
        if (!$importer->hasErrors() and !$importer->hasWarnings()) {
            $stats = $importer->getStats();
            ilUtil::sendSuccess(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>';
            }
            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()

ilOrgUnitSimpleUserImportGUI::executeCommand

(

)

Returns

bool

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

References startImport(), and userImportScreen().

    {
        $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 ( )

protected

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

References $form, and ilFormPropertyGUI\setRequired().

Referenced by startImport(), and userImportScreen().

    {
        $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 134 of file class.ilOrgUnitSimpleUserImportGUI.php.

References $file, $form, displayImportResults(), initForm(), ilUtil\sendFailure(), and ilLog\write().

Referenced by executeCommand().

    {
        $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());
                ilUtil::sendFailure($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:

testImport()

ilOrgUnitSimpleUserImportGUI::testImport ( )

protected

FSX Can be deleted; Just for a single Test of a UserImport

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

References $xml, and ilUtil\sendInfo().

    {
        return false;
        $importer = new ilOrgUnitSimpleUserImport();
        $string = '<Assignment action=\'add\'>
                                                <User id_type=\'ilias_login\'>root</User>
                        <OrgUnit id_type=\'external_id\'>imported_001</OrgUnit>
                                                <Role>superior</Role>
                    </Assignment>';

        $xml = new SimpleXMLElement($string);
        $importer->simpleUserImportElement($xml);
        ilUtil::sendInfo('<pre>' . print_r($importer->getErrors(), 1) . '</pre>');
    }

Here is the call graph for this function:

userImportScreen()

ilOrgUnitSimpleUserImportGUI::userImportScreen

(

)

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

References $form, and initForm().

Referenced by executeCommand().

    {
        $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

ilOrgUnitSimpleUserImportGUI::$ctrl

protected

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

$ilAccess

ilOrgUnitSimpleUserImportGUI::$ilAccess

protected

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

Referenced by __construct().

$lng

ilOrgUnitSimpleUserImportGUI::$lng

protected

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

Referenced by __construct().

$parent_object

ilOrgUnitSimpleUserImportGUI::$parent_object

protected

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

$tabs_gui

ilOrgUnitSimpleUserImportGUI::$tabs_gui

protected

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

$toolbar

ilOrgUnitSimpleUserImportGUI::$toolbar

protected

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

$tpl

ilOrgUnitSimpleUserImportGUI::$tpl

protected

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

Referenced by __construct().

---

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

• Modules/OrgUnit/classes/SimpleUserImport/class.ilOrgUnitSimpleUserImportGUI.php