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

Class: SecurityContainer

Source Location: /common/SecurityManager.php

Class Overview


Abstract class for accessing list of users, checking their passwords and


Author(s):

Methods


Child classes:

IniSecurityContainer
Security container which reads the usernames, passwords and roles out of a plugin .ini file.
DbSecurityContainer
Security container which reads the usernames, passwords and roles from database.
LdapSecurityContainer
Security container which reads the usernames, passwords and roles from ldap storage.
TestSecurityContainer
Security container with hard coded users, passwords and roles, for testing.

Class Details

[line 28]
Abstract class for accessing list of users, checking their passwords and

getting their roles




Tags:

abstract:  


[ Top ]


Class Methods


method checkUser [line 38]

boolean checkUser( string $username, string $password)

Check if a username, password pair is valid. It must return false if the user is unknown or its password is invalid.



Tags:

return:  true if the pair is valid.
abstract:  


Overridden in child classes as:

IniSecurityContainer::checkUser()
DbSecurityContainer::checkUser()
LdapSecurityContainer::checkUser()
TestSecurityContainer::checkUser()

Parameters:

string   $username   the username to check
string   $password   the user's password

[ Top ]

method getRoles [line 46]

array getRoles( string $username)

Returns the list of rules belonging to a user.



Tags:

return:  a list of roles associated to the user
abstract:  


Overridden in child classes as:

IniSecurityContainer::getRoles()
DbSecurityContainer::getRoles()
LdapSecurityContainer::getRoles()
TestSecurityContainer::getRoles()

Parameters:

string   $username   username

[ Top ]


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