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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
<?php
/**
* Klein (klein.php) - A fast & flexible router for PHP
*
* @author Chris O'Hara <cohara87@gmail.com>
* @author Trevor Suarez (Rican7) (contributor and v2 refactorer)
* @copyright (c) Chris O'Hara
* @link https://github.com/klein/klein.php
* @license MIT
*/
namespace Klein;
/**
* ResponseCookie
*
* Class to represent an HTTP response cookie
*/
class ResponseCookie
{
/**
* Class properties
*/
/**
* The name of the cookie
*
* @type string
*/
protected $name;
/**
* The string "value" of the cookie
*
* @type string
*/
protected $value;
/**
* The date/time that the cookie should expire
*
* Represented by a Unix "Timestamp"
*
* @type int
*/
protected $expire;
/**
* The path on the server that the cookie will
* be available on
*
* @type string
*/
protected $path;
/**
* The domain that the cookie is available to
*
* @type string
*/
protected $domain;
/**
* Whether the cookie should only be transferred
* over an HTTPS connection or not
*
* @type boolean
*/
protected $secure;
/**
* Whether the cookie will be available through HTTP
* only (not available to be accessed through
* client-side scripting languages like JavaScript)
*
* @type boolean
*/
protected $http_only;
/**
* Methods
*/
/**
* Constructor
*
* @param string $name The name of the cookie
* @param string $value The value to set the cookie with
* @param int $expire The time that the cookie should expire
* @param string $path The path of which to restrict the cookie
* @param string $domain The domain of which to restrict the cookie
* @param boolean $secure Flag of whether the cookie should only be sent over a HTTPS connection
* @param boolean $http_only Flag of whether the cookie should only be accessible over the HTTP protocol
*/
public function __construct(
$name,
$value = null,
$expire = null,
$path = null,
$domain = null,
$secure = false,
$http_only = false
) {
// Initialize our properties
$this->setName($name);
$this->setValue($value);
$this->setExpire($expire);
$this->setPath($path);
$this->setDomain($domain);
$this->setSecure($secure);
$this->setHttpOnly($http_only);
}
/**
* Gets the cookie's name
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Sets the cookie's name
*
* @param string $name
* @return ResponseCookie
*/
public function setName($name)
{
$this->name = (string) $name;
return $this;
}
/**
* Gets the cookie's value
*
* @return string
*/
public function getValue()
{
return $this->value;
}
/**
* Sets the cookie's value
*
* @param string $value
* @return ResponseCookie
*/
public function setValue($value)
{
if (null !== $value) {
$this->value = (string) $value;
} else {
$this->value = $value;
}
return $this;
}
/**
* Gets the cookie's expire time
*
* @return int
*/
public function getExpire()
{
return $this->expire;
}
/**
* Sets the cookie's expire time
*
* The time should be an integer
* representing a Unix timestamp
*
* @param int $expire
* @return ResponseCookie
*/
public function setExpire($expire)
{
if (null !== $expire) {
$this->expire = (int) $expire;
} else {
$this->expire = $expire;
}
return $this;
}
/**
* Gets the cookie's path
*
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Sets the cookie's path
*
* @param string $path
* @return ResponseCookie
*/
public function setPath($path)
{
if (null !== $path) {
$this->path = (string) $path;
} else {
$this->path = $path;
}
return $this;
}
/**
* Gets the cookie's domain
*
* @return string
*/
public function getDomain()
{
return $this->domain;
}
/**
* Sets the cookie's domain
*
* @param string $domain
* @return ResponseCookie
*/
public function setDomain($domain)
{
if (null !== $domain) {
$this->domain = (string) $domain;
} else {
$this->domain = $domain;
}
return $this;
}
/**
* Gets the cookie's secure only flag
*
* @return boolean
*/
public function getSecure()
{
return $this->secure;
}
/**
* Sets the cookie's secure only flag
*
* @param boolean $secure
* @return ResponseCookie
*/
public function setSecure($secure)
{
$this->secure = (boolean) $secure;
return $this;
}
/**
* Gets the cookie's HTTP only flag
*
* @return boolean
*/
public function getHttpOnly()
{
return $this->http_only;
}
/**
* Sets the cookie's HTTP only flag
*
* @param boolean $http_only
* @return ResponseCookie
*/
public function setHttpOnly($http_only)
{
$this->http_only = (boolean) $http_only;
return $this;
}
}
|