Ibuildings - Docs For Class atkOutput

Docs For Class atkOutput

Home

Documentation home

Atk index

Docs For Class atkOutput [ package: atk ]

Class: atkOutput

Source Location: /ui/class.atkoutput.inc

Class atkOutput

Class Overview

Outputbuffering class.

Any output sent to the browser should be directed through the atkOutput class. Among other things, it buffers debugging output and errormessages, and displays them below the actual output. If $config_output_gzip is set to true, all output is sent gzipped to the browser (saves bandwith).

If $config_mailreport is set to a valid email address, this class also takes care of sending error reports to the email address, if any errors occurred during script execution.

The atkOutput class is a singleton. The one-and-only instance should be retrieved with the getInstance() method.

Located in /ui/class.atkoutput.inc [line 39]

Wiki documentation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Property Summary

mixed	$m_content	Store regular output data.
mixed	$m_raw	Store raw output data.

[ Top ]

Method Summary

static atkOutput	&getInstance()	Retrieve the one-and-only atkOutput instance.
static void	header()	Output header.
static void	sendNoCacheHeaders()	Send no cache headers to the browser.
String	getDebugging()	Display the debug statements
String	gzip()	Gzip a piece of text.
void	output()	Output regular text to the browser.
void	outputFlush()	Send all output to the browser.
void	rawoutput()	Output raw, headerless text to the browser. If this method is called, all regular output is suppressed and the contents of the rawoutput is passed as-is to the browser when outputFlush() is called.
void	sendCachingHeaders()	Send the caching headers

[ Top ]

Properties

mixed $m_content = "" [line 51]

Store regular output data.

API Tags:

Access:

private

[ Top ]

mixed $m_raw = "" [line 45]

Store raw output data.

API Tags:

Access:

private

[ Top ]

Methods

static method getInstance [line 57]

static atkOutput &getInstance(
)

Retrieve the one-and-only atkOutput instance.

API Tags:

Return:	The instance.
Access:	public

[ Top ]

static method header [line 73]

static void header(
string
$header 
)

Output header.

Parameters:

string

$header:

API Tags:

Access:

public

[ Top ]

static method sendNoCacheHeaders [line 117]

static void sendNoCacheHeaders(
)

Send no cache headers to the browser.

API Tags:

Access:

public

[ Top ]

getDebugging [line 188]

String getDebugging(
)

Display the debug statements

API Tags:

Return:	htmlcode with debugging
Access:	public

[ Top ]

gzip [line 228]

String gzip(
String
$contents 
)

Gzip a piece of text.

Called internally by atkOutput when $config_output_gzip is set to true, but can be used by other scripts too, if they need to gzip some data.

Parameters:

String

$contents:

The string to gzip.

API Tags:

Return:	The gzipped string.
Access:	public

[ Top ]

output [line 215]

void output(
String
$txt 
)

Output regular text to the browser.

Parameters:

String

$txt:

The text to output.

API Tags:

Access:

public

[ Top ]

outputFlush [line 139]

void outputFlush(
[boolean
$nocache = true], [int
$lastmodificationstamp = ""], [string
$charset = ""] 
)

Send all output to the browser.

Parameters:

boolean	$nocache:	If true, sends no-cache headers to the browser, so the browser will not cache the output in its browsercache.
int	$lastmodificationstamp:	Timestamp of last modification. If set, a last-modified header containing this stamp will be sent to the browser. If $nocache is true, this parameter is ignored.
string	$charset:	The character set

API Tags:

Access:

public

[ Top ]

rawoutput [line 206]

void rawoutput(
String
$txt 
)

Output raw, headerless text to the browser. If this method is called, all regular output is suppressed and the contents of the rawoutput is passed as-is to the browser when outputFlush() is called.

Parameters:

String

$txt:

The text to output.

API Tags:

Access:

public

[ Top ]

sendCachingHeaders [line 89]

void sendCachingHeaders(
[timestamp
$lastmodificationstamp = ''], [bool
$nocache = true] 
)

Send the caching headers

Parameters:

timestamp	$lastmodificationstamp:	Timestamp of the last modification
bool	$nocache:	Send cache headers?

API Tags:

Access:

public

[ Top ]