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)
string	getStatus ()
int	getStatusCode ()
	setHeader ($name, $value, $replaceExistingHeader=true)
string[]	getHeaders ()
array	getUnpreparedHeaders ()
	sendHeaders ()
	send ()
	addAdditionalHeaderData ($additionalHeaderData)
array	getAdditionalHeaderData ()
	setRequest (\TYPO3\CMS\Extbase\Mvc\Web\Request $request)
TYPO3 CMS Extbase Mvc Web Request	getRequest ()
string null	shutdown ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Response
	setContent ($content)
	appendContent ($content)
string	getContent ()
string	__toString ()

Protected Member Functions
TypoScriptFrontendController	getTypoScriptFrontendController ()

Protected Attributes
array	$headers = array( )
array	$additionalHeaderData = array( )
int	$statusCode
string	$statusMessage = 'OK'
TYPO3 CMS Extbase Mvc Web Request	$request
array	$statusMessages
TYPO3 CMS Extbase Service EnvironmentService	$environmentService
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Response
string	$content

Detailed Description

A web specific response implementation

Definition at line 24 of file Response.php.

Member Function Documentation

addAdditionalHeaderData()

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

(

$additionalHeaderData

)

Adds an additional header data (something like '<script src="myext/Resources/JavaScript/my.js" type="text/javascript"></script>' )

@TODO The workround and the $request member should be removed again, once the PageRender does support non-cached USER_INTs

Parameters

string

$additionalHeaderData

‪The value additional header

Exceptions

Definition at line 270 of file Response.php.

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

getAdditionalHeaderData()

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

(

)

Returns the additional header data

Returns

‪array The additional header data

Definition at line 289 of file Response.php.

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

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

getHeaders()

string [] 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 208 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 Request TYPO3\CMS\Extbase\Mvc\Web\Response::getRequest

(

)

Returns

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

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 307 of file Response.php.

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

getStatus()

string 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 167 of file Response.php.

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

getStatusCode()

int TYPO3\CMS\Extbase\Mvc\Web\Response::getStatusCode

(

)

Returns the status code, if not set, uses the OK status code 200

Returns

‪int

only use for backend module handling

Definition at line 178 of file Response.php.

getTypoScriptFrontendController()

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

protected

Returns

‪TypoScriptFrontendController

Definition at line 330 of file Response.php.

References $GLOBALS.

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

getUnpreparedHeaders()

array TYPO3\CMS\Extbase\Mvc\Web\Response::getUnpreparedHeaders

(

)

Returns the HTTP headers grouped by name without the status header

Returns

‪array all headers set for this request

only used within TYPO3 Core to convert to PSR-7 response headers

Definition at line 230 of file Response.php.

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

injectEnvironmentService()

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

(

\TYPO3\CMS\Extbase\Service\EnvironmentService

$environmentService

)

Parameters

\TYPO3\CMS\Extbase\Service\EnvironmentService

$environmentService

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 138 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

Definition at line 253 of file Response.php.

References TYPO3\CMS\Extbase\Mvc\Response\getContent(), 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.

Definition at line 240 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 191 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

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 298 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 150 of file Response.php.

shutdown()

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

(

)

Sends additional headers and returns the content

Returns

‪string|null

only to be used within Extbase, not part of TYPO3 Core API.

Reimplemented from TYPO3\CMS\Extbase\Mvc\Response.

Definition at line 318 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

array TYPO3\CMS\Extbase\Mvc\Web\Response::$additionalHeaderData = array( )

protected

Additional header tags

Definition at line 36 of file Response.php.

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

$environmentService

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

protected

Definition at line 132 of file Response.php.

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

$headers

array TYPO3\CMS\Extbase\Mvc\Web\Response::$headers = array( )

protected

The HTTP headers which will be sent in the response

Definition at line 30 of file Response.php.

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

$request

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

protected

The Request which generated the Response

Definition at line 54 of file Response.php.

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

$statusCode

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

protected

The HTTP status code

Definition at line 42 of file Response.php.

$statusMessage

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

protected

The HTTP status message

Definition at line 48 of file Response.php.

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

$statusMessages

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

protected

The standardized and other important HTTP Status messages

Definition at line 60 of file Response.php.