Overview

Packages

  • Prefs

Classes

  • Horde_Prefs
  • Horde_Prefs_Cache_Base
  • Horde_Prefs_Cache_Null
  • Horde_Prefs_Cache_Session
  • Horde_Prefs_CategoryManager
  • Horde_Prefs_Exception
  • Horde_Prefs_Identity
  • Horde_Prefs_Scope
  • Horde_Prefs_Storage_Base
  • Horde_Prefs_Storage_File
  • Horde_Prefs_Storage_Imsp
  • Horde_Prefs_Storage_KolabImap
  • Horde_Prefs_Storage_Ldap
  • Horde_Prefs_Storage_Null
  • Horde_Prefs_Storage_Sql
  • Horde_Prefs_Translation
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Prefs_Storage_Ldap

Preferences storage implementation for LDAP servers.

Copyright 1999-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Prefs_Storage_Base
Extended by Horde_Prefs_Storage_Ldap
Package: Prefs
Category: Horde
Author: Jon Parise jon@horde.org
Author: Ben Klang ben@alkaloid.net
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Prefs/Storage/Ldap.php
Methods summary
public
# __construct( string $user, array $params = array() )

Constructor.

Constructor.

Parameters

$user
The username.
$params
Configuration options: <pre>basedn - (string) [REQUIRED] The base DN <span class="php-keyword1">for</span> the LDAP server. hostspec - (string) [REQUIRED] The hostname of the LDAP server. uid - (string) [REQUIRED] The username search <span class="php-keyword2">key</span>. writeas - (string) [REQUIRED] One of <span class="php-quote">&quot;user&quot;</span>, <span class="php-quote">&quot;admin&quot;</span>, <span class="php-keyword1">or</span> <span class="php-quote">&quot;search&quot;</span> Optional parameters: binddn - (string) The DN of the administrative account to bind <span class="php-keyword1">for</span> write operations. bindpw - (string) binddn<span class="php-quote">'s password for bind authentication. port - (integer) The port of the LDAP server. DEFAULT: 389 searchdn - (string) The DN of a user with search permissions on the directory. searchpw - (string) searchdn'</span>s password <span class="php-keyword1">for</span> binding. tls - (boolean) Whether to <span class="php-keyword1">use</span> TLS connections. <span class="php-keyword1">DEFAULT</span>: <span class="php-keyword1">false</span> version - (integer) The version of the LDAP protocol to <span class="php-keyword1">use</span>. <span class="php-keyword1">DEFAULT</span>: NONE (<span class="php-keyword2">system</span> <span class="php-keyword1">default</span> will be used)</pre>

Overrides

Horde_Prefs_Storage_Base::__construct()
public Horde_Prefs_Scope
# get( Horde_Prefs_Scope $scope_ob )

Parameters

$scope_ob
The scope object.

Returns

Horde_Prefs_Scope
The modified scope object.

Throws

Horde_Prefs_Exception
public
# store( Horde_Prefs_Scope $scope_ob )

Parameters

$scope_ob
The scope object.

Throws

Horde_Prefs_Exception
public
# remove( string $scope = null, string $pref = null )

Parameters

$scope
<p>The scope of the prefs to clear. If null, clears all scopes.</p>
$pref
<p>The pref to clear. If null, clears the entire scope.</p>

Throws

Horde_Prefs_Exception
public integer
# rebindProc( mixed $conn, mixed $who )

Callback function for LDAP referrals. This function is called when an LDAP operation returns a referral to an alternate server.

Callback function for LDAP referrals. This function is called when an LDAP operation returns a referral to an alternate server.

Returns

integer
1 on error, 0 on success.
Methods inherited from Horde_Prefs_Storage_Base
getParams(), listScopes(), onChange()
API documentation generated by ApiGen