From 5e47b74ccf0de6e08f9ffa20a87021e83623e6f9 Mon Sep 17 00:00:00 2001 From: Andrew McMillan Date: Thu, 1 Nov 2007 22:29:08 +1300 Subject: [PATCH] Provide example config snippet for docs. --- inc/auth-functions.php | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/inc/auth-functions.php b/inc/auth-functions.php index ece64513..ccbd590a 100644 --- a/inc/auth-functions.php +++ b/inc/auth-functions.php @@ -123,7 +123,21 @@ function UpdateUserFromExternal( &$usr ) { * Authenticate against a different PostgreSQL database which contains a usr table in * the AWL format. * -* @package davical +* Use this as in the following example config snippet: +* +* require_once('auth-functions.php'); +* $c->authenticate_hook = array( +* 'call' => 'AuthExternalAwl', +* 'config' => array( +* // A PgSQL database connection string for the database containing user records +* 'connection' => 'dbname=wrms host=otherhost port=5433 user=general', +* // Which columns should be fetched from the database +* 'columns' => "user_no, active, email_ok, joined, last_update AS updated, last_used, username, password, fullname, email", +* // a WHERE clause to limit the records returned. +* 'where' => "active AND org_code=7" +* ) +* ); +* */ function AuthExternalAWL( $username, $password ) { global $c;