Documentation

Horde_Prefs_Storage_Ldap extends Horde_Prefs_Storage_Base
in package

Preferences storage implementation for LDAP servers.

Tags
author

Jon Parise jon@horde.org

author

Ben Klang ben@alkaloid.net

author

Michael Slusarz slusarz@horde.org

author

Heinz Schweiger heinz@htl-steyr.ac.at

category

Horde

Table of Contents

$_ldap  : Horde_Ldap
Handle for the current LDAP connection.
$_params  : string
Configuration parameters.
$_prefsDN  : string
Current DN holding the preferences.
__construct()  : mixed
Constructor.
get()  : Horde_Prefs_Scope
Retrieves the requested preferences scope from the storage backend.
getParams()  : array<string|int, mixed>
Get the list of driver parameters.
listScopes()  : array<string|int, mixed>
Lists all available scopes.
onChange()  : mixed
Called whenever a preference value is changed.
remove()  : mixed
Removes preferences from the backend.
store()  : mixed
Stores changed preferences in the storage backend.

Properties

$_ldap

Handle for the current LDAP connection.

protected Horde_Ldap $_ldap

$_params

Configuration parameters.

protected string $_params = array()

'user' is always available as an entry.

$_prefsDN

Current DN holding the preferences.

protected string $_prefsDN

Methods

__construct()

Constructor.

public __construct(string $user[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$user : string

The username.

$params : array<string|int, mixed> = array()

Configuration parameters.

  • 'ldap': (Horde_Ldap) [REQUIRED] The DB instance.
Tags
throws
InvalidArgumentException
Return values
mixed —

get()

Retrieves the requested preferences scope from the storage backend.

public get(mixed $scope_ob) : Horde_Prefs_Scope
Parameters
$scope_ob : mixed

The scope object.

Return values
Horde_Prefs_Scope —

The modified scope object.

getParams()

Get the list of driver parameters.

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Driver parameters.

listScopes()

Lists all available scopes.

public listScopes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The list of scopes stored in the backend.

onChange()

Called whenever a preference value is changed.

public onChange(string $scope, string $pref) : mixed
Parameters
$scope : string

Scope specifier.

$pref : string

The preference name.

Return values
mixed —

remove()

Removes preferences from the backend.

public remove([mixed $scope = null ][, mixed $pref = null ]) : mixed
Parameters
$scope : mixed = null

The scope of the prefs to clear. If null, clears all scopes.

$pref : mixed = null

The pref to clear. If null, clears the entire scope.

Return values
mixed —

store()

Stores changed preferences in the storage backend.

public store(mixed $scope_ob) : mixed
Parameters
$scope_ob : mixed

The scope object.

Return values
mixed —

Search results