TYPO3\CMS\Extbase\Mvc\Web\Response Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Web\Response:

Public Member Functions
	injectEnvironmentService (\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
	setStatus ($code, $message=null)
	getStatus ()
	setHeader ($name, $value, $replaceExistingHeader=true)
	getHeaders ()
	sendHeaders ()
	send ()
	getAdditionalHeaderData ()
	setRequest (\TYPO3\CMS\Extbase\Mvc\Web\Request $request)
	getRequest ()
	shutdown ()
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Response
	setContent ($content)
	appendContent ($content)
	getContent ()
	shutdown ()
	__toString ()

Protected Member Functions
	getTypoScriptFrontendController ()

Protected Attributes
	$headers = []
	$additionalHeaderData = []
	$statusCode
	$statusMessage = 'OK'
	$request
	$statusMessages
	$environmentService
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Response
	$content = null

Detailed Description

A web specific response implementation

Definition at line 26 of file Response.php.

Member Function Documentation

getAdditionalHeaderData()

TYPO3\CMS\Extbase\Mvc\Web\Response::getAdditionalHeaderData

(

)

Returns the additional header data

Returns

array The additional header data

Definition at line 268 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$additionalHeaderData.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\shutdown().

getHeaders()

TYPO3\CMS\Extbase\Mvc\Web\Response::getHeaders

(

)

Returns the HTTP headers - including the status header - of this web response

Returns

string[] The HTTP headers

Definition at line 189 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$statusMessage.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\sendHeaders().

getRequest()

TYPO3\CMS\Extbase\Mvc\Web\Response::getRequest

(

)

Returns

Definition at line 284 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$request.

getStatus()

TYPO3\CMS\Extbase\Mvc\Web\Response::getStatus

(

)

Returns status code and status message.

Returns

string The status code and status message, eg. "404 Not Found

Definition at line 156 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$statusMessage.

getTypoScriptFrontendController()

TYPO3\CMS\Extbase\Mvc\Web\Response::getTypoScriptFrontendController ( )

protected

Returns

TypoScriptFrontendController

Definition at line 306 of file Response.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\shutdown().

injectEnvironmentService()

TYPO3\CMS\Extbase\Mvc\Web\Response::injectEnvironmentService

(

\TYPO3\CMS\Extbase\Service\EnvironmentService

$environmentService

)

Parameters

\TYPO3\CMS\Extbase\Service\EnvironmentService

$environmentService

Definition at line 124 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$environmentService.

send()

TYPO3\CMS\Extbase\Mvc\Web\Response::send

(

)

Renders and sends the whole web response

Returns

void

Definition at line 229 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$additionalHeaderData, TYPO3\CMS\Extbase\Mvc\Response\getContent(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Extbase\Mvc\Web\Response\sendHeaders().

sendHeaders()

TYPO3\CMS\Extbase\Mvc\Web\Response::sendHeaders

(

)

Sends the HTTP headers.

If headers have already been sent, this method fails silently.

Returns

void

Definition at line 213 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\getHeaders().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\send(), and TYPO3\CMS\Extbase\Mvc\Web\Response\shutdown().

setHeader()

TYPO3\CMS\Extbase\Mvc\Web\Response::setHeader	(		$name,
			$value,
			$replaceExistingHeader = true
	)

Sets the specified HTTP header

Parameters

string	$name	Name of the header, for example "Location", "Content-Description" etc.
mixed	$value	The value of the given header
bool	$replaceExistingHeader	If a header with the same name should be replaced. Default is TRUE.

Exceptions

Definition at line 171 of file Response.php.

setRequest()

TYPO3\CMS\Extbase\Mvc\Web\Response::setRequest

(

\TYPO3\CMS\Extbase\Mvc\Web\Request

$request

)

Parameters

\TYPO3\CMS\Extbase\Mvc\Web\Request

$request

Definition at line 276 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\$request.

setStatus()

TYPO3\CMS\Extbase\Mvc\Web\Response::setStatus	(		$code,
			$message = null
	)

Sets the HTTP status code and (optionally) a customized message.

Parameters

int	$code	The status code
string	$message	If specified, this message is sent instead of the standard message

Exceptions

Definition at line 138 of file Response.php.

shutdown()

TYPO3\CMS\Extbase\Mvc\Web\Response::shutdown

(

)

Sends additional headers and returns the content

Returns

null|string

Implements TYPO3\CMS\Extbase\Mvc\ResponseInterface.

Definition at line 294 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Web\Response\getAdditionalHeaderData(), TYPO3\CMS\Extbase\Mvc\Web\Response\getTypoScriptFrontendController(), and TYPO3\CMS\Extbase\Mvc\Web\Response\sendHeaders().

Member Data Documentation

$additionalHeaderData

TYPO3\CMS\Extbase\Mvc\Web\Response::$additionalHeaderData = []

protected

Definition at line 40 of file Response.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\getAdditionalHeaderData(), and TYPO3\CMS\Extbase\Mvc\Web\Response\send().

$environmentService

TYPO3\CMS\Extbase\Mvc\Web\Response::$environmentService

protected

Definition at line 119 of file Response.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\injectEnvironmentService().

$headers

TYPO3\CMS\Extbase\Mvc\Web\Response::$headers = []

protected

Definition at line 33 of file Response.php.

$request

TYPO3\CMS\Extbase\Mvc\Web\Response::$request

protected

Definition at line 61 of file Response.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\getRequest(), and TYPO3\CMS\Extbase\Mvc\Web\Response\setRequest().

$statusCode

TYPO3\CMS\Extbase\Mvc\Web\Response::$statusCode

protected

Definition at line 47 of file Response.php.

$statusMessage

TYPO3\CMS\Extbase\Mvc\Web\Response::$statusMessage = 'OK'

protected

Definition at line 54 of file Response.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Response\getHeaders(), and TYPO3\CMS\Extbase\Mvc\Web\Response\getStatus().

$statusMessages

TYPO3\CMS\Extbase\Mvc\Web\Response::$statusMessages

protected

Initial value:

= [
        100 => 'Continue'

Definition at line 68 of file Response.php.