AKSW - Projects/OntoWiki/PluginCookbook

2008-07-22 19:26:14

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-07-22 19:26:14 and 2010-07-05 17:03:38

Additions:

ATTENTION: THIS PAGE IS OUTDATED

2008-05-16 18:19:33

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-05-16 18:19:33 and 2008-07-22 19:26:14

Additions:

You aren't allowed to read action source page.

Deletions:

2008-05-16 18:17:37

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-05-16 18:17:37 and 2008-05-16 18:19:33

Additions:

How to create a new knowledge base template

Onto Builder (modified: modelcontroller.php/createaction, templates/model/create.php (new file))

2008-04-02 18:08:12

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-04-02 18:08:12 and 2008-05-16 18:17:37

Additions:

Ontobuilder (modified: resourcecontroller.php/getTabNavigation)

2008-03-09 15:12:20

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-03-09 15:12:20 and 2008-04-02 18:08:12

Additions:

Overwrite Onto Wiki Strings / Add Plugin Strings

Simply put a strings.ini file in your plugin directory. The plugin manager will include that to the main strings data.
This is a sample strings.ini:
%%(ini)
[english]
; this overwrites the title of the login box
auth.login.login = My own Login String
; this adds a new string to the strings object
myspecialplugin.info = This is my special plugin ...
[german : english]
auth.login.login = My eigener Login String
myspecialplugin.info = Dies ist mein spezielles Plugin ...
[default : english]

Deletions:

Overwrite Onto Wiki Strings

2008-03-03 12:47:28

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-03-03 12:47:28 and 2008-03-09 15:12:20

Additions:

Create a new file called Erfurt Example Plugin.ini-dist. This file will contain the followin lines:

* The first section contains some metadata about the plugin, like author and description.
    * The##switch## directive is very important. It tells the plugin manager, whether the plugin is active or not
    * The##folder## directive announces the folders, which are needed by the plugin. This is in our case only the root of the plugin dir
    * The last section is very important, too. Here you announce your plugin to one or more events and tell the plugin manager, which class(es) and method(s) to use.
  5. Now we have to implement the plugin. Therefor we need to create a file called##ErfurtExamplePlugin.php##, which contains our ##preAddAction## and ##postAddAction## methods, that we defined in the configuration file.

(php)

Deletions:

Create a new file called Erfurt Example Plugin.ini-dist. This file will contain the followin lines:

The first section contains some metadata about the plugin, like author and description.
The switch directive is very important. It tells the plugin manager, whether the plugin is active or not
The folder directive announces the folders, which are needed by the plugin. This is in our case only the root of the plugin dir
The last section is very important, too. Here you announce your plugin to one or more events and tell the plugin manager, which class(es) and method(s) to use.

Now we have to implement the plugin. Therefor we need to create a file called Erfurt Example Plugin.php, which contains our preAddAction and postAddAction methods, that we defined in the configuration file.

2008-03-03 12:41:44

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-03-03 12:41:44 and 2008-03-03 12:47:28

Additions:

Now we have to implement the plugin. Therefor we need to create a file called Erfurt Example Plugin.php, which contains our preAddAction and postAddAction methods, that we defined in the configuration file.

<?php
class Erfurt Example Plugin extends Erfurt_Plugin {

public function preAddAction(&$data) {

// do some stuff before adding a statement

// e.g.:
// 1. check whether predicate is rdfs:label
// 2a: false -> do nothing
// 2b: true -> check whether object has a language
// 3a: true -> do nothing
// 3b: false -> add a standard language tag... e.g. 'de'

$stm = $data['statement'];
if ($stm->getPredicate()->getURI() === EF_RDFS_LABEL) {

$obj = $stm->getObject();

if ($obj->getLanguage() === null) {

$obj->setLanguage('de');

}

}

return;

public function postAddAction(&$data) {

// do some stuff after adding a statement

// e.g. log statement serialization and success status
$stm = $data['statement'];
$success = $data['success'];

$logger = Zend_Registry::get('erfurtLog')->info('ErfurtExamplePlugin – Statement added (' .

date('d.m.Y H:i:s') . '): ' . $stm->toString() .
($success ? ' successfully added' : ' addition failed'));

We are done. If we want to use our plugin, we need to copy the Erfurt Example Plugin.ini-dist file to Erfurt Example Plugin.ini. That's all, no our plugin should work as we expect.

2008-02-27 17:49:27

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-02-27 17:49:27 and 2008-03-03 12:41:44

Additions:

Write Erfurt Plugins

It is also possible to write plugins for the Erfurt Semantic Web Framework. A Erfurt plugin is useful in case your Erfurt based application needs to do some additional things when data is manipulated through Erfurt. A good example for a usecase of such a plugin is cache invalidating when adding or removing statements or logging of the same.
The following example will give you a brief overview of the steps you will have to through in order to build such a plugin.

First of all you have to decide, which events your plugin should handle. Have a look at the Event section of the EventPluginArchitecture page in order to get a up-to-date list of triggered events. Our example plugin will announce to the RDFSModel_add_pre and RDFSModel_add_post events. These Erfurt core events are triggered in the add-method of the RDFSModel-class. The first one is triggered before a statement is added and the second one after the addition of a statements to the model. When a plugin announces to one of these events, it gets a reference to the data, which actually is an array containing a key statement with the statement as payload. The RDFSModel_add_post event has a additional key success, which indicates whether the addition was successful or failed.
Open the plugins/ folder, which is located under your Erfurt/ directory (Have a look at the PluginCookbook#h??? section to learn about setting up custom plugin directories.).

Create a new folder with the name of your plugin. In our case this will be Erfurt Example Plugin.
Create a new file called Erfurt Example Plugin.ini-dist. This file will contain the followin lines:

[general]
name = “Erfurt Example Plugin”
description = “This is a example Erfurt plugin. It will do some example stuff when a statements is added.”
author = “Philipp Frischmuth”
url = "http://ontowiki.net"
switch = “on” ; is plugin active? on|off
folder.0 = "."
announce.0.event = “RDFSModel_add_pre”
announce.0.class = "Erfurt Example Plugin"
announce.0.method = “preAddAction”
announce.1.event = “RDFSModel_add_post”
announce.1.class = "Erfurt Example Plugin"
announce.1.method = “postAddAction”

The first section contains some metadata about the plugin, like author and description.
The switch directive is very important. It tells the plugin manager, whether the plugin is active or not
The folder directive announces the folders, which are needed by the plugin. This is in our case only the root of the plugin dir
The last section is very important, too. Here you announce your plugin to one or more events and tell the plugin manager, which class(es) and method(s) to use.

Deletions:

Write Action Plugins

vakantieland, Ontobuilder

2008-02-27 15:47:47

Comparison for /Projects / Onto Wiki / Plugin Cookbook of 2008-02-27 15:47:47 and 2008-02-27 17:49:27

Additions:

AKSW - Projects/OntoWiki/PluginCookbook

2008-07-22 19:26:14

2008-05-16 18:19:33

2008-05-16 18:17:37

How to create a new knowledge base template

2008-04-02 18:08:12

2008-03-09 15:12:20

Overwrite Onto Wiki Strings / Add Plugin Strings

Overwrite Onto Wiki Strings

2008-03-03 12:47:28

2008-03-03 12:41:44

2008-02-27 17:49:27

Write Erfurt Plugins

Write Action Plugins

2008-02-27 15:47:47

Access to the active resource / resource list