ilConditionsImporter Class Reference

Inheritance diagram for ilConditionsImporter:

Collaboration diagram for ilConditionsImporter:

Public Member Functions
	init ()
	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
	determineRootIdOfImportTree (ilImportMapping $mapping)
	updateInfosWithMapping (InfoCollection $infos, ilImportMapping $mapping)
	updateConditionsWithMapping (array $conditions, ilImportMapping $mapping)
	countObligatory (array $conditions)
	getNewRefId (int $old_ref_id, ilImportMapping $mapping)

Protected Attributes
const string	ENTITY = 'cond'
ConditionExportFactory	$factory
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

Definition at line 24 of file class.ilConditionsImporter.php.

Member Function Documentation

countObligatory()

ilConditionsImporter::countObligatory ( array  $conditions )

protected

Parameters

ilCondition[]

$conditions

Definition at line 143 of file class.ilConditionsImporter.php.

     : int {
        $count = 0;
        foreach ($conditions as $condition) {
            if ($condition->getObligatory()) {
                $count++;
            }
        }
        return $count;
    }

determineRootIdOfImportTree()

ilConditionsImporter::determineRootIdOfImportTree ( ilImportMapping  $mapping )

protected

Definition at line 59 of file class.ilConditionsImporter.php.

     : int {
        // $root_id relies on the fact that the smallest obj_id belongs to the first imported
        // object, wich is the root of the imported object tree
        return (int) min(array_keys($mapping->getAllMappings()['components/ILIAS/Container']['objs']));
    }

getNewRefId()

ilConditionsImporter::getNewRefId ( int  $old_ref_id, ilImportMapping  $mapping  )

protected

Definition at line 155 of file class.ilConditionsImporter.php.

     : int|null {
        $new_ref_id = $mapping->getMapping('components/ILIAS/Container', 'refs', (string) $old_ref_id);
        return is_null($new_ref_id) ? null : (int) $new_ref_id;
    }

importXmlRepresentation()

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

Reimplemented from ilXmlImporter.

Definition at line 36 of file class.ilConditionsImporter.php.

     : void {
        if ($a_entity !== self::ENTITY) {
            return;
        }
        $root_id = $this->determineRootIdOfImportTree($a_mapping);
        if ($root_id !== (int) $a_id) {
            return;
        }
        $reader = $this->factory->xmlReader();
        $infos = $reader->readString($a_xml);
        if ($infos->count() === 0) {
            return;
        }
        $updated_infos = $this->updateInfosWithMapping($infos, $a_mapping);
        $repository = $this->factory->repository();
        $repository->writeByInfos($updated_infos);
    }

init()

ilConditionsImporter::init

(

)

Reimplemented from ilXmlImporter.

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

                          : void
    {
        global $DIC;
        $this->factory = new ConditionExportFactory($DIC->database());
        parent::init();
    }

References $DIC, factory(), and init().

Here is the call graph for this function:

updateConditionsWithMapping()

ilConditionsImporter::updateConditionsWithMapping ( array  $conditions, ilImportMapping  $mapping  )

protected

Parameters

ilCondition[]

$conditions

Returns

ilCondition[]

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

     : array {
        $updated_conditions = [];
        foreach ($conditions as $condition) {
            $new_trigger_ref_id = $this->getNewRefId(
                $condition->getTrigger()->getRefId(),
                $mapping
            );
            if (is_null($new_trigger_ref_id)) {
                continue;
            }
            $new_trigger_obj_id = ilObject::_lookupObjId($new_trigger_ref_id);
            $trigger = new ilConditionTrigger(
                $new_trigger_ref_id,
                $new_trigger_obj_id,
                $condition->getTrigger()->getType()
            );
            $updated_conditions[] = (new ilCondition(
                $trigger,
                $condition->getOperator(),
                $condition->getValue()
            ))
                ->withObligatory($condition->getObligatory())
                ->withId(-1);
        }
        return $updated_conditions;
    }

References ilObject\_lookupObjId().

Here is the call graph for this function:

updateInfosWithMapping()

ilConditionsImporter::updateInfosWithMapping ( InfoCollection  $infos, ilImportMapping  $mapping  )

protected

Definition at line 67 of file class.ilConditionsImporter.php.

     : InfoCollection {
        $updated_infos = $this->factory->infoCollection();
        foreach ($infos as $info) {
            $new_ref_id = $this->getNewRefId(
                $info->getReferenceId(),
                $mapping
            );
            if (is_null($new_ref_id)) {
                continue;
            }
            $new_obj_id = ilObject::_lookupObjId($new_ref_id);
            $conditions = $this->updateConditionsWithMapping(
                $info->getConditionSet()->getConditions(),
                $mapping
            );
            $obligatory_count = $this->countObligatory($conditions);
            $conditions_count = count($conditions);
            $num_obligatory = ($conditions_count - $obligatory_count) < 2
                ? 0
                : min($info->getConditionSet()->getNumObligatory(), $conditions_count - 1);
            $condition_set = (new ilConditionSet($conditions))
                ->withHiddenStatus($info->getConditionSet()->getHiddenStatus())
                ->withNumObligatory($num_obligatory);
            if ($obligatory_count === $conditions_count) {
                $condition_set = $condition_set->withAllObligatory();
            }
            $updated_infos = $updated_infos->withInfo(
                $info
                    ->withConditionSet($condition_set)
                    ->withObjectId($new_obj_id)
                    ->withReferenceId($new_ref_id)
            );
        }
        return $updated_infos;
    }

References $info, and ilObject\_lookupObjId().

Here is the call graph for this function:

Field Documentation

$factory

ConditionExportFactory ilConditionsImporter::$factory

protected

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

ENTITY

const string ilConditionsImporter::ENTITY = 'cond'

protected

Definition at line 26 of file class.ilConditionsImporter.php.

---

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

• components/ILIAS/Conditions/classes/Export/class.ilConditionsImporter.php