ilGroupExporter Class Reference

Folder export. More...

Inheritance diagram for ilGroupExporter:

Collaboration diagram for ilGroupExporter:

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

Constructor & Destructor Documentation

__construct()

ilGroupExporter::__construct

(

)

Constructor.

Reimplemented from ilXmlExporter.

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

    {
    }

Member Function Documentation

getValidSchemaVersions()

ilGroupExporter::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 88 of file class.ilGroupExporter.php.

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

getXmlExportHeadDependencies()

ilGroupExporter::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 44 of file class.ilGroupExporter.php.

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

getXmlRepresentation()

ilGroupExporter::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 64 of file class.ilGroupExporter.php.

    {
        $group_ref_id = end(ilObject::_getAllReferences($a_id));
        $group = ilObjectFactory::getInstanceByRefId($group_ref_id, false);
        
        if (!$group instanceof ilObjGroup) {
            $GLOBALS['DIC']->logger()->grp()->warning($a_id . ' is not instance of type group');
            return '';
        }
        
        include_once './Modules/Group/classes/class.ilGroupXMLWriter.php';
        $this->writer = new ilGroupXMLWriter($group);
        $this->writer->setMode(ilGroupXMLWriter::MODE_EXPORT);
        $this->writer->start();
        return $this->writer->getXML();
    }

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

Here is the call graph for this function:

init()

ilGroupExporter::init

(

)

Init export.

Returns

Reimplemented from ilXmlExporter.

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

    {
    }

Field Documentation

$writer

ilGroupExporter::$writer = null

private

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

---

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

• Modules/Group/classes/class.ilGroupExporter.php