SoPHIE API Documentation

Process API Documentation

SoPHIE Participant API Class

The Participant API provides participant related functionality within
a given execution context.

Init: $processApi = $api->get('sophie_process');

Method: $processApi->translateStepgroupLabel(...)

Translate a special stepgroup label returning the actual label

Parameters:

  • String $stepgroupLabel

Returns String|null

Method: $processApi->translateStepLabel(...)

Translate a special step label returning the actual label

Parameters:

  • String $stepLabel

Returns String|null

Method: $processApi->translateStepgroupLoop(...)

Translate a special stepgroup loop returning the actual loop

Parameters:

  • String|Integer $stepgroupLoop

Returns Integer|null

Method: $processApi->initializeParticipant(...)

Method: $processApi->transferParticipantToNextStep(...)

Transfer a participant to the step that is next in relation to the current context. Participant defaults to the current participant within the context.

Parameters:

  • String $participantLabel

Returns Boolean True if the transfer succeeds, false otherwise.

Method: $processApi->transferParticipantToNextStepgroup(...)

Transfer a participant to the first step in the stepgroup that is next in relation to the current context. Participant defaults to the current participant within the context.

Parameters:

  • String $participantLabel

Returns Boolean True if the transfer succeeds, false otherwise.

Method: $processApi->transferParticipantToNextStepgroupLoop(...)

Transfer a participant to the first step in the current stepgroup that is next in relation to the current context and increases stepgroup loop counter by one. Participant defaults to the current participant within the context.

Parameters:

  • String $participantLabel

Returns Boolean True if the transfer succeeds, false otherwise.

Method: $processApi->transferParticipantToStep(...)

Transfer a participant to the specified step. StepgroupLoop defaults to 1. Participant defaults to the current participant within the context.

Parameters:

  • String $stepLabel
  • Integer $stepgroupLoop
  • String $participantLabel

Returns Boolean True if setting the step succeeds, false otherwise.

Method: $processApi->transferGroupToNextStep(...)

Transfer all participant from a group to the step that is next in relation to the current context. Group defaults to the current group within the context.

Parameters:

  • String $groupLabel

Returns Boolean True if the transfer succeeds for all participants, false otherwise.

Method: $processApi->transferGroupToStep(...)

Transfer all participant from a group to the specified step. StepgroupLoop defaults to 1. Group defaults to the current group within the context.

Parameters:

  • String $stepLabel
  • Integer $stepgroupLoop
  • String $groupLabel

Returns Boolean True if setting the step succeeds for all participants, false otherwise.

Method: $processApi->transferTypeToNextStep(...)

Transfer all participant from a type to the step that is next in relation to the current context. Type defaults to the current type within the context.

Parameters:

  • String $groupLabel

Returns Boolean True if the transfer succeeds for all participants, false otherwise.

Method: $processApi->transferTypeToStep(...)

Transfer all participant from a type to the specified step. StepgroupLoop defaults to 1. Type defaults to the current type within the context.

Parameters:

  • String $stepLabel
  • Integer $stepgroupLoop
  • String $typeLabel

Returns Boolean True if setting the step succeeds for all participants, false otherwise.

Method: $processApi->transferEveryoneToNextStep(...)

Transfer all participant to the step that is next in relation to the current context.

Returns Boolean True if the transfer succeeds for all participants, false otherwise.

Method: $processApi->transferEveryoneToStep(...)

Transfer all participant to the specified step. StepgroupLoop defaults to 1.

Parameters:

  • String $stepLabel
  • Integer $stepgroupLoop

Returns Boolean True if setting the step succeeds for all participants, false otherwise.