Added configuration option for binding Adldap user to laravel model

Author: stevebauman

src/AdldapAuthUserProvider.php

@@ -84,6 +84,10 @@ protected function getModelFromAdldap(User $user, $password)
             $model->save();
         }
 
+        if($this->getBindUserToModel()) {
+            $model->adldapUser = $user;
+        }
+
         return $model;
     }
 
@@ -135,6 +139,17 @@ protected function getLoginAttribute()
         return Config::get('adldap_auth.login_attribute', 'samaccountname');
     }
 
+    /**
+     * Retrieves the Adldap bind user to model config option for binding
+     * the Adldap user model instance to the laravel model.
+     *
+     * @return bool
+     */
+    protected function getBindUserToModel()
+    {
+        return Config::get('adldap_auth.bind_user_to_model', false);
+    }
+
     /**
      * Retrieves the Adldap sync attributes for filling the
      * Laravel user model with active directory fields.

src/Config/auth.php

@@ -15,6 +15,25 @@
 
     'login_attribute' => 'samaccountname',
 
+    /*
+    |--------------------------------------------------------------------------
+    | Bind User to Model
+    |--------------------------------------------------------------------------
+    |
+    | The bind User to Model option allows you to access the Adldap user model
+    | instance on your laravel database model to be able run operations
+    | or retrieve extra attributes on the Adldap user model instance.
+    |
+    | If this option is true, you must insert the trait:
+    |
+    |   `Adldap\Laravel\Traits\AdldapUserModelTrait`
+    |
+    | Onto your User model configured in `config/auth.php`.
+    |
+    */
+
+    'bind_user_to_model' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Sync Attributes

src/Traits/AdldapUserModelTrait.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Adldap\Laravel\Traits;
+
+trait AdldapUserModelTrait
+{
+    /**
+     * The Adldap User that is bound to the current model.
+     *
+     * @var \Adldap\Models\User
+     */
+    public $adldapUser;
+}

tests/AdldapTest.php

@@ -51,10 +51,11 @@ public function testAuthPasses()
 
         $this->assertTrue(Auth::attempt(['mail' => 'jdoe@email.com', 'password' => '12345']));
 
-        $user = \DB::table('users')->where('id', '=', 1)->first();
+        $user = Auth::user();
 
         $this->assertEquals('jdoe@email.com', $user->email);
         $this->assertTrue(\Hash::check('12345', $user->password));
+        $this->assertEquals($adUser, $user->adldapUser);
     }
 
     public function testAuthFails()

tests/FunctionalTestCase.php

@@ -37,6 +37,7 @@ protected function getEnvironmentSetup($app)
         ]);
 
         $app['config']->set('adldap.auto_connect', false);
+        $app['config']->set('adldap_auth.bind_user_to_model', true);
 
         $app['config']->set('auth.driver', 'adldap');
         $app['config']->set('auth.model', 'Adldap\Laravel\Tests\Models\User');

tests/Models/User.php

@@ -2,6 +2,7 @@
 
 namespace Adldap\Laravel\Tests\Models;
 
+use Adldap\Laravel\Traits\AdldapUserModelTrait;
 use Illuminate\Auth\Authenticatable;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Auth\Passwords\CanResetPassword;
@@ -10,7 +11,7 @@
 
 class User extends Model implements AuthenticatableContract, CanResetPasswordContract
 {
-    use Authenticatable, CanResetPassword;
+    use Authenticatable, CanResetPassword, AdldapUserModelTrait;
 
     /**
      * The database table used by the model.