Docs For Class LdapSearchResult

Description

LDAP Search Result class

This class handles the results of an LDAP query. The result entries are parsed and returned as instances of the LdapEntry class.

author: Marcos Pont <mpont@users.sourceforge.net>
version: $Revision$
usedby: LdapClient
uses: LdapEntry
uses: TypeUtils

Located in /core/net/ldap/LdapSearchResult.class.php (line 43)

PHP2Go
   |
   --LdapSearchResult

Variable Summary

resource $conn

resource $entry

resource $handle

Method Summary

LdapSearchResult LdapSearchResult (resource &$conn, resource &$handle)

void __destruct ()

DataSet &createDataSet ()

LdapEntry|FALSE fetchEntry ()

array getAllEntries ()

int getCount ()

bool hasNextEntry ()

void sortEntries ([array $attrs = array()])

string _getErrorMessage ()

array _parseAttrs (resource $entry)

Variables

resource $conn (line 51)

Connection handle

access: private

resource $entry (line 65)

Last fetched entry

access: private

resource $handle (line 58)

Result handle

access: private

Methods

Constructor LdapSearchResult (line 74)

Class constructor

LdapSearchResult LdapSearchResult (resource &$conn, resource &$handle)

resource &$conn: Connection handle
resource &$handle: Result handle

Destructor __destruct (line 86)

Class destructor

void __destruct ()

createDataSet (line 128)

Creates a data set and fills it with all search result entries

uses: DataSet::factory()

DataSet &createDataSet ()

fetchEntry (line 162)

Fetches the next result entry

uses: LdapEntry::createFromResult()

LdapEntry|FALSE fetchEntry ()

getAllEntries (line 110)

Get all entries as an array

uses: LdapEntry::createFromResult()

array getAllEntries ()

getCount (line 98)

Get total number of entries

int getCount ()

hasNextEntry (line 176)

Checks if there are more entries to fetch

bool hasNextEntry ()

sortEntries (line 143)

Sort entries by a given set of attributes

All sort attributes must be present in the LDAP entries.

void sortEntries ([array $attrs = array()])

array $attrs: Sort attributes

_getErrorMessage (line 186)

Parses an error message from the LDAP server

access: private

string _getErrorMessage ()

_parseAttrs (line 200)

Parses the attributes of an LDAP entry

access: private

array _parseAttrs (resource $entry)

resource $entry: Entry handle

Inherited Methods

Inherited From PHP2Go

PHP2Go::PHP2Go()
PHP2Go::equals()
PHP2Go::generateUniqueId()
PHP2Go::getClassName()
PHP2Go::getConfigVal()
PHP2Go::getLangVal()
PHP2Go::getObjectName()
PHP2Go::getParentName()
PHP2Go::hasDestructor()
PHP2Go::hashCode()
PHP2Go::isA()
PHP2Go::isSubclassOf()
PHP2Go::logError()
PHP2Go::raiseError()
PHP2Go::registerDestructor()
PHP2Go::registerShutdownFunc()
PHP2Go::retrieve()
PHP2Go::store()
PHP2Go::__toString()