ilMediaPoolDataSet Class Reference

Media Pool Data set class. More...

Inheritance diagram for ilMediaPoolDataSet:

Collaboration diagram for ilMediaPoolDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	setMasterLanguageOnly ($a_val)
	Set master language only (export) More...
	getMasterLanguageOnly ()
	Get master language only (export) More...
	setTranslationImportMode ($a_lm, $a_lang="")
	Set translation import mode. More...
	getTranslationImportMode ()
	Get translation import mode. More...
	getTranslationLM ()
	Get translation lm (import. More...
	getTranslationLang ()
	Get translation language (import. More...
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...
	init ($a_entity, $a_schema_version)
	Init. More...
	getSupportedVersions ()
	Get supported version. More...
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...
	getDSPrefix ()
	Get XML dataset namespace prefix. More...
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...
	getJsonRepresentation ()
	Get json representation. More...
	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text" > <ftype name="field_2" type="date" > <ftype name="field_3" type="integer" > </types> <types ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> More...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...
	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...
	getJsonRecord ($a_set)
	Get json record for version. More...
	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...
	getJsonTypes ($a_entity, $a_version)
	Get json types. More...
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...
	setImport ($a_val)
	Set import object. More...
	getImport ()
	Get import object. More...
	setCurrentInstallationId ($a_val)
	Set current installation id. More...
	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...
Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...
	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...
	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
	$master_lang_only = false
	$transl_into = false
	$transl_into_lm = null
	$transl_lang = ""
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""
	$db
	$ds_log
	$ds_namespace = 'ds'

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt
const	EXPORT_NO_INST_ID = 1
const	EXPORT_ID_ILIAS_LOCAL = 2
const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3
const	EXPORT_ID_ILIAS_REMOTE = 4
const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5
const	EXPORT_ID = 6
const	EXPORT_ID_INVALID = 7

Detailed Description

Media Pool Data set class.

This class implements the following entities:

• mep_data: data from table mep_data
• mep_tree: data from a join on mep_tree and mep_item

Author

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

Version

$Id$

Definition at line 17 of file class.ilMediaPoolDataSet.php.

Member Function Documentation

getDependencies()

ilMediaPoolDataSet::getDependencies (   $a_entity,   $a_version,   $a_rec,   $a_ids  )

protected

Determine the dependent sets of data.

Definition at line 267 of file class.ilMediaPoolDataSet.php.

    {
        switch ($a_entity) {
            case "mep":
                return array(
                    "mep_tree" => array("ids" => $a_rec["Id"])
                );
        }
        return false;
    }

getMasterLanguageOnly()

ilMediaPoolDataSet::getMasterLanguageOnly

(

)

Get master language only (export)

Returns

bool export only master language

Definition at line 61 of file class.ilMediaPoolDataSet.php.

    {
        return $this->master_lang_only;
    }

References $master_lang_only.

Referenced by readData().

Here is the caller graph for this function:

getSupportedVersions()

ilMediaPoolDataSet::getSupportedVersions

(

)

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        return array("5.1.0", "4.1.0");
    }

getTranslationImportMode()

ilMediaPoolDataSet::getTranslationImportMode

(

)

Get translation import mode.

Returns

bool check if translation import is activated

Definition at line 88 of file class.ilMediaPoolDataSet.php.

    {
        return $this->transl_into;
    }

References $transl_into.

Referenced by importRecord().

Here is the caller graph for this function:

getTranslationLang()

ilMediaPoolDataSet::getTranslationLang

(

)

Get translation language (import.

Returns

string language

Definition at line 108 of file class.ilMediaPoolDataSet.php.

    {
        return $this->transl_lang;
    }

References $transl_lang.

getTranslationLM()

ilMediaPoolDataSet::getTranslationLM

(

)

Get translation lm (import.

Returns

ilObjLearningModule learning module

Definition at line 98 of file class.ilMediaPoolDataSet.php.

    {
        return $this->transl_into_lm;
    }

References $transl_into_lm.

Referenced by importRecord().

Here is the caller graph for this function:

getTypes()

ilMediaPoolDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 119 of file class.ilMediaPoolDataSet.php.

    {
        // mep
        if ($a_entity == "mep") {
            switch ($a_version) {
                case "4.1.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "DefaultWidth" => "integer",
                        "DefaultHeight" => "integer");
 
                case "5.1.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "DefaultWidth" => "integer",
                        "DefaultHeight" => "integer",
                        "ForTranslation" => "integer"
                    );
            }
        }
    
        // mep_tree
        if ($a_entity == "mep_tree") {
            switch ($a_version) {
                case "4.1.0":
                case "5.1.0":
                        return array(
                            "MepId" => "integer",
                            "Child" => "integer",
                            "Parent" => "integer",
                            "Depth" => "integer",
                            "Type" => "text",
                            "Title" => "text",
                            "ForeignId" => "integer",
                            "ImportId" => "text"
                        );
            }
        }
    }

getXmlNamespace()

ilMediaPoolDataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 41 of file class.ilMediaPoolDataSet.php.

    {
        return "http://www.ilias.de/xml/Modules/MediaPool/" . $a_entity;
    }

importRecord()

ilMediaPoolDataSet::importRecord	(		$a_entity,
			$a_types,
			$a_rec,
			$a_mapping,
			$a_schema_version
	)

Definition at line 283 of file class.ilMediaPoolDataSet.php.

    {
        $a_rec = $this->stripTags($a_rec);
 
        switch ($a_entity) {
            case "mep":
 
                if ($this->getTranslationImportMode()) {
                    return;
                }
 
                include_once("./Modules/MediaPool/classes/class.ilObjMediaPool.php");
 
                if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                    $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                } else {
                    $newObj = new ilObjMediaPool();
                    $newObj->setType("mep");
                    $newObj->create(true);
                }
                
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setDescription($a_rec["Description"]);
                $newObj->setDefaultWidth($a_rec["DefaultWidth"]);
                $newObj->setDefaultHeight($a_rec["DefaultHeight"]);
                $newObj->setForTranslation($a_rec["ForTranslation"]);
                $newObj->update();
                
                $this->current_obj = $newObj;
                $a_mapping->addMapping("Modules/MediaPool", "mep", $a_rec["Id"], $newObj->getId());
                $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
                break;
 
            case "mep_tree":
                if (!$this->getTranslationImportMode()) {
                    switch ($a_rec["Type"]) {
                        case "fold":
                            $parent = (int) $a_mapping->getMapping("Modules/MediaPool", "mep_tree", $a_rec["Parent"]);
                            $fold_id =
                                $this->current_obj->createFolder($a_rec["Title"], $parent);
                            $a_mapping->addMapping(
                                "Modules/MediaPool",
                                "mep_tree",
                                $a_rec["Child"],
                                $fold_id
                            );
                            break;
 
                        case "mob":
                            $parent = (int) $a_mapping->getMapping("Modules/MediaPool", "mep_tree", $a_rec["Parent"]);
                            $mob_id = (int) $a_mapping->getMapping("Services/MediaObjects", "mob", $a_rec["ForeignId"]);
                            $item = new ilMediaPoolItem();
                            $item->setType("mob");
                            $item->setForeignId($mob_id);
                            $item->setImportId($a_rec["ImportId"]);
                            $item->setTitle($a_rec["Title"]);
                            $item->create();
                            if ($item->getId() > 0) {
                                $this->current_obj->insertInTree($item->getId(), $parent);
                            }
                            break;
 
                        case "pg":
                            $parent = (int) $a_mapping->getMapping("Modules/MediaPool", "mep_tree", $a_rec["Parent"]);
 
                            $item = new ilMediaPoolItem();
                            $item->setType("pg");
                            $item->setTitle($a_rec["Title"]);
                            $item->setImportId($a_rec["ImportId"]);
                            $item->create();
                            $a_mapping->addMapping("Modules/MediaPool", "pg", $a_rec["Child"], $item->getId());
                            $a_mapping->addMapping(
                                "Services/COPage",
                                "pg",
                                "mep:" . $a_rec["Child"],
                                "mep:" . $item->getId()
                            );
                            if ($item->getId() > 0) {
                                $this->current_obj->insertInTree($item->getId(), $parent);
                            }
                            break;
 
                    }
                } else {
                    if ($a_rec["Type"] == "pg") {
                        $imp_id = explode("_", $a_rec["ImportId"]);
                        if ($imp_id[0] == "il" &&
                            (int) $imp_id[1] == (int) IL_INST_ID &&
                            $imp_id[2] == "pg"
                        ) {
                            $pg_id = $imp_id[3];
                            include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
                            $pool = ilMediaPoolItem::getPoolForItemId($pg_id);
                            $pool = current($pool);
                            if ($pool == $this->getTranslationLM()->getId()) {
                                $a_mapping->addMapping("Modules/MediaPool", "pg", $a_rec["Child"], $pg_id);
                                $a_mapping->addMapping(
                                    "Services/COPage",
                                    "pg",
                                    "mep:" . $a_rec["Child"],
                                    "mep:" . $pg_id
                                );
                            }
                        }
                    }
                }
                break;
        }
    }

