ilBookmark Class Reference

Class Bookmarks Bookmark management. More...

Collaboration diagram for ilBookmark:

Public Member Functions
	__construct ($a_bm_id=0, $a_tree_id=0)
	Constructor public. More...
	read ()
	read bookmark folder data from db More...
	delete ()
	Delete bookmark data. More...
	create ()
	Create new bookmark item. More...
	update ()
	Update bookmark item. More...
	setId ($a_id)
	getId ()
	setTitle ($a_str)
	set title public More...
	getTitle ()
	setDescription ($a_str)
	set description public More...
	getDescription ()
	setTarget ($a_target)
	set target public More...
	getTarget ()
	setParent ($a_parent_id)
	getParent ()

Static Public Member Functions
static	_getTypeOfId ($a_id)
	get type of a given id More...

Data Fields
	$user_Id
	$tree
	$title
	$description
	$target
	$id
	$parent

Protected Attributes
	$db
	$error

Detailed Description

Class Bookmarks Bookmark management.

Author

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

Manfred Thaler manfr.nosp@m.ed.t.nosp@m.haler.nosp@m.@end.nosp@m.o7.co.nosp@m.m

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilBookmark::__construct	(		$a_bm_id = 0,
			$a_tree_id = 0
	)

Constructor public.

Parameters

integer

user_id (optional)

Definition at line 54 of file class.ilBookmark.php.

References $DIC, $GLOBALS, and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->error = $DIC["ilErr"];
        // Initiate variables
        if ($a_tree_id == 0) {
            $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        }

        $this->tree = new ilTree($a_tree_id);
        $this->tree->setTableNames('bookmark_tree', 'bookmark_data');

        $this->id = $a_bm_id;

        if (!empty($this->id)) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

_getTypeOfId()

static ilBookmark::_getTypeOfId (   $a_id )

static

get type of a given id

Parameters

number

id

Definition at line 230 of file class.ilBookmark.php.

References $DIC, and $ilDB.

Referenced by ilBookmarkAdministrationGUI\confirm(), and ilBookmarkAdministrationGUI\delete().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM bookmark_data WHERE obj_id = " .
            $ilDB->quote($a_id, "integer");
        $bm_set = $ilDB->query($q);
        if ($ilDB->numRows($bm_set) == 0) {
            return null;
        } else {
            $bm = $ilDB->fetchAssoc($bm_set);
            return $bm["type"];
        }
    }

Here is the caller graph for this function:

create()

ilBookmark::create

(

)

Create new bookmark item.

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

References $db, $GLOBALS, $ilDB, getId(), getParent(), and setId().

    {
        $ilDB = $this->db;
        
        $this->setId($ilDB->nextId("bookmark_data"));
        $q = sprintf(
            "INSERT INTO bookmark_data (obj_id, user_id, title,description, target, type) " .
                "VALUES (%s,%s,%s,%s,%s,%s)",
            $ilDB->quote($this->getId(), "integer"),
            $ilDB->quote($GLOBALS['DIC']['ilUser']->getId(), "integer"),
            $ilDB->quote($this->getTitle(), "text"),
            $ilDB->quote($this->getDescription(), "text"),
            $ilDB->quote($this->getTarget(), "text"),
            $ilDB->quote('bm', "text")
        );

        $ilDB->manipulate($q);
        $this->tree->insertNode($this->getId(), $this->getParent());
    }

Here is the call graph for this function:

delete()

ilBookmark::delete

(

)

Delete bookmark data.

Definition at line 102 of file class.ilBookmark.php.

References $db, $ilDB, and getId().

    {
        $ilDB = $this->db;

        if ($this->getId() != 1) {
            $q = "DELETE FROM bookmark_data WHERE obj_id = " .
                $ilDB->quote($this->getId(), "integer");
            $ilDB->manipulate($q);
        }
    }

Here is the call graph for this function:

getDescription()

ilBookmark::getDescription

(

)

Definition at line 195 of file class.ilBookmark.php.

References $description.

    {
        return $this->description;
    }

getId()

ilBookmark::getId

(

)

Definition at line 166 of file class.ilBookmark.php.

References $id.

