add a search function with scope (#17)

src/Ltb/Ldap.php

@@ -77,6 +77,34 @@ function connect() {
         return array($ldap, false);
     }
 
+    # Function that call ldap_search, ldap_read, or ldap_list
+    # depending on the given scope
+    # Expected arguments: scope + same list as ldap_search without ldap connection
+    # - string $scope
+    # - array|string $base,
+    # - array|string $filter,
+    # - array $attributes = [],
+    # - int $attributes_only = 0,
+    # - int $sizelimit = -1,
+    # - int $timelimit = -1,
+    # - int $deref = LDAP_DEREF_NEVER,
+    # - ?array $controls = null
+    function search_with_scope(string $scope = "sub", ...$searchargs): LDAP\Result|array|false
+    {
+        switch($scope)
+        {
+            case "sub":
+                return \Ltb\PhpLDAP::ldap_search($this->ldap, ...$searchargs);
+            case "one":
+                return \Ltb\PhpLDAP::ldap_list($this->ldap, ...$searchargs);
+            case "base":
+                return \Ltb\PhpLDAP::ldap_read($this->ldap, ...$searchargs);
+            default:
+                error_log("search_with_scope: invalid scope $scope");
+                return false;
+        }
+    }
+
     function search($ldap_filter,$attributes, $attributes_map, $search_result_title, $search_result_sortby, $search_result_items)
     {
 

src/Ltb/PhpLDAP.php

@@ -66,6 +66,11 @@ public static function ldap_read(...$args)
     return ldap_read(...$args);
   }
 
+  public static function ldap_list(...$args)
+  {
+    return ldap_list(...$args);
+  }
+
   public static function ldap_count_entries($ldap, $result)
   {
     return ldap_count_entries($ldap, $result);

tests/Ltb/LdapTest.php

@@ -269,6 +269,38 @@ public function test_get_list(): void
 
     }
 
+    public function test_search_with_scope(): void
+    {
+
+        $phpLDAPMock = Mockery::mock('overload:Ltb\PhpLDAP');
+
+        $phpLDAPMock->shouldreceive('ldap_search')
+                    ->with("ldap_connection", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn", "sn"))
+                    ->andReturn(array("ldap_search_result"));
+
+        $phpLDAPMock->shouldreceive('ldap_list')
+                    ->with("ldap_connection", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn", "sn"))
+                    ->andReturn(array("ldap_list_result"));
+
+        $phpLDAPMock->shouldreceive('ldap_read')
+                    ->with("ldap_connection", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn", "sn"))
+                    ->andReturn(array("ldap_read_result"));
+
+        $ldapInstance = new \Ltb\Ldap( null, null, null, null, null, null, null, null );
+        $ldapInstance->ldap = "ldap_connection";
+
+        $result_search = $ldapInstance->search_with_scope("sub", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn","sn"));
+        $result_list = $ldapInstance->search_with_scope("one", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn","sn"));
+        $result_read = $ldapInstance->search_with_scope("base", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn","sn"));
+        $result_unknown = $ldapInstance->search_with_scope("unknown", "ou=people,dc=my-domain,dc=com", "(uid=test)", array("cn","sn"));
+
+        $this->assertEquals(array('ldap_search_result'), $result_search, "function ldap_search not correctly called");
+        $this->assertEquals(array('ldap_list_result'), $result_list, "function ldap_list not correctly called");
+        $this->assertFalse($result_unknown, "weird return code in function ldap_read for scope=unknown");
+
+    }
+
+
     public function test_ldapSort(): void
     {