Ibuildings - Docs For Class atkPage

Docs For Class atkPage

Home

Documentation home

Atk index

Docs For Class atkPage [ package: atk ]

Class: atkPage

Source Location: /ui/class.atkpage.inc

Class atkPage

Class Overview

Page renderer.

This class is used to render output as an html page. It takes care of creating a header, loading javascripts and loading stylesheets. Since any script will output exactly one page to the browser, this is a singleton. Use getInstance() to retrieve the one-and-only instance.

Located in /ui/class.atkpage.inc [line 46]

Wiki documentation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Todo:

This should actually not be a singleton. HTML file generation scripts may need an instance per page generated.

Properties

Methods

[ Top ]

Property Summary

String	$m_content	The content to put on the page.
Array	$m_hiddenvars	The hidden variables for the page
array	$m_loadscripts	List of javascript code statements to execute when the page is loaded.
array	$m_scriptcode	List of javascript code statements to include in the header.
array	$m_scriptfiles	The list of javascript files to load.
array	$m_stylecode	List of style statements to include in the header.
array	$m_stylesheets	List of stylesheet files to load.
array	$m_submitscripts	List of javascript code statements to execute when a form on the page is submitted.
string	$m_title	Page title.

[ Top ]

Method Summary

static atkPage	&getInstance()	Retrieve the one-and-only atkPage instance.
atkPage	__construct()	Constructor.
void	addContent()	Add content to the page.
void	addScripts()	Adds javascripts from the member variables to HTML output
void	addStyles()	Add stylesheets and stylecodes to the HMTL output
String	body()	Generate the HTML body (<body></body>) statement for the page.
string	getContent()	Returns the current page content.
void	getLoadScripts()	Returns a copy of the load scripts.
array	getScriptCodes()	Return all javascript codes in an array
array	getScripts()	Return all javascript files
array	getStyleCodes()	Return all style codes
array	getStyles()	Return all stylesheet files
String	head()	Generate the HTML header (<head></head>) statement for the page, including all scripts and styles.
boolean	isEmpty()	Check if the page is empty (no content).
void	register_hiddenvars()	Register hidden variables. These will be accessible to javascript and DHTML functions/scripts
void	register_loadscript()	Register a javascript code statement that is executed on pageload.
void	register_script()	Register a javascript file to be included.
void	register_scriptcode()	Register a javascript code statement which will be rendered in the header.
void	register_style()	Register a Cascading Style Sheet.
void	register_stylecode()	Register Cascading Style Sheet fragment that will be included in the page header.
void	register_submitscript()	Register a javascript code statement that is executed when a form on the page is submitted.
String	render()	Render the complete page, including head and body.
string	renderHiddenVars()	Here we render a hidden div in the page with hidden variables
void	renderPartial()	Render partial.
string	renderScriptCode()	Renders the registered javascripts, if $position is set to "before" the scripts will be placed before the scripts that are already present. Otherwise they will be appended at the end.
void	setContent()	Sets the page content (overwriting current content).
void	setTitle()	Sets the page title.
void	unregister_all_scripts()	Unregister all registered javascripts
void	unregister_style()	Unregister a Cascading Style Sheet.
String	_getGlobalLoadScriptCode()	Get the globalLoad javascript code
String	_getGlobalSubmitScriptCode()	Get the globalSubmit javascript code

[ Top ]

Properties

String $m_content = "" [line 97]

The content to put on the page.

API Tags:

Access:

private

[ Top ]

Array $m_hiddenvars = array() [line 104]

The hidden variables for the page

API Tags:

Access:

private

[ Top ]

array $m_loadscripts = array() [line 76]

List of javascript code statements to execute when the page is loaded.

API Tags:

Access:

private

[ Top ]

array $m_scriptcode = array("before"=>array(),"after"=>array()) [line 60]

List of javascript code statements to include in the header.

API Tags:

Access:

private

[ Top ]

