/
response.texy
150 lines (100 loc) · 6.15 KB
/
response.texy
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
Odpowiedź HTTP
**************
.[perex]
Nette enkapsuluje odpowiedź HTTP w obiekty o zrozumiałym API.
Odpowiedź HTTP jest obiektem [api:Nette\Http\Response], do którego możesz uzyskać dostęp, mając go przekazanego do ciebie za pomocą [wtrysku zależności |dependency-injection:passing-dependencies]. W presenterech wystarczy zadzwonić na `$httpResponse = $this->getHttpResponse()`.
→ [Instalacja i wymagania |@home#Installation]
Odpowiedź sieci .[#toc-nette-http-response]
===========================================
W przeciwieństwie do Nette: [HttpRequest |request], ten obiekt jest zmienny, więc możesz użyć seterów do zmiany stanu, tj. do wysłania nagłówków. Pamiętaj, że wszystkie setery **muszą być wywołane przed wysłaniem jakichkolwiek danych wyjściowych.** Metoda `isSent()` mówi, czy dane wyjściowe zostały wysłane. Jeśli zwraca `true`, to każda próba wysłania nagłówka rzuca wyjątek `Nette\InvalidStateException`.
setCode(int $code, string $reason=null) .[method]
-------------------------------------------------
Zmienia [kod |https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10] statusu [odpowiedzi |https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10]. Dla lepszej czytelności kodu źródłowego zalecamy używanie [predefiniowanych stałych |api:Nette\Http\IResponse] zamiast liczb.
```php
$httpResponse->setCode(Nette\Http\Response::S404_NotFound);
```
getCode(): int .[method]
------------------------
Zwraca kod statusu odpowiedzi.
isSent(): bool .[method]
------------------------
Zwraca, czy nagłówki zostały już wysłane z serwera do przeglądarki i dlatego nie można już wysyłać nagłówków ani zmieniać kodu statusu.
setHeader(string $name, string $value) .[method]
------------------------------------------------
Wysyła nagłówek HTTP i **nadpisuje** wcześniej wysłany nagłówek o tej samej nazwie.
```php
$httpResponse->setHeader('Pragma', 'no-cache');
```
addHeader(string $name, string $value) .[method]
------------------------------------------------
Wysyła nagłówek HTTP i **nie nadpisuje** wcześniej wysłanego nagłówka o tej samej nazwie.
```php
$httpResponse->addHeader('Accept', 'application/json');
$httpResponse->addHeader('Accept', 'application/xml');
```
deleteHeader(string $name) .[method]
------------------------------------
Usuwa wcześniej wysłany nagłówek HTTP.
getHeader(string $header): ?string .[method]
--------------------------------------------
Zwraca wysłany nagłówek HTTP lub `null`, jeśli nie istnieje. Wielkość liter w parametrze nie ma znaczenia.
```php
$pragma = $httpResponse->getHeader('Pragma');
```
getHeaders(): array .[method]
-----------------------------
Zwraca wszystkie wysłane nagłówki HTTP jako tablicę asocjacyjną.
```php
$headers = $httpResponse->getHeaders();
echo $headers['Pragma'];
```
setContentType(string $type, string $charset=null) .[method]
------------------------------------------------------------
Zmienia nagłówek na `Content-Type`.
```php
$httpResponse->setContentType('text/plain', 'UTF-8');
```
redirect(string $url, int $code=self::S302_Found): void .[method]
-----------------------------------------------------------------
Przekierowuje na inny adres URL. Pamiętaj, aby po zakończeniu skryptu wyjść z niego.
```php
$httpResponse->redirect('http://example.com');
exit;
```
setExpiration(?string $time) .[method]
--------------------------------------
Ustawia wygasanie dokumentu HTTP przy użyciu nagłówków `Cache-Control` i `Expires`. Parametrem jest albo przedział czasowy (jako tekst) albo `null`, który wyłącza buforowanie.
```php
// cache przeglądarki wygasa za godzinę
$httpResponse->setExpiration('1 hour');
```
sendAsFile(string $fileName) .[method]
--------------------------------------
Odpowiedź zostanie pobrana za pomocą okna dialogowego *Zapisz jako* pod określoną nazwą. Nie pobiera samego pliku.
```php
$httpResponse->sendAsFile('faktura.pdf');
```
setCookie(string $name, string $value, $time, string $path=null, string $domain=null, bool $secure=null, bool $httpOnly=null, string $sameSite=null) .[method]
--------------------------------------------------------------------------------------------------------------------------------------------------------------
Wysyła ciasteczko. Domyślne wartości parametrów:
| `$path` | `'/'` | cookie dociera do wszystkich ścieżek w (pod)domenie *(konfigurowalne)*
| `$domain` | `null` | co oznacza, że ma zasięg do bieżącej (pod)domeny, ale nie do jej poddomeny *(konfigurowalne)*.
| `$secure` | `true` | jeśli strona działa na HTTPS, w przeciwnym razie `false` *(konfigurowalne)*
| `$httpOnly` | `true` | cookie jest niedostępne dla JavaScript
| `$sameSite` | `'Lax'` | cookie może nie być wysyłane, gdy [dostęp do niego odbywa się z innej domeny |nette:glossary#SameSite-Cookie]
Możesz zmienić domyślne wartości `$path`, `$domain` i `$secure` w [konfiguracji |configuration#HTTP-Cookie].
Czas może być określony jako liczba sekund lub ciąg znaków:
```php
$httpResponse->setCookie('lang', 'cs', '100 days');
```
Parametr `$domain` określa, które domeny mogą akceptować pliki cookie. Jeśli nie zostanie określone, plik cookie jest akceptowany przez tę samą (pod)domenę, która go ustawiła, ale nie przez jej subdomeny. Jeśli określono `$domain`, uwzględniane są subdomeny. Dlatego określenie `$domain` jest mniej restrykcyjne niż pominięcie go. Na przykład, w przypadku `$domain = 'nette.org'`, pliki cookie są również dostępne na wszystkich subdomenach, takich jak `doc.nette.org`.
Dla wartości `$sameSite`, można użyć stałych `Response::SameSiteLax`, `SameSiteStrict`, oraz `SameSiteNone`.
deleteCookie(string $name, string $path=null, string $domain=null, bool $secure=null): void .[method]
-----------------------------------------------------------------------------------------------------
Usuwa plik cookie. Domyślne wartości parametrów to:
- `$path` z zasięgiem do wszystkich katalogów (`'/'`)
- `$domain` z zasięgiem do bieżącej (sub)domeny, ale nie do jej subdomen
- `$secure` jest regulowany przez ustawienia w [konfiguracji |configuration#HTTP-Cookie]
```php
$httpResponse->deleteCookie('lang');
```