SoPHIE API Documentation

Stepgroup API Documentation

SoPHIE Stepgroup API Class

The Stepgroup API provides access to stepgroup defintions in a treatment definition.

Init: $stepgroupApi = $api->get('sophie_stepgroup');

Method: $stepgroupApi->get(...)

Get the stepgroup definition identified by the stepgroup label

Parameters:

  • string $label

Returns array|null

Method: $stepgroupApi->getLabels(...)

Get an array of labels of stepgroups within the treatment.

The method returns an array of labels of all stepgroups within a treatment ordered by position.

Returns Array Array of stepgroup labels

Method: $stepgroupApi->getList(...)

Get an array of stepgroups within the treatment.

The method returns an array of stepgroups within a treatment ordered by position.

Parameters:

  • $options

Returns Array Array of stepgroup labels

Method: $stepgroupApi->getLoops(...)

Get number of loops for a stepgroup identified by the stepgroup label

Parameters:

  • string $label Label of the stepgroup to get the loop number for. Defaults to %current%

Returns Integer|null

Method: $stepgroupApi->translateLabel(...)

Translate a special stepgroup label returning the actual label

Parameters:

  • String $stepgroupLabel

Returns String|null

Method: $stepgroupApi->translateLoop(...)

Translate a special stepgroup loop returning the actual loop

Parameters:

  • String|Integer $stepgroupLoop

Returns Integer|null