Class OutputVariable

Description

Used by the PhpMyCellScript interpreter to get the output value of a variable parameter from an instruction method provided by an addon.

Located in /PhpMyCellScript/OutputVariable.php (line 9)


	
			
Direct descendents
Class Description
DynamicOutputVariable Used by PhpMyCellScript addons to request a variable dynamically from the interpreter for output.
Method Summary
OutputVariable __construct ([string $variable_name = null], [mixed $value = null])
mixed assignValue (mixed $value)
mixed getValue ()
string getVariableName ()
boolean isUpdated ()
void setValue (mixed $value)
void setVariableName (string $variable_name)
Methods
Constructor __construct (line 33)

Constructor

OutputVariable __construct ([string $variable_name = null], [mixed $value = null])
  • string $variable_name: A variable name.
  • mixed $value: The value of the variable.
assignValue (line 76)

Set and then return the value of the variable.

  • return: the value.
mixed assignValue (mixed $value)
  • mixed $value: the value.
getValue (line 58)

Get the value of the variable.

  • return: the value.
mixed getValue ()
getVariableName (line 42)

Get the variable name.

  • return: the variable name.
string getVariableName ()
isUpdated (line 85)

Check whether the value is updated.

  • return: true/false
boolean isUpdated ()
setValue (line 66)

Set the value of the variable.

void setValue (mixed $value)
  • mixed $value: the value.

Redefined in descendants as:
setVariableName (line 50)

Set the variable name.

  • access: protected
void setVariableName (string $variable_name)
  • string $variable_name: the variable name.

Documentation generated on Sun, 01 Mar 2015 08:43:49 +0000 by phpDocumentor 1.4.3