Variable API Documentation
SoPHIE Variable API Class
The Variable API provides methods to interact with SoPHIE's variable system
Getter and Setter Functions follow the form:
get/set + person context + procedural context
Init: $variableApi = $api->get('sophie_variable');
Method: $variableApi->getEE(...)
Get the value of a everyone and everywhere context variable
Parameters:
- $name
- null $cast
Returns mixed
Method: $variableApi->setEE(...)
Set the value of a everyone and everywhere context variable
Parameters:
- $name
- $value
- null $cast
Returns mixed
Method: $variableApi->incEE(...)
Increment the value of a everyone and everywhere context variable by a number or by one on default
Parameters:
- $name
- $by
Method: $variableApi->decEE(...)
Decrement the value of an everyone and everywhere context variable by a number or by one on default
Parameters:
- $name
- $by
Method: $variableApi->unsetEE(...)
Unset the value of a everyone and everywhere context variable
Parameters:
- $name
Method: $variableApi->getES(...)
Get the value of a everyone and stepgroup context variable
Parameters:
- $name
- string $stepgroupLabel
- null $cast
Returns mixed
Method: $variableApi->setES(...)
Set the value of a everyone and stepgroup context variable
Parameters:
- $name
- $value
- string $stepgroupLabel
- null $cast
Returns mixed
Method: $variableApi->incES(...)
Increment the value of a everyone and stepgroup context context variable by a number or by one on default
Parameters:
- $name
- string $stepgroupLabel
- $by
Method: $variableApi->decES(...)
Decrement the value of an everyone and stepgroup context variable by a number or by one on default
Parameters:
- $name
- string $stepgroupLabel
- $by
Method: $variableApi->unsetES(...)
Unset the value of a everyone and stepgroup context variable
Parameters:
- $name
- string $stepgroupLabel
Method: $variableApi->getESL(...)
Get the value of a everyone and stepgroup loop context variable
Parameters:
- $name
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns mixed
Method: $variableApi->setESL(...)
Set the value of a everyone and stepgroup loop context variable
Parameters:
- $name
- $value
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns mixed
Method: $variableApi->incESL(...)
Increment the value of a everyone and stepgroup loop context variable by a number or by one on default
Parameters:
- $name
- string $stepgroupLabel
- string $stepgroupLoop
- $by
Method: $variableApi->decESL(...)
Decrement the value of an everyone and stepgroup loop context variable by a number or by one on default
Parameters:
- $name
- string $stepgroupLabel
- string $stepgroupLoop
- $by
Method: $variableApi->unsetESL(...)
Unset the value of a everyone and stepgroup loop context variable
Parameters:
- $name
- string $stepgroupLabel
- string $stepgroupLoop
Method: $variableApi->getGE(...)
Get the value of a group and everywhere context variable
Parameters:
- $name
- string $groupLabel
- null $cast
Returns mixed
Method: $variableApi->setGE(...)
Set the value of a group and everywhere context variable
Parameters:
- $name
- $value
- null $groupLabel
- null $cast
Returns mixed
Method: $variableApi->incGE(...)
Increment the value of a group and everywhere context variable by a number or by one on default
Parameters:
- $name
- null $groupLabel
- $by
Method: $variableApi->decGE(...)
Decrement the value of a group and everywhere context variable by a number or by one on default
Parameters:
- $name
- null $groupLabel
- $by
Method: $variableApi->unsetGE(...)
Unset the value of a group and everywhere context variable
Parameters:
- $name
- null $groupLabel
Method: $variableApi->getGS(...)
Get the value of a group and stepgroup context variable
Parameters:
- $name
- null $groupLabel
- null $stepgroupLabel
- null $cast
Returns mixed
Method: $variableApi->setGS(...)
Set the value of a group and stepgroup context variable
Parameters:
- $name
- $value
- null $groupLabel
- null $stepgroupLabel
- null $cast
Returns mixed
Method: $variableApi->incGS(...)
Increment the value of a group and stepgroup context variable by a number or by one on default
Parameters:
- $name
- null $groupLabel
- null $stepgroupLabel
- $by
Method: $variableApi->decGS(...)
Decrement the value of an group and stepgroup context variable by a number or by one on default
Parameters:
- $name
- null $groupLabel
- null $stepgroupLabel
- $by
Method: $variableApi->unsetGS(...)
Unset the value of a group and stepgroup context variable
Parameters:
- $name
- null $groupLabel
- null $stepgroupLabel
Method: $variableApi->getGSL(...)
Get the value of a group and stepgroup loop context variable
Parameters:
- $name
- string $groupLabel
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns mixed
Method: $variableApi->setGSL(...)
Set the value of a group and stepgroup loop context variable
Parameters:
- $name
- $value
- string $groupLabel
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns mixed
Method: $variableApi->incGSL(...)
Increment the value of a group and stepgroup loop context variable by a number or by one on default
Parameters:
- $name
- string $groupLabel
- string $stepgroupLabel
- string $stepgroupLoop
- $by
Method: $variableApi->decGSL(...)
Decrement the value of an group and stepgroup loop context variable by a number or by one on default
Parameters:
- $name
- string $groupLabel
- string $stepgroupLabel
- string $stepgroupLoop
- $by
Method: $variableApi->unsetGSL(...)
Unset the value of a group and stepgroup loop context variable
Parameters:
- $name
- string $groupLabel
- string $stepgroupLabel
- string $stepgroupLoop
Method: $variableApi->getPE(...)
Get the value of a participant and everywhere context variable
Parameters:
- $name
- string $participantLabel
- null $cast
Returns mixed
Method: $variableApi->setPE(...)
Set the value of a participant and everywhere context variable
Parameters:
- $name
- $value
- string $participantLabel
- null $cast
Returns mixed
Method: $variableApi->incPE(...)
Increment the value of a participant and everywhere context variable by a number or by one on default
Parameters:
- $name
- string $participantLabel
- $by
Method: $variableApi->decPE(...)
Decrement the value of an participant and everywhere context variable by a number or by one on default
Parameters:
- $name
- string $participantLabel
- $by
Method: $variableApi->unsetPE(...)
Unset the value of a participant and everywhere context variable
Parameters:
- $name
- string $participantLabel
Method: $variableApi->getPS(...)
Get the value of a participant and stepgroup context variable
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- null $cast
Returns mixed
Method: $variableApi->setPS(...)
Set the value of a participant and stepgroup context variable
Parameters:
- $name
- $value
- string $participantLabel
- string $stepgroupLabel
- null $cast
Returns mixed
Method: $variableApi->incPS(...)
Increment the value of a participant and stepgroup context variable by a number or by one on default
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- $by
Method: $variableApi->decPS(...)
Decrement the value of an participant and stepgroup context variable by a number or by one on default
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- $by
Method: $variableApi->unsetPS(...)
Unset the value of a participant and stepgroup context variable
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- null $cast
Method: $variableApi->getPSL(...)
Get the value of a participant and stepgroup loop context variable
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns mixed
Method: $variableApi->setPSL(...)
Set the value of a participant and stepgroup loop context variable
Parameters:
- $name
- $value
- string $participantLabel
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns mixed
Method: $variableApi->incPSL(...)
Increment the value of a participant and stepgroup loop context variable by a number or by one on default
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- string $stepgroupLoop
- $by
Method: $variableApi->decPSL(...)
Decrement the value of an participant and stepgroup loop context variable by a number or by one on default
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- string $stepgroupLoop
- $by
Method: $variableApi->unsetPSL(...)
Unset the value of a participant and stepgroup loop context variable
Parameters:
- $name
- string $participantLabel
- string $stepgroupLabel
- string $stepgroupLoop
Method: $variableApi->mgetEE(...)
Get the values of a list of everyone and everywhere context variables
Parameters:
- $names array
- null $cast
Returns array
Method: $variableApi->mgetES(...)
Get the values of a list of everyone and stepgroup context variables
Parameters:
- $names array
- string $stepgroupLabel
- null $cast
Returns array
Method: $variableApi->mgetESL(...)
Get the values of a list of everyone and stepgroup loop context variables
Parameters:
- $names array
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns array
Method: $variableApi->mgetGE(...)
Get the values of a list of group and everywhere context variables
Parameters:
- $names array
- string $groupLabel
- null $cast
Returns array
Method: $variableApi->mgetGS(...)
Get the values of a list of group and stepgroup context variables
Parameters:
- $names array
- null $groupLabel
- null $stepgroupLabel
- null $cast
Returns array
Method: $variableApi->mgetGSL(...)
Get the values of a list of group and stepgroup loop context variables
Parameters:
- $names array
- string $groupLabel
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns array
Method: $variableApi->mgetPE(...)
Get the values of a list of participant and everywhere context variables
Parameters:
- $names array
- string $participantLabel
- null $cast
Returns array
Method: $variableApi->mgetPS(...)
Get the values of a list of participant and stepgroup context variables
Parameters:
- $names array
- string $participantLabel
- string $stepgroupLabel
- null $cast
Returns array
Method: $variableApi->mgetPSL(...)
Get the values of a list of participant and stepgroup loop context variables
Parameters:
- $names array
- string $participantLabel
- string $stepgroupLabel
- string $stepgroupLoop
- null $cast
Returns array
Method: $variableApi->importArrays(...)
Import variables from a numerical array of arrays
Parameters:
- $variables array