ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilContentPageDataSet Class Reference

Class ilContentPageDataSet. More...

+ Inheritance diagram for ilContentPageDataSet:
+ Collaboration diagram for ilContentPageDataSet:

Public Member Functions

 getSupportedVersions ()
 
 readData (string $a_entity, string $a_version, array $a_ids)
 
 importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
 
- 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...
 
 setExportDirectories (string $a_relative, string $a_absolute)
 
 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 ...> ... 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...
 

Protected Member Functions

 getXmlNamespace (string $a_entity, string $a_schema_version)
 
 getTypes (string $a_entity, string $a_version)
 
- 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)
 
 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

array $newMobIds = []
 
- Protected Attributes inherited from ilDataSet
string $current_installation_id = ""
 
array $data = []
 
ilDBInterface $db
 
ilLogger $ds_log
 
string $import_directory = ""
 
string $entity = ""
 
string $schema_version = ""
 
string $relative_export_dir = ""
 
string $absolute_export_dir = ""
 
string $ds_prefix = "ds"
 
string $version = ""
 
ilSurveyImporter $import
 

Additional Inherited Members

- Data Fields inherited from ilDataSet
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
 
- Data Fields inherited from ilContentPageObjectConstants
const OBJ_TYPE = 'copa'
 
const HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT = 'page_editor_style'
 
const UI_CMD_VIEW = 'view'
 
const UI_CMD_EDIT = 'edit'
 
const UI_CMD_UPDATE = 'update'
 
const UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'
 
const UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'
 
const UI_CMD_COPAGE_DISPLAY_MEDIA = 'displayMedia'
 
const UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'
 
const UI_CMD_COPAGE_EDIT = 'edit'
 
const UI_CMD_STYLES_EDIT = 'editStyleProperties'
 
const UI_TAB_ID_CONTENT = 'content'
 
const UI_TAB_ID_INFO = 'info_short'
 
const UI_TAB_ID_SETTINGS = 'settings'
 
const UI_TAB_ID_STYLE = 'style'
 
const UI_TAB_ID_I18N = 'i18n'
 
const UI_TAB_ID_LP = 'learning_progress'
 
const UI_TAB_ID_EXPORT = 'export'
 
const UI_TAB_ID_PERMISSIONS = 'perm_settings'
 

Detailed Description

Class ilContentPageDataSet.

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

Member Function Documentation

◆ getSupportedVersions()

ilContentPageDataSet::getSupportedVersions ( )

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

29  : array
30  {
31  return [
32  '5.4.0',
33  ];
34  }

◆ getTypes()

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

Definition at line 41 of file class.ilContentPageDataSet.php.

41  : array
42  {
43  switch ($a_entity) {
44  case self::OBJ_TYPE:
45  return [
46  'id' => 'integer',
47  'title' => 'text',
48  'description' => 'text',
49  'info-tab' => 'integer'
50  ];
51 
52  default:
53  return [];
54  }
55  }

◆ getXmlNamespace()

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

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

36  : string
37  {
38  return 'http://www.ilias.de/xml/Modules/ContentPage/' . $a_entity;
39  }

◆ importRecord()

ilContentPageDataSet::importRecord ( string  $a_entity,
array  $a_types,
array  $a_rec,
ilImportMapping  $a_mapping,
string  $a_schema_version 
)

Definition at line 101 of file class.ilContentPageDataSet.php.

References ilContainer\_writeContainerSetting(), ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, and ilUtil\stripSlashes().

107  : void {
108  switch ($a_entity) {
109  case self::OBJ_TYPE:
110  if ($newObjId = $a_mapping->getMapping('Services/Container', 'objs', (string) $a_rec['id'])) {
111  $newObject = ilObjectFactory::getInstanceByObjId((int) $newObjId, false);
112  } else {
113  $newObject = new ilObjContentPage();
114  }
115 
116  $newObject->setTitle(ilUtil::stripSlashes($a_rec['title']));
117  $newObject->setDescription(ilUtil::stripSlashes($a_rec['description']));
118 
119  if (!$newObject->getId()) {
120  $newObject->create();
121  }
122 
124  $newObject->getId(),
126  (string) ((bool) $a_rec['info-tab'])
127  );
128 
129  $a_mapping->addMapping(
130  'Modules/ContentPage',
131  self::OBJ_TYPE,
132  (string) $a_rec['id'],
133  (string) $newObject->getId()
134  );
135  $a_mapping->addMapping(
136  'Services/COPage',
137  'pg',
138  self::OBJ_TYPE . ':' . $a_rec['id'],
139  self::OBJ_TYPE . ':' . $newObject->getId()
140  );
141  break;
142  }
143  }
static stripSlashes(string $a_str, bool $a_strip_html=true, string $a_allow="")
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 _writeContainerSetting(int $a_id, string $a_keyword, string $a_value)
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id
+ Here is the call graph for this function:

◆ readData()

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

Definition at line 57 of file class.ilContentPageDataSet.php.

References ilDataSet\$entity, $objId, ilContainer\_lookupContainerSetting(), ilObject\_lookupType(), ilObjectFactory\getInstanceByObjId(), and ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY.

57  : void
58  {
59  $this->data = [];
60 
61  if (!is_array($a_ids)) {
62  $a_ids = [$a_ids];
63  }
64 
65  $this->readEntityData($a_entity, $a_ids);
66  }
+ Here is the call graph for this function:

Field Documentation

◆ $newMobIds

array ilContentPageDataSet::$newMobIds = []
protected

Definition at line 27 of file class.ilContentPageDataSet.php.


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