Inheritance diagram for ilCmiXapiDataSet:

Collaboration diagram for ilCmiXapiDataSet:

Public Member Functions
	buildMetaData (int $id)

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getSupportedVersions ()
	Get supported versions. More...

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

Public Member Functions inherited from ilDataSet
	__construct ()

	init (string $a_entity, string $a_schema_version)
	Init. More...

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	setExportDirectories (string $a_relative, string $a_absolute)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...

	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

Data Fields
array	$_cmixSettingsProperties

Data Fields inherited from ilDataSet
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

int	$dircnt = 0

Protected Member Functions
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Determine the dependent sets of data. More...

	getTypes (string $a_entity, string $a_version)
	Get field types for entity. More...

Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...

	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...

	stripTags (array $rec, array $omit_keys=[])

Private Member Functions
	buildManifest ()

	buildProperties ($a_entity, bool $a_omit_header=false)

Private Attributes
array	$_data = []

array	$_archive = []

array	$_element_db_mapping = []

Additional Inherited Members
Protected Attributes inherited from ilDataSet
string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$relative_export_dir = ""

string	$absolute_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

Detailed Description

Definition at line 27 of file class.ilCmiXapiDataSet.php.

Member Function Documentation

◆ buildManifest()

ilCmiXapiDataSet::buildManifest ( )

private

Definition at line 368 of file class.ilCmiXapiDataSet.php.

                                    : string
    {
        $manWriter = new ilXmlWriter();
        $manWriter->xmlHeader();
        foreach ($this->_archive['files'] as $key => $value) {
            $manWriter->xmlElement($key, null, $value, true, true);
        }
        #$manWriter->appendXML ("</content>\n");
        return $manWriter->xmlDumpMem(true);
    }

References ILIAS\LTI\ToolProvider\$key.

◆ buildMetaData()

ilCmiXapiDataSet::buildMetaData ( int $id )

Definition at line 361 of file class.ilCmiXapiDataSet.php.

                                          : string
    {
        $md2xml = new ilMD2XML($id, $id, "cmix");
        $md2xml->startExport();
        return $md2xml->getXML();
    }

References $id.

◆ buildProperties()

ilCmiXapiDataSet::buildProperties	(		$a_entity,
		bool	$a_omit_header = `false`
	)

private

Parameters

mixed $a_entity

Definition at line 382 of file class.ilCmiXapiDataSet.php.

                                                                            : string
    {
        $atts = array(
            "InstallationId" => IL_INST_ID,
            "InstallationUrl" => ILIAS_HTTP_PATH,
            "TopEntity" => $a_entity
        );
 
        $writer = new ilXmlWriter();
 
        $writer->xmlStartTag('DataSet', $atts);
 
        if (!$a_omit_header) {
            $writer->xmlHeader();
        }
 
        foreach ($this->data as $key => $value) {
            $writer->xmlElement($key, null, $value, true, true);
        }
 
        $writer->xmlEndTag("DataSet");
 
        return $writer->xmlDumpMem(true);
    }

References ILIAS\LTI\ToolProvider\$key, and IL_INST_ID.

◆ getDependencies()

ilCmiXapiDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Determine the dependent sets of data.

Returns: mixed[]

Reimplemented from ilDataSet.

Definition at line 149 of file class.ilCmiXapiDataSet.php.

     : array {
        return [];
    }

◆ getSupportedVersions()

ilCmiXapiDataSet::getSupportedVersions ( )

Get supported versions.

Returns: string[]

Reimplemented from ilDataSet.

Definition at line 440 of file class.ilCmiXapiDataSet.php.

                                          : array
    {
        return array("5.1.0");
    }

◆ getTypes()

ilCmiXapiDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

Get field types for entity.

Parameters

string	$a_entity	entity
string	$a_version	version number

Returns: array types array

Reimplemented from ilDataSet.

Definition at line 295 of file class.ilCmiXapiDataSet.php.

                                                                    : array
    {
        $types = [];
        foreach ($this->_cmixSettingsProperties as $key => $value) {
            $types[$key] = $value["db_type"];
        }
        //var_dump($types); exit;
        //return $types;
 
        if ($a_entity == "cmix") {
            switch ($a_version) {
                case "5.1.0":
                    $types = [];
                    foreach ($this->_cmixSettingsProperties as $key => $value) {
                        $types[$key] = $value["db_type"];
                    }
                    //return $types;
                    break;
            }
        }
        return $types;
    }

References ILIAS\LTI\ToolProvider\$key.

◆ getXmlNamespace()

ilCmiXapiDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

Get xml namespace.

Reimplemented from ilDataSet.

Definition at line 448 of file class.ilCmiXapiDataSet.php.

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

◆ importRecord()

ilCmiXapiDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Needs to be overwritten for import use case.

Reimplemented from ilDataSet.

Definition at line 407 of file class.ilCmiXapiDataSet.php.

     : void {
        //var_dump( [$a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version] ); exit;
        switch ($a_entity) {
            case "cmix":
 
                if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                    $newObj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
                } else {
                    $newObj = new ilObjCmiXapi();
                    $newObj->setType("cmix");
                    $newObj->create(true);
                }
 
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setDescription($a_rec["Description"]);
                $newObj->update();
 
                //$this->current_obj = $newObj;
                $a_mapping->addMapping("Modules/CmiXapi", "cmix", $a_rec["Id"], (string) $newObj->getId());
                break;
        }
    }

References ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), and ilImportMapping\getMapping().

Here is the call graph for this function:

Field Documentation

◆ $_archive

array ilCmiXapiDataSet::$_archive = []

private

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

◆ $_cmixSettingsProperties

array ilCmiXapiDataSet::$_cmixSettingsProperties

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

◆ $_data

array ilCmiXapiDataSet::$_data = []

private

Definition at line 29 of file class.ilCmiXapiDataSet.php.

◆ $_element_db_mapping

array ilCmiXapiDataSet::$_element_db_mapping = []

private

Definition at line 31 of file class.ilCmiXapiDataSet.php.

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

Modules/CmiXapi/classes/class.ilCmiXapiDataSet.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildManifest()

◆ buildMetaData()

◆ buildProperties()

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

Field Documentation

◆ $_archive

◆ $_cmixSettingsProperties

◆ $_data

◆ $_element_db_mapping