Namespaces

  • Latte
    • Loaders
    • Macros
    • Runtime
  • Nette
    • Application
      • Responses
      • Routers
      • UI
    • Bridges
      • ApplicationDI
      • ApplicationLatte
      • ApplicationTracy
      • CacheDI
      • CacheLatte
      • DatabaseDI
      • DatabaseTracy
      • DITracy
      • FormsDI
      • FormsLatte
      • Framework
      • HttpDI
      • HttpTracy
      • MailDI
      • ReflectionDI
      • SecurityDI
      • SecurityTracy
    • Caching
      • Storages
    • ComponentModel
    • Database
      • Conventions
      • Drivers
      • Reflection
      • Table
    • DI
      • Config
        • Adapters
      • Extensions
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
    • Loaders
    • Localization
    • Mail
    • Neon
    • PhpGenerator
    • Reflection
    • Security
    • Templating
    • Utils
  • NetteModule
  • none
  • Tracy
    • Bridges
      • Nette

Classes

  • Context
  • FileUpload
  • Helpers
  • Request
  • RequestFactory
  • Response
  • Session
  • SessionSection
  • Url
  • UrlScript
  • UserStorage

Interfaces

  • IRequest
  • IResponse
  • ISessionStorage
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (http://nette.org)
  5:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  6:  */
  7: 
  8: namespace Nette\Http;
  9: 
 10: use Nette;
 11: use Nette\Utils\DateTime;
 12: 
 13: 
 14: /**
 15:  * HttpResponse class.
 16:  *
 17:  * @property   int $code
 18:  * @property-read bool $sent
 19:  * @property-read array $headers
 20:  */
 21: class Response extends Nette\Object implements IResponse
 22: {
 23:     /** @var bool  Send invisible garbage for IE 6? */
 24:     private static $fixIE = TRUE;
 25: 
 26:     /** @var string The domain in which the cookie will be available */
 27:     public $cookieDomain = '';
 28: 
 29:     /** @var string The path in which the cookie will be available */
 30:     public $cookiePath = '/';
 31: 
 32:     /** @var string Whether the cookie is available only through HTTPS */
 33:     public $cookieSecure = FALSE;
 34: 
 35:     /** @var string Whether the cookie is hidden from client-side */
 36:     public $cookieHttpOnly = TRUE;
 37: 
 38:     /** @var bool Whether warn on possible problem with data in output buffer */
 39:     public $warnOnBuffer = TRUE;
 40: 
 41:     /** @var int HTTP response code */
 42:     private $code = self::S200_OK;
 43: 
 44: 
 45:     public function __construct()
 46:     {
 47:         if (PHP_VERSION_ID >= 50400) {
 48:             if (is_int($code = http_response_code())) {
 49:                 $this->code = $code;
 50:             }
 51:         }
 52: 
 53:         if (PHP_VERSION_ID >= 50401) { // PHP bug #61106
 54:             $rm = new \ReflectionMethod('Nette\Http\Helpers::removeDuplicateCookies');
 55:             header_register_callback($rm->getClosure()); // requires closure due PHP bug #66375
 56:         }
 57:     }
 58: 
 59: 
 60:     /**
 61:      * Sets HTTP response code.
 62:      * @param  int
 63:      * @return self
 64:      * @throws Nette\InvalidArgumentException  if code is invalid
 65:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
 66:      */
 67:     public function setCode($code)
 68:     {
 69:         $code = (int) $code;
 70:         if ($code < 100 || $code > 599) {
 71:             throw new Nette\InvalidArgumentException("Bad HTTP response '$code'.");
 72:         }
 73:         self::checkHeaders();
 74:         $this->code = $code;
 75:         $protocol = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
 76:         header($protocol . ' ' . $code, TRUE, $code);
 77:         return $this;
 78:     }
 79: 
 80: 
 81:     /**
 82:      * Returns HTTP response code.
 83:      * @return int
 84:      */
 85:     public function getCode()
 86:     {
 87:         return $this->code;
 88:     }
 89: 
 90: 
 91:     /**
 92:      * Sends a HTTP header and replaces a previous one.
 93:      * @param  string  header name
 94:      * @param  string  header value
 95:      * @return self
 96:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
 97:      */
 98:     public function setHeader($name, $value)
 99:     {
100:         self::checkHeaders();
101:         if ($value === NULL) {
102:             header_remove($name);
103:         } elseif (strcasecmp($name, 'Content-Length') === 0 && ini_get('zlib.output_compression')) {
104:             // ignore, PHP bug #44164
105:         } else {
106:             header($name . ': ' . $value, TRUE, $this->code);
107:         }
108:         return $this;
109:     }
110: 
111: 
112:     /**
113:      * Adds HTTP header.
114:      * @param  string  header name
115:      * @param  string  header value
116:      * @return self
117:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
118:      */
119:     public function addHeader($name, $value)
120:     {
121:         self::checkHeaders();
122:         header($name . ': ' . $value, FALSE, $this->code);
123:         return $this;
124:     }
125: 
126: 
127:     /**
128:      * Sends a Content-type HTTP header.
129:      * @param  string  mime-type
130:      * @param  string  charset
131:      * @return self
132:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
133:      */
134:     public function setContentType($type, $charset = NULL)
135:     {
136:         $this->setHeader('Content-Type', $type . ($charset ? '; charset=' . $charset : ''));
137:         return $this;
138:     }
139: 
140: 
141:     /**
142:      * Redirects to a new URL. Note: call exit() after it.
143:      * @param  string  URL
144:      * @param  int     HTTP code
145:      * @return void
146:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
147:      */
148:     public function redirect($url, $code = self::S302_FOUND)
149:     {
150:         $this->setCode($code);
151:         $this->setHeader('Location', $url);
152:         if (preg_match('#^https?:|^\s*+[a-z0-9+.-]*+[^:]#i', $url)) {
153:             $escapedUrl = htmlSpecialChars($url, ENT_IGNORE | ENT_QUOTES, 'UTF-8');
154:             echo "<h1>Redirect</h1>\n\n<p><a href=\"$escapedUrl\">Please click here to continue</a>.</p>";
155:         }
156:     }
157: 
158: 
159:     /**
160:      * Sets the number of seconds before a page cached on a browser expires.
161:      * @param  string|int|\DateTime  time, value 0 means "until the browser is closed"
162:      * @return self
163:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
164:      */
165:     public function setExpiration($time)
166:     {
167:         if (!$time) { // no cache
168:             $this->setHeader('Cache-Control', 's-maxage=0, max-age=0, must-revalidate');
169:             $this->setHeader('Expires', 'Mon, 23 Jan 1978 10:00:00 GMT');
170:             return $this;
171:         }
172: 
173:         $time = DateTime::from($time);
174:         $this->setHeader('Cache-Control', 'max-age=' . ($time->format('U') - time()));
175:         $this->setHeader('Expires', Helpers::formatDate($time));
176:         return $this;
177:     }
178: 
179: 
180:     /**
181:      * Checks if headers have been sent.
182:      * @return bool
183:      */
184:     public function isSent()
185:     {
186:         return headers_sent();
187:     }
188: 
189: 
190:     /**
191:      * Returns value of an HTTP header.
192:      * @param  string
193:      * @param  mixed
194:      * @return mixed
195:      */
196:     public function getHeader($header, $default = NULL)
197:     {
198:         $header .= ':';
199:         $len = strlen($header);
200:         foreach (headers_list() as $item) {
201:             if (strncasecmp($item, $header, $len) === 0) {
202:                 return ltrim(substr($item, $len));
203:             }
204:         }
205:         return $default;
206:     }
207: 
208: 
209:     /**
210:      * Returns a list of headers to sent.
211:      * @return array (name => value)
212:      */
213:     public function getHeaders()
214:     {
215:         $headers = array();
216:         foreach (headers_list() as $header) {
217:             $a = strpos($header, ':');
218:             $headers[substr($header, 0, $a)] = (string) substr($header, $a + 2);
219:         }
220:         return $headers;
221:     }
222: 
223: 
224:     /**
225:      * @deprecated
226:      */
227:     public static function date($time = NULL)
228:     {
229:         return Helpers::formatDate($time);
230:     }
231: 
232: 
233:     /**
234:      * @return void
235:      */
236:     public function __destruct()
237:     {
238:         if (self::$fixIE && isset($_SERVER['HTTP_USER_AGENT']) && strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE ') !== FALSE
239:             && in_array($this->code, array(400, 403, 404, 405, 406, 408, 409, 410, 500, 501, 505), TRUE)
240:             && preg_match('#^text/html(?:;|$)#', $this->getHeader('Content-Type', 'text/html'))
241:         ) {
242:             echo Nette\Utils\Random::generate(2e3, " \t\r\n"); // sends invisible garbage for IE
243:             self::$fixIE = FALSE;
244:         }
245:     }
246: 
247: 
248:     /**
249:      * Sends a cookie.
250:      * @param  string name of the cookie
251:      * @param  string value
252:      * @param  string|int|\DateTime  expiration time, value 0 means "until the browser is closed"
253:      * @param  string
254:      * @param  string
255:      * @param  bool
256:      * @param  bool
257:      * @return self
258:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
259:      */
260:     public function setCookie($name, $value, $time, $path = NULL, $domain = NULL, $secure = NULL, $httpOnly = NULL)
261:     {
262:         self::checkHeaders();
263:         setcookie(
264:             $name,
265:             $value,
266:             $time ? DateTime::from($time)->format('U') : 0,
267:             $path === NULL ? $this->cookiePath : (string) $path,
268:             $domain === NULL ? $this->cookieDomain : (string) $domain,
269:             $secure === NULL ? $this->cookieSecure : (bool) $secure,
270:             $httpOnly === NULL ? $this->cookieHttpOnly : (bool) $httpOnly
271:         );
272:         Helpers::removeDuplicateCookies();
273:         return $this;
274:     }
275: 
276: 
277:     /**
278:      * Deletes a cookie.
279:      * @param  string name of the cookie.
280:      * @param  string
281:      * @param  string
282:      * @param  bool
283:      * @return void
284:      * @throws Nette\InvalidStateException  if HTTP headers have been sent
285:      */
286:     public function deleteCookie($name, $path = NULL, $domain = NULL, $secure = NULL)
287:     {
288:         $this->setCookie($name, FALSE, 0, $path, $domain, $secure);
289:     }
290: 
291: 
292:     /** @internal @deprecated */
293:     public function removeDuplicateCookies()
294:     {
295:         trigger_error('Use Nette\Http\Helpers::removeDuplicateCookies()', E_USER_WARNING);
296:     }
297: 
298: 
299:     private function checkHeaders()
300:     {
301:         if (headers_sent($file, $line)) {
302:             throw new Nette\InvalidStateException('Cannot send header after HTTP headers have been sent' . ($file ? " (output started at $file:$line)." : '.'));
303: 
304:         } elseif ($this->warnOnBuffer && ob_get_length() && !array_filter(ob_get_status(TRUE), function ($i) { return !$i['chunk_size']; })) {
305:             trigger_error('Possible problem: you are sending a HTTP header while already having some data in output buffer. Try Tracy\OutputDebugger or start session earlier.', E_USER_NOTICE);
306:         }
307:     }
308: 
309: }
310: 
Nette 2.3.8 API API documentation generated by ApiGen 2.8.0