COPage Data set class. More...

Inheritance diagram for ilCOPageDataSet:

Collaboration diagram for ilCOPageDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions.
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace.
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data.
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record.
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor.
	init ($a_entity, $a_schema_version)
	Init.
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB.
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories.
	setImportDirectory ($a_val)
	Set import directory.
	getImportDirectory ()
	Get import directory.
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix.
	getDSPrefix ()
	Get XML dataset namespace prefix.
	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.
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string.
	getJsonRepresentation ()
	Get json representation.
	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 ...> ...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml.
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record.
	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces.
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version.
	getJsonRecord ($a_set)
	Get json record for version.
	getXmlTypes ($a_entity, $a_version)
	Get xml types.
	getJsonTypes ($a_entity, $a_version)
	Get json types.
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten)
	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag.
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten)
	setImport ($a_val)
	Set import object.
	getImport ()
	Get import object.

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity.
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data.
Protected Member Functions inherited from ilDataSet
	createObjectExportId ($a_type, $a_id)
	Build ilias export id.
	parseObjectExportId ($a_id, $a_fallback_id=NULL)
	Parse export id.

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

Detailed Description

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: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

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

protected

Determine the dependent sets of data.

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

        {
                return false;
        }

ilCOPageDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                return array("4.2.0");
        }

ilCOPageDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                // 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");
                        }
                }
        }

ilCOPageDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

@return

Reimplemented from ilDataSet.

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

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

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

Import record.

Parameters

@return

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

        {
                switch ($a_entity)
                {
                        case "pgtp":
                                include_once("./Services/Style/classes/class.ilPageLayout.php");
                                $pt = new ilPageLayout();
                                $pt->setTitle($a_rec["Title"]);
                                $pt->setDescription($a_rec["Description"]);
                                $pt->setSpecialPage($a_rec["SpecialPage"]);
                                $pt->update();
                                
                                $this->current_obj = $pt;
                                $a_mapping->addMapping("Services/COPage", "pgtp", $a_rec["Id"],
                                        $pt->getId());
                                $a_mapping->addMapping("Services/COPage", "pg", "stys:".$a_rec["Id"],
                                        "stys:".$pt->getId());
                                break;
                }
        }

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

Read data.

Parameters

@return

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

References ilDataSet\getDirectDataFromQuery().

        {
                global $ilDB;
                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 ".
                                                $ilDB->in("layout_id", $a_ids, false, "integer"));
                                        break;
                        }
                }       
        }

Here is the call graph for this function:

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

Services/COPage/classes/class.ilCOPageDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation