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...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail 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...
	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...

Data Fields
const	ENTITY_OBJECTIVE = 'objectives'
const	ENTITY_MAIN = 'crs'

Protected Attributes
	$logger = null
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

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

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

    {
        $this->logger = $GLOBALS['DIC']->logger()->crs();
    }

References $GLOBALS.

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 152 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 53 of file class.ilCourseExporter.php.

    {
        if ($a_entity != self::ENTITY_MAIN) {
            return array();
        }
 
        // always trigger container because of co-page(s)
        return array(
            array(
                'component' => 'Services/Container',
                'entity' => 'struct',
                'ids' => $a_ids
            )
        );
    }

getXmlExportTailDependencies()

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

    {
        $dependencies = array();
        if ($a_entity == self::ENTITY_MAIN) {
            $obj_id = 0;
            foreach ($a_ids as $id) {
                $obj_id = $id;
            }
 
            $dependencies[] = array(
                    'component' => 'Modules/Course',
                    'entity' => self::ENTITY_OBJECTIVE,
                    'ids' => $obj_id
            );
            
            include_once './Modules/Course/classes/Objectives/class.ilLOPage.php';
            include_once './Modules/Course/classes/class.ilCourseObjective.php';
            $page_ids = array();
            foreach (ilCourseObjective::_getObjectiveIds($obj_id) as $objective_id) {
                foreach (ilLOPage::getAllPages('lobj', $objective_id) as $page_id) {
                    $page_ids[] = ('lobj:' . $page_id['id']);
                }
            }
            
            if ($page_ids) {
                $dependencies[] = array(
                    'component' => 'Services/COPage',
                    'entity' => 'pg',
                    'ids' => $page_ids
                );
            }
        }
        return $dependencies;
    }

References $id, ilCourseObjective\_getObjectiveIds(), and ilPageObject\getAllPages().

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

    {
        $course_ref_id = end(ilObject::_getAllReferences($a_id));
        $course = ilObjectFactory::getInstanceByRefId($course_ref_id, false);
        
        // begin-patch optes_lok_export
        if ($a_entity == self::ENTITY_OBJECTIVE) {
            try {
                include_once './Modules/Course/classes/Objectives/class.ilLOXmlWriter.php';
                $writer = new ilLOXmlWriter($course_ref_id);
                $writer->write();
                return $writer->getXml();
            } catch (Exception $ex) {
                $this->logger->error('Export failed with message: ' . $ex->getMessage());
                // and throw
                throw $ex;
            }
        }
        // end-patch optes_lok_export
        
        if (!$course instanceof ilObjCourse) {
            $this->logger->warning($a_id . ' is not id of course instance.');
            return '';
        }
        
        $this->writer = new ilCourseXMLWriter($course);
        $this->writer->setMode(ilCourseXMLWriter::MODE_EXPORT);
        $this->writer->start();
        return $this->writer->xmlDumpMem(false);
    }

References $writer, 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 41 of file class.ilCourseExporter.php.

    {
    }

Field Documentation

$logger

ilCourseExporter::$logger = null

protected

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

$writer

ilCourseExporter::$writer = null

private

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

Referenced by getXmlRepresentation().

ENTITY_MAIN

const ilCourseExporter::ENTITY_MAIN = 'crs'

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

ENTITY_OBJECTIVE

const ilCourseExporter::ENTITY_OBJECTIVE = 'objectives'

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