ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilCmiXapiDataSet Class Reference
+ Inheritance diagram for ilCmiXapiDataSet:
+ Collaboration diagram for ilCmiXapiDataSet:

Public Member Functions

 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...
 
 initByExporter (ilXmlExporter $xml_exporter)
 
 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...
 
 getCollection (array $record, string $entity, string $schema_version, string $field, string $value)
 
 getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)
 

Data Fields

array $_cmixSettingsProperties
 
- 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)
 
 getExportDirInContainer (string $exp_dir)
 
 getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")
 
 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 $component_export_dir = ""
 
string $ds_prefix = "ds"
 
string $version = ""
 
ilSurveyImporter $import
 
ilExport $export
 

Detailed Description

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

Member Function Documentation

◆ buildManifest()

ilCmiXapiDataSet::buildManifest ( )
private

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

352 : string
353 {
354 $manWriter = new ilXmlWriter();
355 $manWriter->xmlHeader();
356 foreach ($this->_archive['files'] as $key => $value) {
357 $manWriter->xmlElement($key, null, $value, true, true);
358 }
359 #$manWriter->appendXML ("</content>\n");
360 return $manWriter->xmlDumpMem(true);
361 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ buildProperties()

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

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

363 : string
364 {
365 $atts = array(
366 "InstallationId" => IL_INST_ID,
367 "InstallationUrl" => ILIAS_HTTP_PATH,
368 "TopEntity" => $a_entity
369 );
370
371 $writer = new ilXmlWriter();
372
373 $writer->xmlStartTag('DataSet', $atts);
374
375 if (!$a_omit_header) {
376 $writer->xmlHeader();
377 }
378
379 foreach ($this->data as $key => $value) {
380 $writer->xmlElement($key, null, $value, true, true);
381 }
382
383 $writer->xmlEndTag("DataSet");
384
385 return $writer->xmlDumpMem(true);
386 }
const IL_INST_ID
Definition: constants.php:40

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

157 : array {
158 return [];
159 }

◆ getSupportedVersions()

ilCmiXapiDataSet::getSupportedVersions ( )

Get supported versions.

Returns
string[]

Reimplemented from ilDataSet.

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

427 : array
428 {
429 return array("5.1.0");
430 }

◆ getTypes()

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

Get field types for entity.

Parameters
string$a_entityentity
string$a_versionversion number
Returns
array types array

Reimplemented from ilDataSet.

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

286 : array
287 {
288 $types = [];
289 foreach ($this->_cmixSettingsProperties as $key => $value) {
290 $types[$key] = $value["db_type"];
291 }
292 //var_dump($types); exit;
293 //return $types;
294
295 if ($a_entity == "cmix") {
296 switch ($a_version) {
297 case "5.1.0":
298 $types = [];
299 foreach ($this->_cmixSettingsProperties as $key => $value) {
300 $types[$key] = $value["db_type"];
301 }
302 //return $types;
303 break;
304 }
305 }
306 return $types;
307 }

◆ getXmlNamespace()

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

Get xml namespace.

Reimplemented from ilDataSet.

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

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

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

394 : void {
395 //var_dump( [$a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version] ); exit;
396 switch ($a_entity) {
397 case "cmix":
398
399 if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_rec['Id'])) {
400 $newObj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
401 } else {
402 $newObj = new ilObjCmiXapi();
403 $newObj->setType("cmix");
404 $newObj->create(true);
405 }
406
407 $newObj->setTitle($a_rec["Title"]);
408 $newObj->setDescription($a_rec["Description"]);
409 $newObj->update();
410
411 //$this->current_obj = $newObj;
412 $a_mapping->addMapping("components/ILIAS/CmiXapi", "cmix", $a_rec["Id"], (string) $newObj->getId());
413 $a_mapping->addMapping(
414 "components/ILIAS/MetaData",
415 "md",
416 $a_rec["Id"] . ":0:cmix",
417 $newObj->getId() . ":0:cmix"
418 );
419 break;
420 }
421 }
addMapping(string $a_comp, string $a_entity, string $a_old_id, string $a_new_id)
getMapping(string $a_comp, string $a_entity, string $a_old_id)
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id

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

◆ $_cmixSettingsProperties

array ilCmiXapiDataSet::$_cmixSettingsProperties

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

◆ $_data

array ilCmiXapiDataSet::$_data = []
private

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

◆ $_element_db_mapping

array ilCmiXapiDataSet::$_element_db_mapping = []
private

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


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