HTTP Yanıtı

Nette, HTTP yanıtını anlaşılır bir API'ye sahip nesnelerin içine alır.

HTTP yanıtı Nette\Http\Response nesnesiyle temsil edilir. Nette ile çalışıyorsanız bu nesne framework tarafından otomatik oluşturulur ve bağımlılık enjeksiyonuyla size aktarılmasını sağlayabilirsiniz. Presenter'larda yalnızca $this->getHttpResponse() metodunu çağırın.

→ Kurulum ve gereksinimler

Nette\Http\Response

Nette\Http\Request nesnesinin aksine bu nesne değiştirilebilirdir, dolayısıyla durumu değiştirmek için (örneğin header göndermek için) setter'ları kullanabilirsiniz. Tüm setter'ların herhangi bir gerçek çıktı gönderilmeden önce çağrılması gerektiğini unutmayın. isSent() metodu, çıktının gönderilip gönderilmediğini gösterir. true döndürüyorsa, header gönderme girişimi Nette\InvalidStateException fırlatır.

setCode (int $code, ?string $reason=null)

Yanıt durum kodunu değiştirir. Kaynak kodun okunurluğu için, gerçek sayılar yerine önceden tanımlı sabitleri kullanmanız önerilir.

$httpResponse->setCode(Nette\Http\Response::S404_NotFound);

getCode(): int

Yanıtın durum kodunu döndürür.

isSent(): bool

Header'ların sunucudan tarayıcıya gönderilip gönderilmediğini, yani artık header göndermenin ya da durum kodunu değiştirmenin olanaklı olup olmadığını döndürür.

setHeader (string $name, ?string $value)

Bir HTTP header'ı gönderir ve aynı adla daha önce gönderilmiş header'ın üzerine yazar. $value null ise header kaldırılır.

$httpResponse->setHeader('Pragma', 'no-cache');

addHeader (string $name, string $value)

Bir HTTP header'ı gönderir ve aynı adla daha önce gönderilmiş header'ın üzerine yazmaz.

$httpResponse->addHeader('Accept', 'application/json');
$httpResponse->addHeader('Accept', 'application/xml');

deleteHeader (string $name)

Daha önce gönderilmiş bir HTTP header'ını siler.

getHeader (string $header): ?string

Gönderilen HTTP header'ını, yoksa null döndürür. Parametre büyük/küçük harfe duyarsızdır.

$pragma = $httpResponse->getHeader('Pragma');

getHeaders(): array<string, string>

Gönderilen tüm HTTP header'larını ilişkisel bir dizi olarak döndürür.

$headers = $httpResponse->getHeaders();
echo $headers['Pragma'];

setContentType (string $type, ?string $charset=null)

Content-Type header'ını değiştirir.

$httpResponse->setContentType('text/plain', 'UTF-8');

redirect (string $url, int $code=self::S302_Found): void

Başka bir URL'ye yönlendirir. Ardından betiği sonlandırmayı unutmayın.

$httpResponse->redirect('http://example.com');
exit;

setExpiration (?string $expire)

HTTP belgesinin son kullanma süresini Cache-Control ve Expires header'larıyla ayarlar. Parametre ya bir zaman aralığıdır (metin olarak) ya da önbelleklemeyi kapatan null.

// tarayıcı önbelleği bir saat içinde dolar
$httpResponse->setExpiration('1 hour');

sendAsFile (string $fileName)

Yanıt, belirtilen adla bir Farklı kaydet iletişim kutusu üzerinden indirilir. Dosyanın kendisini göndermez.

$httpResponse->sendAsFile('invoice.pdf');

setCookie (string $name, string $value, $expire, ?string $path=null, ?string $domain=null, ?bool $secure=null, ?bool $httpOnly=null, SameSite|string $sameSite='Lax', bool $partitioned=false)

Bir çerez gönderir. Varsayılan parametre değerleri:

$path, $domain ve $secure parametrelerinin varsayılan değerlerini yapılandırmada değiştirebilirsiniz.

