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

Collaboration diagram for ilOrgUnitSimpleUserImport:

Public Member Functions
	__construct ()
	simpleUserImport ($file_path)
	simpleUserImportElement (SimpleXMLElement $a)
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 Attributes
ilOrgUnitPositionDBRepository	$positionRepo
ilOrgUnitUserAssignmentDBRepository	$assignmentRepo
Protected Attributes inherited from ilXmlImporter
array	$skip_entities = array()
ilImport	$imp
string	$install_id
string	$install_url
string	$schema_version
string	$import_directory

Private Member Functions
	buildUserId ($id, $type)

Additional Inherited Members
Data Fields inherited from ilOrgUnitImporter
array	$errors = []
array	$warnings = []
array	$stats
Protected Member Functions inherited from ilOrgUnitImporter
	buildRef ($id, string $type)

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 ilOrgUnitSimpleUserImport

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitSimpleUserImport::__construct

(

)

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

References $dic, and ilOrgUnitLocalDIC\dic().

    {
        $dic = ilOrgUnitLocalDIC::dic();
        $this->positionRepo = $dic["repo.Positions"];
        $this->assignmentRepo = $dic["repo.UserAssignments"];
    }

Here is the call graph for this function:

Member Function Documentation

buildUserId()

ilOrgUnitSimpleUserImport::buildUserId (   $id,   $type  )

private

Parameters

$id
$type

Returns

bool

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

References $DIC, $id, $ilDB, $q, $user_id, ilObjUser\_lookupId(), and ilObject\_lookupObjIdByImportId().

Referenced by simpleUserImportElement().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        if ($type == 'ilias_login') {
            $user_id = ilObjUser::_lookupId($id);

            return $user_id ? $user_id : false;
        } elseif ($type == 'external_id') {
            $user_id = ilObjUser::_lookupObjIdByImportId($id);

            return $user_id ? $user_id : false;
        } elseif ($type == 'email') {
            $q = 'SELECT usr_id FROM usr_data WHERE email = ' . $ilDB->quote($id, 'text');
            $set = $ilDB->query($q);
            $user_id = $ilDB->fetchAssoc($set);

            return $user_id ? $user_id : false;
        } elseif ($type == 'user_id') {
            return $id;
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

simpleUserImport()

ilOrgUnitSimpleUserImport::simpleUserImport

(

$file_path

)

Parameters

$file_path

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

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

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

        if (!count($xml->children())) {
            $this->addError('no_assignment', null, null);

            return;
        }

        foreach ($xml->children() as $a) {
            $this->simpleUserImportElement($a);
        }
    }

Here is the call graph for this function:

simpleUserImportElement()

ilOrgUnitSimpleUserImport::simpleUserImportElement

(

SimpleXMLElement

$a

)

Parameters

SimpleXMLElement

$a

Definition at line 60 of file class.ilOrgUnitSimpleUserImport.php.

References $user_id, ilOrgUnitImporter\addError(), ilOrgUnitImporter\buildRef(), buildUserId(), ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, and ilOrgUnitPosition\CORE_POSITION_SUPERIOR.

Referenced by simpleUserImport().

    {
        $attributes = $a->attributes();
        $action = $attributes->action;
        $user_id_type = $a->User->attributes()->id_type;
        $user_id = (string) $a->User;
        $org_unit_id_type = $a->OrgUnit->attributes()->id_type;
        $org_unit_id = (string) $a->OrgUnit;
        $role = (string) $a->Role;

        if (!$user_id = $this->buildUserId($user_id, $user_id_type)) {
            $this->addError('user_not_found', $a->User);

            return;
        }

        if (!$org_unit_id = $this->buildRef($org_unit_id, $org_unit_id_type)) {
            $this->addError('org_unit_not_found', $a->OrgUnit);

            return;
        }
        $org_unit = new ilObjOrgUnit($org_unit_id);

        if ($role === 'employee') {
            $position_id = $this->positionRepo
                ->getSingle(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE, 'core_identifier')
                ->getId();
        } elseif ($role === 'superior') {
            $position_id = $this->positionRepo
                ->getSingle(ilOrgUnitPosition::CORE_POSITION_SUPERIOR, 'core_identifier')
                ->getId();
        } else {
            //if passed a custom position.
            $position = $this->positionRepo->getSingle($role, 'title');
            if ($position instanceof ilOrgUnitPosition) {
                $position_id = $position->getId();
            } else {
                $this->addError('not_a_valid_role', $user_id);
                return;
            }
        }

        if ($action == 'add') {
            $assignment = $this->assignmentRepo->get($user_id, $position_id, $org_unit_id);
            $this->stats['created']++;
        } elseif ($action == 'remove') {
            $assignment = $this->assignmentRepo->find($user_id, $position_id, $org_unit_id);
            if ($assignment) {
                $this->assignmentRepo->delete($assignment);
                $this->stats['removed']++;
            }
        } else {
            $this->addError('not_a_valid_action', $user_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$assignmentRepo

ilOrgUnitUserAssignmentDBRepository ilOrgUnitSimpleUserImport::$assignmentRepo

protected

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

$positionRepo

ilOrgUnitPositionDBRepository ilOrgUnitSimpleUserImport::$positionRepo

protected

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

---

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

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