ilCourseExporter Class Reference

Folder export. More...

Inheritance diagram for ilCourseExporter:

Collaboration diagram for ilCourseExporter:

Public Member Functions
	__construct ()
	Constructor. More...
	init ()
	Init export. More...
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	Constructor. 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...

Private Attributes
	$writer = null

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

Detailed Description

Folder export.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilCourseExporter::__construct

(

)

Constructor.

Reimplemented from ilXmlExporter.

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

        {
        }

Member Function Documentation

getValidSchemaVersions()

ilCourseExporter::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.

Returns

Reimplemented from ilXmlExporter.

Definition at line 100 of file class.ilCourseExporter.php.

        {
                return array (
                        "4.1.0" => array(
                                "namespace" => "http://www.ilias.de/Modules/Course/crs/4_1",
                                "xsd_file" => "ilias_course_4_1.xsd",
                                "uses_dataset" => false,
                                "min" => "4.1.0",
                                "max" => "4.4.999"),
                        "5.0.0" => array(
                                "namespace" => "http://www.ilias.de/Modules/Course/crs/5_0",
                                "xsd_file" => "ilias_crs_5_0.xsd",
                                "uses_dataset" => false,
                                "min" => "5.0.0",
                                "max" => "")
                );
        }

getXmlExportHeadDependencies()

ilCourseExporter::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 45 of file class.ilCourseExporter.php.

        {
                include_once './Services/Export/classes/class.ilExportOptions.php';
                $eo = ilExportOptions::getInstance();
 
                $obj_id = end($a_ids);
                if($eo->getOption(ilExportOptions::KEY_ROOT) != $obj_id)
                {
                        return array();
                }
                if(count(ilExportOptions::getInstance()->getSubitemsForExport()) > 1)
                {
                        return array(
                                array(
                                        'component'             => 'Services/Container',
                                        'entity'                => 'struct',
                                        'ids'                   => $a_ids
                                )
                        );
                }
                return array();         
        }

References ilExportOptions\getInstance(), and ilExportOptions\KEY_ROOT.

Here is the call graph for this function:

getXmlRepresentation()

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

Get xml.

Parameters

object	$a_entity
object	$a_schema_version
object	$a_id

Returns

Reimplemented from ilXmlExporter.

Definition at line 76 of file class.ilCourseExporter.php.

        {
                $course_ref_id = end(ilObject::_getAllReferences($a_id));
                $course = ilObjectFactory::getInstanceByRefId($course_ref_id,false);
                
                if(!$course instanceof ilObjCourse)
                {
                        $GLOBALS['ilLog']->write(__METHOD__. $a_id . ' is not instance of type course');
                        return ''; 
                }
                
                $this->writer = new ilCourseXMLWriter($course);
                $this->writer->setMode(ilCourseXMLWriter::MODE_EXPORT);
                $this->writer->start();
                return $this->writer->xmlDumpMem(false);
        }

References $GLOBALS, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), and ilCourseXMLWriter\MODE_EXPORT.

Here is the call graph for this function:

init()

ilCourseExporter::init

(

)

Init export.

Returns

Reimplemented from ilXmlExporter.

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

        {
                
        }

Field Documentation

$writer

ilCourseExporter::$writer = null

private

Definition at line 19 of file class.ilCourseExporter.php.

---

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

• Modules/Course/classes/class.ilCourseExporter.php