ilStyleExporter Class Reference

Style export definition. More...

Inheritance diagram for ilStyleExporter:

Collaboration diagram for ilStyleExporter:

Public Member Functions
	init ()
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. 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...

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

Style export definition.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 14 of file class.ilStyleExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilStyleExporter::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. 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" => "")
    );

Returns

array

Reimplemented from ilXmlExporter.

Definition at line 51 of file class.ilStyleExporter.php.

    {
        return array(
            "5.1.0" => array(
                "namespace" => "http://www.ilias.de/Services/Style/5_1",
                "xsd_file" => "ilias_style_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.1.0",
                "max" => ""),
            "5.0.0" => array(
                "namespace" => "http://www.ilias.de/Services/Style/5_0",
                "xsd_file" => "ilias_style_5_0.xsd",
                "uses_dataset" => false,
                "min" => "5.0.0",
                "max" => "")
        );
    }

getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns

string xml string

Reimplemented from ilXmlExporter.

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

    {
        if ($a_schema_version == "5.1.0") {
            ilUtil::makeDirParents($this->getAbsoluteExportDirectory());
            $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
            return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
        }
        if ($a_schema_version == "5.0.0") {
            if ($a_entity == "sty") {
                include_once "Services/Style/Content/classes/class.ilObjStyleSheet.php";
                $style = new ilObjStyleSheet($a_id, false);
 
                // images
                $target = $this->getAbsoluteExportDirectory();
                if ($target && !is_dir($target)) {
                    ilUtil::makeDirParents($target);
                }
                ilUtil::rCopy($style->getImagesDirectory(), $target);
 
                return "<StyleSheetExport>" .
                    "<ImagePath>" . $this->getRelativeExportDirectory() . "</ImagePath>" .
                    $style->getXML() .
                    "</StyleSheetExport>";
            }
        }
    }

References $style, $target, ilXmlExporter\getAbsoluteExportDirectory(), ilXmlExporter\getRelativeExportDirectory(), ilUtil\makeDirParents(), and ilUtil\rCopy().

Here is the call graph for this function:

init()

ilStyleExporter::init

(

)

Reimplemented from ilXmlExporter.

Definition at line 16 of file class.ilStyleExporter.php.

    {
        include_once("./Services/Style/classes/class.ilStyleDataSet.php");
        $this->ds = new ilStyleDataSet();
        $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
        $this->ds->setDSPrefix("ds");
    }

---

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

• Services/Style/classes/class.ilStyleExporter.php