AKSW - Projects/OntoWiki/EventPluginArchitecture

2008-07-22 19:23:21

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-07-22 19:23:21 and 2008-07-22 20:20:21

Additions:

The event dispatcher has been built in with OntoWiki 0.8.5 and it can be used to publish events (trigger events) and to subscribe event handlers (announcing mthods from plugin classes as event handlers) to those events. We distinguish between three groups of events:

Zend events: those events are triggered automatically based on Zend event methods
Core events: contains events which are triggered in the core code on decision by OntoWiki / Erfurt developers
Third party events: events triggered by plugins

Technically there are no differences between the events of each group.

Zend events

In OntoWiki we trigger Zend event methods automatically, names are:
Additionally we have those events prefixed by the current route request. The prefix is composed of the module name, controller name and the action name (all parts in lowercase letters) of the requested route. OntoWiki has only one default module, so the prefix is ending up in default_controllername_actionname_. For example while the request of http://demo.ontowiki.net/wiki/registerNew/ the event default_wiki_registernew_ZendPostDispatch is published beside the ZendPostDispatch event. The prefixed Zend event are triggered right after the usual Zend event has been published.
Please pass references to the trigger (objects are references!).

Deletions:

We distinguish between three groups of events. One group of events is generated automatically (automatic events), the second group contains events which are set on decision by OntoWiki / Erfurt developers (core events). Also plugins itself can trigger events (third party events), these events are in group three. Technically there are no differences between the events of each group.

Automatic events

This section needs an update
Automatic events basically trigger event methods of the Zend Framwork (OntoWiki/Erfurt is using the Zend Framework). For better understanding how Zend Framework works you may read Zend Controller quick start, Zend Controller basics and Zend Controller plugins (description of Zend event methods).
In OntoWiki we trigger Zend event methods automatically, names are:
Additionally these Zend event methods will be triggered prefixed by the current route request, prefix is ModuleName_ControllerName_ActionName_. Please replace ModuleName, ControllerName and ActionName in the trigger's name by the defined names of the module, controller and action of the route your plugin should be executed by the trigger. For example plugin code will be executed at http://demo.ontowiki.net/wiki/registerNew/ when the plugin announced methods to default_wiki_registerNew_ZendPostDispatch.
Currently these triggers will pass the zend plugin object to your plugin's method.
Please pass pointers to the trigger (objects are pointers!).

2008-07-22 17:35:51

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-07-22 17:35:51 and 2008-07-22 19:23:21

Additions:

Plugin Cookbook (work in process)

Deletions:

Plugin Cookbook

2008-07-22 17:33:10

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-07-22 17:33:10 and 2008-07-22 17:35:51

No differences.

2008-07-22 17:31:38

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-07-22 17:31:38 and 2008-07-22 17:33:10

Additions:

; The path to Onto Wiki plugin folder ;

How to develop an OntoWiki plugin

Deletions:

; The path to Onto Wiki's plugin folder ;

How to develop an ~OntoWiki plugin

2008-06-10 08:49:24

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-06-10 08:49:24 and 2008-07-22 17:31:38

Additions:

Plugins and Events

Overview: Plugins and Events
Plugin Development
- Plugin Cookbook (work in process)
- Examples

With OntoWiki 0.8.5 we add a plugin architecture which can be used to integrate your own functionality to OntoWiki and Erfurt through plugins. Those plugins can be deployed by providing classes and methods as event handlers to OntoWiki and Erfurt events. An event dispatcher is used to publish those events.

Installation

