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.
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, the $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()
TestSecurityContainer::checkUser()

Parameters:

string   $username   the username to check
the   $password   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()
TestSecurityContainer::getRoles()

Parameters:

string   $username   username

[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:55 +0200 by phpDocumentor 1.3.0RC3