From 8ac054cb7244886f3f03885fbf9a9a5b334ad05c Mon Sep 17 00:00:00 2001
From: Uwe Steinmann <steinm@debian.org>
Date: Fri, 25 Aug 2023 12:33:08 +0200
Subject: [PATCH] add documentation for authenticate()

---
 inc/inc.ClassAuthenticationService.php | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/inc/inc.ClassAuthenticationService.php b/inc/inc.ClassAuthenticationService.php
index f04ac304d..d9d49212a 100644
--- a/inc/inc.ClassAuthenticationService.php
+++ b/inc/inc.ClassAuthenticationService.php
@@ -63,6 +63,19 @@ class SeedDMS_AuthenticationService {
 		return $this->errors;
 	} /* }}} */
 
+	/**
+	 * Run each authentication service
+	 *
+	 * This method calls authenticate() of each authentication service and
+	 * evaluates the returned value.
+	 * If the authentication method returns false (some internal error which
+	 * prevented to check authentication at all), this method will return
+	 * false imediately, in case of null (no valid authentication) the next
+	 * service will be tried and in all other cases the value will be returned.
+	 *
+	 * @param string $username name of user
+	 * @param string $password password of user
+	 */
 	public function authenticate($username, $password) { /* {{{ */
 		$user = null;
 		foreach($this->services as $name => $service) {