ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
ilLearningModuleDataSet Class Reference

LearningModule Data set class. More...

+ Inheritance diagram for ilLearningModuleDataSet:
+ Collaboration diagram for ilLearningModuleDataSet:

Public Member Functions

 __construct ()
 Constructor. 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...
 
 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...
 
 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, $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 ...> ... 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 = ""
 
 $lm_log
 
- 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

LearningModule Data set class.

This class implements the following entities:

  • lm: data from content_object
  • lm_tree: data from lm_tree/lm_data
  • lm_data_transl: data from lm_data_transl
  • lm_menu: data from lm_menu
Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningModuleDataSet::__construct ( )

Constructor.

Definition at line 34 of file class.ilLearningModuleDataSet.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().

35  {
37 
38  $this->lm_log = ilLoggerFactory::getLogger('lm');
39  }
__construct(Container $dic, ilPlugin $plugin)
static getLogger($a_component_id)
Get component logger.
+ Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilLearningModuleDataSet::getDependencies (   $a_entity,
  $a_version,
  $a_rec,
  $a_ids 
)
protected

Determine the dependent sets of data.

Definition at line 397 of file class.ilLearningModuleDataSet.php.

References getMasterLanguageOnly().

398  {
399  switch ($a_entity) {
400  case "lm":
401  return array(
402  "lm_tree" => array("ids" => $a_rec["Id"]),
403  "lm_menu" => array("ids" => $a_rec["Id"])
404  );
405 
406  case "lm_tree":
407  if ($this->getMasterLanguageOnly()) {
408  return false;
409  } else {
410  return array(
411  "lm_data_transl" => array("ids" => $a_rec["Child"])
412  );
413  }
414  }
415 
416  return false;
417  }
getMasterLanguageOnly()
Get master language only (export)
+ Here is the call graph for this function:

◆ getMasterLanguageOnly()

ilLearningModuleDataSet::getMasterLanguageOnly ( )

Get master language only (export)

Returns
bool export only master language

Definition at line 55 of file class.ilLearningModuleDataSet.php.

References $master_lang_only.

Referenced by getDependencies(), and readData().

+ Here is the caller graph for this function:

◆ getSupportedVersions()

ilLearningModuleDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

Definition at line 113 of file class.ilLearningModuleDataSet.php.

114  {
115  return array("5.1.0", "5.4.0");
116  }

◆ getTranslationImportMode()

ilLearningModuleDataSet::getTranslationImportMode ( )

Get translation import mode.

Returns
bool check if translation import is activated

Definition at line 82 of file class.ilLearningModuleDataSet.php.

References $transl_into.

Referenced by importRecord().

+ Here is the caller graph for this function:

◆ getTranslationLang()

ilLearningModuleDataSet::getTranslationLang ( )

