ilOrgUnitImporter 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 ilOrgUnitImporter:

Collaboration diagram for ilOrgUnitImporter:

Public Member Functions
	__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)

Data Fields
array	$errors = []
array	$warnings = []
array	$stats

Protected Member Functions
	buildRef ($id, string $type)

Private Attributes
ilDBInterface	$database

Additional Inherited Members
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 ilOrgUnitImporter

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 25 of file class.ilOrgUnitImporter.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitImporter::__construct

(

)

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

References $DIC.

    {
        global $DIC;
        $this->database = $DIC->database();
    }

Member Function Documentation

addError()

ilOrgUnitImporter::addError	(	string	$lang_var,
		string	$import_id,
		?string	$action = null
	)

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

Referenced by ilOrgUnitSimpleImport\simpleImport(), ilOrgUnitSimpleImport\simpleImportElement(), ilOrgUnitSimpleUserImport\simpleUserImport(), and ilOrgUnitSimpleUserImport\simpleUserImportElement().

                                                                                         : void
    {
        $this->errors[] = array('lang_var' => $lang_var, 'import_id' => $import_id, 'action' => $action);
    }

Here is the caller graph for this function:

addWarning()

ilOrgUnitImporter::addWarning	(	string	$lang_var,
		string	$import_id,
		?string	$action = null
	)

Definition at line 112 of file class.ilOrgUnitImporter.php.

Referenced by ilOrgUnitSimpleImport\moveObject(), and ilOrgUnitSimpleImport\simpleImportElement().

                                                                                           : void
    {
        $this->warnings[] = array('lang_var' => $lang_var, 'import_id' => $import_id, 'action' => $action);
    }

Here is the caller graph for this function:

buildRef()

ilOrgUnitImporter::buildRef (   $id, string  $type  )

protected

Parameters

$id	int|string

Returns

bool|int

Definition at line 45 of file class.ilOrgUnitImporter.php.

References $id, $ref_id, ilObjOrgUnit\_exists(), ilObject\_getAllReferences(), ilObject\_hasUntrashedReference(), ilObject\_isInTrash(), ilObject\_lookupObjIdByImportId(), and ilObject\_lookupType().

Referenced by ilOrgUnitSimpleImport\simpleImportElement(), and ilOrgUnitSimpleUserImport\simpleUserImportElement().

    {
        if (!is_int($id) && !is_string($id)) {
            throw new \InvalidArgumentException("Expected int or string as \$id, got: " . gettype($id));
        }

        if ($type === 'reference_id') {
            if (!ilObjOrgUnit::_exists((int) $id, true)) {
                return false;
            }

            return $id;
        } elseif ($type === 'external_id') {
            $obj_id = ilObject::_lookupObjIdByImportId($id);

            if (ilObject::_lookupType($obj_id) !== 'orgu') {
                return false;
            }

            if (!ilObject::_hasUntrashedReference($obj_id)) {
                return false;
            }

            $ref_ids = ilObject::_getAllReferences($obj_id);

            if (!count($ref_ids)) {
                return false;
            }

            foreach ($ref_ids as $ref_id) {
                if (!ilObject::_isInTrash($ref_id)) {
                    return $ref_id;
                }
            }

            return false;
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getErrors()

ilOrgUnitImporter::getErrors

(

)

Definition at line 122 of file class.ilOrgUnitImporter.php.

References $errors.

Referenced by ilOrgUnitSimpleUserImportGUI\displayImportResults().

                               : array
    {
        return $this->errors;
    }

Here is the caller graph for this function:

getStats()

ilOrgUnitImporter::getStats

(

)

Definition at line 132 of file class.ilOrgUnitImporter.php.

References $stats.

Referenced by ilOrgUnitSimpleUserImportGUI\displayImportResults().

                              : array
    {
        return $this->stats;
    }

Here is the caller graph for this function:

getWarnings()

ilOrgUnitImporter::getWarnings

(

)

Definition at line 127 of file class.ilOrgUnitImporter.php.

References $warnings.

Referenced by ilOrgUnitSimpleUserImportGUI\displayImportResults().

                                 : array
    {
        return $this->warnings;
    }

Here is the caller graph for this function:

hasErrors()

ilOrgUnitImporter::hasErrors

(

)

Definition at line 102 of file class.ilOrgUnitImporter.php.

Referenced by ilOrgUnitSimpleUserImportGUI\displayImportResults().

                               : bool
    {
        return count($this->errors) != 0;
    }

Here is the caller graph for this function:

hasMoreThanOneMatch()

ilOrgUnitImporter::hasMoreThanOneMatch

(

string

$external_id

)

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

References $res.

Referenced by ilOrgUnitSimpleImport\simpleImportElement().

                                                            : bool
    {
        $query = "SELECT * FROM object_data " .
            "INNER JOIN object_reference as ref on ref.obj_id = object_data.obj_id and ref.deleted is null " .
            'WHERE object_data.type = "orgu" and import_id = ' . $this->database->quote($external_id, "text") . " " .
            "ORDER BY create_date DESC";

        $res = $this->database->query($query);

        if ($this->database->numRows($res) > 1) {
            return true;
        } else {
            return false;
        }
    }

Here is the caller graph for this function:

hasWarnings()

ilOrgUnitImporter::hasWarnings

(

)

Definition at line 107 of file class.ilOrgUnitImporter.php.

Referenced by ilOrgUnitSimpleUserImportGUI\displayImportResults().

                                 : bool
    {
        return count($this->warnings) != 0;
    }

Here is the caller graph for this function:

importXmlRepresentation()

ilOrgUnitImporter::importXmlRepresentation	(	string	$a_entity,
		string	$a_id,
		string	$a_xml,
		ilImportMapping	$a_mapping
	)

Deprecated:

Definition at line 138 of file class.ilOrgUnitImporter.php.

References ilObject\_lookupType(), ilImportMapping\addMapping(), and ilImportMapping\getMappingsOfEntity().

     : void {
        $container_mappings = $a_mapping->getMappingsOfEntity("components/ILIAS/Container", "objs");
        foreach ($container_mappings as $old => $new) {
            if (ilObject2::_lookupType($new) === 'orgu') {
                $a_mapping->addMapping('components/ILIAS/OrgUnit', 'orgu', $old, $new);
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$database

ilDBInterface ilOrgUnitImporter::$database

private

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

$errors

array ilOrgUnitImporter::$errors = []

Definition at line 28 of file class.ilOrgUnitImporter.php.

Referenced by getErrors().

$stats

array ilOrgUnitImporter::$stats

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

Referenced by getStats().

$warnings

array ilOrgUnitImporter::$warnings = []

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

Referenced by getWarnings().

---

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

• components/ILIAS/OrgUnit/classes/class.ilOrgUnitImporter.php