ObjectPlugin

Use a topic as an object store.

The object is to use foswiki topics to store lots of objects (chunks of structured data) that can be searched, filtered and manipulated. The intention is to avoid the creation of thousands of topics with minimal content and offer an object management service to other plugins.

In the future, the plugin will additionally manage the objects in a DBCacheContrib? database for the object type thus offering the search functions of the DBCachePlugin?. And there will be the possibility to define an object type as meta data (so the created object is added to the topic as %META:OBJECT ) thus offering an 'easy' way of adding structural elements to a topic without having to extend the attached form. This data will be added to the topic entry in the DBCacheContrib? database of the web.

Acknowledgements

I see this plugin as a generalised version of the ActionTrackerPlugin? and, indeed, started development with lots of find/replacing.

What is an ObjectPlugin object

An object is like a topic with a DataForm? and a VIEW_TEMPLATE . An object has default parameters (creator, created, uid, type and text). Additional parameters can be defined using an Object Form which is just a DataForm? (see the EventObject from the FullCalendarPlugin for an example). An additional noload form type is introduced for 'support' parameters that are default for an object type and so are not intended to be stored with individual objects in the topic.

(Lots) More docco to follow

The code is stable and full featured but this early release without completed documentation is for the benefit of the FullCalendarPlugin.

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Info

Plugin Author: Foswiki:Main/DavidPatterson
Copyright: ©
License: GPL (Gnu General Public License)
Release: 1.01
Version: 8478 (2010-08-12)
Change History:  
12 Aug 2010 Foswiki:Tasks/Item9465 fix permanent expanding of macros when updating an object
06 Aug 2010 first release
Dependencies:
NameVersionDescription
Time::ParseDate>=2003.0211Required.
JSON>=2.21Required.
JSON::XS>=2.29Recommended for performance.
Foswiki::Plugins::HijaxPlugin>=1.1Required.
Foswiki::Plugins::FlexWebListPlugin>=1.51Required, see ObjectModules.
Home page: http://foswiki.org/bin/view/Extensions/ObjectPlugin
Support: http://foswiki.org/bin/view/Support/ObjectPlugin

Print version |  PDF  | History: r0 | 
Topic revision: r1 - 09 Jun 2010 - 10:59:40 - ProjectContributor
 

TUTWiki

This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding TUTWiki? Send feedback