sspmod_riak_Store_Store Class Reference

Inheritance diagram for sspmod_riak_Store_Store:

Collaboration diagram for sspmod_riak_Store_Store:

Public Member Functions
	get ($type, $key)
	Retrieve a value from the datastore. More...
	set ($type, $key, $value, $expire=null)
	Save a value to the datastore. More...
	delete ($type, $key)
	Delete a value from the datastore. More...
Public Member Functions inherited from SimpleSAML\Store
	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...

Data Fields
	$client
	$bucket

Protected Member Functions
	__construct ()

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

Detailed Description

Definition at line 25 of file Store.php.

Constructor & Destructor Documentation

__construct()

sspmod_riak_Store_Store::__construct ( )

protected

Definition at line 30 of file Store.php.

References $bucket, $config, $path, and SimpleSAML_Configuration\getConfig().

    {
                $config = SimpleSAML_Configuration::getConfig('module_riak.php');

                $path = $config->getString('path', 'riak-php-client/riak.php');
                $host = $config->getString('host', 'localhost');
                $port = $config->getString('port', 8098);
                $bucket = $config->getString('bucket', 'simpleSAMLphp');

                require_once($path);
                $this->client = new \RiakClient($host, $port);
                $this->bucket = $this->client->bucket($bucket);
        }

Here is the call graph for this function:

Member Function Documentation

delete()

sspmod_riak_Store_Store::delete	(		$type,
			$key
	)

Delete a value from the datastore.

Parameters

string	$type	The datatype.
string	$key	The key.

Definition at line 99 of file Store.php.

References $type.

    {
                assert(is_string($type));
                assert(is_string($key));

                $v = $this->bucket->getBinary("$type.$key");
                if (!$v->exists()) {
                        return;
                }

                $v->delete();
        }

get()

sspmod_riak_Store_Store::get	(		$type,
			$key
	)

Retrieve a value from the datastore.

Parameters

string	$type	The datatype.
string	$key	The key.

Returns

mixed|NULL The value.

Definition at line 51 of file Store.php.

References $key, and $type.

    {
                assert(is_string($type));
                assert(is_string($key));

                $v = $this->bucket->getBinary("$type.$key");
                if (!$v->exists()) {
                        return null;
                }

                $expires = $v->getIndex('Expires', 'int');
                if (sizeof($expires) && (int)array_shift($expires) <= time()) {
                        $v->delete();
                        return null;
                }

                return (unserialize($v->getData()));
        }

set()

sspmod_riak_Store_Store::set	(		$type,
			$key,
			$value,
			$expire = null
	)

Save a value to the datastore.

Parameters

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

Definition at line 79 of file Store.php.

References $type.

    {
                assert(is_string($type));
                assert(is_string($key));
                assert($expire === null || (is_int($expire) && $expire > 2592000));

                $v = $this->bucket->newBinary("$type.$key", serialize($value), 'application/php');
                if (!is_null($expire)) {
                        $v->addIndex("Expires", "int", $expire);
                }

                $v->store();
        }

Field Documentation

$bucket

sspmod_riak_Store_Store::$bucket

Definition at line 28 of file Store.php.

Referenced by __construct().

$client

sspmod_riak_Store_Store::$client

Definition at line 27 of file Store.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/riak/lib/Store/Store.php