summaryrefslogtreecommitdiffstats
path: root/lib/SimpleSAML/Store/Memcache.php
blob: ea5187ad130d2852bccfa45a9072c9042470d028 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?php

/**
 * A memcache based datastore.
 *
 * @package SimpleSAMLphp
 */
class SimpleSAML_Store_Memcache extends SimpleSAML_Store
{
    /**
     * Initialize the memcache datastore.
     */

    /**
     * This variable contains the session name prefix.
     *
     * @var string
     */
    private $prefix;

    /**
     * This function implements the constructor for this class. It loads the Memcache configuration.
     */
    protected function __construct() {
        $config = SimpleSAML_Configuration::getInstance();
        $this->prefix = $config->getString('memcache_store.prefix', 'simpleSAMLphp');
    }


    /**
     * Retrieve a value from the datastore.
     *
     * @param string $type  The datatype.
     * @param string $key  The key.
     * @return mixed|NULL  The value.
     */
    public function get($type, $key)
    {
        assert('is_string($type)');
        assert('is_string($key)');

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


    /**
     * Save a value to the datastore.
     *
     * @param string $type  The datatype.
     * @param string $key  The key.
     * @param mixed $value  The value.
     * @param int|NULL $expire  The expiration time (unix timestamp), or NULL if it never expires.
     */
    public function set($type, $key, $value, $expire = null)
    {
        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);
    }


    /**
     * Delete a value from the datastore.
     *
     * @param string $type  The datatype.
     * @param string $key  The key.
     */
    public function delete($type, $key)
    {
        assert('is_string($type)');
        assert('is_string($key)');

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