SimpleSAML_AuthMemCookie Class Reference

Collaboration diagram for SimpleSAML_AuthMemCookie:

Public Member Functions
	getAuthSource ()
	Retrieve the authentication source that should be used to authenticate the user. More...
	getCookieName ()
	This function retrieves the name of the cookie from the configuration. More...
	getUsernameAttr ()
	This function retrieves the name of the attribute which contains the username from the configuration. More...
	getGroupsAttr ()
	This function retrieves the name of the attribute which contains the groups from the configuration. More...
	getMemcache ()
	This function creates and initializes a Memcache object from our configuration. More...

Static Public Member Functions
static	getInstance ()
	This function is used to retrieve the singleton instance of this class. More...
static	logoutHandler ()
	This function implements the logout handler. More...

Private Member Functions
	__construct ()
	This function implements the constructor for this class. More...
	doLogout ()
	This function logs the user out by deleting the session information from memcache. More...

Private Attributes
	$amcConfig

Static Private Attributes
static	$instance = null

Detailed Description

Definition at line 13 of file AuthMemCookie.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_AuthMemCookie::__construct ( )

private

This function implements the constructor for this class.

It loads the Auth MemCookie configuration.

Definition at line 46 of file AuthMemCookie.php.

References SimpleSAML_Configuration\getConfig().

    {
        // load AuthMemCookie configuration
        $this->amcConfig = SimpleSAML_Configuration::getConfig('authmemcookie.php');
    }

Here is the call graph for this function:

Member Function Documentation

doLogout()

SimpleSAML_AuthMemCookie::doLogout ( )

private

This function logs the user out by deleting the session information from memcache.

Definition at line 139 of file AuthMemCookie.php.

References $_COOKIE, $cookieName, $memcache, $sessionID, getCookieName(), getMemcache(), and SimpleSAML\Utils\HTTP\setCookie().

    {
        $cookieName = $this->getCookieName();

        // check if we have a valid cookie
        if (!array_key_exists($cookieName, $_COOKIE)) {
            return;
        }

        $sessionID = $_COOKIE[$cookieName];

        // delete the session from memcache
        $memcache = $this->getMemcache();
        $memcache->delete($sessionID);

        // delete the session cookie
        \SimpleSAML\Utils\HTTP::setCookie($cookieName, null);
    }

Here is the call graph for this function:

getAuthSource()

SimpleSAML_AuthMemCookie::getAuthSource

(

)

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

Returns

string The login type which should be used for Auth MemCookie.

Definition at line 58 of file AuthMemCookie.php.

    {
        return $this->amcConfig->getString('authsource');
    }

getCookieName()

SimpleSAML_AuthMemCookie::getCookieName

(

)

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

Returns

string The name of the cookie.

Exceptions

Exception

If the value of the 'cookiename' configuration option is invalid.

Definition at line 70 of file AuthMemCookie.php.

References $cookieName.

Referenced by doLogout().

    {
        $cookieName = $this->amcConfig->getString('cookiename', 'AuthMemCookie');
        if (!is_string($cookieName) || strlen($cookieName) === 0) {
            throw new Exception(
                "Configuration option 'cookiename' contains an invalid value. This option should be a string."
            );
        }

        return $cookieName;
    }

Here is the caller graph for this function:

getGroupsAttr()

SimpleSAML_AuthMemCookie::getGroupsAttr

(

)

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

Returns

string The name of the attribute which contains the groups.

Definition at line 101 of file AuthMemCookie.php.

References $groupsAttr.

    {
        $groupsAttr = $this->amcConfig->getString('groups', null);

        return $groupsAttr;
    }

getInstance()

static SimpleSAML_AuthMemCookie::getInstance ( )

static

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

Returns

SimpleSAML_AuthMemCookie The singleton instance of this class.

Definition at line 33 of file AuthMemCookie.php.

    {
        if (self::$instance === null) {
            self::$instance = new SimpleSAML_AuthMemCookie();
        }

        return self::$instance;
    }

getMemcache()

SimpleSAML_AuthMemCookie::getMemcache

(

)

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

Returns

Memcache A Memcache object initialized from our configuration.

Exceptions

Exception

If the servers configuration is invalid.

Definition at line 115 of file AuthMemCookie.php.

References $memcache.

Referenced by doLogout().

    {
        $memcacheHost = $this->amcConfig->getString('memcache.host', '127.0.0.1');
        $memcachePort = $this->amcConfig->getInteger('memcache.port', 11211);

        $class = class_exists('Memcache') ? 'Memcache' : (class_exists('Memcached') ? 'Memcached' : FALSE);
        if (!$class) {
            throw new Exception('Missing Memcached implementation. You must install either the Memcache or Memcached extension.');
        }

        // Create the Memcache(d) object.
        $memcache = new $class();

        foreach (explode(',', $memcacheHost) as $memcacheHost) {
            $memcache->addServer($memcacheHost, $memcachePort);
        }

        return $memcache;
    }

Here is the caller graph for this function:

getUsernameAttr()

SimpleSAML_AuthMemCookie::getUsernameAttr

(

)

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

Returns

string The name of the attribute which contains the username.

Definition at line 88 of file AuthMemCookie.php.

References $usernameAttr.

    {
        $usernameAttr = $this->amcConfig->getString('username', null);

        return $usernameAttr;
    }

logoutHandler()

static SimpleSAML_AuthMemCookie::logoutHandler ( )

static

This function implements the logout handler.

It deletes the information from Memcache.

Definition at line 162 of file AuthMemCookie.php.

    {
        self::getInstance()->doLogout();
    }

Field Documentation

$amcConfig

SimpleSAML_AuthMemCookie::$amcConfig

private

Definition at line 25 of file AuthMemCookie.php.

$instance

SimpleSAML_AuthMemCookie::$instance = null

staticprivate

Definition at line 19 of file AuthMemCookie.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/AuthMemCookie.php