class Pike\Response
Luokka jolla rakennetaan HTTP-vastaukset, jotka Pike toimittaa clientille.
Synopsis
class Response {
/* Metodit */
public __construct ( int $statusCode = 200 )
public status ( int $statusCode ) : $this
public json ( object|array|string $data ) : $this
public html ( string $body ) : $this
public plain ( string $body ) : $this
public type ( string $type ) : $this
public attachment ( string $data, string $fileName = 'file.zip', string $mime = 'application/zip' ) : $this
public redirect ( string $to, bool $isPermanent = true ) : $this
public header ( string $name, string $value, bool $replace = true ) : $this
public send ( string $body ) : void
public commitIfReady ( void ) : bool
public isCommitted ( void ) : bool
}
Metodit
__construct()
Luo uuden response-olion.
Signature
public function __construct ( int $statusCode = 200 )
Esimerkit
$response = new Response(404);
status()
Asettaa vastauksen HTTP-statuskoodin.
Signature
public function status ( int $statusCode ) : $this
Esimerkit
$response = $response->status(418);
json()
Asettaa vastauksen bodyksi $data, ja statuskoodiksi application/json.
Signature
public function json ( object|array|string $data ) : $this
Esimerkit
$response = $response->json(['key' => 'val']);
html()
Asettaa vastauksen bodyksi $data, ja statuskoodiksi text/html.
Signature
public function html ( string $body ) : $this
Esimerkit
$response = $response->html('<!DOCTYPE html>...');
plain()
Asettaa vastauksen bodyksi $data, ja statuskoodiksi text/plain.
Signature
public function plain ( string $body ) : $this
Esimerkit
$response = $response->plain('Tekstiä...');
type()
Asettaa vastauksen Content-Type:n.
Signature
public function type ( string $type ) : $this
Esimerkit
$response = $response->type('image/png')->send(...);
attachment()
Lisää vastaukseen tiedoston.
Signature
public function attachment ( string $data, string $fileName = 'file.zip', string $mime = 'application/zip' ) : $this
Esimerkit
$response = $response->attachment('Tekstiä', 'tiedosto.txt', 'text/plain');
redirect()
Asettaa vastaukseen uudelleenohjauksen.
Signature
public function redirect ( string $to, bool $isPermanent = true ) : $this
Esimerkit
$response = $response->redirect('https://site.com/url');
header()
Lisää vastaukseen HTTP-headerin.
Signature
public function header ( string $name, string $value, bool $replace = true ) : $this
Esimerkit
$response = $response->header('name', 'value');
send()
Asettaa vastauksen body:n.
Signature
public function send ( string $body ) : void
Esimerkit
$response->send('data');
commitIfReady()
Lähettää vastauksen mikäli se ei ollut vielä lähetetty.
Signature
public function commitIfReady ( void ) : bool
Esimerkit
$wasSent = $response->commitIfReady();
isCommitted()
Kertoo onko vastaus lähetetty.
Signature
public function isCommitted ( void ) : bool
Esimerkit
$isIt = $response->isCommitted();