public function SimpleLdapServer::search in Simple LDAP 7.2

Same name and namespace in other branches

1. 7 SimpleLdapServer.class.php \SimpleLdapServer::search()

Search the LDAP server.

@throw SimpleLdapException

Parameters

string $base_dn: LDAP search base.

string $filter: LDAP search filter.

string $scope: LDAP search scope. Valid values are 'sub', 'one', and 'base'.

array $attributes: Array of attributes to retrieve.

int $attrsonly: Set to 1 in order to retrieve only the attribute names without the values. Set to 0 (default) to retrieve both the attribute names and values.

int $sizelimit: Client-side size limit. Set this to 0 to indicate no limit. The server may impose stricter limits.

int $timelimit: Client-side time limit. Set this to 0 to indicate no limit. The server may impose stricter limits.

int $deref: Specifies how aliases should be handled during the search.

Return value

array Search results.

5 calls to SimpleLdapServer::search()

SimpleLdapServer::copy in ./SimpleLdapServer.class.php

Copy an entry to a new DN.

SimpleLdapServer::delete in ./SimpleLdapServer.class.php

Delete an entry from the directory.

SimpleLdapServer::entry in ./SimpleLdapServer.class.php

Gets a single entry from the LDAP server.

SimpleLdapServer::exists in ./SimpleLdapServer.class.php

Check whether the provided DN exists.

SimpleLdapServer::rootdse in ./SimpleLdapServer.class.php

Loads the server's rootDSE.

File

./SimpleLdapServer.class.php, line 345

Class to handle LDAP server connections and related operations.

Class

SimpleLdapServer

Simple LDAP server class.

Code

public function search($base_dn, $filter = 'objectclass=*', $scope = 'sub', $attributes = array(), $attrsonly = 0, $sizelimit = 0, $timelimit = 0, $deref = LDAP_DEREF_NEVER) {

  // Make sure there is a valid binding.
  $this
    ->bind();
  try {

    // Use a post-test loop (do/while) because this will always be done once.
    // It will only loop if paged queries are supported/enabled, and more than
    // one page is available.
    $entries = array(
      'count' => 0,
    );
    $cookie = '';
    do {
      if ($this->pagesize) {

        // Set the paged query cookie.
        SimpleLdap::ldap_control_paged_result($this->resource, $this->pagesize, FALSE, $cookie);
      }

      // Perform the search based on the scope provided.
      switch ($scope) {
        case 'base':
          $result = SimpleLdap::ldap_read($this->resource, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref);
          break;
        case 'one':
          $result = SimpleLdap::ldap_list($this->resource, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref);
          break;
        case 'sub':
        default:
          $result = SimpleLdap::ldap_search($this->resource, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref);
          break;
      }
      if ($this->pagesize) {

        // Merge page into $entries.
        $e = SimpleLdap::ldap_get_entries($this->resource, $result);
        $entries['count'] += $e['count'];
        for ($i = 0; $i < $e['count']; $i++) {
          $entries[] = $e[$i];
        }

        // Get the paged query response cookie.
        SimpleLdap::ldap_control_paged_result_response($this->resource, $result, $cookie);
      }
      else {
        $entries = SimpleLdap::ldap_get_entries($this->resource, $result);
      }

      // Free the query result memory.
      SimpleLdap::ldap_free_result($result);
    } while ($cookie !== NULL && $cookie != '');
  } catch (SimpleLdapException $e) {

    // Error code 32 means there were no matching search results.
    if ($e
      ->getCode() == 32) {
      $entries = array(
        'count' => 0,
      );
    }
    else {
      throw $e;
    }
  }

  // ldap_get_entries returns NULL if ldap_read does not find anything.
  // Reformat the result into something consistent with the other search
  // types.
  if ($entries === NULL) {
    $entries = array(
      'count' => 0,
    );
  }
  return $entries;
}