Class: StatusTemplate

Source Location: /upgrade/StatusTemplate.class

Class StatusTemplate

Class Overview

Progress bar status

Located in /upgrade/StatusTemplate.class [line 29]

Method Summary

void	hideStatusBlock()	Hide the status block
void	renderBodyAndFooter()	Render the body and footer (everything below the status message)
void	renderHeader()	Render the header (from <html> to the statusblock or the navbar)
void	renderHeaderBodyAndFooter()	Render the whole page, except for the status block and messages. This is the way that we render most pages that don't have interactive status messages.
GalleryStatus	renderStatusMessage()	Render a single status message

[ Top ]

Methods

hideStatusBlock [line 85]

void hideStatusBlock(
)

Hide the status block

[ Top ]

renderBodyAndFooter [line 69]

void renderBodyAndFooter(
array
$templateData 
)

Render the body and footer (everything below the status message)

Parameters:

array

$templateData:

[ Top ]

renderHeader [line 33]

void renderHeader(
[
$renderStatusBlock = false] 
)

Render the header (from <html> to the statusblock or the navbar)

Parameters:

$renderStatusBlock:

[ Top ]

renderHeaderBodyAndFooter [line 96]

void renderHeaderBodyAndFooter(
array
$templateData 
)

Render the whole page, except for the status block and messages. This is the way that we render most pages that don't have interactive status messages.

Parameters:

array

$templateData:

[ Top ]

renderStatusMessage [line 52]

GalleryStatus renderStatusMessage(
string
$title, string
$description, float
$percentComplete 
)

Render a single status message

Parameters:

string	$title:	the status title
string	$description:	the status description
float	$percentComplete:	ranging from 0 to 1

API Tags:

Return:

a status code

[ Top ]

Documentation generated on Sat, 21 Nov 2009 05:29:58 -0800 by phpDocumentor 1.3.0RC6

	Upgrade

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