Class JResponse

JResponse Class.

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

Package: Joomla\Legacy\Response
Deprecated: 1.5 Use JApplicationWeb instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 11.1
Located at legacy/response/response.php

Methods summary

`public static boolean`	# `allowCache( boolean $allow = null )` Set/get cachable state for the response. Set/get cachable state for the response. If $allow is set, sets the cachable state of the response. Always returns current state. Parameters `$allow` `boolean` - $allow True to allow browser caching. Returns `boolean` - True if browser caching should be allowed Since 1.5
`public static`	# `setHeader( string $name, string $value, boolean $replace = false )` Set a header. Set a header. If $replace is true, replaces any headers already defined with that $name. Parameters `$name` `string` - $name The name of the header to set. `$value` `string` - $value The value of the header to set. `$replace` `boolean` - $replace True to replace any existing headers by name. Since 1.5
`public static array`	# `getHeaders( )` Return array of headers. Return array of headers. Returns `array` Since 1.5
`public static`	# `clearHeaders( )` Clear headers. Clear headers. Since 1.5
`public static`	# `sendHeaders( )` Send all headers. Send all headers. Since 1.5
`public static`	# `setBody( string $content )` Set body content. Set body content. If body content already defined, this will replace it. Parameters `$content` `string` - $content The content to set to the response body. Since 1.5
`public static`	# `prependBody( string $content )` Prepend content to the body content Prepend content to the body content Parameters `$content` `string` - $content The content to prepend to the response body. Since 1.5
`public static`	# `appendBody( string $content )` Append content to the body content Append content to the body content Parameters `$content` `string` - $content The content to append to the response body. Since 1.5
`public static string`	# `getBody( boolean $toArray = false )` Return the body content Return the body content Parameters `$toArray` `boolean` - $toArray Whether or not to return the body content as an array of strings or as a single string; defaults to false. Returns `string` - array Since 1.5
`public static string`	# `toString( boolean $compress = false )` Sends all headers prior to returning the string Sends all headers prior to returning the string Parameters `$compress` `boolean` - $compress If true, compress the data Returns `string` Since 1.5
`protected static string`	# `compress( string $data )` Compress the data Compress the data Checks the accept encoding of the browser and compresses the data before sending it to the client. Parameters `$data` `string` - $data Content to compress for output. Returns `string` - compressed data Since 1.7 Note Replaces _compress method from 1.5
`protected static boolean`	# `clientEncoding( )` Check, whether client supports compressed data Check, whether client supports compressed data Returns `boolean` Since 1.7 Note Replaces _clientEncoding method from 1.5

Magic methods summary

Properties summary

`protected static array`	`$body`	# Response body Response body Deprecated 3.2 Since 1.6
`protected static boolean`	`$cachable`	# Flag if the response is cachable Flag if the response is cachable Deprecated 3.2 Since 1.6
`protected static array`	`$headers`	# Response headers Response headers Deprecated 3.2 Since 1.6

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JResponse

Methods summary

Parameters

Returns

Since

Parameters

Since

Returns

Since

Since

Since

Parameters

Since

Parameters

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Note

Returns

Since

Note

Magic methods summary

Properties summary

Deprecated

Since

Deprecated

Since

Deprecated

Since