ilBookmarkFolder Class Reference

bookmark folder (note: this class handles personal bookmarks folders only) More...

Collaboration diagram for ilBookmarkFolder:

Public Member Functions
	__construct ($a_bmf_id=0, $a_tree_id=0)
	Constructor public. More...
	read ()
	read bookmark folder data from db More...
	delete ()
	delete object data More...
	createNewBookmarkTree ()
	create personal bookmark tree More...
	create ()
	creates new bookmark folder in db More...
	update ()
	Update bookmark folder item. More...
	getId ()
	setId ($a_id)
	getTitle ()
	setTitle ($a_title)
	getParent ()
	setParent ($a_parent_id)
	getRootFolder ()

Static Public Member Functions
static	_lookupTitle ($a_bmf_id)
	lookup bookmark folder title More...
static	getObjects ($a_id)
	static More...
static	_getNumberOfObjects ()
	Get number of folders and bookmarks for current user. More...
static	getObject ($a_id)
	static More...
static	isRootFolder ($a_id)
static	_getParentId ($a_id)

Data Fields
	$tree
	$id
	$title
	$parent

Protected Attributes
	$db
	$error

Detailed Description

bookmark folder (note: this class handles personal bookmarks folders only)

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

Constructor & Destructor Documentation

__construct()

ilBookmarkFolder::__construct	(		$a_bmf_id = 0,
			$a_tree_id = 0
	)

Constructor public.

Parameters

integer

user_id (optional)

Definition at line 41 of file class.ilBookmarkFolder.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_bmf_id;

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

Here is the call graph for this function:

Member Function Documentation

_getNumberOfObjects()

static ilBookmarkFolder::_getNumberOfObjects ( )

static

Get number of folders and bookmarks for current user.

Definition at line 233 of file class.ilBookmarkFolder.php.

References $GLOBALS, $tree, and array.

Referenced by ilBookmarkBlockGUI\fillDataSection().

    {
        $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        $tree = new ilTree($a_tree_id);
        $tree->setTableNames('bookmark_tree', 'bookmark_data');

        $root_node = $tree->getNodeData($tree->getRootId());
        
        if ($root_node["lft"] != "") {
            $bmf = $tree->getSubTree($root_node, false, "bmf");
            $bm = $tree->getSubTree($root_node, false, "bm");
        } else {
            $bmf = array("dummy");
            $bm = array();
        }
        
        return array("folders" => (int) count($bmf) - 1, "bookmarks" => (int) count($bm));
    }

Here is the caller graph for this function:

_getParentId()

static ilBookmarkFolder::_getParentId (   $a_id )

static

Definition at line 292 of file class.ilBookmarkFolder.php.

References $GLOBALS, and $tree.

Referenced by ilBookmarkBlockGUI\getListRowData().

    {
        $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        $tree = new ilTree($a_tree_id);
        $tree->setTableNames('bookmark_tree', 'bookmark_data');
        return $tree->getParentId($a_id);
    }

Here is the caller graph for this function:

_lookupTitle()

static ilBookmarkFolder::_lookupTitle (   $a_bmf_id )

static

lookup bookmark folder title

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

References $DIC, and $ilDB.

Referenced by ilBookmarkBlockGUI\getListRowData().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM bookmark_data WHERE obj_id = " .
            $ilDB->quote($a_bmf_id, "integer");
        $bmf_set = $ilDB->query($q);
        $bmf = $ilDB->fetchAssoc($bmf_set);

        return $bmf["title"];
    }

Here is the caller graph for this function:

create()

ilBookmarkFolder::create

(

)

creates new bookmark folder in db

note: parent and title must be set

Definition at line 113 of file class.ilBookmarkFolder.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, type) " .
                "VALUES (%s,%s,%s,%s)",
            $ilDB->quote($this->getId(), "integer"),
            $ilDB->quote($GLOBALS['DIC']['ilUser']->getId(), "integer"),
            $ilDB->quote($this->getTitle(), "text"),
            $ilDB->quote('bmf', "text")
        );

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

Here is the call graph for this function:

createNewBookmarkTree()

ilBookmarkFolder::createNewBookmarkTree

(

)

create personal bookmark tree

Definition at line 96 of file class.ilBookmarkFolder.php.

References $db, and $ilDB.

    {
        $ilDB = $this->db;

        /*
        $q = "INSERT INTO bookmark_data (user_id, title, target, type) ".
            "VALUES ('".$this->tree->getTreeId()."','dummy_folder','','bmf')";
        $ilDB->query($q);*/
        //$this->tree->addTree($this->tree->getTreeId(), $ilDB->getLastInsertId());
        $this->tree->addTree($this->tree->getTreeId(), 1);
    }

delete()

ilBookmarkFolder::delete

(

)

delete object data

Definition at line 85 of file class.ilBookmarkFolder.php.

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

    {
        $ilDB = $this->db;
        
        $q = "DELETE FROM bookmark_data WHERE obj_id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->query($q);
    }

Here is the call graph for this function:

getId()

ilBookmarkFolder::getId

(

)

Definition at line 148 of file class.ilBookmarkFolder.php.

References $id.

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

    {
        return $this->id;
    }

Here is the caller graph for this function:

getObject()

static ilBookmarkFolder::getObject (   $a_id )

static

static

Definition at line 256 of file class.ilBookmarkFolder.php.

References $GLOBALS, and $tree.

Referenced by ilBookmarkImportExport\_exportBookmark().

    {
        $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        $tree = new ilTree($a_tree_id);
        $tree->setTableNames('bookmark_tree', 'bookmark_data');

        if (empty($a_id)) {
            $a_id = $tree->getRootId();
        }

        $object = $tree->getNodeData($a_id);
        return $object;
    }

Here is the caller graph for this function:

getObjects()

static ilBookmarkFolder::getObjects (   $a_id )

static

static

Definition at line 198 of file class.ilBookmarkFolder.php.

References $GLOBALS, $key, $tree, and array.

Referenced by ilBookmarkImportExport\__parseExport(), ilBookmarkBlockGUI\getListRowData(), and ilBookmarkAdministrationGUI\view().

    {
        $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        $tree = new ilTree($a_tree_id);
        $tree->setTableNames('bookmark_tree', 'bookmark_data');

        if (empty($a_id)) {
            $a_id = $tree->getRootId();
        }

        $childs = $tree->getChilds($a_id, "title");

        $objects = array();
        $bookmarks = array();

        foreach ($childs as $key => $child) {
            switch ($child["type"]) {
                case "bmf":
                    $objects[] = $child;
                    break;

                case "bm":
                    $bookmarks[] = $child;
                    break;
            }
        }
        foreach ($bookmarks as $key => $bookmark) {
            $objects[] = $bookmark;
        }
        return $objects;
    }

Here is the caller graph for this function:

getParent()

ilBookmarkFolder::getParent

(

)

Definition at line 168 of file class.ilBookmarkFolder.php.

References $parent.

Referenced by create().

    {
        return $this->parent;
    }

Here is the caller graph for this function:

getRootFolder()

ilBookmarkFolder::getRootFolder

(

)

Definition at line 283 of file class.ilBookmarkFolder.php.

References $GLOBALS, and $tree.

    {
        $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        $tree = new ilTree($a_tree_id);
        $tree->setTableNames('bookmark_tree', 'bookmark_data');

        return $tree->getRootId();
    }

getTitle()

ilBookmarkFolder::getTitle

(

)

Definition at line 158 of file class.ilBookmarkFolder.php.

References $title.

    {
        return $this->title;
    }

isRootFolder()

static ilBookmarkFolder::isRootFolder (   $a_id )

static

Definition at line 270 of file class.ilBookmarkFolder.php.

References $GLOBALS, and $tree.

Referenced by ilBookmarkBlockGUI\getListRowData().

    {
        $a_tree_id = $GLOBALS['DIC']['ilUser']->getId();
        $tree = new ilTree($a_tree_id);
        $tree->setTableNames('bookmark_tree', 'bookmark_data');

        if ($a_id == $tree->getRootId()) {
            return true;
        } else {
            return false;
        }
    }

Here is the caller graph for this function:

read()

ilBookmarkFolder::read

(

)

read bookmark folder data from db

Definition at line 64 of file class.ilBookmarkFolder.php.

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

Referenced by __construct().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

ilBookmarkFolder::setId

(

$a_id

)

Definition at line 153 of file class.ilBookmarkFolder.php.

Referenced by create().

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setParent()

ilBookmarkFolder::setParent

(

$a_parent_id

)

Definition at line 173 of file class.ilBookmarkFolder.php.

Referenced by read().

    {
        $this->parent = $a_parent_id;
    }

Here is the caller graph for this function:

setTitle()

ilBookmarkFolder::setTitle

(

$a_title

)

Definition at line 163 of file class.ilBookmarkFolder.php.

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

update()

ilBookmarkFolder::update

(

)

Update bookmark folder item.

Definition at line 134 of file class.ilBookmarkFolder.php.

References $db, and $ilDB.

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

Field Documentation

$db

ilBookmarkFolder::$db

protected

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

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

$error

ilBookmarkFolder::$error

protected

Definition at line 24 of file class.ilBookmarkFolder.php.

Referenced by read().

$id

ilBookmarkFolder::$id

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

Referenced by getId().

$parent

ilBookmarkFolder::$parent

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

Referenced by getParent().

$title

ilBookmarkFolder::$title

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

Referenced by getTitle().

$tree

ilBookmarkFolder::$tree

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

Referenced by _getNumberOfObjects(), _getParentId(), getObject(), getObjects(), getRootFolder(), and isRootFolder().

---

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

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