Class: Buffer

Source Location: /myphp-1.9/myphp-1.9-cache/html/util/Buffer.php

Class Buffer

Class Overview

The Buffer Object with pure static methods

Note: A global object is created with this file, in order to hold all the html for publishing, caching purposes

 Usage:
   Buffer::add($html);      // Add the $html to the global html code
   print Buffer::getHtml(); // Get the global html code
   Buffer::display();       // Display the html code
   Buffer::cache();         // Cache the page for the global html code
   Buffer::show();

Located in /myphp-1.9/myphp-1.9-cache/html/util/Buffer.php [line 34]

Properties

$html

Methods

[ Top ]

Property Summary

String

$html

[ Top ]

Method Summary

Buffer	Buffer()	Constructor
void	add()	Add the html to the Buffer object
void	cache()	A cache file is created in the cache directory
void	clear()	Clear
void	display()	Display html
String	getHtml()	Get the html
boolean	save()	Save the content to the file opened by fp
void	show()	Show buffer
String	showSouce()	Show Source

[ Top ]

Properties

String $html = '' [line 38]

[ Top ]

Methods

Constructor Buffer [line 44]

Buffer Buffer(
[String
$html = ''] 
)

Constructor

Parameters:

String

$html:

The html to startup with

[ Top ]

add [line 58]

void add(
String
$html 
)

Add the html to the Buffer object

 Usage:
    Buffer::add($html);

Parameters:

String

$html:

The html to startup with

API Tags:

Global:	GLOBAL_SOURCE_CODE_NAME 0:
Static:

[ Top ]

cache [line 187]

void cache(
)

A cache file is created in the cache directory

Only files with no GET and no POST request parameters are cached

 Usage:
    Buffer::cache();

API Tags:

Global:	GLOBAL_SOURCE_CODE_NAME 0:
Static:

[ Top ]

clear [line 89]

void clear(
)

Clear

 Usage:
    $globalHtmlCode = Buffer::clear();

API Tags:

Global:	GLOBAL_SOURCE_CODE_NAME 0:
Static:

[ Top ]

display [line 169]

void display(
)

Display html

 Usage:
    Buffer::display();

API Tags:

Global:	GLOBAL_SOURCE_CODE_NAME 0:
Static:

[ Top ]

getHtml [line 76]

String getHtml(
)

Get the html

 Usage:
    $globalHtmlCode = Buffer::getHtml();

API Tags:

Return:	The html
Global:	GLOBAL_SOURCE_CODE_NAME 0:
Static:

[ Top ]

save [line 238]

boolean save(
String
$content 
)

Save the content to the file opened by fp

Parameters:

String

$content:

The content to write

API Tags:

Return:	Returns True on success, False on failure
Global:	GLOBAL_SOURCE_CODE_NAME 0:

[ Top ]

show [line 134]

void show(
[String
$file = ''] 
)

Show buffer

 Usage:
    Buffer::show();

Parameters:

String

$file:

The file to show

API Tags:

Global:	GLOBAL_SOURCE_CODE_NAME 0:
Static:

[ Top ]

showSouce [line 103]

String showSouce(
String
$file 
)

Show Source

 Usage:
    Buffer::showSource($file);

Parameters:

String

$file:

The file to show source

API Tags:

Return:	The html
Static:

[ Top ]

Documentation generated on Thu, 22 Dec 2005 17:02:59 +0100 by phpDocumentor 1.3.0RC3

	cache

[ class tree: cache ] [ index: cache ] [ all elements ]