From e29430a9693b8d9bb5426affa54c2e254d054e54 Mon Sep 17 00:00:00 2001
From: Andrew Hoffmann <andrew.hoffmann@wisc.edu>
Date: Tue, 6 Dec 2016 12:58:42 -0600
Subject: [PATCH] Docblock and PSR-2 formatting improvements
---
src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php | 2 +-
.../wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php | 6 +-----
2 files changed, 2 insertions(+), 6 deletions(-)
diff --git a/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php b/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php
index 9ebd735..6a5def3 100644
--- a/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php
+++ b/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php
@@ -36,7 +36,7 @@ abstract class UserDetailsProvider
/**
* Map Shibboleth header values to an associative array.
*
- * @return UserDetails
+ * @return UserDetails currently authenticated user, null if not logged in
*/
abstract public function loadUser();
diff --git a/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php b/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php
index 58b647d..e128eee 100644
--- a/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php
+++ b/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php
@@ -9,7 +9,7 @@ use edu\wisc\doit\uwphps\UWUserDetails;
* PreauthUserDetailsProvider is an implementation of {@link UserDetailsProvider} for loading users authenticated
* with UW-Madison login.
*
- * {@see FederatedPreauthUserDetailsProvider} for loading users authenticated through UW-System Federated login.
+ * See {@link FederatedPreauthUserDetailsProvider} for loading users authenticated through UW-System Federated login.
*/
class PreauthUserDetailsProvider extends UserDetailsProvider
{
@@ -23,9 +23,6 @@ class PreauthUserDetailsProvider extends UserDetailsProvider
const FIRST_NAME = 'givenName';
const LAST_NAME = 'sn';
- /**
- * {@inheritdoc}
- */
public function loadUser()
{
// Return null if no Shib session is found
@@ -62,5 +59,4 @@ class PreauthUserDetailsProvider extends UserDetailsProvider
return $userDetails;
}
-
}
--
GitLab