Son kullanma; saniye sayısı olarak, metinsel bir aralık ya da tarih olarak veya bir DateTimeInterface nesnesi olarak verilir. null değeri, tarayıcının kapatıldığında attığı bir oturum çerezi oluşturur. Nette, son kullanmayı hem Expires hem de Max-Age niteliklerinde gönderir.

$httpResponse->setCookie('lang', 'en', '100 days');  // 100 gün içinde dolar
$httpResponse->setCookie('lang', 'en', null);        // oturum çerezi

$domain parametresi, çerezi hangi alan adlarının kabul edebileceğini belirler. Belirtilmezse çerez, onu ayarlayan aynı (alt) alan adı tarafından kabul edilir, ama onun alt alan adları tarafından edilmez. $domain belirtilirse alt alan adları da dahil olur. Bu yüzden $domain belirtmek, onu atlamaktan daha az kısıtlayıcıdır. Örneğin $domain = 'nette.org' ile çerezler doc.nette.org gibi tüm alt alan adlarında da kullanılabilir.

$sameSite değerini bir Nette\Http\SameSite enum'u olarak verebilirsiniz: SameSite::Lax, SameSite::Strict ya da SameSite::None ('Lax', 'Strict', 'None' dize değerleri de çalışır). Onu SameSite::None yaparsanız $secure niteliği otomatik açılır; çünkü tarayıcılar güvenli olmayan bir SameSite=None çerezini reddeder.

Bölümlenmiş çerezler (CHIPS), bir çereze her üst düzey site için kendi ayrı deposunu verir. Böylece üçüncü taraf bir servis (örneğin gömülü bir widget) bölümlenmiş bir çerez ayarladığında, tarayıcı widget'ın göründüğü her site için ayrı bir kopya tutar ve bu kopyalar siteler arası izleme için birbirine bağlanamaz. Onu $partitioned değerini true yaparak açın; bu, $secure niteliğini de gerektirir, dolayısıyla otomatik açılır.

$httpResponse->setCookie('theme', 'dark', '1 year', sameSite: SameSite::None, partitioned: true);

deleteCookie (string $name, ?string $path=null, ?string $domain=null, ?bool $secure=null): void

Bir çerezi siler. Parametrelerin varsayılan değerleri:

• tüm dizinleri kapsayan $path ('/')
• geçerli (alt) alan adını kapsayan, ama onun alt alan adlarını kapsamayan $domain
• $secure, yapılandırmadaki ayarlara bağlıdır

$httpResponse->deleteCookie('lang');

Nette\Http\Context

Nette\Http\Context nesnesi, isteği ve yanıtı bir araya getirir ve HTTP önbelleklemesine yardım eder. Servis olarak kaydedilmez, dolayısıyla onu kendiniz oluşturursunuz. Presenter'larda genellikle lastModified() metodunu kullanmak daha kolaydır; context, yanıtı örneğin kendi yanıt sınıfınızdan kendiniz gönderdiğinizde işe yarar.

isModified (string|int|\DateTimeInterface|null $lastModified=null, ?string $etag=null): bool

İçeriğin istemcinin son ziyaretinden bu yana değişip değişmediğini belirler. Son değiştirilme zamanını verirseniz Last-Modified header'ını gönderir; bir ETag doğrulayıcısı (içeriğin geçerli sürümünü tanımlayan kısa bir dize, örneğin hash'i) verirseniz ETag header'ını gönderir. Sonra ikisini de tarayıcının gönderdiği If-Modified-Since ve If-None-Match header'larıyla karşılaştırır.

Tarayıcıda zaten uyan bir sürüm varsa, metot 304 Not Modified kodunu ayarlar ve false döndürür; o durumda yanıtın gövdesini hiç göndermeyin. Aksi hâlde true döndürür.

public function send(Nette\Http\IRequest $request, Nette\Http\IResponse $response): void
{
	$context = new Nette\Http\Context($request, $response);
	if ($context->isModified(filemtime($this->file), md5_file($this->file))) {
		readfile($this->file);
	}
}

Her iki parametre de isteğe bağlıdır. İçeriğin değiştirilme zamanını bilmiyorsanız yalnızca ETag kullanın, tersi de geçerlidir.