ResponseInterface.php
3.1 KB
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
<?php
namespace Phalcon\Http {
/**
* Phalcon\Http\ResponseInterface initializer
*/
interface ResponseInterface {
/**
* Sets the HTTP response code
*
* @param int $code
* @param string $message
* @return \Phalcon\Http\ResponseInterface
*/
public function setStatusCode($code, $message);
/**
* Returns headers set by the user
*
* @return \Phalcon\Http\Response\Headers
*/
public function getHeaders();
/**
* Overwrites a header in the response
*
* @param string $name
* @param string $value
* @return \Phalcon\Http\ResponseInterface
*/
public function setHeader($name, $value);
/**
* Send a raw header to the response
*
* @param string $header
* @return \Phalcon\Http\ResponseInterface
*/
public function setRawHeader($header);
/**
* Resets all the stablished headers
*
* @return \Phalcon\Http\ResponseInterface
*/
public function resetHeaders();
/**
* Sets output expire time header
*
* @param DateTime $datetime
* @return \Phalcon\Http\ResponseInterface
*/
public function setExpires($datetime);
/**
* Sends a Not-Modified response
*
* @return \Phalcon\Http\ResponseInterface
*/
public function setNotModified();
/**
* Sets the response content-type mime, optionally the charset
*
* @param string $contentType
* @param string $charset
* @return \Phalcon\Http\ResponseInterface
*/
public function setContentType($contentType, $charset=null);
/**
* Redirect by HTTP to another action or URL
*
* @param string $location
* @param boolean $externalRedirect
* @param int $statusCode
* @return \Phalcon\Http\ResponseInterface
*/
public function redirect($location=null, $externalRedirect=null, $statusCode=null);
/**
* Sets HTTP response body
*
* @param string $content
* @return \Phalcon\Http\ResponseInterface
*/
public function setContent($content);
/**
* Sets HTTP response body. The parameter is automatically converted to JSON
*
*<code>
* $response->setJsonContent(array("status" => "OK"));
*</code>
*
* @param string $content
* @return \Phalcon\Http\ResponseInterface
*/
public function setJsonContent($content);
/**
* Appends a string to the HTTP response body
*
* @param string $content
* @return \Phalcon\Http\ResponseInterface
*/
public function appendContent($content);
/**
* Gets the HTTP response body
*
* @return string
*/
public function getContent();
/**
* Sends headers to the client
*
* @return \Phalcon\Http\ResponseInterface
*/
public function sendHeaders();
/**
* Sends cookies to the client
*
* @return \Phalcon\Http\ResponseInterface
*/
public function sendCookies();
/**
* Prints out HTTP response to the client
*
* @return \Phalcon\Http\ResponseInterface
*/
public function send();
/**
* Sets an attached file to be sent at the end of the request
*
* @param string $filePath
* @param string $attachmentName
*/
public function setFileToSend($filePath, $attachmentName=null);
}
}