<<

NAME

Konstrukt::Plugin::bookmarks::DBI - Konstrukt bookmarks DBI backend driver

SYNOPSIS

        #TODO

DESCRIPTION

Konstrukt bookmarks DBI backend driver.

CONFIGURATION

Note that you have to create the tables bookmarks_item and bookmarks_category. You may turn on the install setting (see "CONFIGURATION" in Konstrukt::Handler) or use the KonstruktBackendInitialization.pl script to accomplish this task.

You may define those settings to use this backend.

        #Backend
        bookmarks/backend/DBI/source       dbi:mysql:database:host
        bookmarks/backend/DBI/user         user
        bookmarks/backend/DBI/pass         pass

If no database settings are set the defaults from "CONFIGURATION" in Konstrukt::DBI will be used.

METHODS

init

Initialization of this class

install

Installs the backend (e.g. create tables).

Parameters:

none

add_entry

Adds a new bookmark.

Parameters:

get_entry

Returns the requested bookmark as an hash reference with the keys id, url, title, category, private, visits, author, year, month, day, hour and minute.

Parameters:

get_entries

Returns the requested category and its sub-categories and -bookmarks visible to the specified author as an hash reference: { id => .., title => .., author => .., private => .., categories => [ { id => .. }, { id => .. }, ... ], bookmarks => [ { id => .., url => "..", title => "..", author => .., private => .., category => .., visits => .., year => .., month => .., ... }, ... ] }

Parameters:

update_entry

Updates an existing bookmark.

Parameters:

delete_entry

Removes an existing bookmark.

Parameters:

add_category

Adds a new category.

Parameters:

get_category

Returns the requested category as an hash reference: { id => .., title => .., author => .., private => .., parent => ..}

Parameters:

update_category

Updates an existing category.

Parameters:

delete_category

Recursively deletes an existing category and all sub-categories and -items.

Parameters:

visit

Increates the visits counter and updates the last_visit timestamp for a specified bookmark.

Parameters:

AUTHOR

Copyright 2006 Thomas Wittek (mail at gedankenkonstrukt dot de). All rights reserved.

This document is free software. It is distributed under the same terms as Perl itself.

SEE ALSO

Konstrukt::Plugins::bookmarks, Konstrukt

<<