/
Message.php
209 lines (185 loc) · 3.64 KB
/
Message.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
202
203
204
205
206
207
208
209
<?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.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Client;
/**
* Base class for other HTTP requests/responses
*
* Defines some common helper methods, constants
* and properties.
*/
class Message
{
/**
* HTTP 200 code
*
* @var int
*/
const STATUS_OK = 200;
/**
* HTTP 201 code
*
* @var int
*/
const STATUS_CREATED = 201;
/**
* HTTP 202 code
*
* @var int
*/
const STATUS_ACCEPTED = 202;
/**
* HTTP 301 code
*
* @var int
*/
const STATUS_MOVED_PERMANENTLY = 301;
/**
* HTTP 302 code
*
* @var int
*/
const STATUS_FOUND = 302;
/**
* HTTP 303 code
*
* @var int
*/
const STATUS_SEE_OTHER = 303;
/**
* HTTP 307 code
*
* @var int
*/
const STATUS_TEMPORARY_REDIRECT = 307;
/**
* HTTP GET method
*
* @var string
*/
const METHOD_GET = 'GET';
/**
* HTTP POST method
*
* @var string
*/
const METHOD_POST = 'POST';
/**
* HTTP PUT method
*
* @var string
*/
const METHOD_PUT = 'PUT';
/**
* HTTP DELETE method
*
* @var string
*/
const METHOD_DELETE = 'DELETE';
/**
* HTTP PATCH method
*
* @var string
*/
const METHOD_PATCH = 'PATCH';
/**
* HTTP OPTIONS method
*
* @var string
*/
const METHOD_OPTIONS = 'OPTIONS';
/**
* HTTP TRACE method
*
* @var string
*/
const METHOD_TRACE = 'TRACE';
/**
* HTTP HEAD method
*
* @var string
*/
const METHOD_HEAD = 'HEAD';
/**
* The array of headers in the response.
*
* @var array
*/
protected $_headers = [];
/**
* The array of cookies in the response.
*
* @var array
*/
protected $_cookies = [];
/**
* HTTP Version being used.
*
* @var string
*/
protected $_version = '1.1';
/**
* Normalize header names to Camel-Case form.
*
* @param string $name The header name to normalize.
* @return string Normalized header name.
*/
protected function _normalizeHeader($name)
{
$parts = explode('-', trim($name));
$parts = array_map('strtolower', $parts);
$parts = array_map('ucfirst', $parts);
return implode('-', $parts);
}
/**
* Get all headers
*
* @return array
*/
public function headers()
{
return $this->_headers;
}
/**
* Get all cookies
*
* @return array
*/
public function cookies()
{
return $this->_cookies;
}
/**
* Get the HTTP version used.
*
* @return string
*/
public function version()
{
return $this->_version;
}
/**
* Get/set the body for the message.
*
* @param string|null $body The body for the request. Leave null for get
* @return mixed Either $this or the body value.
*/
public function body($body = null)
{
if ($body === null) {
return $this->_body;
}
$this->_body = $body;
return $this;
}
}