Skip to content

Latest commit

 

History

History
146 lines (115 loc) · 4.08 KB

response.md

File metadata and controls

146 lines (115 loc) · 4.08 KB
Raw

Response

This Response class allows you to output data from your application in different ways.

Usage

Creating a new response

use Mk4U\Http\Response;

$response=new Response(
  'Hello World!',
  headers:[
    'content-type' => 'text/plain'
    ]
);
return $response;
// or
$response=new Response();
return $response->plain('Hello World!');
// Both implementations return "Hello World!"" and the default status code is 200.

Can also create responses for different types of content and status codes.

$response=new Response();

// You can specify the status code and the reason phrase via the Status enum or as an array.
$status=Mk4U\Http\Status::MovedPermanently;
// or
$status=[301,'Moved Permanently'];


return $response->html('<h1>Hello World!</h1>', $status,['Retry-After'=>'Retry-After: 120'],'1.2');

return $response->json(
  '{"message":"Hello World!"}',
   $status,
   ['Content-MD5'=>'d41d8cd98f00b204e9800998ecf8427e'],
   '1.0'
  );

Returns information for object debugging.

The magic method __debugInfo returns an array with information about the HTTP response, including the protocol version, code, phrase, headers and body.

var_dump($response);

Method Response::getStatusCode().

This method returns the HTTP response status code.

$response->getStatusCode();
// 200

Method Response::setStatus(int $code, string $reasonPhrase = '').

This method sets the status code and optionally, the HTTP response reason phrase. The InvalidArgumentException is thrown if the status code is invalid.

Parameters:

  • $code (int): The 3-digit status code to be set.
  • $reasonPhrase (string): The reason phrase to associate with the status code. If not provided, a default value can be used.
$response->setStatus(200, 'OK');
// or
$response->setStatus(Mk4U\Http\Status::Ok->value);

Method Response::getReasonPhrase().

This method returns the reason phrase associated with the HTTP response status code.

$response->getReasonPhrase();
// return "Ok"

Method Response::getBody().

This method returns the message body of the response.

$body=$response->getBody();

Method Response::setBody(mixed $body).

This method sets the message body of the response.

$response->setBody($content);

Method Response::json(array|object $content, Status|array $status = Status::Ok, array $headers = []).

This method returns the message body in JSON format.

Parameters:

  • $content (array|object): The content to be converted to JSON.
  • $status (Status|array): The status of the response (default is Ok).
  • $headers (array): The headers of the response.
Response::json('{"message":"Hello World!"}', $status, $headers);

Method Response::plain(string $content, Status|array $status = Status::Ok, array $headers = []).

This method returns the message body in plain text format.

Parameters:

  • $content (string): The content in plain text format.
  • $status (Status|array): The status of the response (default is Ok).
  • $headers (array): The headers of the response
Response::plain('Hello World!', $status, $headers);

Method Response::html(string $content, Status|array $status = Status::Ok, array $headers = []).

This method returns the message body in HTML format.

Parameters:

  • $content (string): The content in HTML format.
  • $status (Status|array): The status of the response (default is Ok).
  • $headers (array): The headers of the response
Response::html('<h1>Hello World!</h1>', $status, $headers);

Method Response::xml(string $content, Status|array $status = Status::Ok, array $headers = []).

This method returns the message body in XML format.

Parameters:

  • $content (string): The content in XML format.
  • $status (Status|array): The status of the response (default is Ok).
  • $headers (array): The headers of the response
$xml=<<<XML
<?xml version="1.0" encoding="UTF-8"?>
<note>
  <to>Tove</to>
  <from>Jani</from>
  <heading>Reminder</heading>
  <body>Don't forget me this weekend!</body>
</note>
XML;
Response::xml($xml, $status, $headers);