array $m_scriptfiles = array() [line 53]

The list of javascript files to load.

API Tags:

Access:

private

[ Top ]

array $m_stylecode = array() [line 90]

List of style statements to include in the header.

API Tags:

Access:

private

[ Top ]

array $m_stylesheets = array() [line 83]

List of stylesheet files to load.

API Tags:

Access:

private

[ Top ]

array $m_submitscripts = array() [line 68]

List of javascript code statements to execute when a form on the page is submitted.

API Tags:

Access:

private

[ Top ]

string $m_title = '' [line 111]

Page title.

API Tags:

Access:

protected

[ Top ]

Methods

static method getInstance [line 117]

static atkPage &getInstance(
)

Retrieve the one-and-only atkPage instance.

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 131]

atkPage __construct(
)

Constructor.

API Tags:

Access:

public

[ Top ]

addContent [line 540]

void addContent(
String
$content 
)

Add content to the page.

Parameters:

String

$content:

The content to add to the page.

[ Top ]

addScripts [line 384]

void addScripts(

&$res, [Bool
$partial = false], String
$res 
)

Adds javascripts from the member variables to HTML output

Parameters:

String	$res:	Reference to the HTML output
Bool	$partial:	Is this a partial request or a complete request
	&$res:

[ Top ]

addStyles [line 508]

void addStyles(

&$res, [Bool
$partial = false], String
$res 
)

Add stylesheets and stylecodes to the HMTL output

Parameters:

String	$res:	Reference to the HTML output
Bool	$partial:	Is this a partial request or a complete request
	&$res:

[ Top ]

body [line 570]

String body(
[String
$extraprops = ""] 
)

Generate the HTML body (<body></body>) statement for the page.

Parameters:

String

$extraprops:

Extra attributes to add to the <body> tag.

API Tags:

Return:

The HTML body, including <body> and </body> tags.

[ Top ]

getContent [line 550]

string getContent(
)

Returns the current page content.

API Tags:

Return:

current page content

[ Top ]

getLoadScripts [line 233]

void getLoadScripts(
)

Returns a copy of the load scripts.

API Tags:

Access:

public

[ Top ]

getScriptCodes [line 259]

array getScriptCodes(
)

Return all javascript codes in an array

[ Top ]

getScripts [line 198]

array getScripts(
)

Return all javascript files

API Tags:

Return:

contain file paths

[ Top ]

getStyleCodes [line 329]

array getStyleCodes(
)

Return all style codes

[ Top ]

getStyles [line 308]

array getStyles(
)

Return all stylesheet files

API Tags:

Return:

contain file paths

[ Top ]

head [line 355]

String head(
String
$title, [String
$extra_header = ""] 
)

Generate the HTML header (<head></head>) statement for the page, including all scripts and styles.

Parameters:

String	$title:	Title of the html page.
String	$extra_header:	HTML code of extra headers to add to the head section

API Tags:

Return:

The HTML pageheader, including <head> and </head> tags.

[ Top ]

isEmpty [line 681]

boolean isEmpty(
)

Check if the page is empty (no content).

This is useful to check at the rendering stage of scripts whether there is something to render.

API Tags:

Return:

true if there is no content in the page, false if there is

[ Top ]

register_hiddenvars [line 340]

void register_hiddenvars(
array
$hiddenvars 
)

but will not be shown to the user unless he/she has a very, very old browser that is not capable of rendering CSS

Parameters:

array

$hiddenvars:

the hiddenvariables we want to register

[ Top ]

register_loadscript [line 242]

void register_loadscript(
String
$code, [
$offset = null] 
)

Parameters:

String	$code:	The javascript code fragment to execute on load.
	$offset:

[ Top ]

register_script [line 154]

void register_script(
String
$file, [String
$before = ""] 
)

If called twice for the same filename, the file is loaded only once.

Parameters:

