summaryrefslogtreecommitdiff
path: root/app/Core/Session/SessionStorage.php
blob: 667d9253d9c5244407545b0b3793617b56160958 (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
82
83
84
85
86
87
88
89
<?php

namespace Kanboard\Core\Session;

/**
 * Session Storage
 *
 * @package  session
 * @author   Frederic Guillot
 *
 * @property array  $user
 * @property array  $flash
 * @property array  $csrf
 * @property array  $postAuthenticationValidated
 * @property array  $filters
 * @property string $redirectAfterLogin
 * @property string $captcha
 * @property string $commentSorting
 * @property bool   $hasSubtaskInProgress
 * @property bool   $hasRememberMe
 * @property bool   $boardCollapsed
 * @property bool   $twoFactorBeforeCodeCalled
 * @property string $twoFactorSecret
 */
class SessionStorage
{
    /**
     * Pointer to external storage
     *
     * @access private
     * @var array
     */
    private $storage = array();

    /**
     * Set external storage
     *
     * @access public
     * @param  array  $storage  External session storage (example: $_SESSION)
     */
    public function setStorage(array &$storage)
    {
        $this->storage =& $storage;

        // Load dynamically existing session variables into object properties
        foreach ($storage as $key => $value) {
            $this->$key = $value;
        }
    }

    /**
     * Get all session variables
     *
     * @access public
     * @return array
     */
    public function getAll()
    {
        $session = get_object_vars($this);
        unset($session['storage']);

        return $session;
    }

    /**
     * Flush session data
     *
     * @access public
     */
    public function flush()
    {
        $session = get_object_vars($this);
        unset($session['storage']);

        foreach (array_keys($session) as $property) {
            unset($this->$property);
        }
    }

    /**
     * Copy class properties to external storage
     *
     * @access public
     */
    public function __destruct()
    {
        $this->storage = $this->getAll();
    }
}