ilMediaPoolExporter Class Reference

Export2 class for media pools. More...

Inheritance diagram for ilMediaPoolExporter:

Collaboration diagram for ilMediaPoolExporter:

Public Member Functions
	init ()
	Initialisation. 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 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...

Private Attributes
	$ds

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

Export2 class for media pools.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

Id

Definition at line 13 of file class.ilMediaPoolExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilMediaPoolExporter::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 135 of file class.ilMediaPoolExporter.php.

References array.

        {
                return array (
                        "5.1.0" => array(
                                "namespace" => "http://www.ilias.de/Modules/MediaPool/mep/5_1",
                                "xsd_file" => "ilias_mep_5_1.xsd",
                                "uses_dataset" => true,
                                "min" => "5.1.0",
                                "max" => ""),
                        "4.1.0" => array(
                                "namespace" => "http://www.ilias.de/Modules/MediaPool/mep/4_1",
                                "xsd_file" => "ilias_mep_4_1.xsd",
                                "uses_dataset" => true,
                                "min" => "4.1.0",
                                "max" => "")
                                );
        }

getXmlExportHeadDependencies()

ilMediaPoolExporter::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 43 of file class.ilMediaPoolExporter.php.

References array, and ilObjMediaPool\getAllMobIds().

        {
                include_once("./Modules/MediaPool/classes/class.ilObjMediaPool.php");
                include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
                $pg_ids = array();
                $mob_ids = array();

                foreach ($a_ids as $id)
                {
                        $m_ids = ilObjMediaPool::getAllMobIds($id);
                        foreach ($m_ids as $m)
                        {
                                $mob_ids[] = $m;
                        }
                }

                if ($this->config->getMasterLanguageOnly())
                {
                        return array();
                }

                return array (
                        array(
                                "component" => "Services/MediaObjects",
                                "entity" => "mob",
                                "ids" => $mob_ids)
                        );
        }

Here is the call graph for this function:

getXmlExportTailDependencies()

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

Definition at line 81 of file class.ilMediaPoolExporter.php.

References array, and ilMediaPoolItem\getIdsForType().

        {
                include_once("./Modules/MediaPool/classes/class.ilObjMediaPool.php");
                include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
                $pg_ids = array();
                $mob_ids = array();

                foreach ($a_ids as $id)
                {
                        $pages = ilMediaPoolItem::getIdsForType($id, "pg");
                        foreach ($pages as $p)
                        {
                                $pg_ids[] = "mep:".$p;
                        }
                }

                $deps = array (
                        array(
                                "component" => "Services/COPage",
                                "entity" => "pg",
                                "ids" => $pg_ids)
                        );

                if (!$this->config->getMasterLanguageOnly())
                {
                        $deps[] = array(
                                "component" => "Services/Object",
                                "entity" => "transl",
                                "ids" => $a_ids);
                }

                return $deps;
        }

Here is the call graph for this function:

getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns

string xml string

Definition at line 123 of file class.ilMediaPoolExporter.php.

        {
                return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
        }

init()

ilMediaPoolExporter::init

(

)

Initialisation.

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

References ilXmlExporter\getExport().

        {
                include_once("./Modules/MediaPool/classes/class.ilMediaPoolDataSet.php");
                $this->ds = new ilMediaPoolDataSet();
                $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
                $this->ds->setDSPrefix("ds");
                $this->config = $this->getExport()->getConfig("Modules/MediaPool");
                if ($this->config->getMasterLanguageOnly())
                {
                        $conf = $this->getExport()->getConfig("Services/COPage");
                        $conf->setMasterLanguageOnly(true);
                        $this->ds->setMasterLanguageOnly(true);
                }
        }

Here is the call graph for this function:

Field Documentation

$ds

ilMediaPoolExporter::$ds

private

Definition at line 15 of file class.ilMediaPoolExporter.php.

---

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

• Modules/MediaPool/classes/class.ilMediaPoolExporter.php