build in authenticator hooks

to be implemented in calling application
gte451f · Aug 20, 2015 · b12cb2f · b12cb2f
1 parent e6e01c3
commit b12cb2f
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 5 deletions.
diff --git a/src/Authentication/AdapterInterface.php b/src/Authentication/AdapterInterface.php
@@ -11,7 +11,8 @@ interface AdapterInterface
 {
 
     /**
-     * each adapter mush provide a way to authenticate a user
+     * each adapter must provide a way to authenticate a user
+     * 
      * @param string $userName
      * @param string $password
      * @return boolean

diff --git a/src/Authentication/Authenticator.php b/src/Authentication/Authenticator.php
@@ -16,7 +16,7 @@
  * @author jjenkins
  *        
  */
-final class Authenticator extends Injectable implements AuthenticatorInterface
+class Authenticator extends Injectable implements AuthenticatorInterface
 {
 
     /**
@@ -70,9 +70,11 @@ public function isLoggedIn($token)
     public function logUserOut($token)
     {
         $result = $this->isLoggedIn($token);
+        $this->beforeLogout($token);
         if ($result) {
             $result = $this->profile->resetToken(true);
         }
+        $this->afterLogout($token, $result);
         return $result;
     }
 
@@ -86,11 +88,13 @@ public function logUserOut($token)
      */
     public function authenticate($userName, $password)
     {
+        $this->beforeLogin($userName, $password);
         $result = $this->adapter->authenticate($userName, $password);
         if ($result) {
             $this->profile->loadProfile("$this->userNameFieldName = '$userName'");
             $this->profile->resetToken();
         }
+        $this->afterLogin($userName, $password, $result);
         return $result;
     }
 
@@ -104,4 +108,40 @@ function getProfile($userName = false)
     {
         return $this->profile;
     }
+
+    /**
+     * hook to call before a login attempt
+     *
+     * @param string $userName            
+     * @param string $password            
+     */
+    public function beforeLogin($userName, $password)
+    {}
+
+    /**
+     * hook to call after a login attempt
+     *
+     * @param string $userName            
+     * @param string $password            
+     */
+    public function afterLogin($userName, $password, $result)
+    {}
+
+    /**
+     * hook to call before a logout attempt
+     *
+     * @param string $userName            
+     * @param string $password            
+     */
+    public function beforeLogout($token)
+    {}
+
+    /**
+     * hook to call after a logout attempt
+     *
+     * @param string $userName            
+     * @param string $password            
+     */
+    public function afterLogout($token, $result)
+    {}
 }
diff --git a/src/Authentication/AuthenticatorInterface.php b/src/Authentication/AuthenticatorInterface.php
@@ -9,9 +9,8 @@
  *        
  */
 interface AuthenticatorInterface
-{
-
-    // persiste to cache or session?
+{    
+    // persist to cache or session?
     
     /**
      * is the current user logged in?