Class DynamicOutputVariable

Description
Description | Methods (details)

Used by PhpMyCellScript addons to request a variable dynamically from the interpreter for output.

The logic for requesting a variable dynamically:

  1. The interpreter calls an addon instruction method with a new DynamicOutputVariable object.
  2. The addon instruction method requests a variable through the DynamicOutputVariable object, then returns control to the interpreter.
  3. The interpreter sets the DynamicOutputVariable object for the variable requested, then calls the addon instruction method again.
  4. The addon instruction method processes the instruction, then returns control to the interpreter.
  5. The interpreter updates the variable value if needed.

Located in /PhpMyCellScript/DynamicOutputVariable.php (line 20) 

OutputVariable
   |
   --DynamicOutputVariable
Method Summary
Description | Methods (details)
string getRequestedVariableName ()
void requestVariable (string $variable_name)
void setValue (mixed $value)
Methods
Description | Methods (details)
getRequestedVariableName (line 31)

Get the requested variable name.

  • return: the requested variable name.
string getRequestedVariableName ()
requestVariable (line 39)

Used by an addon to request a variable dynamically from the interpreter.

void requestVariable (string $variable_name)
  • string $variable_name: The name of the variable.
setValue (line 47)

Set the value of the variable, or the requested variable.

void setValue (mixed $value)
  • mixed $value: the value.
Redefinition of:
OutputVariable::setValue()
Set the value of the variable.

Inherited Methods

Inherited From OutputVariable

OutputVariable::__construct()
OutputVariable::assignValue()
OutputVariable::getValue()
OutputVariable::getVariableName()
OutputVariable::isUpdated()
OutputVariable::setValue()
OutputVariable::setVariableName()

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