TKCSERDClassicReview Class Reference

A TK View to display a CSERDClassicReview object. More...

Inheritance diagram for TKCSERDClassicReview:

List of all members.

Public Member Functions

__construct ($review, $params=array())

Constructor.

render ()

Converts this component (and any children) to HTML.

setAppearance ($app)

Set the appearance for this view.

setParams ($params)

Store a new set of params (other than defaults or those passed in with constructor).

Protected Member Functions

buildButtonBox ()

Build a box containing the action buttons. This box floats right and is intended to be added to the header/title section of a review view.

layoutReviewBox ()

Layout the different components making up a review. Choose whether to add the different components to this object based on the appearance variable.

Detailed Description

A TK View to display a CSERDClassicReview object.

Author:: jwsm@shodor.org

Date:: 2/25/09

Definition at line 8 of file TKCSERDClassicReview.php5.

Constructor & Destructor Documentation

TKCSERDClassicReview::__construct	(	$	review,
		$	params = `array()`
	)

Constructor.

Parameters:

	$review	[CSERDClassicReview]: The review to be viewed
	$params	[array]: Additional parameters for how this object should appear 'appearance' => full/compact/minimal (how in-depth is the display) 'showButtons' => true/false (show action buttons in the display?) 'landingURL' => SiteURL constant (force a landing URL to be set when one of the action buttons is clicked)

Definition at line 31 of file TKCSERDClassicReview.php5.

Member Function Documentation

TKCSERDClassicReview::buildButtonBox ( ) [protected]

Build a box containing the action buttons. This box floats right and is intended to be added to the header/title section of a review view.

Returns:: [TKNullBox]: The box containing the buttons

Definition at line 122 of file TKCSERDClassicReview.php5.

Referenced by layoutReviewBox().

TKCSERDClassicReview::render ( )

Converts this component (and any children) to HTML.

This will only actually generate the HTML once. If render() has been called before, this will only return the results of the previous render operation.

Returns:: [string] HTML from rendering, or false if there was an error rendering

Reimplemented from TKComponent.

Definition at line 207 of file TKCSERDClassicReview.php5.

References layoutReviewBox().

TKCSERDClassicReview::setAppearance ( $ app )

Set the appearance for this view.

Parameters:

$app

[string]: full/compact/minimal

Definition at line 45 of file TKCSERDClassicReview.php5.

The documentation for this class was generated from the following file:

sdr/ui/tk/TKCSERDClassicReview.php5


Public Member Functions
	__construct ($review, $params=array())
	Constructor.
	render ()
	Converts this component (and any children) to HTML.
	setAppearance ($app)
	Set the appearance for this view.
	setParams ($params)
	Store a new set of params (other than defaults or those passed in with constructor).
Protected Member Functions
	buildButtonBox ()
	Build a box containing the action buttons. This box floats right and is intended to be added to the header/title section of a review view.
	layoutReviewBox ()
	Layout the different components making up a review. Choose whether to add the different components to this object based on the appearance variable.