Docs For Class LDAPConnector

Description

LDAPConnector is a class used by the LDAPAuthNMethod and the LDAPAuthNTokens to handle common functions

version: $Id: LDAPConnector.class.php,v 1.13 2007/09/04 20:25:37 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agentmanagement/AuthNMethods/LDAPConnector.class.php (line 22)

Variable Summary

boolean $_bind

object Properties $_configuration

integer $_conn

Method Summary

void LDAPConnector (ref $configuration)

boolean authenticateDN (string $dn, string $password)

string|null dnExists (mixed $dn, string $systemName)

string getClassesDNsBySearch (mixed $filter, string $systemName)

string getDNsByList (mixed $filter, mixed $baseDN, string $systemName)

string getDNsBySearch (mixed $filter, mixed $baseDN, string $systemName)

string getGroupDNsBySearch (mixed $filter, string $systemName)

string getInfo (string $dn, optional $fields)

string getUserDNsBySearch (mixed $filter, string $systemName)

string|null groupDNExists (mixed $dn, string $systemName)

string|null userDNExists (mixed $dn, string $systemName)

boolean _anonymousBind ()

boolean _bind (string $dn, string $password)

void _bindForSearch ()

void _connect ()

void _disconnect ()

Variables

boolean $_bind (line 36)

LDAP bind result.

access: private

object Properties $_configuration (line 43)

The configuration for this method.

access: private

integer $_conn (line 29)

The LDAP connection ID.

access: private

Methods

Constructor LDAPConnector (line 51)

The constructor.

access: public

void LDAPConnector (ref $configuration)

ref $configuration: object $configuration A Properties Properties with configuration for connection.

authenticateDN (line 157)

authenticate will check a DN/password pair against the LDAP server.

return: true if authentication succeeded with the method, false if not
access: public

boolean authenticateDN (string $dn, string $password)

string $dn
string $password: the password associated with $systemName

dnExists (line 294)

returns true if the dn exists

return: The DN, or NULL if it can't be found.
access: private

string|null dnExists (mixed $dn, string $systemName)

string $systemName: The name to fetch the DN for.

getClassesDNsBySearch (line 182)

Get the course DNs that match the search

since: 3/4/05
access: public

string getClassesDNsBySearch (mixed $filter, string $systemName)

string $systemName

getDNsByList (line 267)

Get the DNs that match the search immediately below the baseDN

since: 3/4/05
access: public

string getDNsByList (mixed $filter, mixed $baseDN, string $systemName)

string $systemName

getDNsBySearch (line 238)

Get the DNs that match the search

since: 3/4/05
access: public

string getDNsBySearch (mixed $filter, mixed $baseDN, string $systemName)

string $systemName

getGroupDNsBySearch (line 216)

Get the user DNs that match the search

since: 3/4/05
access: public

string getGroupDNsBySearch (mixed $filter, string $systemName)

string $systemName

getInfo (line 323)

Get the DN for the systemname passed

since: 3/4/05
access: public

string getInfo (string $dn, optional $fields)

string $dn
optional $fields: array $return An array of fields to return.

getUserDNsBySearch (line 194)

Get the user DNs that match the search

since: 3/4/05
access: public

string getUserDNsBySearch (mixed $filter, string $systemName)

string $systemName

groupDNExists (line 226)

returns true if the Group dn exists

return: The DN, or NULL if it can't be found.
access: private

string|null groupDNExists (mixed $dn, string $systemName)

string $systemName: The name to fetch the DN for.

userDNExists (line 204)

returns true if the User dn exists

return: The DN, or NULL if it can't be found.
access: private

string|null userDNExists (mixed $dn, string $systemName)

string $systemName: The name to fetch the DN for.

_anonymousBind (line 103)

Attempts to bind to the LDAP server anonymously.

return: TRUE if bind was successful, FALSE otherwise.
access: private

boolean _anonymousBind ()

_bind (line 91)

Attempt to bind to the LDAP server using $dn and $password credentials.

return: TRUE if bind was successful, FALSE otherwise.
access: private

boolean _bind (string $dn, string $password)

string $dn: The LDAP DN.
string $password: The password.

_bindForSearch (line 116)

Attempts to bind to the LDAP server either anonymously or with a DN and password supplied in the configuration so that we can search the database.

access: public

void _bindForSearch ()

_connect (line 129)

Connects to the LDAP server.

access: private

void _connect ()

_disconnect (line 144)

Disconnects from the LDAP server.

access: private

void _disconnect ()