HTML learning module data set class. More...

Inheritance diagram for ilHTMLLearningModuleDataSet:

Collaboration diagram for ilHTMLLearningModuleDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record. More...

	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...

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

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

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

Detailed Description

HTML learning module data set class.

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

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Definition at line 95 of file class.ilHTMLLearningModuleDataSet.php.

        {
                return false;
        }

◆ getSupportedVersions()

ilHTMLLearningModuleDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

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

        {
                return array("4.1.0");
        }

◆ getTypes()

ilHTMLLearningModuleDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 43 of file class.ilHTMLLearningModuleDataSet.php.

        {
                if ($a_entity == "htlm")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        return array(
                                                "Id" => "integer",
                                                "Title" => "text",
                                                "Description" => "text",
                                                "StartFile" => "text",
                                                "Dir" => "directory");
                        }
                }
 
        }

◆ getXmlNamespace()

ilHTMLLearningModuleDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

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

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

◆ getXmlRecord()

ilHTMLLearningModuleDataSet::getXmlRecord	(	$a_entity,
		$a_version,
		$a_set
	)

Get xml record.

Parameters

return

Reimplemented from ilDataSet.

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

        {
                                include_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLM.php");
                $lm = new ilObjFileBasedLM($a_set["Id"], false);
                $dir = $lm->getDataDirectory();
                $a_set["Dir"] = $dir;
 
                return $a_set;
        }

◆ importRecord()

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

Import record.

Parameters

return

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

        {
//echo $a_entity;
//var_dump($a_rec);
 
                switch ($a_entity)
                {
                        case "htlm":
                                
                                include_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLM.php");
                                if($new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['Id']))
                                {
                                        $newObj = ilObjectFactory::getInstanceByObjId($new_id,false);
                                }
                                else
                                {
                                        $newObj = new ilObjFileBasedLM();
                                        $newObj->setType("htlm");
                                        $newObj->create(true);
                                }
 
                                $newObj->setTitle($a_rec["Title"]);
                                $newObj->setDescription($a_rec["Description"]);
                                $newObj->setStartFile($a_rec["StartFile"], true);
                                $newObj->update();
                                $this->current_obj = $newObj;
 
                                $dir = str_replace("..", "", $a_rec["Dir"]);
                                if ($dir != "" && $this->getImportDirectory() != "")
                                {
                                        $source_dir = $this->getImportDirectory()."/".$dir;
                                        $target_dir = $newObj->getDataDirectory();
                                        ilUtil::rCopy($source_dir, $target_dir);
                                }
 
                                $a_mapping->addMapping("Modules/HTMLLearningModule", "htlm", $a_rec["Id"], $newObj->getId());
                                $a_mapping->addMapping("Services/MetaData", "md",
                                        $a_rec["Id"].":0:htlm", $newObj->getId().":0:htlm");
                                break;
                }
        }

References ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), and ilUtil\rCopy().

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

Definition at line 67 of file class.ilHTMLLearningModuleDataSet.php.

        {
                global $ilDB;
 
                if (!is_array($a_ids))
                {
                        $a_ids = array($a_ids);
                }
                                
                if ($a_entity == "htlm")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        $this->getDirectDataFromQuery("SELECT id, title, description, ".
                                                " startfile start_file ".
                                                " FROM file_based_lm JOIN object_data ON (file_based_lm.id = object_data.obj_id) ".
                                                "WHERE ".
                                                $ilDB->in("id", $a_ids, false, "integer"));
                                        break;
                        }
                }
 
        }

References $ilDB, and ilDataSet\getDirectDataFromQuery().

Here is the call graph for this function:

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

Modules/HTMLLearningModule/classes/class.ilHTMLLearningModuleDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()