ilOrgUnitImporter Class Reference

Class ilOrgUnitImporter. More...

Inheritance diagram for ilOrgUnitImporter:

Collaboration diagram for ilOrgUnitImporter:

Public Member Functions
	hasMoreThanOneMatch ($external_id)
	hasErrors ()
	hasWarnings ()
	addWarning ($lang_var, $import_id, $action=null)
	addError ($lang_var, $import_id, $action=null)
	getErrors ()
	getWarnings ()
	getStats ()
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
Public Member Functions inherited from ilXmlImporter
	__construct ()
	Constructor. More...
	setImport ($a_val)
	Set import. More...
	getImport ()
	Get import. More...
	init ()
	Init. More...
	setInstallId ($a_val)
	Set installation id. More...
	getInstallId ()
	Get installation id. More...
	setInstallUrl ($a_val)
	Set installation url. More...
	getInstallUrl ()
	Get installation url. More...
	setSchemaVersion ($a_val)
	Set schema version. More...
	getSchemaVersion ()
	Get schema version. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setSkipEntities ($a_val)
	Set skip entities. More...
	getSkipEntities ()
	Get skip entities. More...
	exportedFromSameInstallation ()
	Is exporting and importing installation identical? More...
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
	Import xml representation. More...
	finalProcessing ($a_mapping)
	Final processing. More...
	afterContainerImportProcessing (ilImportMapping $mapping)
	Called after all container objects have been implemented. More...

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

Protected Member Functions
	buildRef ($id, $type)

Additional Inherited Members
Protected Attributes inherited from ilXmlImporter
	$skip_entities = array()
	$imp

Detailed Description

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

Member Function Documentation

addError()

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

Parameters

	$lang_var
	$import_id
null	$action

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

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

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

Here is the caller graph for this function:

addWarning()

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

Parameters

	$lang_var
	$import_id
null	$action

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

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

    {
        $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,   $type  )

protected

Parameters

$id
$type

Returns

bool|int

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

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

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

    {
        if ($type == 'reference_id') {
            if (!ilObjOrgUnit::_exists($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

(

)

Returns

array

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

References $errors.

    {
        return $this->errors;
    }

getStats()

ilOrgUnitImporter::getStats

(

)

Returns

array

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

References $stats.

    {
        return $this->stats;
    }

getWarnings()

ilOrgUnitImporter::getWarnings

(

)

Returns

array

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

References $warnings.

    {
        return $this->warnings;
    }

hasErrors()

ilOrgUnitImporter::hasErrors

(

)

Returns

bool

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

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

hasMoreThanOneMatch()

ilOrgUnitImporter::hasMoreThanOneMatch

(

$external_id

)

Parameters

string

$external_id

Returns

bool

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

References $DIC, $ilDB, $query, and $res.

Referenced by ilOrgUnitSimpleImport\simpleImportElement().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $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 = ' . $ilDB->quote($external_id, "text") . " " .
            "ORDER BY create_date DESC";

        $res = $ilDB->query($query);

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

Here is the caller graph for this function:

hasWarnings()

ilOrgUnitImporter::hasWarnings

(

)

Returns

bool

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

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

importXmlRepresentation()

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

Parameters

$a_entity
$a_id
$a_xml
$a_mapping	ilImportMapping

Returns

string|void

Deprecated:

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

References ilObject2\_lookupType().

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

Here is the call graph for this function:

Field Documentation

$errors

ilOrgUnitImporter::$errors = []

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

Referenced by getErrors().

$stats

ilOrgUnitImporter::$stats

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

Referenced by getStats().

$warnings

ilOrgUnitImporter::$warnings = []

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

Referenced by getWarnings().

---

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

• Modules/OrgUnit/classes/class.ilOrgUnitImporter.php