1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (https://nette.org)
  5:  * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
  6:  */
  7: 
  8: namespace Nette\Http;
  9: 
 10: 
 11: /**
 12:  * IHttpResponse interface.
 13:  */
 14: interface IResponse
 15: {
 16:     /** @var int cookie expiration: forever (23.1.2037) */
 17:     const PERMANENT = 2116333333;
 18: 
 19:     /** @var int cookie expiration: until the browser is closed */
 20:     const BROWSER = 0;
 21: 
 22:     /** HTTP 1.1 response code */
 23:     const
 24:         S100_CONTINUE = 100,
 25:         S101_SWITCHING_PROTOCOLS = 101,
 26:         S102_PROCESSING = 102,
 27:         S200_OK = 200,
 28:         S201_CREATED = 201,
 29:         S202_ACCEPTED = 202,
 30:         S203_NON_AUTHORITATIVE_INFORMATION = 203,
 31:         S204_NO_CONTENT = 204,
 32:         S205_RESET_CONTENT = 205,
 33:         S206_PARTIAL_CONTENT = 206,
 34:         S207_MULTI_STATUS = 207,
 35:         S208_ALREADY_REPORTED = 208,
 36:         S226_IM_USED = 226,
 37:         S300_MULTIPLE_CHOICES = 300,
 38:         S301_MOVED_PERMANENTLY = 301,
 39:         S302_FOUND = 302,
 40:         S303_SEE_OTHER = 303,
 41:         S303_POST_GET = 303,
 42:         S304_NOT_MODIFIED = 304,
 43:         S305_USE_PROXY = 305,
 44:         S307_TEMPORARY_REDIRECT = 307,
 45:         S308_PERMANENT_REDIRECT = 308,
 46:         S400_BAD_REQUEST = 400,
 47:         S401_UNAUTHORIZED = 401,
 48:         S402_PAYMENT_REQUIRED = 402,
 49:         S403_FORBIDDEN = 403,
 50:         S404_NOT_FOUND = 404,
 51:         S405_METHOD_NOT_ALLOWED = 405,
 52:         S406_NOT_ACCEPTABLE = 406,
 53:         S407_PROXY_AUTHENTICATION_REQUIRED = 407,
 54:         S408_REQUEST_TIMEOUT = 408,
 55:         S409_CONFLICT = 409,
 56:         S410_GONE = 410,
 57:         S411_LENGTH_REQUIRED = 411,
 58:         S412_PRECONDITION_FAILED = 412,
 59:         S413_REQUEST_ENTITY_TOO_LARGE = 413,
 60:         S414_REQUEST_URI_TOO_LONG = 414,
 61:         S415_UNSUPPORTED_MEDIA_TYPE = 415,
 62:         S416_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
 63:         S417_EXPECTATION_FAILED = 417,
 64:         S421_MISDIRECTED_REQUEST = 421,
 65:         S422_UNPROCESSABLE_ENTITY = 422,
 66:         S423_LOCKED = 423,
 67:         S424_FAILED_DEPENDENCY = 424,
 68:         S426_UPGRADE_REQUIRED = 426,
 69:         S428_PRECONDITION_REQUIRED = 428,
 70:         S429_TOO_MANY_REQUESTS = 429,
 71:         S431_REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
 72:         S451_UNAVAILABLE_FOR_LEGAL_REASONS = 451,
 73:         S500_INTERNAL_SERVER_ERROR = 500,
 74:         S501_NOT_IMPLEMENTED = 501,
 75:         S502_BAD_GATEWAY = 502,
 76:         S503_SERVICE_UNAVAILABLE = 503,
 77:         S504_GATEWAY_TIMEOUT = 504,
 78:         S505_HTTP_VERSION_NOT_SUPPORTED = 505,
 79:         S506_VARIANT_ALSO_NEGOTIATES = 506,
 80:         S507_INSUFFICIENT_STORAGE = 507,
 81:         S508_LOOP_DETECTED = 508,
 82:         S510_NOT_EXTENDED = 510,
 83:         S511_NETWORK_AUTHENTICATION_REQUIRED = 511;
 84: 
 85:     /**
 86:      * Sets HTTP response code.
 87:      * @param  int
 88:      * @return static
 89:      */
 90:     function setCode($code);
 91: 
 92:     /**
 93:      * Returns HTTP response code.
 94:      * @return int
 95:      */
 96:     function getCode();
 97: 
 98:     /**
 99:      * Sends a HTTP header and replaces a previous one.
100:      * @param  string  header name
101:      * @param  string  header value
102:      * @return static
103:      */
104:     function setHeader($name, $value);
105: 
106:     /**
107:      * Adds HTTP header.
108:      * @param  string  header name
109:      * @param  string  header value
110:      * @return static
111:      */
112:     function addHeader($name, $value);
113: 
114:     /**
115:      * Sends a Content-type HTTP header.
116:      * @param  string  mime-type
117:      * @param  string  charset
118:      * @return static
119:      */
120:     function setContentType($type, $charset = null);
121: 
122:     /**
123:      * Redirects to a new URL.
124:      * @param  string  URL
125:      * @param  int     HTTP code
126:      * @return void
127:      */
128:     function redirect($url, $code = self::S302_FOUND);
129: 
130:     /**
131:      * Sets the number of seconds before a page cached on a browser expires.
132:      * @param  string|int|\DateTimeInterface  time, value 0 means "until the browser is closed"
133:      * @return static
134:      */
135:     function setExpiration($seconds);
136: 
137:     /**
138:      * Checks if headers have been sent.
139:      * @return bool
140:      */
141:     function isSent();
142: 
143:     /**
144:      * Returns value of an HTTP header.
145:      * @param  string
146:      * @param  string|null
147:      * @return string|null
148:      */
149:     function getHeader($header, $default = null);
150: 
151:     /**
152:      * Returns a list of headers to sent.
153:      * @return array (name => value)
154:      */
155:     function getHeaders();
156: 
157:     /**
158:      * Sends a cookie.
159:      * @param  string name of the cookie
160:      * @param  string value
161:      * @param  string|int|\DateTimeInterface  time, value 0 means "until the browser is closed"
162:      * @param  string
163:      * @param  string
164:      * @param  bool
165:      * @param  bool
166:      * @return static
167:      */
168:     function setCookie($name, $value, $expire, $path = null, $domain = null, $secure = null, $httpOnly = null);
169: 
170:     /**
171:      * Deletes a cookie.
172:      * @param  string name of the cookie.
173:      * @param  string
174:      * @param  string
175:      * @param  bool
176:      * @return void
177:      */
178:     function deleteCookie($name, $path = null, $domain = null, $secure = null);
179: }
180: