From 568c84466c2c3480f42e2125881b7c7020940b70 Mon Sep 17 00:00:00 2001
From: Andrew Hoffmann <andrew.hoffmann@wisc.edu>
Date: Mon, 5 Dec 2016 14:07:27 -0600
Subject: [PATCH] Rename mapAttribute method to httpHeaderFromAttribute to
better describe what it does
Minor documentation improvements included in this commit.
---
.../wisc/doit/uwphps/UserDetailsProvider.php | 10 ++++++----
.../FederatedPreauthUserDetailsProvider.php | 18 +++++++++---------
.../preauth/PreauthUserDetailsProvider.php | 18 +++++++++---------
3 files changed, 24 insertions(+), 22 deletions(-)
diff --git a/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php b/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php
index 78b9c9e..f211ca7 100644
--- a/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php
+++ b/src/main/edu/wisc/doit/uwphps/UserDetailsProvider.php
@@ -20,12 +20,13 @@ abstract class UserDetailsProvider
const SOURCE = "source";
const ISIS_EMPLID = "isisEmplid";
- // Delimiter used by multi-valued headers
+ /** Delimiter used by multi-valued headers */
const DELIMITER = ';';
/**
* UserDetailsProvider constructor.
- * @param $http
+ *
+ * @param bool $http true if Shibboleth attributes are delivered via HTTP request headers
*/
public function __construct($http = false)
{
@@ -45,10 +46,11 @@ abstract class UserDetailsProvider
*
* @param string $attribute attribute to map
* @return string Shibboleth attribute name mapped to its equivalent HTTP header name
+ *
+ * @see https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPAttributeAccess NativeSPAttributeAccess
*/
- protected function mapAttribute($attribute)
+ protected function httpHeaderFromAttribute($attribute)
{
return 'HTTP_' . strtoupper($attribute);
}
-
}
diff --git a/src/main/edu/wisc/doit/uwphps/preauth/FederatedPreauthUserDetailsProvider.php b/src/main/edu/wisc/doit/uwphps/preauth/FederatedPreauthUserDetailsProvider.php
index e8d896b..baafe05 100644
--- a/src/main/edu/wisc/doit/uwphps/preauth/FederatedPreauthUserDetailsProvider.php
+++ b/src/main/edu/wisc/doit/uwphps/preauth/FederatedPreauthUserDetailsProvider.php
@@ -34,15 +34,15 @@ class FederatedPreauthUserDetailsProvider extends UserDetailsProvider
if ($this->httpHeaders) {
$userDetails = new UWUserDetails(
- getenv($this->mapAttribute(static::EPPN)),
- getenv($this->mapAttribute(static::SPVI)),
- getenv($this->mapAttribute(static::FULL_NAME)),
- explode(static::DELIMITER, getenv($this->mapAttribute(static::UDDS))),
- getenv($this->mapAttribute(static::EMAIL)),
- getenv($this->mapAttribute(static::SOURCE)),
- getenv($this->mapAttribute(static::ISIS_EMPLID)),
- getenv($this->mapAttribute(static::FIRST_NAME)),
- getenv($this->mapAttribute(static::LAST_NAME))
+ getenv($this->httpHeaderFromAttribute(static::EPPN)),
+ getenv($this->httpHeaderFromAttribute(static::SPVI)),
+ getenv($this->httpHeaderFromAttribute(static::FULL_NAME)),
+ explode(static::DELIMITER, getenv($this->httpHeaderFromAttribute(static::UDDS))),
+ getenv($this->httpHeaderFromAttribute(static::EMAIL)),
+ getenv($this->httpHeaderFromAttribute(static::SOURCE)),
+ getenv($this->httpHeaderFromAttribute(static::ISIS_EMPLID)),
+ getenv($this->httpHeaderFromAttribute(static::FIRST_NAME)),
+ getenv($this->httpHeaderFromAttribute(static::LAST_NAME))
);
} else {
$userDetails = new UWUserDetails(
diff --git a/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php b/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php
index 80d36d9..2406b38 100644
--- a/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php
+++ b/src/main/edu/wisc/doit/uwphps/preauth/PreauthUserDetailsProvider.php
@@ -36,15 +36,15 @@ class PreauthUserDetailsProvider extends UserDetailsProvider
if ($this->httpHeaders) {
$userDetails = new UWUserDetails(
- getenv($this->mapAttribute(static::EPPN)),
- getenv($this->mapAttribute(static::PVI)),
- getenv($this->mapAttribute(static::FULL_NAME)),
- explode(static::DELIMITER, getenv($this->mapAttribute(static::UDDS))),
- getenv($this->mapAttribute(static::EMAIL)),
- getenv($this->mapAttribute(static::SOURCE)),
- getenv($this->mapAttribute(static::ISIS_EMPLID)),
- getenv($this->mapAttribute(static::FIRST_NAME)),
- getenv($this->mapAttribute(static::LAST_NAME))
+ getenv($this->httpHeaderFromAttribute(static::EPPN)),
+ getenv($this->httpHeaderFromAttribute(static::PVI)),
+ getenv($this->httpHeaderFromAttribute(static::FULL_NAME)),
+ explode(static::DELIMITER, getenv($this->httpHeaderFromAttribute(static::UDDS))),
+ getenv($this->httpHeaderFromAttribute(static::EMAIL)),
+ getenv($this->httpHeaderFromAttribute(static::SOURCE)),
+ getenv($this->httpHeaderFromAttribute(static::ISIS_EMPLID)),
+ getenv($this->httpHeaderFromAttribute(static::FIRST_NAME)),
+ getenv($this->httpHeaderFromAttribute(static::LAST_NAME))
);
} else {
$userDetails = new UWUserDetails(
--
GitLab