Added config sync attribute callbacks

- Added ability to define a callback class and method to retrieve fields
from the user model upon synchronization.

Author: stevebauman

src/AdldapAuthUserProvider.php

@@ -142,21 +142,13 @@ protected function syncModelFromAdldap(User $user, Authenticatable $model)
         $attributes = $this->getSyncAttributes();
 
         foreach ($attributes as $modelField => $adField) {
-            if ($adField === ActiveDirectory::THUMBNAIL) {
-                // If the field we're retrieving is the users thumbnail photo, we need
-                // to retrieve it encoded so we're able to save it to the database.
-                $adValue = $user->getThumbnailEncoded();
+            if ($this->isAttributeCallback($adField)) {
+                $value = $this->handleAttributeCallback($user, $adField);
             } else {
-                $adValue = $user->{$adField};
-
-                if (is_array($adValue)) {
-                    // If the AD Value is an array, we'll
-                    // retrieve the first value.
-                    $adValue = Arr::get($adValue, 0);
-                }
+                $value = $this->handleAttributeRetrieval($user, $adField);
             }
 
-            $model->{$modelField} = $adValue;
+            $model->{$modelField} = $value;
         }
 
         if ($model instanceof Model) {
@@ -259,6 +251,68 @@ protected function authenticate($username, $password)
         return Adldap::authenticate($username, $password);
     }
 
+    /**
+     * Returns true / false if the specified string
+     * is a callback for an attribute handler.
+     *
+     * @param string $string
+     *
+     * @return bool
+     */
+    protected function isAttributeCallback($string)
+    {
+        $matches = preg_grep("/(\w)@(\w)/", explode("\n", $string));
+
+        return (count($matches) > 0);
+    }
+
+    /**
+     * Handles retrieving the value from an attribute callback.
+     *
+     * @param User  $user
+     * @param string $callback
+     *
+     * @return mixed
+     */
+    protected function handleAttributeCallback(User $user, $callback)
+    {
+        // Explode the callback into its class and method.
+        list($class, $method) = explode('@', $callback);
+
+        // Create the handler.
+        $handler = app($class);
+
+        // Call the attribute handler method and return the result.
+        return call_user_func_array([$handler, $method], [$user]);
+    }
+
+    /**
+     * Handles retrieving the specified field from the User model.
+     *
+     * @param User   $user
+     * @param string $field
+     *
+     * @return string|null
+     */
+    protected function handleAttributeRetrieval(User $user, $field)
+    {
+        if ($field === ActiveDirectory::THUMBNAIL) {
+            // If the field we're retrieving is the users thumbnail photo, we need
+            // to retrieve it encoded so we're able to save it to the database.
+            $value = $user->getThumbnailEncoded();
+        } else {
+            $value = $user->{$field};
+
+            if (is_array($value)) {
+                // If the AD Value is an array, we'll
+                // retrieve the first value.
+                $value = Arr::get($value, 0);
+            }
+        }
+
+        return $value;
+    }
+
     /**
      * Returns the username attribute for discovering LDAP users.
      *

tests/AdldapTest.php

@@ -161,4 +161,17 @@ public function testCredentialsKeyDoesNotExist()
 
         Auth::attempt([$nonExistantInputKey => '[email protected]', 'password' => '12345']);
     }
+
+    public function testConfigCallbackAttributeHandler()
+    {
+        $this->app['config']->set('adldap_auth.sync_attributes', [
+            'name' => 'Adldap\Laravel\Tests\Handlers\LdapAttributeHandler@name',
+        ]);
+
+        $this->testAuthPasses();
+
+        $user = \Auth::user();
+
+        $this->assertEquals('handled', $user->name);
+    }
 }

tests/Handlers/LdapAttributeHandler.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Adldap\Laravel\Tests\Handlers;
+
+use Adldap\Models\User;
+
+class LdapAttributeHandler
+{
+    /**
+     * Returns the common name of the AD User.
+     *
+     * @param User $user
+     *
+     * @return string
+     */
+    public function name(User $user)
+    {
+        return 'handled';
+    }
+}