PHP Class SimpleSAML_AuthMemCookie, simplesamlphp

It handles the configuration, and implements the logout handler.
Deprecation: This class has been deprecated and will be removed in SSP 2.0. Use the memcookie module instead.
Author: Olav Morken, UNINETT AS.
Afficher le fichier Open project: simplesamlphp/simplesamlphp Class Usage Examples

Méthodes publiques

Méthode Description
getAuthSource ( ) : string Retrieve the authentication source that should be used to authenticate the user.
getCookieName ( ) : string This function retrieves the name of the cookie from the configuration.
getGroupsAttr ( ) : string This function retrieves the name of the attribute which contains the groups from the configuration.
getInstance ( ) : SimpleSAML_AuthMemCookie This function is used to retrieve the singleton instance of this class.
getMemcache ( ) : Memcache This function creates and initializes a Memcache object from our configuration.
getUsernameAttr ( ) : string This function retrieves the name of the attribute which contains the username from the configuration.
logoutHandler ( ) This function implements the logout handler. It deletes the information from Memcache.

Private Methods

Méthode Description
__construct ( ) This function implements the constructor for this class. It loads the Auth MemCookie configuration.
doLogout ( ) This function logs the user out by deleting the session information from memcache.

Method Details

getAuthSource() public méthode

Retrieve the authentication source that should be used to authenticate the user.
public getAuthSource ( ) : string
Résultat string The login type which should be used for Auth MemCookie.

getCookieName() public méthode

This function retrieves the name of the cookie from the configuration.
public getCookieName ( ) : string
Résultat string The name of the cookie.

getGroupsAttr() public méthode

This function retrieves the name of the attribute which contains the groups from the configuration.
public getGroupsAttr ( ) : string
Résultat string The name of the attribute which contains the groups.

getInstance() public static méthode

This function is used to retrieve the singleton instance of this class.
public static getInstance ( ) : SimpleSAML_AuthMemCookie
Résultat SimpleSAML_AuthMemCookie The singleton instance of this class.

getMemcache() public méthode

This function creates and initializes a Memcache object from our configuration.
public getMemcache ( ) : Memcache
Résultat Memcache A Memcache object initialized from our configuration.

getUsernameAttr() public méthode

This function retrieves the name of the attribute which contains the username from the configuration.
public getUsernameAttr ( ) : string
Résultat string The name of the attribute which contains the username.

logoutHandler() public static méthode

This function implements the logout handler. It deletes the information from Memcache.
public static logoutHandler ( )