/
CookieInterface.php
201 lines (177 loc) · 4.37 KB
/
CookieInterface.php
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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.5.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Cookie;
/**
* Cookie Interface
*/
interface CookieInterface
{
/**
* Expires attribute format.
*
* @var string
*/
const EXPIRES_FORMAT = 'D, d-M-Y H:i:s T';
/**
* Sets the cookie name
*
* @param string $name Name of the cookie
* @return static
*/
public function withName($name);
/**
* Gets the cookie name
*
* @return string
*/
public function getName();
/**
* Gets the cookie value
*
* @return string|array
*/
public function getValue();
/**
* Gets the cookie value as a string.
*
* This will collapse any complex data in the cookie with json_encode()
*
* @return string
*/
public function getStringValue();
/**
* Create a cookie with an updated value.
*
* @param string|array $value Value of the cookie to set
* @return static
*/
public function withValue($value);
/**
* Get the id for a cookie
*
* Cookies are unique across name, domain, path tuples.
*
* @return string
*/
public function getId();
/**
* Get the path attribute.
*
* @return string
*/
public function getPath();
/**
* Create a new cookie with an updated path
*
* @param string $path Sets the path
* @return static
*/
public function withPath($path);
/**
* Get the domain attribute.
*
* @return string
*/
public function getDomain();
/**
* Create a cookie with an updated domain
*
* @param string $domain Domain to set
* @return static
*/
public function withDomain($domain);
/**
* Get the current expiry time
*
* @return \DateTime|\DateTimeImmutable|null Timestamp of expiry or null
*/
public function getExpiry();
/**
* Get the timestamp from the expiration time
*
* Timestamps are strings as large timestamps can overflow MAX_INT
* in 32bit systems.
*
* @return string|null The expiry time as a string timestamp.
*/
public function getExpiresTimestamp();
/**
* Builds the expiration value part of the header string
*
* @return string
*/
public function getFormattedExpires();
/**
* Create a cookie with an updated expiration date
*
* @param \DateTime|\DateTimeImmutable $dateTime Date time object
* @return static
*/
public function withExpiry($dateTime);
/**
* Create a new cookie that will virtually never expire.
*
* @return static
*/
public function withNeverExpire();
/**
* Create a new cookie that will expire/delete the cookie from the browser.
*
* This is done by setting the expiration time to 1 year ago
*
* @return static
*/
public function withExpired();
/**
* Check if a cookie is expired when compared to $time
*
* Cookies without an expiration date always return false.
*
* @param \DateTime|\DateTimeImmutable $time The time to test against. Defaults to 'now' in UTC.
* @return bool
*/
public function isExpired($time = null);
/**
* Check if the cookie is HTTP only
*
* @return bool
*/
public function isHttpOnly();
/**
* Create a cookie with HTTP Only updated
*
* @param bool $httpOnly HTTP Only
* @return static
*/
public function withHttpOnly($httpOnly);
/**
* Check if the cookie is secure
*
* @return bool
*/
public function isSecure();
/**
* Create a cookie with Secure updated
*
* @param bool $secure Secure attribute value
* @return static
*/
public function withSecure($secure);
/**
* Returns the cookie as header value
*
* @return string
*/
public function toHeaderValue();
}