Plugin integration to OntoWiki is easy: copy all files of a plugin package and the associated configuration file (config.ini) into one own folder in OntoWiki's plugin directory and switch the plugin on (for now in config.ini). You can specify OntoWiki's plugin directory in OntoWiki's config.ini:
%%(ini)
plugins.ontowiki = plugins/ ; relative path to Onto Wiki root directory
Add more different folders (this feature is planned, it's not working yet):
Choose your own alphanumerical names but please do not use plugins.erfurt in config.ini. All added paths are crawled for plugins' for the config.ini configuration file.

Plugin development

Plugins can be used to add new functionality to OntoWiki or its user interface without the necessary to hack the OntoWiki core code. Additionally you can provide new libraries and their interfaces through plugins. To integrate plugins automatically we provide events which can be subscribed by your plugin's methods as event handlers. Please read further:

How to develop an ~OntoWiki plugin
Plugin Cookbook

Deletions:

With OntoWiki 0.8.5 we add a plugin architecture which you can use to integrate your plugins to OntoWiki and Erfurt in an easy way. A new event manager is used to trigger named events, a plugin can announce classes and their methods on that namend events.
Integration of plugins to OntoWiki is easy: copy all plugin files and the associated ini-file in OntoWiki's plugin folder and switch the plugin on (for now in config.ini, later we will do that in OntoWiki itself). You can specify the plugin folder relative to application's root in OntoWiki's config.ini:
plugins.ontowiki = plugins/
Add more different folders:
Choose your own alphanumerical names but please do not use plugins.erfurt in config.ini. All added paths are crawled for plugins' for the config.ini configuration file.

Plugin configuration file

You define everything in your config.ini. See the the configuration file config.ini of the Example plugin:
[general]
;

; ; Information about Plugin ;
;

; name = “Example Plugin”
description = «This is a example for a Onto Wiki / Erfurt plugin.»
author = “Michael Haschke”
url = "http://ontowiki.net"
switch = “off” ;is plugin active? on|off
;

; ; Which folders are needed ;
;

; folder.0 = "."
;folder.1 = «./foldername»
;

; ; Announcements to triggers ;
;

; announce.0.event = “exampletrigger”
announce.0.class = “Example”
announce.0.method = “example”
;announce.1.event = “testtrigger2”
;announce.1.class = "My Class 2"
;announce.1.method = “myFunction2”
;

; ; Announce additional Classes and Methods ;
;

;

; use this for Announcements which are not related to a trigger ;

;add.0.class = "Class Name"
;add.0.method = “methodName”
;add.1.class = "Class Name 2"
;add.1.method = “methodName2”

Folders

Use folder.x to specify all folders where your plugin files (your classes) are located in, specified path names must be relative to the point where your plugin configuration file is located. The configuration file may be somewhere in OntoWiki's plugin folder but the path of your plugin's root is a good place.

Announcements to event triggers

Use announce.x to announce your plugin's methods to named events — event is the event's name you want your method announce to, class is the name of your plugin's class and method is the name of the method in your class. Please take care that the class ClassName is in file ClassName.php.

Private configuration sections

In case your plugin needs some configuration internally, we encourage you to use one or more sections in your config.ini file, e.g. [private]. You also can use another name for the section or define more than one section, but in most cases a [private] section should fullfill your needs.
You can access the config in your plugin class by calling the protected _getPluginConfig() method. This method will return an instance of Zend_Config. In case your section is called [private] you would access your configuration the following way: $this->_getPluginConfig()->private->foo->bar.

Language configuration files

Your plugin can have it's own language configuration file in order to support multiple languages or change the default behaviour of Onto Wiki. You just have to create a file called string.ini in your plugin root folder and add at least two sections: [english] and [default : english]. So your file could look like this:
[english]
foo = “Bar”
[default : english]

Code definitions

Is coming later ...

2008-03-11 19:43:47

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-03-11 19:43:47 and 2008-06-10 08:49:24

Additions:

Deletions:

With OntoWiki 0.9 we add a plugin architecture which you can use to integrate your plugins to OntoWiki and Erfurt in an easy way. A new event manager is used to trigger named events, a plugin can announce classes and their methods on that namend events.

2008-03-11 19:18:35

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-03-11 19:18:35 and 2008-03-11 19:43:47

Additions:

Language configuration files

2008-03-06 11:03:11

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-03-06 11:03:11 and 2008-03-11 19:18:35

Additions:

Integration of plugins to OntoWiki is easy: copy all plugin files and the associated ini-file in OntoWiki's plugin folder and switch the plugin on (for now in config.ini, later we will do that in OntoWiki itself). You can specify the plugin folder relative to application's root in OntoWiki's config.ini:
Choose your own alphanumerical names but please do not use plugins.erfurt in config.ini. All added paths are crawled for plugins' for the config.ini configuration file.
You define everything in your config.ini. See the the configuration file config.ini of the Example plugin:

Private configuration sections

Deletions:

Integration of plugins to OntoWiki is easy: copy all plugin files and the associated ini-file in OntoWiki's plugin folder and switch the plugin on (for now in pluginname.ini, later we will do that in OntoWiki itself). You can specify the plugin folder relative to application's root in OntoWiki's config.ini:
Choose your own alphanumerical names but please do not use plugins.erfurt in config.ini. All added paths are crawled for plugins' configuration files (including subfolders).
You define everything in your pluginname.ini. Please replace pluginname by plugin's name :) See the the configuration file Example.ini of the Example plugin:

2008-02-29 18:35:43

Comparison for /Projects / Onto Wiki / Event Plugin Architecture of 2008-02-29 18:35:43 and 2008-03-06 11:03:11

Additions:

RDFSModel_remove_pre with data: associative array with key statement
RDFSModel_remove_post with data: associative array with keys statement, success