Referenced by create(), delete(), and read().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getParent()

ilBookmark::getParent

(

)

Definition at line 221 of file class.ilBookmark.php.

References $parent.

Referenced by create().

    {
        return $this->parent;
    }

Here is the caller graph for this function:

getTarget()

ilBookmark::getTarget

(

)

Definition at line 211 of file class.ilBookmark.php.

References $target.

    {
        return $this->target;
    }

getTitle()

ilBookmark::getTitle

(

)

Definition at line 181 of file class.ilBookmark.php.

References $title.

    {
        return $this->title;
    }

read()

ilBookmark::read

(

)

read bookmark folder data from db

Definition at line 79 of file class.ilBookmark.php.

References $db, $error, $ilDB, $ilErr, $message, getId(), setDescription(), setParent(), setTarget(), and setTitle().

Referenced by __construct().

    {
        $ilDB = $this->db;
        $ilErr = $this->error;

        $q = "SELECT * FROM bookmark_data WHERE obj_id = " .
            $ilDB->quote($this->getId(), "integer");
        $bm_set = $ilDB->query($q);
        if ($ilDB->numRows($bm_set) == 0) {
            $message = "ilBookmark::read(): Bookmark with id " . $this->id . " not found!";
            $ilErr->raiseError($message, $ilErr->WARNING);
        } else {
            $bm = $ilDB->fetchAssoc($bm_set);
            $this->setTitle($bm["title"]);
            $this->setDescription($bm["description"]);
            $this->setTarget($bm["target"]);
            $this->setParent($this->tree->getParentId($this->id));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDescription()

ilBookmark::setDescription

(

$a_str

)

set description public

Parameters

string

Definition at line 190 of file class.ilBookmark.php.

Referenced by read().

    {
        $this->description = $a_str;
    }

Here is the caller graph for this function:

setId()

ilBookmark::setId

(

$a_id

)

Definition at line 161 of file class.ilBookmark.php.

Referenced by create().

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setParent()

ilBookmark::setParent

(

$a_parent_id

)

Definition at line 216 of file class.ilBookmark.php.

Referenced by read().

    {
        $this->parent = $a_parent_id;
    }

Here is the caller graph for this function:

setTarget()

ilBookmark::setTarget

(

$a_target

)

set target public

Parameters

string

Definition at line 205 of file class.ilBookmark.php.

Referenced by read().

    {
        $this->target = $a_target;
    }

Here is the caller graph for this function:

setTitle()

ilBookmark::setTitle

(

$a_str

)

set title public

Parameters

string

Definition at line 176 of file class.ilBookmark.php.

Referenced by read().

    {
        $this->title = $a_str;
    }

Here is the caller graph for this function:

update()

ilBookmark::update

(

)

Update bookmark item.

Definition at line 140 of file class.ilBookmark.php.

References $db, and $ilDB.

    {
        $ilDB = $this->db;
        
        $q = sprintf(
            "UPDATE bookmark_data SET title=%s,description=%s,target=%s " .
                "WHERE obj_id=%s",
            $ilDB->quote($this->getTitle(), "text"),
            $ilDB->quote($this->getDescription(), "text"),
            $ilDB->quote($this->getTarget(), "text"),
            $ilDB->quote($this->getId(), "integer")
        );
        $ilDB->manipulate($q);
    }

Field Documentation

$db

ilBookmark::$db

protected

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

Referenced by create(), delete(), read(), and update().

$description

ilBookmark::$description

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

Referenced by getDescription().

$error

ilBookmark::$error

protected

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

Referenced by read().

$id

ilBookmark::$id

Definition at line 46 of file class.ilBookmark.php.

Referenced by getId().

$parent

ilBookmark::$parent

Definition at line 47 of file class.ilBookmark.php.

Referenced by getParent().

$target

ilBookmark::$target

Definition at line 45 of file class.ilBookmark.php.

Referenced by getTarget().

$title

ilBookmark::$title

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

Referenced by getTitle().

$tree

ilBookmark::$tree

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

$user_Id

ilBookmark::$user_Id

Definition at line 34 of file class.ilBookmark.php.

---

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

• Services/Bookmarks/classes/class.ilBookmark.php