Changes between Version 3 and Version 4 of AccountManagerPlugin/RegistrationInspector

Timestamp:

Aug 11, 2012, 2:33:26 PM (12 years ago)

Author:

Steffen Hoffmann

Comment:

include interface definition from current source

AccountManagerPlugin/RegistrationInspector

@@ -1 +1 @@
 [[PageOutline()]]
-= New User Registration Process =
+= New User Registration =
 
 == Involved Modules ==
@@ -58 +58 @@
 As shown in the configuration above, you'll have to enable the accountchangelistener component as well. Without it, verification emails will be silently ignored (but the web-UI will still say they got sent!).
 
-== Registration Checks ==
+== Modular Registration Checks ==
+=== Interface Definition ===
+{{{
+#!python
+class IAccountRegistrationInspector(Interface):
+    """An interface for Components, that wish to participate in examining
+    requests for account creation.
+
+    The check method is called not only by RegistrationModule but when adding
+    new users from the user editor in AccountManagerAdminPanels too.
+    """
+
+    def render_registration_fields(req):
+        """Emit one or multiple additional fields for registration form built.
+
+        Returns a dict containing a 'required' and/or 'optional' tuple of
+         * Genshi Fragment or valid XHTML markup for registration form
+         * template data object with default values or empty dict
+        If the return value is just a single tuple, its fragment or markup
+        will be inserted into the 'required' section.
+        """
+
+    def validate_registration(req):
+        """Check registration form input.
+
+        Returns a RegistrationError with error message, or None on success.
+        """
+}}}
+
 === Related external resources ===
 There are some 3rd-party extensions to the registration module/process: