ilOrgUnitSimpleImport Class Reference

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

Inheritance diagram for ilOrgUnitSimpleImport:

Collaboration diagram for ilOrgUnitSimpleImport:

Public Member Functions
	simpleImport (string $file_path)
	simpleImportElement (SimpleXMLElement $o)
Public Member Functions inherited from ilOrgUnitImporter
	__construct ()
	hasMoreThanOneMatch (string $external_id)
	hasErrors ()
	hasWarnings ()
	addWarning (string $lang_var, string $import_id, ?string $action=null)
	addError (string $lang_var, string $import_id, ?string $action=null)
	getErrors ()
	getWarnings ()
	getStats ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
Public Member Functions inherited from ilXmlImporter
	__construct ()
	setImport (ilImport $a_val)
	getImport ()
	init ()
	setInstallId (string $a_val)
	getInstallId ()
	setInstallUrl (string $a_val)
	getInstallUrl ()
	setSchemaVersion (string $a_val)
	getSchemaVersion ()
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setSkipEntities (array $a_val)
	getSkipEntities ()
	exportedFromSameInstallation ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	finalProcessing (ilImportMapping $a_mapping)
	afterContainerImportProcessing (ilImportMapping $mapping)

Protected Member Functions
	moveObject (int $ref_id, int $parent_ref_id, string $ou_id, string $external_id)
Protected Member Functions inherited from ilOrgUnitImporter
	buildRef ($id, string $type)

Additional Inherited Members
Data Fields inherited from ilOrgUnitImporter
array	$errors = []
array	$warnings = []
array	$stats
Protected Attributes inherited from ilXmlImporter
array	$skip_entities = array()
ilImport	$imp
string	$install_id
string	$install_url
string	$schema_version
string	$import_directory

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 ilOrgUnitSimpleImport

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.ilOrgUnitSimpleImport.php.

Member Function Documentation

moveObject()

ilOrgUnitSimpleImport::moveObject ( int  $ref_id, int  $parent_ref_id, string  $ou_id, string  $external_id  )

protected

Parameters

string	$ou_id	this is only needed for displaying the warning.
string	$external_id	this is only needed for displaying the warning.

Definition at line 159 of file class.ilOrgUnitSimpleImport.php.

References $DIC, Vendor\Package\$e, $path, and ilOrgUnitImporter\addWarning().

