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.

Public Methods

Method	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.

Method	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.

Retrieve the authentication source that should be used to authenticate the user.

public getAuthSource ( ) : string
return	string	The login type which should be used for Auth MemCookie.

This function retrieves the name of the cookie from the configuration.

public getCookieName ( ) : string
return	string	The name of the cookie.

This function retrieves the name of the attribute which contains the groups from the configuration.

public getGroupsAttr ( ) : string
return	string	The name of the attribute which contains the groups.

This function is used to retrieve the singleton instance of this class.

public static getInstance ( ) : SimpleSAML_AuthMemCookie
return	SimpleSAML_AuthMemCookie	The singleton instance of this class.

This function creates and initializes a Memcache object from our configuration.

public getMemcache ( ) : Memcache
return	Memcache	A Memcache object initialized from our configuration.

This function retrieves the name of the attribute which contains the username from the configuration.

public getUsernameAttr ( ) : string
return	string	The name of the attribute which contains the username.

This function implements the logout handler. It deletes the information from Memcache.

public static logoutHandler ( )