Step API Documentation
SoPHIE Step API Class
The Step API provides access to step defintions in a treatment definition.
Init: $stepApi = $api->get('sophie_step');
Method: $stepApi->get(...)
Get the step definition identified by the step label
Parameters:
- string $label
Returns array|null
Method: $stepApi->getStepgroupLabel(...)
Get the stepgroup label by the step label
Parameters:
- string $label
Returns null|String
Method: $stepApi->getLabels(...)
Get an array of labels of steps within the treatment (optionally for a specific stepgroup).
The method returns an array of labels of all steps within a treatment ordered by position optionally for a specific steptype.
Parameters:
- $options
Returns Array of step labels
Method: $stepApi->getList(...)
Get an array of steps within the treatment (optionally for a specific stepgroup).
The method returns an array of all steps within a treatment ordered by position optionally for a specific steptype.
Parameters:
- $options
Returns Array of steps
Method: $stepApi->isActive(...)
Get the active setting for a step identified by the step label
Parameters:
- string $label Label of the step to get the active setting for. Defaults to %current%
Returns boolean|null
Method: $stepApi->getById(...)
Get the step definition identified by the step id
Parameters:
- Integer $id
Returns array|null
Method: $stepApi->getLabelById(...)
Translate a step id returning the step label
Parameters:
- Integer $id
Returns String|null
Method: $stepApi->translateLabel(...)
Translate a special step label returning the actual label
Parameters:
- String $label
Returns String|null
Method: $stepApi->setRuntimeAttribute(...)
Set a step attribute runtime value
Parameters:
- string $attributeName
- mixed $attributeValue
Returns boolean
Method: $stepApi->getRuntimeAttributes(...)
Get all step attribute runtime values
Returns Array
Method: $stepApi->getRuntimeAttribute(...)
Get a step attribute runtime value
Parameters:
- string $attributeName
Returns mixed
Method: $stepApi->resetRuntimeAttribute(...)
Reset a step attribute runtime value to the initial configuration value
Parameters:
- string $attributeName
Returns boolean
Method: $stepApi->getAttributes(...)
Get all step attribute configuration values
Returns mixed
Method: $stepApi->getAttribute(...)
Get a step attribute configuration value
Parameters:
- string $attributeName
Returns mixed