TYPO3 API  SVNRelease
Public Member Functions | Protected Attributes
Tx_Extbase_MVC_Web_Response Class Reference
Inheritance diagram for Tx_Extbase_MVC_Web_Response:
Inheritance graph
[legend]
Collaboration diagram for Tx_Extbase_MVC_Web_Response:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 setStatus ($code, $message=NULL)
 getStatus ()
 setHeader ($name, $value, $replaceExistingHeader=TRUE)
 getHeaders ()
 sendHeaders ()
 send ()
 addAdditionalHeaderData ($additionalHeaderData)
 getAdditionalHeaderData ()

Protected Attributes

 $headers = array()
 $additionalHeaderData = array()
 $statusCode
 $statusMessage = 'OK'
 $statusMessages

Detailed Description

Definition at line 37 of file Response.php.


Member Function Documentation

Tx_Extbase_MVC_Web_Response::addAdditionalHeaderData ( additionalHeaderData)

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

Parameters:
string$additionalHeaderDataThe value additonal header
Returns:
void

Definition at line 222 of file Response.php.

References $additionalHeaderData.

Tx_Extbase_MVC_Web_Response::getAdditionalHeaderData ( )

Returns the additional header data

Returns:
array The additional header data

Definition at line 233 of file Response.php.

Tx_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 170 of file Response.php.

References $value.

Referenced by sendHeaders().

Tx_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 142 of file Response.php.

Tx_Extbase_MVC_Web_Response::send ( )

Renders and sends the whole web response

Returns:
void

Definition at line 206 of file Response.php.

References Tx_Extbase_MVC_Response\getContent(), and sendHeaders().

Tx_Extbase_MVC_Web_Response::sendHeaders ( )

Sends the HTTP headers.

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

Returns:
void

Definition at line 193 of file Response.php.

References getHeaders().

Referenced by send().

Tx_Extbase_MVC_Web_Response::setHeader ( name,
value,
replaceExistingHeader = TRUE 
)

Sets the specified HTTP header

Parameters:
string$nameName of the header, for example "Location", "Content-Description" etc.
mixed$valueThe value of the given header
boolean$replaceExistingHeaderIf a header with the same name should be replaced. Default is TRUE.
Returns:
void

Definition at line 155 of file Response.php.

References $value.

Tx_Extbase_MVC_Web_Response::setStatus ( code,
message = NULL 
)

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

Parameters:
integer$codeThe status code
string$messageIf specified, this message is sent instead of the standard message
Returns:
void
Exceptions:
InvalidArgumentExceptionif the specified status code is not valid

Definition at line 128 of file Response.php.


Member Data Documentation

Tx_Extbase_MVC_Web_Response::$additionalHeaderData = array() [protected]

Definition at line 51 of file Response.php.

Referenced by addAdditionalHeaderData().

Tx_Extbase_MVC_Web_Response::$headers = array() [protected]

Definition at line 44 of file Response.php.

Tx_Extbase_MVC_Web_Response::$statusCode [protected]

Definition at line 58 of file Response.php.

Tx_Extbase_MVC_Web_Response::$statusMessage = 'OK' [protected]

Definition at line 65 of file Response.php.

Tx_Extbase_MVC_Web_Response::$statusMessages [protected]

Definition at line 72 of file Response.php.


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