ilFolderExporter Class Reference

Folder export. More...

Inheritance diagram for ilFolderExporter:

Collaboration diagram for ilFolderExporter:

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

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
	$exp

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

Constructor & Destructor Documentation

__construct()

ilFolderExporter::__construct

(

)

Constructor.

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

    {
    }

Member Function Documentation

getValidSchemaVersions()

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

Definition at line 107 of file class.ilFolderExporter.php.

    {
        return array(
            "4.1.0" => array(
                "namespace" => "http://www.ilias.de/Modules/Folder/fold/4_1",
                "xsd_file" => "ilias_fold_4_1.xsd",
                "uses_dataset" => false,
                "min" => "4.1.0",
                "max" => "")
        );
    }

getXmlExportHeadDependencies()

ilFolderExporter::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"

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

    {
        // always trigger container because of co-page(s)
        return array(
            array(
                'component' => 'Services/Container',
                'entity' => 'struct',
                'ids' => $a_ids
            )
        );
        
        /*
        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();
        */
    }

getXmlRepresentation()

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

Get xml.

Parameters

object	$a_entity
object	$a_schema_version
object	$a_id

Returns

Definition at line 87 of file class.ilFolderExporter.php.

References $GLOBALS.

    {
        try {
            $this->writer = new ilFolderXmlWriter(false);
            $this->writer->setObjId($a_id);
            $this->writer->write();
            return $this->writer->xmlDumpMem(false);
        } catch (UnexpectedValueException $e) {
            $GLOBALS['ilLog']->write("Caught error: " . $e->getMessage());
            return '';
        }
    }

init()

ilFolderExporter::init

(

)

Init export.

Returns

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

    {
    }

Field Documentation

$writer

ilFolderExporter::$writer = null

private

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

---

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

• Modules/Folder/classes/class.ilFolderExporter.php