SoPHIE API Documentation

Type API Documentation

SoPHIE Type API Class

The Type API provides type related functionality within
the execution context.

Init: $typeApi = $api->get('sophie_type');

Method: $typeApi->getTypes(...)

Get an array of types within the treatment.

The method returns an array of labels of all types within a treatment.

Returns Array Array of types

Method: $typeApi->getTypeLabels(...)

Get an array of labels of types within the treatment.

The method returns an array of labels of all types within a treatment.

Returns Array Array of type labels

Method: $typeApi->getTypeNamesAssoc(...)

Get an associative array of type names with label as key within the treatment.

The method returns an array of names of all types within a treatment with the type label as the key.

Returns Array Assoc array of type names

Method: $typeApi->getTypeName(...)

Get the full type name from the label

The method returns the type name

Parameters:

  • String typeLabel

Returns Array Array of type labels