Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques statiques | Fonctions membres protégées statiques | Attributs protégés statiques
Référence de la classe JResponse

Liste de tous les membres

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

Définition à la ligne 25 du fichier response.php.

Documentation des fonctions membres

static JResponse::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$allowTrue to allow browser caching.
Renvoie:
boolean True if browser caching should be allowed
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::allowCache() instead

Définition à la ligne 60 du fichier response.php.

Références JFactory\getApplication().

{
return JFactory::getApplication()->allowCache($allow);
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::appendBody (   $content)
static

Append content to the body content

Paramètres:
string$contentThe content to append to the response body.
Renvoie:
void
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::appendBody() instead

Définition à la ligne 165 du fichier response.php.

Références JFactory\getApplication().

{
JFactory::getApplication()->appendBody($content);
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::clearHeaders ( )
static

Clear headers.

Renvoie:
void
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::clearHeaders() instead

Définition à la ligne 105 du fichier response.php.

Références JFactory\getApplication().

{
JFactory::getApplication()->clearHeaders();
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::clientEncoding ( )
staticprotected

Check, whether client supports compressed data

Renvoie:
boolean
Depuis:
11.1
Note:
Replaces _clientEncoding method from 11.1
Obsolète:
4.0 Use JApplicationWebClient instead

Définition à la ligne 274 du fichier response.php.

{
if (!isset($_SERVER['HTTP_ACCEPT_ENCODING']))
{
return false;
}
$encoding = false;
if (false !== strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip'))
{
$encoding = 'gzip';
}
if (false !== strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'x-gzip'))
{
$encoding = 'x-gzip';
}
return $encoding;
}
static JResponse::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$dataContent to compress for output.
Renvoie:
string compressed data
Note:
Replaces _compress method in 11.1
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::compress() instead

Définition à la ligne 214 du fichier response.php.

Références JFactory\getConfig().

{
$encoding = self::clientEncoding();
if (!$encoding)
{
return $data;
}
if (!extension_loaded('zlib') || ini_get('zlib.output_compression'))
{
return $data;
}
if (headers_sent())
{
return $data;
}
if (connection_status() !== 0)
{
return $data;
}
// Ideal level
$level = 4;
/*
$size = strlen($data);
$crc = crc32($data);
$gzdata = "\x1f\x8b\x08\x00\x00\x00\x00\x00";
$gzdata .= gzcompress($data, $level);
$gzdata = substr($gzdata, 0, strlen($gzdata) - 4);
$gzdata .= pack("V",$crc) . pack("V", $size);
*/
$gzdata = gzencode($data, $level);
self::setHeader('Content-Encoding', $encoding);
// Header will be removed at 4.0
if (JFactory::getConfig()->get('MetaVersion', 0) && defined('JVERSION'))
{
self::setHeader('X-Content-Encoded-By', 'Joomla! ' . JVERSION);
}
return $gzdata;
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::getBody (   $toArray = false)
static

Return the body content

Paramètres:
boolean$toArrayWhether or not to return the body content as an array of strings or as a single string; defaults to false.
Renvoie:
string array
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::getBody() instead

Définition à la ligne 180 du fichier response.php.

Références JFactory\getApplication().

{
return JFactory::getApplication()->getBody($toArray);
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::getHeaders ( )
static

Return array of headers.

Renvoie:
array
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::getHeaders() instead

Définition à la ligne 92 du fichier response.php.

Références JFactory\getApplication().

{
return JFactory::getApplication()->getHeaders();
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::prependBody (   $content)
static

Prepend content to the body content

Paramètres:
string$contentThe content to prepend to the response body.
Renvoie:
void
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::prependBody() instead

Définition à la ligne 150 du fichier response.php.

Références JFactory\getApplication().

{
JFactory::getApplication()->prependBody($content);
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::sendHeaders ( )
static

Send all headers.

Renvoie:
void
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::sendHeaders() instead

Définition à la ligne 118 du fichier response.php.

Références JFactory\getApplication().

{
JFactory::getApplication()->sendHeaders();
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::setBody (   $content)
static

Set body content.

If body content already defined, this will replace it.

Paramètres:
string$contentThe content to set to the response body.
Renvoie:
void
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::setBody() instead

Définition à la ligne 135 du fichier response.php.

Références JFactory\getApplication().

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

{
JFactory::getApplication()->setBody($content);
}

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

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

Set a header.

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

Paramètres:
string$nameThe name of the header to set.
string$valueThe value of the header to set.
boolean$replaceTrue to replace any existing headers by name.
Renvoie:
void
Depuis:
11.1
Obsolète:
4.0 Use JApplicationWeb::setHeader() instead

Définition à la ligne 79 du fichier response.php.

Références JFactory\getApplication().

{
JFactory::getApplication()->setHeader($name, $value, $replace);
}

+ Voici le graphe d'appel pour cette fonction :

static JResponse::toString (   $compress = false)
static

Sends all headers prior to returning the string

Paramètres:
boolean$compressIf true, compress the data
Renvoie:
string
Depuis:
11.1
Obsolète:
4.0 Use JApplicationCms::toString() instead

Définition à la ligne 195 du fichier response.php.

Références JFactory\getApplication().

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

{
return JFactory::getApplication()->toString($compress);
}

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

Documentation des données membres

JResponse::$body = array()
staticprotected

Définition à la ligne 32 du fichier response.php.

JResponse::$cachable = false
staticprotected

Définition à la ligne 39 du fichier response.php.

JResponse::$headers = array()
staticprotected

Définition à la ligne 46 du fichier response.php.

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