Open Journal Systems  3.3.0
Public Member Functions | Protected Attributes
Http\Message\Builder\ResponseBuilder Class Reference

Public Member Functions

 __construct (ResponseInterface $response)
 
 addHeader ($headerLine)
 
 getResponse ()
 
 setHeadersFromArray (array $headers)
 
 setHeadersFromString ($headers)
 
 setStatus ($statusLine)
 

Protected Attributes

 $response
 

Detailed Description

Fills response object with values.

Definition at line 10 of file ResponseBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

Http\Message\Builder\ResponseBuilder::__construct ( ResponseInterface  $response)

Create builder for the given response.

Parameters
ResponseInterface$response

Definition at line 27 of file ResponseBuilder.php.

References Http\Message\Builder\ResponseBuilder\$response.

Member Function Documentation

◆ addHeader()

Http\Message\Builder\ResponseBuilder::addHeader (   $headerLine)

Add header represented by a string.

Parameters
string$headerLineResponse header as a string.
Returns
$this
Exceptions

Definition at line 133 of file ResponseBuilder.php.

Referenced by Http\Message\Builder\ResponseBuilder\setHeadersFromArray().

◆ getResponse()

Http\Message\Builder\ResponseBuilder::getResponse ( )

Return response.

Returns
ResponseInterface

Definition at line 37 of file ResponseBuilder.php.

References Http\Message\Builder\ResponseBuilder\$response.

◆ setHeadersFromArray()

Http\Message\Builder\ResponseBuilder::setHeadersFromArray ( array  $headers)

Add headers represented by an array of header lines.

Parameters
string[]$headersResponse headers as array of header lines.
Returns
$this
Exceptions

Definition at line 52 of file ResponseBuilder.php.

References Http\Message\Builder\ResponseBuilder\addHeader(), and Http\Message\Builder\ResponseBuilder\setStatus().

Referenced by Http\Message\Builder\ResponseBuilder\setHeadersFromString().

◆ setHeadersFromString()

Http\Message\Builder\ResponseBuilder::setHeadersFromString (   $headers)

Add headers represented by a single string.

Parameters
string$headersResponse headers as single string.
Returns
$this
Exceptions

Definition at line 79 of file ResponseBuilder.php.

References Http\Message\Builder\ResponseBuilder\setHeadersFromArray().

◆ setStatus()

Http\Message\Builder\ResponseBuilder::setStatus (   $statusLine)

Set response status from a status string.

Parameters
string$statusLineResponse status as a string.
Returns
$this
Exceptions

Definition at line 107 of file ResponseBuilder.php.

Referenced by Http\Message\Builder\ResponseBuilder\setHeadersFromArray().

Field Documentation

◆ $response

ResponseInterface Http\Message\Builder\ResponseBuilder::$response
protected

The response to be built.

Definition at line 20 of file ResponseBuilder.php.

Referenced by Http\Message\Builder\ResponseBuilder\__construct(), and Http\Message\Builder\ResponseBuilder\getResponse().

The documentation for this class was generated from the following file: