Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: LdapSecurityContainer

Source Location: /plugins/auth/client/ClientAuth.php

Class Overview

SecurityContainer
   |
   --LdapSecurityContainer

Security container which reads the usernames, passwords and roles from ldap storage.


Variables

Methods


Inherited Methods

Class: SecurityContainer

SecurityContainer::checkUser()
Check if a username, password pair is valid. It must return false if the user is unknown or its password is invalid.
SecurityContainer::getRoles()
Returns the list of rules belonging to a user.

Class Details

[line 171]
Security container which reads the usernames, passwords and roles from ldap storage.



[ Top ]


Class Variables

$config =

[line 181]



Tags:

access:  protected

Type:   ClientPluginConfig


[ Top ]

$ldap =

[line 176]



Tags:

var:  link identifier
access:  protected

Type:   LDAP


[ Top ]



Class Methods


constructor __construct [line 189]

LdapSecurityContainer __construct( ClientPluginConfig $config)

Constructor



Tags:

access:  public


Parameters:

ClientPluginConfig   $config   the plugin configuration to use for fetching users and roles.

[ Top ]

method checkUser [line 245]

void checkUser( mixed $username, mixed $password)



Tags:

access:  public
see:  SecurityContainer::checkUser()


Overrides SecurityContainer::checkUser() (Check if a username, password pair is valid. It must return false if the user is unknown or its password is invalid.)

[ Top ]

method getLdap [line 232]

Object getLdap( )

Returns the LDAP link identifier



Tags:

return:  LDAP link identifier
access:  protected


[ Top ]

method getRoles [line 283]

void getRoles( mixed $username)



Tags:

access:  public
see:  SecurityContainer::getRoles()


Overrides SecurityContainer::getRoles() (Returns the list of rules belonging to a user.)

[ Top ]

method parseConfig [line 220]

void parseConfig( stdclass $object)

Parses config parameters



Tags:

access:  private


Parameters:

stdclass   $object   configstruct object

[ Top ]

method scope2function [line 329]

string scope2function( string $scope)

Returns search function for scope



Tags:

return:  ldap search function
access:  private


Parameters:

string   $scope   scope

[ Top ]

method setDefaults [line 203]

void setDefaults( )

Sets some default options



Tags:

access:  private


[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:11 +0200 by phpDocumentor 1.3.0RC3