Class Scenario_Renderer_Abstract

Description

Renderer abstract

Defines the basic structure of a renderer object that should be passed to Scenario_ResultSet rendering methods, or used by itself.

  • copyright: Copyright (c) 2010 TK Studios. (http://www.tkstudios.com)
  • abstract:
  • license: New BSD License

Located in /Scenario/Renderer/Abstract.php (line 33)


	
			
Direct descendents
Class Description
Scenario_Renderer_Xml XML / XSLT resultset renderer.
Variable Summary
array $_params
Method Summary
Scenario_Renderer_Abstract __construct ([array $options = array()])
void clearParam (string $name)
mixed getParam (string $name)
array getParams ()
void renderSet (Scenario_ResultSet $results)
void setParam (string $name, mixed $value)
void setParams ([ $params = array()], [ $clearFirst = false])
Variables
array $_params (line 40)

Array of key=>value parameters/options.

  • access: protected
Methods
Constructor __construct (line 45)
  • access: public
Scenario_Renderer_Abstract __construct ([array $options = array()])
  • array $options: The options for this renderer.

Redefined in descendants as:
clearParam (line 89)

Unset a specific parameter.

  • access: public
void clearParam (string $name)
  • string $name: The parameter to unset.
getParam (line 100)

Retrieve a parameter from the renderer's settings.

  • return: The value of the specified parameter, or null if it does not exist.
  • access: public
mixed getParam (string $name)
  • string $name: Name of the parameter to retrieve.
getParams (line 68)

Return the current parameter array.

  • access: public
array getParams ()
renderSet (line 111)

renderSet

Render the resultset of a single experiment

  • abstract:
  • access: public
void renderSet (Scenario_ResultSet $results)

Redefined in descendants as:
setParam (line 78)

Set a specific parameter.

  • access: public
void setParam (string $name, mixed $value)
  • string $name: Key for the associated value.
  • mixed $value: Value to set.
setParams (line 54)

Set parameters to pass to aggregator and render function. Overwrites current params.

  • access: public
void setParams ([ $params = array()], [ $clearFirst = false])
  • array $params: Parameters to set (key => value)
  • $clearFirst

Documentation generated on Sat, 23 Oct 2010 18:10:43 -0400 by phpDocumentor 1.4.3