ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Protected Member Functions
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, $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...
 

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 182 of file class.ilObjectDataSet.php.

References array.

183  {
184  switch ($a_entity)
185  {
186  case "transl":
187  return array (
188  "transl_entry" => array("ids" => $a_rec["ObjId"])
189  );
190  }
191 
192  return false;
193  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19

◆ getSupportedVersions()

ilObjectDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

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

References array.

26  {
27  return array("4.4.0", "5.1.0", "5.2.0");
28  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19

◆ getTypes()

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

Get field types for entity.

Parameters

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

References array.

48  {
49  if ($a_entity == "transl_entry")
50  {
51  switch ($a_version)
52  {
53  case "4.4.0":
54  case "5.1.0":
55  case "5.2.0":
56  return array(
57  "ObjId" => "integer",
58  "Title" => "text",
59  "Description" => "text",
60  "LangCode" => "text",
61  "LangDefault" => "integer");
62  }
63  }
64  if ($a_entity == "transl")
65  {
66  switch ($a_version)
67  {
68  case "4.4.0":
69  case "5.1.0":
70  case "5.2.0":
71  return array(
72  "ObjId" => "integer",
73  "MasterLang" => "text");
74  }
75  }
76  if ($a_entity == "service_settings")
77  {
78  switch ($a_version)
79  {
80  case "5.1.0":
81  case "5.2.0":
82  return array(
83  "ObjId" => "integer",
84  "Setting" => "text",
85  "Value" => "text");
86  }
87  }
88  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19

◆ 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 202 of file class.ilObjectDataSet.php.

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

203  {
204  switch ($a_entity)
205  {
206  case "transl_entry":
207  $new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ObjId']);
208  if (!$new_id)
209  {
210  $new_id = $a_mapping->getMapping('Services/Object','obj',$a_rec['ObjId']);
211  }
212  if ($new_id > 0)
213  {
214  include_once("./Services/Object/classes/class.ilObjectTranslation.php");
215  $transl = ilObjectTranslation::getInstance($new_id);
216  $transl->addLanguage($a_rec["LangCode"], $a_rec["Title"], $a_rec["Description"], $a_rec["LangDefault"], true);
217  $transl->save();
218  }
219  break;
220 
221  case "transl":
222  $new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ObjId']);
223  if (!$new_id)
224  {
225  $new_id = $a_mapping->getMapping('Services/Object','obj',$a_rec['ObjId']);
226  }
227  if ($new_id > 0)
228  {
229  include_once("./Services/Object/classes/class.ilObjectTranslation.php");
230  $transl = ilObjectTranslation::getInstance($new_id);
231  $transl->setMasterLanguage($a_rec["MasterLang"]);
232  $transl->save();
233  }
234  break;
235 
236  case "service_settings":
237  include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
238  include_once("./Services/Container/classes/class.ilContainer.php");
239 
240  // info, news, custom metadata, tags, taxonomies, auto rating (all stored in container settings)
241  $settings = array(
242  ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
243  ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
244  ilObjectServiceSettingsGUI::CUSTOM_METADATA,
245  ilObjectServiceSettingsGUI::TAG_CLOUD,
246  ilObjectServiceSettingsGUI::TAXONOMIES,
247  ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS,
248  ilObjectServiceSettingsGUI::CALENDAR_VISIBILITY,
249  ilObjectServiceSettingsGUI::USE_NEWS
250  );
251 
252  $new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ObjId']);
253  if (!$new_id)
254  {
255  $new_id = $a_mapping->getMapping('Services/Object','obj',$a_rec['ObjId']);
256  }
257  if ($new_id > 0)
258  {
259  if (in_array($a_rec["Setting"], $settings))
260  {
261  ilContainer::_writeContainerSetting($new_id, $a_rec["Setting"], $a_rec["Value"]);
262  }
263  }
264  break;
265  }
266  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilObjectTranslation\getInstance
static getInstance($a_obj_id)
Get instance.
Definition: class.ilObjectTranslation.php:67
ilContainer\_writeContainerSetting
static _writeContainerSetting($a_id, $a_keyword, $a_value)
Definition: class.ilContainer.php:384
+ 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 96 of file class.ilObjectDataSet.php.

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

97  {
98  global $ilDB;
99 
100  if (!is_array($a_ids))
101  {
102  $a_ids = array($a_ids);
103  }
104 
105  if ($a_entity == "transl_entry")
106  {
107  switch ($a_version)
108  {
109  case "4.4.0":
110  case "5.1.0":
111  case "5.2.0":
112  $this->getDirectDataFromQuery("SELECT obj_id, title, description,".
113  " lang_code, lang_default".
114  " FROM object_translation".
115  " WHERE ".$ilDB->in("obj_id", $a_ids, false, "integer"));
116  break;
117  }
118  }
119 
120  if ($a_entity == "transl")
121  {
122  switch ($a_version)
123  {
124  case "4.4.0":
125  case "5.1.0":
126  case "5.2.0":
127  $this->getDirectDataFromQuery("SELECT obj_id, master_lang".
128  " FROM obj_content_master_lng".
129  " WHERE ".$ilDB->in("obj_id", $a_ids, false, "integer"));
130  break;
131  }
132  }
133 
134  if ($a_entity == "service_settings")
135  {
136  switch ($a_version)
137  {
138  case "5.1.0":
139  case "5.2.0":
140  include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
141  include_once("./Services/Container/classes/class.ilContainer.php");
142 
143  $this->data = array();
144  foreach ($a_ids as $id)
145  {
146  // info, news, custom metadata, tags, taxonomies, auto rating (all stored in container settings)
147  $settings = array(
148  ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
149  ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
150  ilObjectServiceSettingsGUI::CUSTOM_METADATA,
151  ilObjectServiceSettingsGUI::TAG_CLOUD,
152  ilObjectServiceSettingsGUI::TAXONOMIES,
153  ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS,
154  ilObjectServiceSettingsGUI::CALENDAR_VISIBILITY
155  );
156  if ($a_version == "5.2.0")
157  {
158  $settings[] = ilObjectServiceSettingsGUI::USE_NEWS;
159  }
160  foreach ($settings as $s)
161  {
162  $val = ilContainer::_lookupContainerSetting($id, $s);
163  if ($val)
164  {
165  $this->data[] = array(
166  "ObjId" => $id,
167  "Setting" => $s,
168  "Value" => $val
169  );
170  }
171  }
172  }
173  break;
174  }
175  }
176 
177  }
data
Add some data
Definition: 01pharSimple.php:56
ilDataSet\getDirectDataFromQuery
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 ...
Definition: class.ilDataSet.php:164
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilContainer\_lookupContainerSetting
static _lookupContainerSetting($a_id, $a_keyword, $a_default_value=NULL)
Lookup a container setting.
Definition: class.ilContainer.php:358
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ Here is the call graph for this function:
The documentation for this class was generated from the following file: