[Fusionforge-commits] r12866 - in trunk/src: common/include docs plugins/authbuiltin/common

Olivier Berger olberger at fusionforge.org
Mon Mar 21 14:48:56 CET 2011


Author: olberger
Date: 2011-03-21 14:48:55 +0100 (Mon, 21 Mar 2011)
New Revision: 12866

Modified:
   trunk/src/common/include/AuthPlugin.class.php
   trunk/src/docs/README.Plugins
   trunk/src/plugins/authbuiltin/common/AuthBuiltinPlugin.class.php
Log:
Somme comments and more docs


Modified: trunk/src/common/include/AuthPlugin.class.php
===================================================================
--- trunk/src/common/include/AuthPlugin.class.php	2011-03-21 13:48:43 UTC (rev 12865)
+++ trunk/src/common/include/AuthPlugin.class.php	2011-03-21 13:48:55 UTC (rev 12866)
@@ -63,6 +63,9 @@
 			break;
 		case 'display_auth_form':
 			// no default implementation, but see AuthBuiltinPlugin::displayAuthForm()
+			//  $params can be passed with a 'return_to' attribute
+			//  it should return an HTML dialog appened to passed $params['html_snippets']
+            //  it may return a redirection URL appened to  $params['transparent_redirect_urls']
 			$this->displayAuthForm($params);
 			break;
 		case 'display_create_user_form':

Modified: trunk/src/docs/README.Plugins
===================================================================
--- trunk/src/docs/README.Plugins	2011-03-21 13:48:43 UTC (rev 12865)
+++ trunk/src/docs/README.Plugins	2011-03-21 13:48:55 UTC (rev 12866)
@@ -447,4 +447,13 @@
 
 TODO : document user_logo (plugin_hook_by_reference) : returns in params['content'] 
 
+TODO : document Auth plugins :
+
+  Hook Name  : display_auth_form
+  Parameters : return_to
+  Locations  : www/include/login-form.php
+  Description: returns a login dialog and/or a redirect URL :
+               it should return an HTML dialog appened to passed $params['html_snippets']
+               it may return a redirection URL appened to  $params['transparent_redirect_urls']
+
   -- Roland Mas <lolando at debian.org>

Modified: trunk/src/plugins/authbuiltin/common/AuthBuiltinPlugin.class.php
===================================================================
--- trunk/src/plugins/authbuiltin/common/AuthBuiltinPlugin.class.php	2011-03-21 13:48:43 UTC (rev 12865)
+++ trunk/src/plugins/authbuiltin/common/AuthBuiltinPlugin.class.php	2011-03-21 13:48:55 UTC (rev 12866)
@@ -51,7 +51,7 @@
 	}
 
 	/**
-	 * Display a form to input credentials : default login dialog
+	 * Display a form to input credentials : default login dialog ('display_auth_form' hook)
 	 * @param unknown_type $params
 	 * @return boolean
 	 */




More information about the Fusionforge-commits mailing list