Changeset 5072

Timestamp:

23 Mar 2010, 14:34:14 (15 years ago)

Author:

uli

Message:

Show, how plugins work.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/README.txt (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/README.txt

@@ -97 +97 @@
 ===========
 
+
+WAeUP SIRP plugins
+==================
+
+waeup.sirp provides an API to 'plugin' components. Things that should
+be setup at creation time of a WAeUP SIRP application can indicate
+that by providing a utility providing IWAeUPSIRPPlugin.
+
+The plugins are looked up by an created app, which then will call the
+``setup()`` method of each plugin.
+
+   >>> from waeup.sirp.interfaces import IWAeUPSIRPPluggable
+   >>> from zope.component import getAdapters, getUtilitiesFor
+   >>> sorted(list(getUtilitiesFor(IWAeUPSIRPPluggable)))
+   [(u'accesscodes', <waeup.sirp.accesscodes...AccessCodePlugin ...)]
+
+
+We can provide a new plugin like this:
+
+   >>> import grok
+   >>> from waeup.sirp.interfaces import IWAeUPSIRPPluggable
+   >>> class MyPlugin(grok.GlobalUtility):
+   ...   grok.implements(IWAeUPSIRPPluggable)
+   ...   def setup(self, site, name, logger):
+   ...     print "Setup was called for"
+   ...     print site
+   ...   def update(self, site, name, logger):
+   ...     pass
+
+When we register the plugin
+
+   >>> grok.testing.grok_component('MyPlugin', MyPlugin)
+   True
+
+and setup a new WAeUP SIRP instance, we will get a message:
+
+   >>> from waeup.sirp.app import University
+   >>> site = University()
+   Setup was called for
+   <waeup.sirp.app.University object at 0x...>
+
+Apparently the plugin can do with the University object whatever it
+likes. That's what plugins are for.