Added ability to use a custom user import scope

Closes #699

Author: stevebauman

src/Commands/Import.php

@@ -14,6 +14,13 @@
 
 class Import
 {
+    /**
+     * The scope to utilize for locating the LDAP user to synchronize.
+     *
+     * @var string
+     */
+    public static $scope = UserImportScope::class;
+
     /**
      * The LDAP user that is being imported.
      *
@@ -28,6 +35,16 @@ class Import
      */
     protected $model;
 
+    /**
+     * Sets the scope to use for locating LDAP users.
+     *
+     * @param $scope
+     */
+    public static function useScope($scope)
+    {
+        static::$scope = $scope;
+    }
+
     /**
      * Constructor.
      *
@@ -83,17 +100,15 @@ protected function findUser()
             $query->withTrashed();
         }
 
-        // We'll try to locate the user by their object guid,
-        // otherwise we'll locate them by their username.
-        return $query->where(
-            Resolver::getDatabaseIdColumn(),
-            '=',
-            $this->getUserObjectGuid()
-        )->orWhere(
-            Resolver::getDatabaseUsernameColumn(),
-            '=',
+        /** @var \Illuminate\Database\Eloquent\Scope $scope */
+        $scope = new static::$scope(
+            $this->getUserObjectGuid(),
             $this->getUserUsername()
-        )->first();
+        );
+
+        $scope->apply($query, $this->model);
+
+        return $query->first();
     }
 
     /**

src/Commands/UserImportScope.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Adldap\Laravel\Commands;
+
+use Adldap\Laravel\Facades\Resolver;
+use Illuminate\Database\Eloquent\Scope;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Builder;
+
+class UserImportScope implements Scope
+{
+    /**
+     * The LDAP users object guid.
+     *
+     * @var string
+     */
+    protected $guid;
+
+    /**
+     * The LDAP users username.
+     *
+     * @var string
+     */
+    protected $username;
+
+    /**
+     * Constructor.
+     *
+     * @param string $guid
+     * @param string $username
+     */
+    public function __construct($guid, $username)
+    {
+        $this->guid = $guid;
+        $this->username = $username;
+    }
+
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     *
+     * @param Builder $query
+     * @param Model   $model
+     *
+     * @return void
+     */
+    public function apply(Builder $query, Model $model)
+    {
+        // We'll try to locate the user by their object guid,
+        // otherwise we'll locate them by their username.
+        $query
+            ->where(Resolver::getDatabaseIdColumn(), '=', $this->getGuid())
+            ->orWhere(Resolver::getDatabaseUsernameColumn(), '=', $this->getUsername());
+    }
+
+    /**
+     * Returns the users object guid.
+     *
+     * @return string
+     */
+    protected function getGuid()
+    {
+        return $this->guid;
+    }
+
+    /**
+     * Returns the LDAP users username.
+     *
+     * @return string
+     */
+    protected function getUsername()
+    {
+        return $this->username;
+    }
+}