String	$file:	The (relative path and) filename of the javascript file.
String	$before:	The (partial) name of a script that this script should be loaded in front of. This can be used to inject a script before another script, or to avoid conflicts. Usually, this parameter is not needed.

[ Top ]

register_scriptcode [line 212]

void register_scriptcode(
String
$code, [Boolean
$before = false] 
)

The method has a duplicate check. Registering the exact same statement twice, will result in the statement only being rendered and executed once.

Parameters:

String	$code:	The javascript code to place in the header.
Boolean	$before:	Include the script before the javascript files

[ Top ]

register_style [line 277]

void register_style(
String
$file, [String
$media = 'all'] 
)

This method has a duplicate check. Calling it with the same stylesheet more than once, will still result in only one single include of the stylesheet.

Parameters:

String	$file:	The (relative path and) filename of the stylesheet.
String	$media:	The stylesheet media (defaults to 'all').

[ Top ]

register_stylecode [line 319]

void register_stylecode(
String
$code 
)

Parameters:

String

$code:

The Cascading Style Sheet code fragment to place in the header.

[ Top ]

register_submitscript [line 225]

void register_submitscript(
String
$code 
)

Parameters:

String

$code:

The javascript code fragment to execute on submit.

Information Tags:

Todo:

This is inconsequent, if multiple forms are present, each should have its own submitscripts. Should be moved to an atkForm class.

[ Top ]

render [line 602]

String render(
[String
$title = null], [bool|int
$flags = HTML_STRICT], [string
$extrabodyprops = ""], [string
$extra_header = ""] 
)

Render the complete page, including head and body.

Parameters:

String	$title:	Title of the HTML page.
bool\|int	$flags:	(bool) Set to true to generate <body> tags. It is useful to set this to false only when rendering content that either already had its own <body></body> statement, or content that needs no body statements, like a frameset. (DEPRICATED !!) (int) Flags for the render function
string	$extrabodyprops:	Extra attributes to add to the <body> tag.
string	$extra_header:	HTML code of extra headers to add to the head section

API Tags:

Return:

The HTML page, including <html> and </html> tags.

[ Top ]

renderHiddenVars [line 658]

string renderHiddenVars(
)

Here we render a hidden div in the page with hidden variables

that we want to make accessible to client side scripts

API Tags:

Return:

a hidden div with the selected ATK variabels

[ Top ]

renderPartial [line 645]

void renderPartial(
)

Render partial.

[ Top ]

renderScriptCode [line 431]

string renderScriptCode(
string
$position 
)

Renders the registered javascripts, if $position is set to "before" the scripts will be placed before the scripts that are already present. Otherwise they will be appended at the end.

Parameters:

string

$position:

("before" or "after")

[ Top ]

setContent [line 560]

void setContent(
string
$content 
)

Sets the page content (overwriting current content).

Parameters:

string

$content:

new page content

[ Top ]

setTitle [line 584]

void setTitle(
string
$title 
)

Sets the page title.

Parameters:

string

$title:

page title

API Tags:

Access:

public

[ Top ]

unregister_all_scripts [line 187]

void unregister_all_scripts(
)

Unregister all registered javascripts

[ Top ]

unregister_style [line 295]

void unregister_style(
String
$file 
)

Unregister a Cascading Style Sheet.

Parameters:

String

$file:

The (relative path and) filename of the stylesheet.

[ Top ]

_getGlobalLoadScriptCode [line 476]

String _getGlobalLoadScriptCode(
[bool
$partial = false] 
)

Get the globalLoad javascript code

Parameters:

bool

$partial:

Is this a partial request or a complete request

API Tags:

Return:

with javascript code

[ Top ]

_getGlobalSubmitScriptCode [line 447]

String _getGlobalSubmitScriptCode(
[bool
$partial = false] 
)

Get the globalSubmit javascript code

Parameters:

bool

$partial:

Is this a partial request or a complete request

API Tags:

Return:

with javascript code

[ Top ]