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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?php
/**
*
* This file is part of Aura for PHP.
*
* @license http://opensource.org/licenses/bsd-license.php BSD
*
*/
namespace Aura\Session;
/**
*
* An interface for session segment objects.
*
* @package Aura.Session
*
*/
interface SegmentInterface
{
/**
*
* Returns the value of a key in the segment.
*
* @param string $key The key in the segment.
*
* @param mixed $alt An alternative value to return if the key is not set.
*
* @return mixed
*
*/
public function get($key, $alt = null);
/**
*
* Sets the value of a key in the segment.
*
* @param string $key The key to set.
*
* @param mixed $val The value to set it to.
*
*/
public function set($key, $val);
/**
*
* Clear all data from the segment.
*
* @return null
*
*/
public function clear();
/**
*
* Sets a flash value for the *next* request.
*
* @param string $key The key for the flash value.
*
* @param mixed $val The flash value itself.
*
*/
public function setFlash($key, $val);
/**
*
* Gets the flash value for a key in the *current* request.
*
* @param string $key The key for the flash value.
*
* @param mixed $alt An alternative value to return if the key is not set.
*
* @return mixed The flash value itself.
*
*/
public function getFlash($key, $alt = null);
/**
*
* Clears flash values for *only* the next request.
*
* @return null
*
*/
public function clearFlash();
/**
*
* Gets the flash value for a key in the *next* request.
*
* @param string $key The key for the flash value.
*
* @param mixed $alt An alternative value to return if the key is not set.
*
* @return mixed The flash value itself.
*
*/
public function getFlashNext($key, $alt = null);
/**
*
* Sets a flash value for the *next* request *and* the current one.
*
* @param string $key The key for the flash value.
*
* @param mixed $val The flash value itself.
*
*/
public function setFlashNow($key, $val);
/**
*
* Clears flash values for *both* the next request *and* the current one.
*
* @return null
*
*/
public function clearFlashNow();
/**
*
* Retains all the current flash values for the next request; values that
* already exist for the next request take precedence.
*
* @return null
*
*/
public function keepFlash();
}
|