Référence de la classe JResponse

Fonctions membres publiques statiques
static	allowCache ($allow=null)
static	setHeader ($name, $value, $replace=false)
static	getHeaders ()
static	clearHeaders ()
static	sendHeaders ()
static	setBody ($content)
static	prependBody ($content)
static	appendBody ($content)
static	getBody ($toArray=false)
static	toString ($compress=false)

Fonctions membres protégées statiques
static	compress ($data)
static	clientEncoding ()

Attributs protégés statiques
static	$body = array()
static	$cachable = false
static	$headers = array()

Description détaillée

JResponse Class.

This class serves to provide the Joomla Platform with a common interface to access response variables. This includes header and body.

Depuis

1.7.0

Obsolète:

1.5 Use JApplicationWeb instead

Documentation des fonctions membres

allowCache()

static allowCache (   $allow = null )

static

Set/get cachable state for the response.

If $allow is set, sets the cachable state of the response. Always returns current state.

Paramètres

boolean

$allow

True to allow browser caching.

Renvoie

boolean True if browser caching should be allowed

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::allowCache() instead

appendBody()

static appendBody (   $content )

static

Append content to the body content

Paramètres

string

$content

The content to append to the response body.

Renvoie

void

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::appendBody() instead

Références $content.

clearHeaders()

static clearHeaders ( )

static

Clear headers.

Renvoie

void

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::clearHeaders() instead

clientEncoding()

static clientEncoding ( )

staticprotected

Check, whether client supports compressed data

Renvoie

boolean

Depuis

1.7

Note

Replaces _clientEncoding method from 1.5

Obsolète:

3.2 Use JApplicationWebClient instead

compress()

static compress (   $data )

staticprotected

Compress the data

Checks the accept encoding of the browser and compresses the data before sending it to the client.

Paramètres

string

$data

Content to compress for output.

Renvoie

string compressed data

Note

Replaces _compress method from 1.5

Depuis

1.7

Obsolète:

3.2 Use JApplicationWeb::compress() instead

Références $data.

getBody()

static getBody (   $toArray = false )

static

Return the body content

Paramètres

boolean

$toArray

Whether or not to return the body content as an array of strings or as a single string; defaults to false.

Renvoie

string array

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::getBody() instead

getHeaders()

static getHeaders ( )

static

Return array of headers.

Renvoie

array

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::getHeaders() instead

prependBody()

static prependBody (   $content )

static

Prepend content to the body content

Paramètres

string

$content

The content to prepend to the response body.

Renvoie

void

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::prependBody() instead

Références $content.

sendHeaders()

static sendHeaders ( )

static

Send all headers.

Renvoie

void

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::sendHeaders() instead

Référencé par FOFIntegrationJoomlaPlatform\sendHeaders().

setBody()

static setBody (   $content )

static

Set body content.

If body content already defined, this will replace it.

Paramètres

string

$content

The content to set to the response body.

Renvoie

void

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::setBody() instead

Références $content.

Référencé par JApplication\render().

setHeader()

static setHeader (   $name,   $value,   $replace = false  )

static

Set a header.

If $replace is true, replaces any headers already defined with that $name.

Paramètres

string	$name	The name of the header to set.
string	$value	The value of the header to set.
boolean	$replace	True to replace any existing headers by name.

Renvoie

void

Depuis

1.5

Obsolète:

3.2 Use JApplicationWeb::setHeader() instead

Références $name, et $value.

Référencé par FOFIntegrationJoomlaPlatform\setHeader().

toString()

static toString (   $compress = false )

static

Sends all headers prior to returning the string

Paramètres

boolean

$compress

If true, compress the data

Renvoie

string

Depuis

1.5

Obsolète:

3.2 Use JApplicationCms::toString() instead

Référencé par JApplication\__toString().

Documentation des champs

$body

$body = array()

staticprotected

$cachable

$cachable = false

staticprotected

$headers

$headers = array()

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• response.php