ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilHTMLLearningModuleDataSet Class Reference

HTML learning module data set class. More...

+ Inheritance diagram for ilHTMLLearningModuleDataSet:
+ Collaboration diagram for ilHTMLLearningModuleDataSet:

Public Member Functions

 __construct ()
 
 getSupportedVersions ()
 
 readData (string $a_entity, string $a_version, array $a_ids)
 Read data from DB. More...
 
 getXmlRecord (string $a_entity, string $a_version, array $a_set)
 Get xml record for version. More...
 
 getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)
 
- 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)
 

Protected Member Functions

 getXmlNamespace (string $a_entity, string $a_schema_version)
 
 getTypes (string $a_entity, string $a_version)
 Get (abstract) types for (abstract) field names. 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=[])
 

Protected Attributes

ilObjFileBasedLM $current_obj
 
IRSSWrapper $irss_wrapper
 
- 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
 

Additional Inherited Members

- 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
 

Detailed Description

HTML learning module data set class.

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilHTMLLearningModuleDataSet::__construct ( )

Reimplemented from ilDataSet.

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

32 {
33 global $DIC;
34
36 $this->irss_wrapper = $DIC->htmlLearningModule()->internal()->repo()->irss();
37 }
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

+ Here is the call graph for this function:

Member Function Documentation

◆ getContainerExportConfig()

ilHTMLLearningModuleDataSet::getContainerExportConfig ( array  $record,
string  $entity,
string  $schema_version,
string  $field,
string  $value 
)

Reimplemented from ilDataSet.

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

97 if ($entity === "htlm" && $field === "Dir") {
98 $lm = new ilObjFileBasedLM($record["Id"], false);
99 $container = $lm->getResource();
100 if ($container) {
101 return
104 ""
105 );
106 }
107 }
108 return null;
109 }
getIRSSContainerExportConfig(StorableResource $source_container, string $source_path, string $target_path="")
string $entity
File Based Learning Module (HTML) object.
$container
@noRector
Definition: wac.php:37

References $container, and ilDataSet\getIRSSContainerExportConfig().

+ Here is the call graph for this function:

◆ getSupportedVersions()

ilHTMLLearningModuleDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

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

39 : array
40 {
41 return array("4.1.0");
42 }

◆ getTypes()

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

Get (abstract) types for (abstract) field names.

Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns
array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented from ilDataSet.

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

49 : array
50 {
51 if ($a_entity === "htlm") {
52 switch ($a_version) {
53 case "4.1.0":
54 return array(
55 "Id" => "integer",
56 "Title" => "text",
57 "Description" => "text",
58 "StartFile" => "text",
59 "Dir" => "rscontainer");
60 }
61 }
62 return [];
63 }

◆ getXmlNamespace()

ilHTMLLearningModuleDataSet::getXmlNamespace ( string  $a_entity,
string  $a_schema_version 
)
protected

Reimplemented from ilDataSet.

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

44 : string
45 {
46 return "https://www.ilias.de/xml/Modules/HTMLLearningModule/" . $a_entity;
47 }

◆ getXmlRecord()

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

Get xml record for version.

Parameters
array$a_setabstract data record

Reimplemented from ilDataSet.

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

82 : array
83 {
84 $lm = new ilObjFileBasedLM($a_set["Id"], false);
85 $a_set["Dir"] = $lm->getResource()->getIdentification();
86
87 return $a_set;
88 }

◆ readData()

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

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented from ilDataSet.

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

65 : void
66 {
68
69 if ($a_entity === "htlm") {
70 switch ($a_version) {
71 case "4.1.0":
72 $this->getDirectDataFromQuery("SELECT id, title, description, " .
73 " startfile start_file" .
74 " FROM file_based_lm JOIN object_data ON (file_based_lm.id = object_data.obj_id) " .
75 "WHERE " .
76 $ilDB->in("id", $a_ids, false, "integer"));
77 break;
78 }
79 }
80 }
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 ...
ilDBInterface $db

References ilDataSet\$db, $ilDB, and ilDataSet\getDirectDataFromQuery().

+ Here is the call graph for this function:

Field Documentation

◆ $current_obj

ilObjFileBasedLM ilHTMLLearningModuleDataSet::$current_obj
protected

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

◆ $irss_wrapper

IRSSWrapper ilHTMLLearningModuleDataSet::$irss_wrapper
protected

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


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