Referenced by simpleImportElement().

    {
        global $DIC;
        $tree = $DIC['tree'];
        if ($parent_ref_id != $tree->getParentId($ref_id)) {
            try {
                $path = $tree->getPathId($parent_ref_id);
                if (in_array($ref_id, $path)) {
                    $this->addWarning("not_movable_to_subtree", $ou_id ? $ou_id : $external_id, "update");
                } else {
                    $tree->moveTree($ref_id, $parent_ref_id);
                }
            } catch (Exception $e) {
                global $DIC;
                $ilLog = $DIC['ilLog'];
                $this->addWarning("not_movable", $ou_id ? $ou_id : $external_id, "update");
                $ilLog->write($e->getMessage() . "\\n" . $e->getTraceAsString());
                error_log($e->getMessage() . "\\n" . $e->getTraceAsString());
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

simpleImport()

ilOrgUnitSimpleImport::simpleImport

(

string

$file_path

)

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

References Vendor\Package\$a, ilOrgUnitImporter\addError(), and simpleImportElement().

    {
        $this->stats = array("created" => 0, "updated" => 0, "deleted" => 0);
        $a = file_get_contents($file_path, "r");
        $xml = new SimpleXMLElement($a);

        if (!count($xml->OrgUnit)) {
            $this->addError("no_orgunit", $xml->external_id, null);
            return;
        }

        foreach ($xml->OrgUnit as $o) {
            $this->simpleImportElement($o);
        }
    }

Here is the call graph for this function:

simpleImportElement()

ilOrgUnitSimpleImport::simpleImportElement

(

SimpleXMLElement

$o

)

Definition at line 43 of file class.ilOrgUnitSimpleImport.php.

References $DIC, Vendor\Package\$e, $ref_id, ilObject\_hasUntrashedReference(), ilObject\_lookupObjIdByImportId(), ilObject\_lookupType(), ilOrgUnitImporter\addError(), ilOrgUnitImporter\addWarning(), ilOrgUnitImporter\buildRef(), ilObjOrgUnit\getRootOrgRefId(), ilOrgUnitImporter\hasMoreThanOneMatch(), if, and moveObject().

Referenced by simpleImport().

    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $title = (string) $o->title;
        $description = (string) $o->description;
        $external_id = (string) $o->external_id;
        $create_mode = true;
        $attributes = $o->attributes();
        $action = (string) $attributes->action;
        $ou_id = (string) $attributes->ou_id;
        $ou_id_type = (string) $attributes->ou_id_type;
        $ou_parent_id = (string) $attributes->ou_parent_id;
        $ou_parent_id_type = (string) $attributes->ou_parent_id_type;

        if ($ou_id == ilObjOrgUnit::getRootOrgRefId()) {
            $this->addWarning("cannot_change_root_node", $ou_id ? $ou_id : $external_id, $action);

            return;
        }

        if ($ou_parent_id == "__ILIAS") {
            $ou_parent_id = ilObjOrgUnit::getRootOrgRefId();
            $ou_parent_id_type = "reference_id";
        }

        //see mantis 0024601
        if ($ou_id_type == 'external_id') {
            if (strlen($external_id) == 0) {
                $external_id = $ou_id;
            }

            if ($this->hasMoreThanOneMatch($external_id)) {
                $this->addError("ou_more_than_one_match_found", $external_id, $action);

                return;
            }
        }

        $ref_id = $this->buildRef($ou_id, $ou_id_type);
        $parent_ref_id = $this->buildRef($ou_parent_id, $ou_parent_id_type);

        if ($action == "delete") {
            if (!$parent_ref_id) {
                $this->addError("ou_parent_id_not_valid", $ou_id ? $ou_id : $external_id, $action);

                return;
            }
            if (!$ref_id) {
                $this->addError("ou_id_not_valid", $ou_id ? $ou_id : $external_id, $action);

                return;
            }
            $ru = new ilRepUtil($this);
            try {
                $ru->deleteObjects($parent_ref_id, array($ref_id)) !== false;
                $this->stats["deleted"]++;
            } catch (Exception $e) {
                $this->addWarning("orgu_already_deleted", $ou_id ? $ou_id : $external_id, $action);
            }

            return;
        } elseif ($action == "update") {
            if (!$parent_ref_id) {
                $this->addError("ou_parent_id_not_valid", $ou_id ? $ou_id : $external_id, $action);

                return;
            }
            if (!$ref_id) {
                $this->addError("ou_id_not_valid", $ou_id ? $ou_id : $external_id, $action);

                return;
            }
            $object = new ilObjOrgUnit($ref_id);
            $object->setTitle($title);

            $object->updateTranslation($title, $description, $ilUser->getLanguage(), "");

            $object->setDescription($description);
            $object->update();
            $object->setImportId($external_id);
            $this->moveObject($ref_id, $parent_ref_id, $ou_id, $external_id);

            $this->stats["updated"]++;
        } elseif ($action == "create") {
            if (!$parent_ref_id) {
                $this->addError("ou_parent_id_not_valid", $ou_id ? $ou_id : $external_id, $action);

                return;
            }
            if ($external_id) {
                $obj_id = ilObject::_lookupObjIdByImportId($external_id);
                if (ilObject::_hasUntrashedReference($obj_id) && ilObject::_lookupType($obj_id) == 'orgu') {
                    $this->addError("ou_external_id_exists", $ou_id ? $ou_id : $external_id, $action);

                    return;
                }
            }
            $object = new ilObjOrgUnit();
            $object->setTitle($title);
            $object->setDescription($description);
            $object->setImportId($external_id);
            $object->create();
            $object->createReference();
            $object->putInTree($parent_ref_id);
            $object->setPermissions($parent_ref_id);
            $this->stats["created"]++;
        } else {
            $this->addError("no_valid_action_given", $ou_id, $action);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/OrgUnit/classes/SimpleImport/class.ilOrgUnitSimpleImport.php