SimpleSAML\Store\Memcache Class Reference

Inheritance diagram for SimpleSAML\Store\Memcache:

Collaboration diagram for SimpleSAML\Store\Memcache:

Public Member Functions
	get ($type, $key)
	Retrieve a value from the data store. More...
	set ($type, $key, $value, $expire=null)
	Save a value to the data store. More...
	delete ($type, $key)
	Delete a value from the data store. More...
	get ($type, $key)
	Retrieve a value from the data store. More...
	set ($type, $key, $value, $expire=null)
	Save a value to the data store. More...
	delete ($type, $key)
	Delete a value from the data store. More...

Protected Member Functions
	__construct ()
	This function implements the constructor for this class. More...

Private Attributes
	$prefix

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML\Store
static	getInstance ()
	Retrieve our singleton instance. More...

Detailed Description

Definition at line 13 of file Memcache.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Store\Memcache::__construct ( )

protected

This function implements the constructor for this class.

It loads the Memcache configuration.

Definition at line 26 of file Memcache.php.

    {
        $config = Configuration::getInstance();
        $this->prefix = $config->getString('memcache_store.prefix', 'simpleSAMLphp');
    }

References $config.

Member Function Documentation

delete()

SimpleSAML\Store\Memcache::delete	(		$type,
			$key
	)

Delete a value from the data store.

Parameters

string	$type	The data type.
string	$key	The key.

Reimplemented from SimpleSAML\Store.

Definition at line 77 of file Memcache.php.

    {
        assert('is_string($type)');
        assert('is_string($key)');
 
        \SimpleSAML_Memcache::delete($this->prefix . '.' . $type . '.' . $key);
    }

References $key, $type, and SimpleSAML_Memcache\delete().

Here is the call graph for this function:

get()

SimpleSAML\Store\Memcache::get	(		$type,
			$key
	)

Retrieve a value from the data store.

Parameters

string	$type	The data type.
string	$key	The key.

Returns

mixed|null The value.

Reimplemented from SimpleSAML\Store.

Definition at line 40 of file Memcache.php.

    {
        assert('is_string($type)');
        assert('is_string($key)');
 
        return \SimpleSAML_Memcache::get($this->prefix . '.' . $type . '.' . $key);
    }

References $key, and $type.

set()

SimpleSAML\Store\Memcache::set	(		$type,
			$key,
			$value,
			$expire = null
	)

Save a value to the data store.

Parameters

string	$type	The data type.
string	$key	The key.
mixed	$value	The value.
int | NULL	$expire	The expiration time (unix timestamp), or NULL if it never expires.

Reimplemented from SimpleSAML\Store.

Definition at line 57 of file Memcache.php.

    {
        assert('is_string($type)');
        assert('is_string($key)');
        assert('is_null($expire) || (is_int($expire) && $expire > 2592000)');
 
        if ($expire === null) {
            $expire = 0;
        }
 
        \SimpleSAML_Memcache::set($this->prefix . '.' . $type . '.' . $key, $value, $expire);
    }

References $expire, $key, $type, and SimpleSAML_Memcache\set().

Here is the call graph for this function:

Field Documentation

$prefix

SimpleSAML\Store\Memcache::$prefix

private

Definition at line 20 of file Memcache.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Store/Memcache.php