Inheritance diagram for ilCmiXapiDataSet:

Collaboration diagram for ilCmiXapiDataSet:

Public Member Functions
	readData (string $a_entity, string $a_version, array $a_ids)

	buildMetaData (int $id)

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

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

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

Data Fields
array	$_cmixSettingsProperties

array	db_type

Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

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 (mixed $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
ILIAS ResourceStorage Services	$irss

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 286 of file class.ilCmiXapiDataSet.php.

References ILIAS\LTI\ToolProvider\$key.

                                     : 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);
     }

◆ buildMetaData()

ilCmiXapiDataSet::buildMetaData ( int $id )

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

Referenced by getDependencies().

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

Here is the caller graph for this function:

◆ buildProperties()

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

private

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

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

Referenced by getDependencies().

                                                                                   : 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);
     }

Here is the caller graph for this function:

◆ 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[]

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

References $DIC, $GLOBALS, $id, buildMetaData(), buildProperties(), CLIENT_ID, getTypes(), ILIAS_WEB_DIR, ILIAS\Repository\int(), and readData().

      : array {
         return [];
     }

Here is the call graph for this function:

◆ getSupportedVersions()

ilCmiXapiDataSet::getSupportedVersions ( )

Get supported versions.

Returns: string[]

Definition at line 355 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

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by getDependencies().

                                                                     : array
     {
         $types = [];
         foreach ($this->_cmixSettingsProperties as $key => $value) {
             $types[$key] = $value["db_type"];
         }
 
         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;
     }

Here is the caller graph for this function:

◆ getXmlNamespace()

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

Get xml namespace.

Definition at line 363 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
	)

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

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

      : 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;
         }
     }

Here is the call graph for this function:

◆ readData()

ilCmiXapiDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

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

References ilDataSet\$data, $DIC, ILIAS\LTI\ToolProvider\$key, and ilDataSet\getDirectDataFromQuery().

Referenced by getDependencies().

                                                                                : void
     {
         global $DIC;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         //var_dump([$a_entity, $a_version, $a_id]); exit;
         if ($a_entity == "cmix") {
             switch ($a_version) {
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT obj_id id, title, description " .
                         " FROM object_data " .
                         "WHERE " .
                         $DIC->database()->in("obj_id", $a_ids, false, "integer"));
                     break;
             } // EOF switch
         } // EOF if( $a_entity == "cmix" )
 
         foreach ($this->data as $key => $data) {
             $query = "SELECT " . implode(",", array_keys($this->_element_db_mapping)) . " ";
             $query .= "FROM `cmix_settings` ";
             $query .= "WHERE " . $DIC->database()->in("obj_id", $a_ids, false, "integer");
             $result = $DIC->database()->query($query);
             //$this->data = [];
             if ($dataset = $DIC->database()->fetchAssoc($result)) {
                 $this->_data = $dataset;
             }
 
             //foreach( $this->_data AS $key => $data ) {
             foreach ($this->_data as $dbColName => $value) {
                 $attr = $this->_element_db_mapping[$dbColName];
                 $this->data[$key][$attr] = $value;
                 //$this->data[$key][$dbColName] = $value;
             } // EOF foreach ($this->_dataSetMapping as $dbColName => $value)
         } // EOF foreach( $this->_data AS $key => $data )
         $this->data = $this->data[0];
         //var_dump($this->data); exit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_archive

array ilCmiXapiDataSet::$_archive = []

private

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

◆ $_cmixSettingsProperties

array ilCmiXapiDataSet::$_cmixSettingsProperties

Initial value:

= [

"LrsTypeId" => ["db_col" => "lrs_type_id"

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.

◆ db_type

array ilCmiXapiDataSet::db_type

Definition at line 33 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()

◆ readData()

Field Documentation

◆ $_archive

◆ $_cmixSettingsProperties

◆ $_data

◆ $_element_db_mapping

◆ db_type