References ilObjectFactory\getInstanceByObjId(), ilMediaPoolItem\getPoolForItemId(), getTranslationImportMode(), getTranslationLM(), IL_INST_ID, and ilDataSet\stripTags().

Here is the call graph for this function:

readData()

ilMediaPoolDataSet::readData	(		$a_entity,
			$a_version,
			$a_ids,
			$a_field = ""
	)

Read data.

Parameters

return

Definition at line 169 of file class.ilMediaPoolDataSet.php.

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
 
        // mep_data
        if ($a_entity == "mep") {
            switch ($a_version) {
                case "4.1.0":
                    $this->getDirectDataFromQuery("SELECT id, title, description, " .
                        " default_width, default_height" .
                        " FROM mep_data JOIN object_data ON (mep_data.id = object_data.obj_id) " .
                        "WHERE " .
                        $ilDB->in("id", $a_ids, false, "integer"));
                    break;
 
                case "5.1.0":
                    $q = "SELECT id, title, description, " .
                        " default_width, default_height" .
                        " FROM mep_data JOIN object_data ON (mep_data.id = object_data.obj_id) " .
                        "WHERE " .
                        $ilDB->in("id", $a_ids, false, "integer");
 
                    $set = $ilDB->query($q);
                    $this->data = array();
                    while ($rec = $ilDB->fetchAssoc($set)) {
                        if ($this->getMasterLanguageOnly()) {
                            $rec["for_translation"] = 1;
                        }
                        $tmp = array();
                        foreach ($rec as $k => $v) {
                            $tmp[$this->convertToLeadingUpper($k)]
                                = $v;
                        }
                        $rec = $tmp;
 
                        $this->data[] = $rec;
                    }
                    break;
 
            }
        }
 
        // mep_tree
        if ($a_entity == "mep_tree") {
            switch ($a_version) {
                case "4.1.0":
                    $this->getDirectDataFromQuery("SELECT mep_id, child " .
                        " ,parent,depth,type,title,foreign_id " .
                        " FROM mep_tree JOIN mep_item ON (child = obj_id) " .
                        " WHERE " .
                        $ilDB->in("mep_id", $a_ids, false, "integer") .
                        " ORDER BY depth");
                    break;
 
                case "5.1.0":
                    $type = "";
                    if ($this->getMasterLanguageOnly()) {
                        $type = " AND type <> " . $ilDB->quote("mob", "text");
                    }
 
                    $q = "SELECT mep_id, child " .
                        " ,parent,depth,type,title,foreign_id, import_id " .
                        " FROM mep_tree JOIN mep_item ON (child = obj_id) " .
                        " WHERE " .
                        $ilDB->in("mep_id", $a_ids, false, "integer") .
                        $type .
                        " ORDER BY depth";
 
                    $set = $ilDB->query($q);
                    $this->data = array();
                    while ($rec = $ilDB->fetchAssoc($set)) {
                        $set2 = $ilDB->query("SELECT for_translation FROM mep_data WHERE id = " . $ilDB->quote($rec["mep_id"], true));
                        $rec2 = $ilDB->fetchAssoc($set2);
                        if (!$rec2["for_translation"]) {
                            $rec["import_id"] = "il_" . IL_INST_ID . "_" . $rec["type"] . "_" . $rec["child"];
                        }
                        $tmp = array();
                        foreach ($rec as $k => $v) {
                            $tmp[$this->convertToLeadingUpper($k)]
                                = $v;
                        }
                        $rec = $tmp;
 
                        $this->data[] = $rec;
                    }
 
                    break;
            }
        }
    }

