PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of response.php

(no description)

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id: response.php 21044 2011-03-31 16:03:23Z dextercowley $
File Size:	283 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

JResponse:: (12 methods):
  allowCache()
  setHeader()
  getHeaders()
  clearHeaders()
  sendHeaders()
  setBody()
  prependBody()
  appendBody()
  getBody()
  toString()
  _compress()
  _clientEncoding()

Class: JResponse - X-Ref

JResponse Class

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

allowCache($allow = null) X-Ref

Set/get cachable state for the response

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

param: boolean    $allow
return: boolean     True of browser caching should be allowed

setHeader($name, $value, $replace = false) X-Ref

Set a header

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

param: string     $name
param: string     $value
param: boolean     $replace

getHeaders() X-Ref

Return array of headers;

return: array

clearHeaders() X-Ref

Clear headers

sendHeaders() X-Ref

Send all headers

return: void

setBody($content) X-Ref

Set body content

If body content already defined, this will replace it.

param: string $content

prependBody($content) X-Ref

Prepend content to the body content

param: string $content

appendBody($content) X-Ref

Append content to the body content

param: string $content

getBody($toArray = false) X-Ref

Return the body content

param: boolean $toArray Whether or not to return the body content as an
return: string|array

toString($compress = false) X-Ref

Sends all headers prior to returning the string

param: boolean $compress If true, compress the data
return: string

_compress( $data ) X-Ref

Compress the data

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

param: string data
return: string compressed data

_clientEncoding() X-Ref

check, whether client supports compressed data

return: boolean

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/environment/ -> response.php (summary)

Defines 1 class