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

Collaboration diagram for ilCourseExporter:

Public Member Functions
	__construct ()
	init ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	setExport (ilExport $a_exp)
	getExport ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	init ()
	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
	getRelativeExportDirectory ()
	getAbsoluteExportDirectory ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion (string $a_entity, string $a_target_release)

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

Protected Attributes
ilXmlWriter	$writer
ilLogger	$logger
Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""
string	$dir_absolute = ""
ilExport	$exp

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")

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 Folder export

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCourseExporter::__construct

(

)

Reimplemented from ilXmlExporter.

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

    {
        global $DIC;
        $this->logger = $DIC->logger()->crs();
    }

References $DIC, and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

getValidSchemaVersions()

ilCourseExporter::getValidSchemaVersions

(

string

$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" => "") );

Reimplemented from ilXmlExporter.

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

                                                            : array
    {
        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	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get head dependencies.

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        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	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get tail dependencies.

Returns

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

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        $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
            );
 
            $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	(	string	$a_entity,
		string	$a_schema_version,
		string	$a_id
	)

Reimplemented from ilXmlExporter.

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

                                                                                                  : string
    {
        $refs = ilObject::_getAllReferences((int) $a_id);
        $course_ref_id = end($refs);
        $course = ilObjectFactory::getInstanceByRefId($course_ref_id, false);
 
        // begin-patch optes_lok_export
        if ($a_entity == self::ENTITY_OBJECTIVE) {
            try {
                $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(), ILIAS\Repository\logger(), and ilCourseXMLWriter\MODE_EXPORT.

Here is the call graph for this function:

init()

ilCourseExporter::init

(

)

Reimplemented from ilXmlExporter.

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

                          : void
    {
    }

Field Documentation

$logger

ilLogger ilCourseExporter::$logger

protected

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

$writer

ilXmlWriter ilCourseExporter::$writer

protected

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

Referenced by getXmlRepresentation().

ENTITY_MAIN

const ilCourseExporter::ENTITY_MAIN = 'crs'

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

ENTITY_OBJECTIVE

const ilCourseExporter::ENTITY_OBJECTIVE = 'objectives'

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

---

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

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