provide some documentation on interfaces

plone · Jan 9, 2017 · 42428ff · 42428ff
1 parent 643001e
commit 42428ff
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,6 +13,7 @@ Contents:
    applications
    addons
    services
+   interfaces
    migrations
    behavior
    commands

diff --git a/docs/source/interfaces.md b/docs/source/interfaces.md
@@ -0,0 +1,22 @@
+# Interfaces
+
+`plone.server` uses interfaces to abstract and define various things including
+content. Interfaces are useful when defining api contracts, using inheritance,
+defining schema/behaviors and being able to define which content your services
+are used for.
+
+In the services example, you'll notice the use of `context=ISite` for the service
+decorator configuration. In that case, it's to tell `plone.server` that the
+service is only defined for a site object.
+
+## Common interfaces
+
+Interfaces you will be interested in defining services for are:
+
+ - `plone.server.interface.IDatabase`: A database contains the site objects
+ - `plone.server.interface.ISite`: Site content object
+ - `plone.server.interface.IResource`: Base interface for all content
+ - `plone.server.interface.IContainer`: Base interface for content that can contain other content
+ - `plone.server.interface.IRegistry`: Registry object interface
+ - `plone.server.interface.IDefaultLayer`: Layers are an interface applied to the
+   request object. IDefaultLayer is the base default layer applied to the request object.