summaryrefslogtreecommitdiff
path: root/docs/zcml/adapter.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/zcml/adapter.rst')
-rw-r--r--docs/zcml/adapter.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/zcml/adapter.rst b/docs/zcml/adapter.rst
new file mode 100644
index 000000000..48ed49f6c
--- /dev/null
+++ b/docs/zcml/adapter.rst
@@ -0,0 +1,51 @@
+.. _adapter_directive:
+
+``adapter``
+-----------
+
+Register a :term:`Zope Component Architecture` "adapter".
+
+Attributes
+~~~~~~~~~~
+
+``factory``
+
+ The adapter factory (often a class).
+
+``provides``
+
+ The :term:`interface` that an adapter instance resulting from a
+ lookup will provide.
+
+``for``
+
+ Interfaces or classes to be adapted, separated by spaces,
+ e.g. ``interfaces.IFoo interfaces.IBar``.
+
+``name``
+
+ The adapter name.
+
+Example
+~~~~~~~
+
+.. code-block:: xml
+ :linenos:
+
+ <adapter
+ for=".foo.IFoo .bar.IBar"
+ provides=".interfaces.IMyAdapter"
+ factory=".adapters.MyAdapter"
+ />
+
+Alternatives
+~~~~~~~~~~~~
+
+Use the ``registerAdapter`` method of the ``registry`` attribute of a
+:term:`Configurator` instance during initial application setup.
+
+See Also
+~~~~~~~~
+
+None.
+