ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjectDataSet Class Reference

Object data set class. More...

+ Inheritance diagram for ilObjectDataSet:
+ Collaboration diagram for ilObjectDataSet:

Public Member Functions

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

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
 
- Protected Attributes inherited from ilDataSet
 $current_installation_id = ""
 

Detailed Description

Object data set class.

This class implements the following entities:

  • transl_entry: data from object_translation
  • transl: data from obj_content_master_lang
Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 17 of file class.ilObjectDataSet.php.

Member Function Documentation

◆ getDependencies()

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

Determine the dependent sets of data.

Definition at line 172 of file class.ilObjectDataSet.php.

173  {
174  switch ($a_entity)
175  {
176  case "transl":
177  return array (
178  "transl_entry" => array("ids" => $a_rec["ObjId"])
179  );
180  }
181 
182  return false;
183  }

◆ getSupportedVersions()

ilObjectDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

Definition at line 25 of file class.ilObjectDataSet.php.

26  {
27  return array("4.4.0", "5.1.0");
28  }

◆ getTypes()

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

Get field types for entity.

Parameters

Definition at line 47 of file class.ilObjectDataSet.php.

48  {
49  if ($a_entity == "transl_entry")
50  {
51  switch ($a_version)
52  {
53  case "4.4.0":
54  case "5.1.0":
55  return array(
56  "ObjId" => "integer",
57  "Title" => "text",
58  "Description" => "text",
59  "LangCode" => "text",
60  "LangDefault" => "integer");
61  }
62  }
63  if ($a_entity == "transl")
64  {
65  switch ($a_version)
66  {
67  case "4.4.0":
68  case "5.1.0":
69  return array(
70  "ObjId" => "integer",
71  "MasterLang" => "text");
72  }
73  }
74  if ($a_entity == "service_settings")
75  {
76  switch ($a_version)
77  {
78  case "5.1.0":
79  return array(
80  "ObjId" => "integer",
81  "Setting" => "text",
82  "Value" => "text");
83  }
84  }
85  }

◆ getXmlNamespace()

ilObjectDataSet::getXmlNamespace (   $a_entity,
  $a_schema_version 
)

Get xml namespace.

Parameters

Definition at line 36 of file class.ilObjectDataSet.php.

37  {
38  return "http://www.ilias.de/xml/Services/Object/".$a_entity;
39  }

◆ importRecord()

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

Import record.

Parameters

Definition at line 192 of file class.ilObjectDataSet.php.

References ilContainer\_writeContainerSetting(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilObjectTranslation\getInstance(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ilObjectServiceSettingsGUI\TAG_CLOUD, and ilObjectServiceSettingsGUI\TAXONOMIES.

193  {
194  switch ($a_entity)
195  {
196  case "transl_entry":
197  $new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ObjId']);
198  if (!$new_id)
199  {
200  $new_id = $a_mapping->getMapping('Services/Object','obj',$a_rec['ObjId']);
201  }
202  if ($new_id > 0)
203  {
204  include_once("./Services/Object/classes/class.ilObjectTranslation.php");
205  $transl = ilObjectTranslation::getInstance($new_id);
206  $transl->addLanguage($a_rec["LangCode"], $a_rec["Title"], $a_rec["Description"], $a_rec["LangDefault"], true);
207  $transl->save();
208  }
209  break;
210 
211  case "transl":
212  $new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ObjId']);
213  if (!$new_id)
214  {
215  $new_id = $a_mapping->getMapping('Services/Object','obj',$a_rec['ObjId']);
216  }
217  if ($new_id > 0)
218  {
219  include_once("./Services/Object/classes/class.ilObjectTranslation.php");
220  $transl = ilObjectTranslation::getInstance($new_id);
221  $transl->setMasterLanguage($a_rec["MasterLang"]);
222  $transl->save();
223  }
224  break;
225 
226  case "service_settings":
227  include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
228  include_once("./Services/Container/classes/class.ilContainer.php");
229 
230  // info, news, custom metadata, tags, taxonomies, auto rating (all stored in container settings)
231  $settings = array(
239  );
240 
241  $new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ObjId']);
242  if (!$new_id)
243  {
244  $new_id = $a_mapping->getMapping('Services/Object','obj',$a_rec['ObjId']);
245  }
246  if ($new_id > 0)
247  {
248  if (in_array($a_rec["Setting"], $settings))
249  {
250  ilContainer::_writeContainerSetting($new_id, $a_rec["Setting"], $a_rec["Value"]);
251  }}
252  break;
253  }
254  }
_writeContainerSetting($a_id, $a_keyword, $a_value)
static getInstance($a_obj_id)
Get instance.
+ Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

Definition at line 93 of file class.ilObjectDataSet.php.

References $ilDB, ilContainer\_lookupContainerSetting(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilDataSet\getDirectDataFromQuery(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ilObjectServiceSettingsGUI\TAG_CLOUD, and ilObjectServiceSettingsGUI\TAXONOMIES.

94  {
95  global $ilDB;
96 
97  if (!is_array($a_ids))
98  {
99  $a_ids = array($a_ids);
100  }
101 
102  if ($a_entity == "transl_entry")
103  {
104  switch ($a_version)
105  {
106  case "4.4.0":
107  case "5.1.0":
108  $this->getDirectDataFromQuery("SELECT obj_id, title, description,".
109  " lang_code, lang_default".
110  " FROM object_translation".
111  " WHERE ".$ilDB->in("obj_id", $a_ids, false, "integer"));
112  break;
113  }
114  }
115 
116  if ($a_entity == "transl")
117  {
118  switch ($a_version)
119  {
120  case "4.4.0":
121  case "5.1.0":
122  $this->getDirectDataFromQuery("SELECT obj_id, master_lang".
123  " FROM obj_content_master_lng".
124  " WHERE ".$ilDB->in("obj_id", $a_ids, false, "integer"));
125  break;
126  }
127  }
128 
129  if ($a_entity == "service_settings")
130  {
131  switch ($a_version)
132  {
133  case "5.1.0":
134  include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
135  include_once("./Services/Container/classes/class.ilContainer.php");
136 
137  $this->data = array();
138  foreach ($a_ids as $id)
139  {
140  // info, news, custom metadata, tags, taxonomies, auto rating (all stored in container settings)
141  $settings = array(
149  );
150  foreach ($settings as $s)
151  {
152  $val = ilContainer::_lookupContainerSetting($id, $s);
153  if ($val)
154  {
155  $this->data[] = array(
156  "ObjId" => $id,
157  "Setting" => $s,
158  "Value" => $val
159  );
160  }
161  }
162  }
163  break;
164  }
165  }
166 
167  }
getDirectDataFromQuery($a_query, $a_convert_to_leading_upper=true)
Get data from query.This is a standard procedure, all db field names are directly mapped to abstract ...
_lookupContainerSetting($a_id, $a_keyword, $a_default_value=NULL)
Lookup a container setting.
global $ilDB
+ Here is the call graph for this function:

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