SimpleSAML\Store\Redis Class Reference

Inheritance diagram for SimpleSAML\Store\Redis:

Collaboration diagram for SimpleSAML\Store\Redis:

Public Member Functions
	__construct ($redis=null)
	Initialize the Redis data store. More...
	__destruct ()
	Deconstruct the Redis data store. More...
	get ($type, $key)
	Retrieve a value from the data store. More...
	set ($type, $key, $value, $expire=null)
	Save a value in the data store. More...
	delete ($type, $key)
	Delete an entry 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...

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

Constructor & Destructor Documentation

__construct()

SimpleSAML\Store\Redis::__construct

(

$redis = null

)

Initialize the Redis data store.

Definition at line 18 of file Redis.php.

    {
        assert('is_null($redis) || is_subclass_of($redis, "Predis\\Client")');
 
        if (!class_exists('\Predis\Client')) {
            throw new \SimpleSAML\Error\CriticalConfigurationError('predis/predis is not available.');
        }
 
        if (is_null($redis)) {
            $config = Configuration::getInstance();
 
            $host = $config->getString('store.redis.host', 'localhost');
            $port = $config->getInteger('store.redis.port', 6379);
            $prefix = $config->getString('store.redis.prefix', 'SimpleSAMLphp');
 
            $redis = new \Predis\Client(
                array(
                    'scheme' => 'tcp',
                    'host' => $host,
                    'port' => $port,
                ),
                array(
                    'prefix' => $prefix,
                )
            );
        }
 
        $this->redis = $redis;
    }

References $config.

__destruct()

SimpleSAML\Store\Redis::__destruct

(

)

Deconstruct the Redis data store.

Definition at line 51 of file Redis.php.

    {
        if (method_exists($this->redis, 'disconnect')) {
            $this->redis->disconnect();
        }
    }

Member Function Documentation

delete()

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

Delete an entry from the data store.

Parameters

string	$type	The type of the data
string	$key	The key to delete.

Reimplemented from SimpleSAML\Store.

Definition at line 109 of file Redis.php.

    {
        assert('is_string($type)');
        assert('is_string($key)');
 
        $this->redis->del("{$type}.{$key}");
    }

get()

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

Retrieve a value from the data store.

Parameters

string	$type	The type of the data.
string	$key	The key to retrieve.

Returns

mixed|null The value associated with that key, or null if there's no such key.

Reimplemented from SimpleSAML\Store.

Definition at line 66 of file Redis.php.

    {
        assert('is_string($type)');
        assert('is_string($key)');
 
        $result = $this->redis->get("{$type}.{$key}");
 
        if ($result === false || $result === null) {
            return null;
        }
 
        return unserialize($result);
    }

References $result.

set()

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

Save a value in the data store.

Parameters

string	$type	The type of the data.
string	$key	The key to insert.
mixed	$value	The value itself.
int | null	$expire	The expiration time (unix timestamp), or null if it never expires.

Reimplemented from SimpleSAML\Store.

Definition at line 88 of file Redis.php.

    {
        assert('is_string($type)');
        assert('is_string($key)');
        assert('is_null($expire) || (is_int($expire) && $expire > 2592000)');
 
        $serialized = serialize($value);
 
        if (is_null($expire)) {
            $this->redis->set("{$type}.{$key}", $serialized);
        } else {
            $this->redis->setex("{$type}.{$key}", $expire, $serialized);
        }
    }

References $expire.

---

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

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