1 | <?php |
||
13 | class Session { |
||
14 | use Module, Events; |
||
15 | |||
16 | /** |
||
17 | * Start session handler |
||
18 | * |
||
19 | * @access public |
||
20 | * @static |
||
21 | * @return void |
||
22 | */ |
||
23 | static public function start($name=null){ |
||
32 | |||
33 | /** |
||
34 | * Get/Set Session's cookie params |
||
35 | * |
||
36 | * @access public |
||
37 | * @static |
||
38 | * @param array $args Array of cookie's parameters |
||
39 | * @see http://php.net/manual/en/function.session-set-cookie-params.php |
||
40 | * @example $args = [ |
||
41 | * "lifetime" => 600, |
||
42 | * "path" => "/", |
||
43 | * "domain" => ".caffeina.com", |
||
44 | * "secure" => true, |
||
45 | * "httponly" => false |
||
46 | * ]; |
||
47 | * |
||
48 | * @return array The cookie's parameters |
||
49 | * @see http://php.net/manual/en/function.session-get-cookie-params.php |
||
50 | */ |
||
51 | static public function cookieParams($args = []) { |
||
57 | |||
58 | /** |
||
59 | * Get/Set Session name |
||
60 | * |
||
61 | * @access public |
||
62 | * @static |
||
63 | * @param string $key The session name |
||
64 | * @return string The session value |
||
65 | */ |
||
66 | static public function name($name=null){ |
||
69 | |||
70 | /** |
||
71 | * Get a session variable reference |
||
72 | * |
||
73 | * @access public |
||
74 | * @static |
||
75 | * @param mixed $key The variable name |
||
76 | * @return mixed The variable value |
||
77 | */ |
||
78 | static public function get($key,$default=null){ |
||
87 | |||
88 | /** |
||
89 | * Set a session variable |
||
90 | * |
||
91 | * @access public |
||
92 | * @static |
||
93 | * @param mixed $key The variable name |
||
94 | * @param mixed $value The variable value |
||
95 | * @return void |
||
96 | */ |
||
97 | static public function set($key,$value=null){ |
||
105 | |||
106 | /** |
||
107 | * Delete a session variable |
||
108 | * |
||
109 | * @access public |
||
110 | * @static |
||
111 | * @param mixed $key The variable name |
||
112 | * @return void |
||
113 | */ |
||
114 | static public function delete($key){ |
||
118 | |||
119 | |||
120 | /** |
||
121 | * Delete all session variables |
||
122 | * |
||
123 | * @access public |
||
124 | * @static |
||
125 | * @return void |
||
126 | */ |
||
127 | static public function clear(){ |
||
133 | |||
134 | /** |
||
135 | * Check if session is active |
||
136 | * |
||
137 | * @access public |
||
138 | * @static |
||
139 | * @return void |
||
140 | */ |
||
141 | static public function active(){ |
||
144 | |||
145 | /** |
||
146 | * Check if a session variable exists |
||
147 | * |
||
148 | * @access public |
||
149 | * @static |
||
150 | * @param mixed $key The variable name |
||
151 | * @return bool |
||
152 | */ |
||
153 | static public function exists($key){ |
||
157 | |||
158 | /** |
||
159 | * Return a read-only accessor to session variables for in-view use. |
||
160 | * @return SessionReadOnly |
||
161 | */ |
||
162 | static public function readOnly(){ |
||
165 | |||
166 | } /* End of class */ |
||
167 | |||
209 |