SimpleSAML\Store Class Reference

Inheritance diagram for SimpleSAML\Store:

Collaboration diagram for SimpleSAML\Store:

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

Static Public Member Functions
static	getInstance ()
	Retrieve our singleton instance. More...

Static Private Attributes
static	$instance

Detailed Description

Definition at line 12 of file Store.php.

Member Function Documentation

delete()

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

abstract

Delete a value from the data store.

Parameters

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

Reimplemented in SimpleSAML\Store\Memcache, SimpleSAML\Store\Redis, SimpleSAML\Store\SQL, and sspmod_riak_Store_Store.

get()

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

abstract

Retrieve a value from the data store.

Parameters

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

Returns

mixed|null The value.

Reimplemented in SimpleSAML\Store\Memcache, SimpleSAML\Store\Redis, SimpleSAML\Store\SQL, and sspmod_riak_Store_Store.

getInstance()

static SimpleSAML\Store::getInstance ( )

static

Retrieve our singleton instance.

Returns

false|\SimpleSAML\Store The data store, or false if it isn't enabled.

Exceptions

SimpleSAML\Error\CriticalConfigurationError

Definition at line 31 of file Store.php.

    {
        if (self::$instance !== null) {
            return self::$instance;
        }
 
        $config = \SimpleSAML_Configuration::getInstance();
        $storeType = $config->getString('store.type', null);
        if ($storeType === null) {
            $storeType = $config->getString('session.handler', 'phpsession');
        }
 
        switch ($storeType) {
            case 'phpsession':
                // we cannot support advanced features with the PHP session store
                self::$instance = false;
                break;
            case 'memcache':
                self::$instance = new Store\Memcache();
                break;
            case 'sql':
                self::$instance = new Store\SQL();
                break;
            case 'redis':
                self::$instance = new Store\Redis();
                break;
            default:
                // datastore from module
                try {
                    $className = Module::resolveClass($storeType, 'Store', '\SimpleSAML\Store');
                } catch (\Exception $e) {
                    $c = $config->toArray();
                    $c['store.type'] = 'phpsession';
                    throw new CriticalConfigurationError(
                        "Invalid 'store.type' configuration option. Cannot find store '$storeType'.",
                        null,
                        $c
                    );
                }
                self::$instance = new $className();
        }
 
        return self::$instance;
    }

References $config, and SimpleSAML_Configuration\getInstance().

Referenced by sspmod_saml_SP_LogoutStore\addSession(), and sspmod_saml_IdP_SQLNameID\getStore().

Here is the call graph for this function:

Here is the caller graph for this function:

set()

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

abstract

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 in SimpleSAML\Store\Memcache, SimpleSAML\Store\Redis, SimpleSAML\Store\SQL, and sspmod_riak_Store_Store.

Field Documentation

$instance

SimpleSAML\Store::$instance

staticprivate

Definition at line 21 of file Store.php.

---

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

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