Get translation language (import.

Returns
string language

Definition at line 102 of file class.ilLearningModuleDataSet.php.

References $transl_lang.

Referenced by importRecord().

+ Here is the caller graph for this function:

◆ getTranslationLM()

ilLearningModuleDataSet::getTranslationLM ( )

Get translation lm (import.

Returns
ilObjLearningModule learning module

Definition at line 92 of file class.ilLearningModuleDataSet.php.

References $transl_into_lm.

Referenced by importRecord().

+ Here is the caller graph for this function:

◆ getTypes()

ilLearningModuleDataSet::getTypes (   $a_entity,
  $a_version 
)
protected

Get field types for entity.

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

Definition at line 136 of file class.ilLearningModuleDataSet.php.

137  {
138  if ($a_entity == "lm") {
139  switch ($a_version) {
140  case "5.1.0":
141  return array(
142  "Id" => "integer",
143  "Title" => "text",
144  "Description" => "text",
145  "DefaultLayout" => "text",
146  "PageHeader" => "text",
147  "TocActive" => "text",
148  "LMMenuActive" => "text",
149  "TOCMode" => "text",
150  "PrintViewActive" => "text",
151  "Numbering" => "text",
152  "HistUserComments" => "text",
153  "PublicAccessMode" => "text",
154  "PubNotes" => "text",
155  "HeaderPage" => "integer",
156  "FooterPage" => "integer",
157  "LayoutPerPage" => "integer",
158  "Rating" => "integer",
159  "HideHeadFootPrint" => "integer",
160  "DisableDefFeedback" => "integer",
161  "RatingPages" => "integer",
162  "ProgrIcons" => "integer",
163  "StoreTries" => "integer",
164  "RestrictForwNav" => "integer",
165  "Comments" => "integer",
166  "ForTranslation" => "integer",
167  "StyleId" => "integer"
168  );
169 
170  case "5.4.0":
171  return array(
172  "Id" => "integer",
173  "Title" => "text",
174  "Description" => "text",
175  "DefaultLayout" => "text",
176  "PageHeader" => "text",
177  "TocActive" => "text",
178  "LMMenuActive" => "text",
179  "TOCMode" => "text",
180  "PrintViewActive" => "text",
181  "NoGloAppendix" => "text",
182  "Numbering" => "text",
183  "HistUserComments" => "text",
184  "PublicAccessMode" => "text",
185  "PubNotes" => "text",
186  "HeaderPage" => "integer",
187  "FooterPage" => "integer",
188  "LayoutPerPage" => "integer",
189  "Rating" => "integer",
190  "HideHeadFootPrint" => "integer",
191  "DisableDefFeedback" => "integer",
192  "RatingPages" => "integer",
193  "ProgrIcons" => "integer",
194  "StoreTries" => "integer",
195  "RestrictForwNav" => "integer",
196  "Comments" => "integer",
197  "ForTranslation" => "integer",
198  "StyleId" => "integer"
199  );
200 
201  }
202  }
203 
204  if ($a_entity == "lm_tree") {
205  switch ($a_version) {
206  case "5.1.0":
207  case "5.4.0":
208  return array(
209  "LmId" => "integer",
210  "Child" => "integer",
211  "Parent" => "integer",
212  "Depth" => "integer",
213  "Type" => "text",
214  "Title" => "text",
215  "ShortTitle" => "text",
216  "PublicAccess" => "text",
217  "Active" => "text",
218  "Layout" => "text",
219  "ImportId" => "text"
220  );
221  }
222  }
223 
224  if ($a_entity == "lm_menu") {
225  switch ($a_version) {
226  case "5.1.0":
227  case "5.4.0":
228  return array(
229  "LmId" => "integer",
230  "LinkType" => "text",
231  "Title" => "text",
232  "Target" => "text",
233  "LinkRefId" => "text",
234  "Active" => "text"
235  );
236  }
237  }
238 
239  if ($a_entity == "lm_data_transl") {
240  switch ($a_version) {
241  case "5.1.0":
242  case "5.4.0":
243  return array(
244  "Id" => "integer",
245  "Lang" => "text",
246  "Title" => "text",
247  "ShortTitle" => "text"
248  );
249  }
250  }
251  }

◆ getXmlNamespace()

ilLearningModuleDataSet::getXmlNamespace (   $a_entity,
  $a_schema_version 
)

Get xml namespace.

Parameters

Definition at line 124 of file class.ilLearningModuleDataSet.php.

125  {
126  return "http://www.ilias.de/xml/Modules/LearningModule/" . $a_entity;
127  }

◆ importRecord()

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

Import record.

Parameters

Definition at line 426 of file class.ilLearningModuleDataSet.php.

References ilNote\activateComments(), ilDataSet\getCurrentInstallationId(), ilObjectFactory\getInstanceByObjId(), getTranslationImportMode(), getTranslationLang(), getTranslationLM(), IL_INST_ID, IL_LAST_NODE, ilLMObject\putInTree(), ilDataSet\stripTags(), and ilUtil\yn2tf().

427  {
428  $a_rec = $this->stripTags($a_rec);
429  //var_dump($a_rec);
430 
431  switch ($a_entity) {
432  case "lm":
433 
434  if ($this->getTranslationImportMode()) {
435  return;
436  }
437 
438  if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
439  $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
440  } else {
441  $newObj = new ilObjLearningModule();
442  $newObj->setType("lm");
443  $newObj->create(true);
444  $newObj->createLMTree();
445  }
446 
447  $newObj->setTitle($a_rec["Title"]);
448  $newObj->setDescription($a_rec["Description"]);
449  $newObj->setLayout($a_rec["DefaultLayout"]);
450  $newObj->setPageHeader($a_rec["PageHeader"]);
451  $newObj->setActiveTOC(ilUtil::yn2tf($a_rec["TocActive"]));
452  $newObj->setActiveLMMenu(ilUtil::yn2tf($a_rec["LmMenuActive"]));
453  $newObj->setTOCMode($a_rec["TocMode"]);
454  $newObj->setActivePrintView(ilUtil::yn2tf($a_rec["PrintViewActive"]));
455  $newObj->setActivePreventGlossaryAppendix(ilUtil::yn2tf($a_rec["NoGloAppendix"]));
456  $newObj->setActiveNumbering(ilUtil::yn2tf($a_rec["Numbering"]));
457  $newObj->setHistoryUserComments(ilUtil::yn2tf($a_rec["HistUserComments"]));
458  $newObj->setPublicAccessMode($a_rec["PublicAccessMode"]);
459  $newObj->setPublicNotes(ilUtil::yn2tf($a_rec["PubNotes"]));
460  // Header Page/ Footer Page ???
461  $newObj->setLayoutPerPage($a_rec["LayoutPerPage"]);
462  $newObj->setRating($a_rec["Rating"]);
463  $newObj->setHideHeaderFooterPrint($a_rec["HideHeadFootPrint"]);
464  $newObj->setDisableDefaultFeedback($a_rec["DisableDefFeedback"]);
465  $newObj->setRatingPages($a_rec["RatingPages"]);
466  $newObj->setForTranslation($a_rec["ForTranslation"]);
467  $newObj->setProgressIcons($a_rec["ProgrIcons"]);
468  $newObj->setStoreTries($a_rec["StoreTries"]);
469  $newObj->setRestrictForwardNavigation($a_rec["RestrictForwNav"]);
470  if ($a_rec["HeaderPage"] > 0) {
471  $a_mapping->addMapping("Modules/LearningModule", "lm_header_page", $a_rec["HeaderPage"], "-");
472  }
473  if ($a_rec["FooterPage"] > 0) {
474  $a_mapping->addMapping("Modules/LearningModule", "lm_footer_page", $a_rec["FooterPage"], "-");
475  }
476 
477  $newObj->update(true);
478  $this->current_obj = $newObj;
479 
480  // activated comments
481  ilNote::activateComments($newObj->getId(), 0, "lm", (int) $a_rec["Comments"]);
482 
483  $a_mapping->addMapping("Modules/LearningModule", "lm", $a_rec["Id"], $newObj->getId());
484  $a_mapping->addMapping("Modules/LearningModule", "lm_style", $newObj->getId(), $a_rec["StyleId"]);
485  $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
486  $a_mapping->addMapping(
487  "Services/MetaData",
488  "md",
489  $a_rec["Id"] . ":0:lm",
490  $newObj->getId() . ":0:lm"
491  );
492  break;
493 
494  case "lm_tree":
495  if (!$this->getTranslationImportMode()) {
496  switch ($a_rec["Type"]) {
497  case "st":
498  $parent = (int) $a_mapping->getMapping("Modules/LearningModule", "lm_tree", $a_rec["Parent"]);
499  $st_obj = new ilStructureObject($this->current_obj);
500  $st_obj->setType("st");
501  $st_obj->setLMId($this->current_obj->getId());
502  $st_obj->setTitle($a_rec["Title"]);
503  $st_obj->setShortTitle($a_rec["ShortTitle"]);
504  $st_obj->setImportId($a_rec["ImportId"]);
505  $st_obj->create(true);
506  ilLMObject::putInTree($st_obj, $parent, IL_LAST_NODE);
507  $a_mapping->addMapping(
508  "Modules/LearningModule",
509  "lm_tree",
510  $a_rec["Child"],
511  $st_obj->getId()
512  );
513  $a_mapping->addMapping(
514  "Services/MetaData",
515  "md",
516  $a_rec["LmId"] . ":" . $a_rec["Child"] . ":st",
517  $this->current_obj->getId() . ":" . $st_obj->getId() . ":st"
518  );
519  break;
520 
521  case "pg":
522  $parent = (int) $a_mapping->getMapping("Modules/LearningModule", "lm_tree", $a_rec["Parent"]);
523  $pg_obj = new ilLMPageObject($this->current_obj);
524  $pg_obj->setType("pg");
525  $pg_obj->setLMId($this->current_obj->getId());
526  $pg_obj->setTitle($a_rec["Title"]);
527  $pg_obj->setShortTitle($a_rec["ShortTitle"]);
528  $pg_obj->setImportId($a_rec["ImportId"]);
529  $pg_obj->create(true, true);
530  ilLMObject::putInTree($pg_obj, $parent, IL_LAST_NODE);
531  $a_mapping->addMapping(
532  "Modules/LearningModule",
533  "lm_tree",
534  $a_rec["Child"],
535  $pg_obj->getId()
536  );
537  $a_mapping->addMapping("Modules/LearningModule", "pg", $a_rec["Child"], $pg_obj->getId());
538  $this->lm_log->debug("add pg map (1), old : " . $a_rec["Child"] . ", new: " . $pg_obj->getId());
539  $a_mapping->addMapping(
540  "Services/COPage",
541  "pg",
542  "lm:" . $a_rec["Child"],
543  "lm:" . $pg_obj->getId()
544  );
545  $a_mapping->addMapping(
546  "Services/MetaData",
547  "md",
548  $a_rec["LmId"] . ":" . $a_rec["Child"] . ":pg",
549  $this->current_obj->getId() . ":" . $pg_obj->getId() . ":pg"
550  );
551  break;
552 
553  // add free pages #18976
554  case "free_pg":
555  $pg_obj = new ilLMPageObject($this->current_obj);
556  $pg_obj->setType("pg");
557  $pg_obj->setLMId($this->current_obj->getId());
558  $pg_obj->setTitle($a_rec["Title"]);
559  $pg_obj->setShortTitle($a_rec["ShortTitle"]);
560  $pg_obj->setImportId($a_rec["ImportId"]);
561  $pg_obj->create(true, true);
562  $a_mapping->addMapping(
563  "Modules/LearningModule",
564  "lm_tree",
565  $a_rec["Child"],
566  $pg_obj->getId()
567  );
568  $a_mapping->addMapping("Modules/LearningModule", "pg", $a_rec["Child"], $pg_obj->getId());
569  $this->lm_log->debug("add pg map (2), old : " . $a_rec["Child"] . ", new: " . $pg_obj->getId());
570  $a_mapping->addMapping(
571  "Services/COPage",
572  "pg",
573  "lm:" . $a_rec["Child"],
574  "lm:" . $pg_obj->getId()
575  );
576  $a_mapping->addMapping(
577  "Services/MetaData",
578  "md",
579  $a_rec["LmId"] . ":" . $a_rec["Child"] . ":pg",
580  $this->current_obj->getId() . ":" . $pg_obj->getId() . ":pg"
581  );
582  break;
583  }
584  } else {
585  switch ($a_rec["Type"]) {
586  case "st":
587  //"il_inst_st_66"
588  $imp_id = explode("_", $a_rec["ImportId"]);
589  if ($imp_id[0] == "il" &&
590  (int) $imp_id[1] == (int) IL_INST_ID &&
591  $imp_id[2] == "st"
592  ) {
593  $st_id = $imp_id[3];
594  if (ilLMObject::_lookupContObjId($st_id) == $this->getTranslationLM()->getId()) {
595  $trans = new ilLMObjTranslation($st_id, $this->getTranslationLang());
596  $trans->setTitle($a_rec["Title"]);
597  $trans->save();
598  $a_mapping->addMapping(
599  "Modules/LearningModule",
600  "link",
601  "il_" . $this->getCurrentInstallationId() . "_" . $a_rec["Type"] . "_" . $a_rec["Child"],
602  $a_rec["ImportId"]
603  );
604  }
605  }
606  // no meta-data mapping, since we do not want to import metadata
607  break;
608 
609  case "pg":
610  //"il_inst_pg_66"
611  $imp_id = explode("_", $a_rec["ImportId"]);
612  if ($imp_id[0] == "il" &&
613  (int) $imp_id[1] == (int) IL_INST_ID &&
614  $imp_id[2] == "pg"
615  ) {
616  $pg_id = $imp_id[3];
617  if (ilLMObject::_lookupContObjId($pg_id) == $this->getTranslationLM()->getId()) {
618  $trans = new ilLMObjTranslation($pg_id, $this->getTranslationLang());
619  $trans->setTitle($a_rec["Title"]);
620  $trans->save();
621  $a_mapping->addMapping("Modules/LearningModule", "pg", $a_rec["Child"], $pg_id);
622  $this->lm_log->debug("add pg map (3), old : " . $a_rec["Child"] . ", new: " . $pg_id);
623  $a_mapping->addMapping(
624  "Modules/LearningModule",
625  "link",
626  "il_" . $this->getCurrentInstallationId() . "_" . $a_rec["Type"] . "_" . $a_rec["Child"],
627  $a_rec["ImportId"]
628  );
629  $a_mapping->addMapping(
630  "Services/COPage",
631  "pg",
632  "lm:" . $a_rec["Child"],
633  "lm:" . $pg_id
634  );
635  }
636  }
637  // no meta-data mapping, since we do not want to import metadata
638  break;
639  }
640  }
641  break;
642 
643  case "lm_data_transl":
644  if (!$this->getTranslationImportMode()) {
645  // save page/chapter title translation
646  $lm_obj_id = $a_mapping->getMapping("Modules/LearningModule", "lm_tree", $a_rec["Id"]);
647  if ($lm_obj_id > 0) {
648  $t = new ilLMObjTranslation($lm_obj_id, $a_rec["Lang"]);
649  $t->setTitle($a_rec["Title"]);
650  $t->setShortTitle($a_rec["ShortTitle"]);
651  $t->save();
652  }
653  }
654  break;
655 
656  case "lm_menu":
657  $lm_id = (int) $a_mapping->getMapping("Modules/LearningModule", "lm", $a_rec["LmId"]);
658  if ($lm_id > 0) {
659  $lm_menu_ed = new ilLMMenuEditor();
660  $lm_menu_ed->setObjId($lm_id);
661  $lm_menu_ed->setTitle($a_rec["Title"]);
662  $lm_menu_ed->setTarget($a_rec["Target"]);
663  $lm_menu_ed->setLinkType($a_rec["LinkType"]);
664  $lm_menu_ed->setLinkRefId($a_rec["LinkRefId"]);
665  $lm_menu_ed->setActive($a_rec["Active"]);
666  $lm_menu_ed->create();
667  }
668  break;
669 
670  }
671  }
Class ilObjLearningModule.
const IL_INST_ID
Definition: constants.php:38
getTranslationLM()
Get translation lm (import.
Class ilLMPageObject.
static putInTree($a_obj, $a_parent_id="", $a_target_node_id="")
put this object into content object tree
class for editing lm menu
getCurrentInstallationId()
Get current installation id.
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
const IL_LAST_NODE
Definition: class.ilTree.php:4
getTranslationImportMode()
Get translation import mode.
Class ilStructreObject.
static activateComments($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_activate=true)
Activate notes feature.
stripTags(array $rec, array $omit_keys=[])
static yn2tf($a_yn)
convert "y"/"n" to true/false
Translation information on lm object.
getTranslationLang()
Get translation language (import.
+ Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

Definition at line 259 of file class.ilLearningModuleDataSet.php.

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

260  {
261  $ilDB = $this->db;
262 
263  if (!is_array($a_ids)) {
264  $a_ids = array($a_ids);
265  }
266 
267  if ($a_entity == "lm") {
268  switch ($a_version) {
269  case "5.1.0":
270  case "5.4.0":
271  switch ($a_version) {
272  case "5.1.0":
273  $q = "SELECT id, title, description," .
274  " default_layout, page_header, toc_active, lm_menu_active, toc_mode, print_view_active, numbering," .
275  " hist_user_comments, public_access_mode, header_page, footer_page, layout_per_page, rating, " .
276  " hide_head_foot_print, disable_def_feedback, rating_pages, store_tries, restrict_forw_nav, progr_icons, stylesheet style_id" .
277  " FROM content_object JOIN object_data ON (content_object.id = object_data.obj_id)" .
278  " WHERE " . $ilDB->in("id", $a_ids, false, "integer");
279  break;
280 
281  case "5.4.0":
282  $q = "SELECT id, title, description," .
283  " default_layout, page_header, toc_active, lm_menu_active, toc_mode, print_view_active, numbering," .
284  " hist_user_comments, public_access_mode, no_glo_appendix, header_page, footer_page, layout_per_page, rating, " .
285  " hide_head_foot_print, disable_def_feedback, rating_pages, store_tries, restrict_forw_nav, progr_icons, stylesheet style_id" .
286  " FROM content_object JOIN object_data ON (content_object.id = object_data.obj_id)" .
287  " WHERE " . $ilDB->in("id", $a_ids, false, "integer");
288 
289  }
290 
291  $set = $ilDB->query($q);
292  $this->data = array();
293  while ($rec = $ilDB->fetchAssoc($set)) {
294  // comments activated?
295  $rec["comments"] = ilNote::commentsActivated($rec["id"], 0, "lm");
296 
297  if ($this->getMasterLanguageOnly()) {
298  $rec["for_translation"] = 1;
299  }
300  $tmp = array();
301  foreach ($rec as $k => $v) {
302  $tmp[$this->convertToLeadingUpper($k)]
303  = $v;
304  }
305  $rec = $tmp;
306 
307  $this->data[] = $rec;
308  }
309  break;
310 
311 
312  break;
313  }
314  }
315 
316  if ($a_entity == "lm_tree") {
317  switch ($a_version) {
318  case "5.1.0":
319  case "5.4.0":
320  // the order by lft is very important, this ensures that parent nodes are written before
321  // their childs and that the import can add nodes simply with a "add at last child" target
322  $q = "SELECT lm_tree.lm_id, child, parent, depth, type, title, short_title, public_access, active, layout, import_id" .
323  " FROM lm_tree JOIN lm_data ON (lm_tree.child = lm_data.obj_id)" .
324  " WHERE " . $ilDB->in("lm_tree.lm_id", $a_ids, false, "integer") .
325  " ORDER BY lft";
326 
327  $set = $ilDB->query($q);
328  $this->data = array();
329  $obj_ids = array();
330  while ($rec = $ilDB->fetchAssoc($set)) {
331  $set2 = $ilDB->query("SELECT for_translation FROM content_object WHERE id = " . $ilDB->quote($rec["lm_id"], "integer"));
332  $rec2 = $ilDB->fetchAssoc($set2);
333  if (!$rec2["for_translation"]) {
334  $rec["import_id"] = "il_" . IL_INST_ID . "_" . $rec["type"] . "_" . $rec["child"];
335  }
336  $tmp = array();
337  foreach ($rec as $k => $v) {
338  $tmp[$this->convertToLeadingUpper($k)]
339  = $v;
340  }
341  $rec = $tmp;
342  $obj_ids[] = $rec["Child"];
343  $this->data[] = $rec;
344  }
345 
346  // add free pages #18976
347  $set3 = $ilDB->query($q = "SELECT lm_id, type, title, short_title, public_access, active, layout, import_id, obj_id child FROM lm_data " .
348  "WHERE " . $ilDB->in("lm_id", $a_ids, false, "integer") .
349  " AND " . $ilDB->in("obj_id", $obj_ids, true, "integer") .
350  " AND type = " . $ilDB->quote("pg", "text"));
351  while ($rec3 = $ilDB->fetchAssoc($set3)) {
352  $set2 = $ilDB->query("SELECT for_translation FROM content_object WHERE id = " . $ilDB->quote($rec3["lm_id"], "integer"));
353  $rec2 = $ilDB->fetchAssoc($set2);
354  if (!$rec2["for_translation"]) {
355  $rec3["import_id"] = "il_" . IL_INST_ID . "_pg_" . $rec3["child"];
356  }
357  $rec3["type"] = "free_pg";
358  $rec3["depth"] = 0;
359  $rec3["parent"] = 0;
360  $tmp = array();
361  foreach ($rec3 as $k => $v) {
362  $tmp[$this->convertToLeadingUpper($k)]
363  = $v;
364  }
365  $this->data[] = $tmp;
366  }
367  break;
368  }
369  }
370 
371  if ($a_entity == "lm_menu") {
372  switch ($a_version) {
373  case "5.1.0":
374  case "5.4.0":
375  $this->getDirectDataFromQuery("SELECT lm_id, link_type, title, target, link_ref_id, active" .
376  " FROM lm_menu " .
377  " WHERE " . $ilDB->in("lm_id", $a_ids, false, "integer"));
378  break;
379  }
380  }
381 
382  if ($a_entity == "lm_data_transl") {
383  switch ($a_version) {
384  case "5.1.0":
385  case "5.4.0":
386  $this->getDirectDataFromQuery("SELECT id, lang, title, short_title" .
387  " FROM lm_data_transl " .
388  " WHERE " . $ilDB->in("id", $a_ids, false, "integer"));
389  break;
390  }
391  }
392  }
static commentsActivated($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_news_id=0)
Are comments activated for object?
const IL_INST_ID
Definition: constants.php:38
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 ...
convertToLeadingUpper($a_str)
Make xyz_abc a XyzAbc string.
global $ilDB
getMasterLanguageOnly()
Get master language only (export)
+ Here is the call graph for this function:

◆ setMasterLanguageOnly()

ilLearningModuleDataSet::setMasterLanguageOnly (   $a_val)

Set master language only (export)

Parameters
bool$a_valexport only master language

Definition at line 45 of file class.ilLearningModuleDataSet.php.

46  {
47  $this->master_lang_only = $a_val;
48  }

◆ setTranslationImportMode()

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

Set translation import mode.

Parameters
ilObjLearningModule$a_lmlearning module
string$a_langlanguage

Definition at line 66 of file class.ilLearningModuleDataSet.php.

67  {
68  if ($a_lm != null) {
69  $this->transl_into = true;
70  $this->transl_into_lm = $a_lm;
71  $this->transl_lang = $a_lang;
72  } else {
73  $this->transl_into = false;
74  }
75  }

Field Documentation

◆ $lm_log

ilLearningModuleDataSet::$lm_log
protected

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

◆ $master_lang_only

ilLearningModuleDataSet::$master_lang_only = false
protected

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

Referenced by getMasterLanguageOnly().

◆ $transl_into

ilLearningModuleDataSet::$transl_into = false
protected

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

Referenced by getTranslationImportMode().

◆ $transl_into_lm

ilLearningModuleDataSet::$transl_into_lm = null
protected

Definition at line 23 of file class.ilLearningModuleDataSet.php.

Referenced by getTranslationLM().

◆ $transl_lang

ilLearningModuleDataSet::$transl_lang = ""
protected

Definition at line 24 of file class.ilLearningModuleDataSet.php.

Referenced by getTranslationLang().


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