Class Scenario_Result

Description

Result object

Essentially a storage object for all data related to a given result.

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

Located in /Scenario/Result.php (line 32)


	
			
Variable Summary
Method Summary
Scenario_Result __construct ( $experiment,  $treatment,  $identity,  $completed)
Scenario_Experiment getExperiment ([bool $tryResolve = true])
bool isCompleted ()
void setExperiment (mixed $value)
void setIdentity (mixed $value)
void setTreatment (mixed $value)
Variables
bool $_completed (line 44)
  • access: protected
mixed $_experiment (line 57)

Experiment. May be a string or Scenario_Experiment object.

  • access: protected
Scenario_Identity $_ident (line 38)
  • access: protected
Scenario_Treatment $_treatment (line 50)
  • access: protected
Methods
Constructor __construct (line 59)
  • access: public
Scenario_Result __construct ( $experiment,  $treatment,  $identity,  $completed)
  • $experiment
  • $treatment
  • $identity
  • $completed
getCore (line 177)

Gets the core reference appropriate to this instance.

  • todo: Use a reference to the core rather than the singleton.
  • access: public
Scenario_Core getCore ()
getExperiment (line 80)

Gets the associated experiment, optionally resolving it to an object if it's a string.

  • return: The experiment associated with this result.
  • access: public
Scenario_Experiment getExperiment ([bool $tryResolve = true])
  • bool $tryResolve: (Optional) Whether the experiment should be resolved to an object if it is a string.
getIdentity (line 114)

Returns the identity associated with this result.

  • access: public
Scenario_Identity getIdentity ()
getTreatment (line 96)

Returns the treatment associated with this result.

  • access: public
Scenario_Treatment getTreatment ()
isCompleted (line 70)
  • return: Whether the treatment was completed or not.
  • access: public
bool isCompleted ()
setExperiment (line 123)

Set the associated experiment.

  • access: public
void setExperiment (mixed $value)
  • mixed $value: Must be null, a string, or an instance of Scenario_Experiment
setIdentity (line 159)

Set the associated identity.

  • access: public
void setIdentity (mixed $value)
  • mixed $value: Must be null, a string, or an instance of Scenario_Identity.
setTreatment (line 140)

Set the associated treatment.

  • access: public
void setTreatment (mixed $value)
  • mixed $value: Must be a null, a string, or an instance of Scenario_Treatment.

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