Bookmarks Data set class. More...

Inheritance diagram for ilBookmarkDataSet:

Collaboration diagram for ilBookmarkDataSet:

Public Member Functions
	__construct ()
	Constructor. More...

	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 ...> ... </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 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 = ""

	$db

	$ds_log

Detailed Description

Bookmarks Data set class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 13 of file class.ilBookmarkDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilBookmarkDataSet::__construct ( )

Constructor.

Reimplemented from ilDataSet.

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

    {
        global $DIC;
 
        parent::__construct();
        $this->db = $DIC->database();
    }

References $DIC.

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Definition at line 129 of file class.ilBookmarkDataSet.php.

    {
        switch ($a_entity) {
            case "bookmarks":
                return array(
                    "bookmark_tree" => array("ids" => $a_rec["UserId"])
                );
        }
        return false;
    }

◆ getSupportedVersions()

ilBookmarkDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        return array("4.3.0");
    }

◆ getTypes()

ilBookmarkDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 55 of file class.ilBookmarkDataSet.php.

    {
        // bookmarks
        if ($a_entity == "bookmarks") {
            switch ($a_version) {
                case "4.3.0":
                    return array(
                        "UserId" => "integer"
                    );
            }
        }
    
        // bookmark_tree
        if ($a_entity == "bookmark_tree") {
            switch ($a_version) {
                case "4.3.0":
                        return array(
                            "UserId" => "integer",
                            "Child" => "integer",
                            "Parent" => "integer",
                            "Depth" => "integer",
                            "Type" => "text",
                            "Title" => "text",
                            "Description" => "text",
                            "Target" => "text"
                        );
            }
        }
    }

◆ getXmlNamespace()

ilBookmarkDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 44 of file class.ilBookmarkDataSet.php.

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

◆ importRecord()

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

Import record.

Parameters

return

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

    {
        switch ($a_entity) {
            case "bookmarks":
                break;
 
            case "bookmark_tree":
                $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["UserId"]);
                if ($usr_id > 0 && ilObject::_lookupType($usr_id) == "usr") {
                    //echo "<br><br>";
                    //var_dump($a_rec);
                    switch ($a_rec["Type"]) {
                        case "bmf":
                            if ($a_rec["Parent"] > 0) {
                                $parent = (int) $a_mapping->getMapping("Services/Bookmarks", "bookmark_tree", $a_rec["Parent"]);
                                include_once("./Services/Bookmarks/classes/class.ilBookmarkFolder.php");
                                $bmf = new ilBookmarkFolder(0, $usr_id);
                                $bmf->setTitle($a_rec["Title"]);
                                $bmf->setParent($parent);
                                $bmf->create();
                                $fold_id = $bmf->getId();
                            } else {
                                $tree = new ilTree($usr_id);
                                $tree->setTableNames('bookmark_tree', 'bookmark_data');
                                $fold_id = $tree->readRootId();
                            }
                            $a_mapping->addMapping(
                                "Services/Bookmarks",
                                "bookmark_tree",
                                $a_rec["Child"],
                                $fold_id
                            );
                            break;
    
                        case "bm":
                            $parent = 0;
                            if (((int) $a_rec["Parent"]) > 0) {
                                $parent = (int) $a_mapping->getMapping("Services/Bookmarks", "bookmark_tree", $a_rec["Parent"]);
                            } else {
                                return;
                            }
                            
                            if ($parent == 0) {
                                $tree = new ilTree($usr_id);
                                $tree->setTableNames('bookmark_tree', 'bookmark_data');
                                $parent = $tree->readRootId();
                            }
//echo "-$parent-";
                            include_once("./Services/Bookmarks/classes/class.ilBookmark.php");
                            $bm = new ilBookmark(0, $usr_id);
                            $bm->setTitle($a_rec["Title"]);
                            $bm->setDescription($a_rec["Description"]);
                            $bm->setTarget($a_rec["Target"]);
                            $bm->setParent($parent);
                            $bm->create();
                            break;
    
                    }
                }
                break;
        }
    }

References $tree, and ilObject\_lookupType().

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

Definition at line 91 of file class.ilBookmarkDataSet.php.

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
                
        // bookmarks
        if ($a_entity == "bookmarks") {
            switch ($a_version) {
                case "4.3.0":
                    $this->data = array();
                    foreach ($a_ids as $id) {
                        $this->data[] = array("UserId" => $id);
                    }
                    break;
            }
        }
 
        // bookmark_tree
        if ($a_entity == "bookmark_tree") {
            switch ($a_version) {
                case "4.3.0":
                    $this->getDirectDataFromQuery("SELECT tree user_id, child " .
                        " ,parent,depth,type,title,description,target " .
                        " FROM bookmark_tree JOIN bookmark_data ON (child = obj_id) " .
                        " WHERE " .
                        $ilDB->in("tree", $a_ids, false, "integer") .
                        " ORDER BY tree, depth");
                    break;
            }
        }
    }

References ilDataSet\$db, $id, $ilDB, data, and ilDataSet\getDirectDataFromQuery().

Here is the call graph for this function:

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

Services/Bookmarks/classes/class.ilBookmarkDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()