Class ilContentPageDataSet. More...

Inheritance diagram for ilContentPageDataSet:

Collaboration diagram for ilContentPageDataSet:

Public Member Functions

getSupportedVersions ()

Get supported version.

Returns: array array of supported version

More...

getXmlNamespace ($a_entity, $a_schema_version)

Get xml namespace. More...

readData ($a_entity, $a_version, $a_ids)

Read data from DB.This should result in the abstract field structure of the version set in the constructor.

Parameters

array one or multiple ids

More...

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

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 ...> ... </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 ($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 (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", ...) More...

	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)

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
	$data = []

	$newMobIds = []

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

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_EDIT = 'edit'

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_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_ICON = 'icon'

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

Member Function Documentation

◆ getDependencies()

ilContentPageDataSet::getDependencies	(	$a_entity,
		$a_version,
		$a_rec,
		$a_ids
	)

protected

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

◆ getSupportedVersions()

ilContentPageDataSet::getSupportedVersions ( )

Get supported version.

Returns: array array of supported version

Reimplemented from ilDataSet.

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

    {
        return [
            '5.4.0',
        ];
    }

◆ getTypes()

ilContentPageDataSet::getTypes	(	$a_entity,
		$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 40 of file class.ilContentPageDataSet.php.

    {
        switch ($a_entity) {
            case self::OBJ_TYPE:
                return [
                    'id' => 'integer',
                    'title' => 'text',
                    'description' => 'text',
                    'info-tab' => 'integer',
                    'style-id' => 'integer',
                ];
 
            default:
                return [];
        }
    }

References ilContentPageObjectConstants\OBJ_TYPE.

◆ getXmlNamespace()

ilContentPageDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Reimplemented from ilDataSet.

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

    {
        return 'http://www.ilias.de/xml/Modules/ContentPage/' . $a_entity;
    }

◆ importRecord()

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

Parameters

	$a_entity
	$a_types
	$a_rec
ilImportMapping	$a_mapping
	$a_schema_version

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

                                                                                             : void
    {
        switch ($a_entity) {
            case self::OBJ_TYPE:
                if ($newObjId = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['id'])) {
                    $newObject = ilObjectFactory::getInstanceByObjId($newObjId, false);
                } else {
                    $newObject = new ilObjContentPage();
                }
 
                $newObject->setTitle(ilUtil::stripSlashes($a_rec['title']));
                $newObject->setDescription(ilUtil::stripSlashes($a_rec['description']));
                $newObject->setStyleSheetId((int) ilUtil::stripSlashes($a_rec['style-id']));
 
                if (!$newObject->getId()) {
                    $newObject->create();
                }
 
                ilContainer::_writeContainerSetting(
                    $newObject->getId(),
                    ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                    (int) $a_rec['info-tab']
                );
 
                $a_mapping->addMapping('Modules/ContentPage', self::OBJ_TYPE, $a_rec['id'], $newObject->getId());
                $a_mapping->addMapping('Modules/ContentPage', 'style', $newObject->getId(), $newObject->getStyleSheetId());
                $a_mapping->addMapping(
                    'Services/COPage',
                    'pg',
                    self::OBJ_TYPE . ':' . $a_rec['id'],
                    self::OBJ_TYPE . ':' . $newObject->getId()
                );
                break;
        }
    }

References ilContainer\_writeContainerSetting(), ilObjectFactory\getInstanceByObjId(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilContentPageObjectConstants\OBJ_TYPE, and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ readData()

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

Read data from DB.This should result in the abstract field structure of the version set in the constructor.

Parameters

array one or multiple ids

Reimplemented from ilDataSet.

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

    {
        $this->data = [];
 
        if (!is_array($a_ids)) {
            $a_ids = [$a_ids];
        }
 
        $this->readEntityData($a_entity, $a_ids);
    }

Field Documentation

◆ $data

ilContentPageDataSet::$data = []

protected

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

◆ $newMobIds

ilContentPageDataSet::$newMobIds = []

protected

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

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

Modules/ContentPage/classes/class.ilContentPageDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $data

◆ $newMobIds