References ilDataSet\$db, $ilDB, $type, ilDataSet\convertToLeadingUpper(), ilDataSet\getDirectDataFromQuery(), getMasterLanguageOnly(), and IL_INST_ID.

Here is the call graph for this function:

setMasterLanguageOnly()

ilMediaPoolDataSet::setMasterLanguageOnly

(

$a_val

)

Set master language only (export)

Parameters

bool

$a_val

export only master language

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

    {
        $this->master_lang_only = $a_val;
    }

setTranslationImportMode()

ilMediaPoolDataSet::setTranslationImportMode	(		$a_lm,
			$a_lang = ""
	)

Set translation import mode.

Parameters

ilObjLearningModule	$a_lm	learning module
string	$a_lang	language

Definition at line 72 of file class.ilMediaPoolDataSet.php.

    {
        if ($a_lm != null) {
            $this->transl_into = true;
            $this->transl_into_lm = $a_lm;
            $this->transl_lang = $a_lang;
        } else {
            $this->transl_into = false;
        }
    }

Field Documentation

$master_lang_only

ilMediaPoolDataSet::$master_lang_only = false

protected

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

Referenced by getMasterLanguageOnly().

$transl_into

ilMediaPoolDataSet::$transl_into = false

protected

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

Referenced by getTranslationImportMode().

$transl_into_lm

ilMediaPoolDataSet::$transl_into_lm = null

protected

Definition at line 21 of file class.ilMediaPoolDataSet.php.

Referenced by getTranslationLM().

$transl_lang

ilMediaPoolDataSet::$transl_lang = ""

protected

Definition at line 22 of file class.ilMediaPoolDataSet.php.

Referenced by getTranslationLang().

---

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

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