This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCOPageDataSet:

Collaboration diagram for ilCOPageDataSet:

Public Member Functions
	setMasterLanguageOnly (bool $a_val)

	getMasterLanguageOnly ()

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

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

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

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Determine the dependent sets of data. 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
ilPageLayout	$current_obj

bool	$master_lang_only = false

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning COPage Data set class This class implements the following entities:

pgtp: page layout template Please note that the usual page xml export DOES NOT use the dataset. The page export uses pre-existing methods to create the xml.

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

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

Member Function Documentation

◆ getDependencies()

ilCOPageDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Determine the dependent sets of data.

Reimplemented from ilDataSet.

Definition at line 95 of file class.ilCOPageDataSet.php.

     : array {
        return [];
    }

◆ getMasterLanguageOnly()

ilCOPageDataSet::getMasterLanguageOnly ( )

Definition at line 38 of file class.ilCOPageDataSet.php.

                                           : bool
    {
        return $this->master_lang_only;
    }

References $master_lang_only.

◆ getSupportedVersions()

ilCOPageDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

Definition at line 43 of file class.ilCOPageDataSet.php.

                                          : array
    {
        return array("4.2.0");
    }

◆ getTypes()

ilCOPageDataSet::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 53 of file class.ilCOPageDataSet.php.

                                                                    : array
    {
        // pgtp: page layout template
        if ($a_entity == "pgtp") {
            switch ($a_version) {
                case "4.2.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "SpecialPage" => "integer",
                        "StyleId" => "integer");
            }
        }
        return [];
    }

◆ getXmlNamespace()

ilCOPageDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

protected

Reimplemented from ilDataSet.

Definition at line 48 of file class.ilCOPageDataSet.php.

                                                                                  : string
    {
        return "https://www.ilias.de/xml/Services/COPage/" . $a_entity;
    }

◆ importRecord()

ilCOPageDataSet::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.

Reimplemented from ilDataSet.

Definition at line 104 of file class.ilCOPageDataSet.php.

                                                                                                                                      : void
    {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "pgtp":
                $pt = new ilPageLayout();
                $pt->setTitle($a_rec["Title"]);
                $pt->setDescription($a_rec["Description"]);
                $pt->update();
 
                $this->current_obj = $pt;
                $a_mapping->addMapping(
                    "components/ILIAS/COPage",
                    "pgtp",
                    $a_rec["Id"],
                    $pt->getId()
                );
                $a_mapping->addMapping(
                    "components/ILIAS/COPage",
                    "pg",
                    "stys:" . $a_rec["Id"],
                    "stys:" . $pt->getId()
                );
                break;
        }
    }

References ilImportMapping\addMapping().

Here is the call graph for this function:

◆ readData()

ilCOPageDataSet::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 70 of file class.ilCOPageDataSet.php.

                                                                               : void
    {
        $db = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
 
        // mep_data
        if ($a_entity == "pgtp") {
            switch ($a_version) {
                case "4.2.0":
                    $this->getDirectDataFromQuery("SELECT layout_id id, title, description, " .
                        " style_id, special_page " .
                        " FROM page_layout " .
                        "WHERE " .
                        $db->in("layout_id", $a_ids, false, "integer"));
                    break;
            }
        }
    }

References ilDataSet\$db, ilDataSet\getDirectDataFromQuery(), and ilDBInterface\in().

Here is the call graph for this function:

◆ setMasterLanguageOnly()

ilCOPageDataSet::setMasterLanguageOnly ( bool $a_val )

Definition at line 33 of file class.ilCOPageDataSet.php.

                                                      : void
    {
        $this->master_lang_only = $a_val;
    }

Field Documentation

◆ $current_obj

ilPageLayout ilCOPageDataSet::$current_obj

protected

Definition at line 30 of file class.ilCOPageDataSet.php.

◆ $master_lang_only

bool ilCOPageDataSet::$master_lang_only = false

protected

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

Referenced by getMasterLanguageOnly().

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

components/ILIAS/COPage/classes/class.ilCOPageDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getMasterLanguageOnly()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

◆ setMasterLanguageOnly()

Field Documentation

◆ $current_obj

◆ $master_lang_only