SingleChoiceVariable
in package
implements
ClosedVariableInterface
uses
GetName, GetTitle, GetRawConfiguration
Read onlyYes
FinalYes
Table of Contents
Interfaces
Properties
- $dataPath : array<string|int, mixed>
- $measure : Measure
- $name : string
- $rawConfiguration : array<string|int, mixed>
- $titles : array<string|int, mixed>
- $valueMap : array<int|string, ValueOptionInterface>
- We can say this is non-empty, since valueoptions is non-empty, and this is a direct mapping from valueoptions
Methods
- __construct() : mixed
- getMeasure() : Measure
- getName() : string
- getNumberOfOptions() : int
- getOptions() : array<int, ValueOptionInterface>
- getRawConfigurationValue() : mixed
- getTitle() : string
- getValue() : ValueOptionInterface|SpecialValueInterface
Properties
$dataPath
private
array<string|int, mixed>
$dataPath
$measure
private
Measure
$measure
= Measure::Nominal
$name
private
string
$name
$rawConfiguration
private
array<string|int, mixed>
$rawConfiguration
= []
$titles
private
array<string|int, mixed>
$titles
= []
$valueMap
We can say this is non-empty, since valueoptions is non-empty, and this is a direct mapping from valueoptions
private
array<int|string, ValueOptionInterface>
$valueMap
Methods
__construct()
public
__construct(string $name, array<int, ValueOptionInterface> $options, array<int, string> $dataPath[, array<string|int, mixed> $rawConfiguration = [] ][, array<string, string> $titles = [] ][, Measure $measure = Measure::Nominal ]) : mixed
Parameters
- $name : string
- $options : array<int, ValueOptionInterface>
- $dataPath : array<int, string>
- $rawConfiguration : array<string|int, mixed> = []
- $titles : array<string, string> = []
- $measure : Measure = Measure::Nominal
getMeasure()
public
getMeasure() : Measure
Return values
MeasuregetName()
public
getName() : string
Return values
stringgetNumberOfOptions()
public
getNumberOfOptions() : int
Return values
intgetOptions()
public
getOptions() : array<int, ValueOptionInterface>
Return values
array<int, ValueOptionInterface>getRawConfigurationValue()
public
getRawConfigurationValue(string|int $key) : mixed
Parameters
- $key : string|int
getTitle()
public
getTitle([string|null $locale = null ]) : string
Parameters
- $locale : string|null = null
Return values
stringgetValue()
public
getValue(RecordInterface $record) : ValueOptionInterface|SpecialValueInterface
Parameters
- $record : RecordInterface