Class ExtensionAdapter
Provides a very thin OOP wrapper around the ldap_* functions.
We don't need and want a huge LDAP lib for our purpose.
But this makes it easier to unit test code that is using LDAP because we can mock it very easy. It also provides some convenience.
Property Summary
-
$_connection protected
resource|nullLDAP Object
Method Summary
-
__construct() public
Constructor
-
_setErrorHandler() protected
Set an error handler to turn LDAP errors into exceptions
-
_unsetErrorHandler() protected
Restore the error handler
-
bind() public
Bind to LDAP directory
-
connect() public
Connect to an LDAP server
-
getConnection() public
Get the LDAP connection
-
getDiagnosticMessage() public
Get the diagnostic message
-
getOption() public
Get the current value for given option
-
setOption() public
Set the value of the given option
-
unbind() public
Unbind from LDAP directory
Method Detail
_setErrorHandler() ¶ protected
_setErrorHandler(): voidSet an error handler to turn LDAP errors into exceptions
Returns
voidThrows
ErrorExceptionbind() ¶ public
bind(string $bind, string $password): boolBind to LDAP directory
Parameters
-
string$bind Bind rdn
-
string$password Bind password
Returns
boolconnect() ¶ public
connect(string $host, int $port, array $options): voidConnect to an LDAP server
Parameters
-
string$host Hostname
-
int$port Port
-
array$options Additonal LDAP options
Returns
voidgetConnection() ¶ public
getConnection(): resourceGet the LDAP connection
Returns
resourceThrows
RuntimeExceptionIf the connection is empty
getDiagnosticMessage() ¶ public
getDiagnosticMessage(): string|nullGet the diagnostic message
Returns
string|nullgetOption() ¶ public
getOption(int $option): mixedGet the current value for given option
Parameters
-
int$option Option to get
Returns
mixedsetOption() ¶ public
setOption(int $option, mixed $value): voidSet the value of the given option
Parameters
-
int$option Option to set
-
mixed$value The new value for the specified option
Returns
void