ilLearningSequenceExporter Class Reference

Inheritance diagram for ilLearningSequenceExporter:

Collaboration diagram for ilLearningSequenceExporter:

Public Member Functions
	init ()
	getXmlRepresentation ($entity, $target_release, $obj_id)
	Get xml representation. More...
	getValidSchemaVersions ($entity)
	Returns schema versions that the component can export to. More...
	getXmlExportHeadDependencies ($entity, $target_release, $ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. Parameters string entity string target release array ids Returns array array of array with keys "component", entity", "ids" More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	Constructor. More...
	setExport (ilExport $a_exp)
	Set export object. More...
	getExport ()
	Get export. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	init ()
	setExportDirectories ($a_dir_relative, $a_dir_absolute)
	Export directories. More...
	getRelativeExportDirectory ()
	Get relative export directory. More...
	getAbsoluteExportDirectory ()
	Get absolute export directory. More...
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion ($a_entity, $a_target_release)
	Determine schema version. More...

Protected Member Functions
	getWriter (int $obj_id)

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
	export directory lookup More...
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

Detailed Description

Author

Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

Definition at line 8 of file class.ilLearningSequenceExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilLearningSequenceExporter::getValidSchemaVersions

(

$a_entity

)

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top. Example:

            return array (
    "4.1.0" => array(
            "namespace" => "http://www.ilias.de/Services/MetaData/md/4_1",
            "xsd_file" => "ilias_md_4_1.xsd",
            "min" => "4.1.0",
            "max" => "")
    );

Returns

array

Reimplemented from ilXmlExporter.

Definition at line 44 of file class.ilLearningSequenceExporter.php.

    {
        return array(
            "5.4.0" => array(
                "namespace" => "http://www.ilias.de/Modules/LearningSequence/lso/5_4",
                "xsd_file" => "ilias_lso_5_4.xsd",
                "uses_dataset" => false,
                "min" => "5.4.0",
                "max" => ""
            )
        );
    }

getWriter()

ilLearningSequenceExporter::getWriter ( int  $obj_id )

protected

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

                                              : ilLearningSequenceXMLWriter
    {
        if ($type = ilObject::_lookupType($obj_id) != "lso") {
            throw new Exception("Wrong type " . $type . " for lso export.");
        }
 
        $ls_ref_id = end(ilObject::_getAllReferences($obj_id));
        $ls_object = ilObjectFactory::getInstanceByRefId($ls_ref_id, false);
        $lp_settings = new ilLPObjSettings($obj_id);
 
        return new ilLearningSequenceXMLWriter(
            $ls_object,
            $this->settings,
            $lp_settings,
            $this->rbac_review
        );
    }

References $type, ilObject\_getAllReferences(), ilObject\_lookupType(), ilObjectFactory\getInstanceByRefId(), and settings().

Referenced by getXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

getXmlExportHeadDependencies()

ilLearningSequenceExporter::getXmlExportHeadDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get head dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

Definition at line 57 of file class.ilLearningSequenceExporter.php.

    {
        return array(
            array(
                'component' => 'Services/Container',
                'entity' => 'struct',
                'ids' => $ids
            )
        );
    }

getXmlExportTailDependencies()

ilLearningSequenceExporter::getXmlExportTailDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

Definition at line 71 of file class.ilLearningSequenceExporter.php.

    {
        $res = [];
 
        if ($a_entity == "lso") {
            // service settings
            $res[] = array(
                "component" => "Services/Object",
                "entity" => "common",
                "ids" => $a_ids
            );
        }
 
        return $res;
    }

References $res.

getXmlRepresentation()

ilLearningSequenceExporter::getXmlRepresentation	(		$a_entity,
			$a_schema_version,
			$a_id
	)

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns

string xml string

Reimplemented from ilXmlExporter.

Definition at line 18 of file class.ilLearningSequenceExporter.php.

    {
        $writer = $this->getWriter((int) $obj_id);
        $writer->start();
 
        return $writer->getXml();
    }

References getWriter().

Here is the call graph for this function:

init()

ilLearningSequenceExporter::init

(

)

Reimplemented from ilXmlExporter.

Definition at line 10 of file class.ilLearningSequenceExporter.php.

    {
        global $DIC;
 
        $this->settings = $DIC["ilSetting"];
        $this->rbac_review = $DIC["rbacreview"];
    }

References $DIC, and settings().

Here is the call graph for this function:

---

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

• Modules/LearningSequence/classes/class.ilLearningSequenceExporter.php