JavascriptVariableInterface
extends
VariableInterface
in
This interface extends the variable interface and adds methods for doing the annotation on the client side.
Table of Contents
- getDisplayValue() : StringValueInterface
- Extract a display value from a record If a locale is given the display value should be returned using the given locale. If the locale is not available a fallback MUST be used and an exeception MUST NOT be thrown
- getJavascriptRepresentation() : string
- This creates a plain javascript object with the following structure: { getName(): string, getTitle(string|null locale): string, getValue(dict record): TBD, getMeasure(): nominal|ordinal|scale getDisplayValue(dict record, string|null locale): string }
- getMeasure() : Measure
- Return the type of measure for this variable
- getName() : string
- getRawConfigurationValue() : mixed
- getTitle() : string
- getValue() : ValueInterface|ValueSetInterface
- Extracts the variable value from a record
Methods
getDisplayValue()
Extract a display value from a record If a locale is given the display value should be returned using the given locale. If the locale is not available a fallback MUST be used and an exeception MUST NOT be thrown
public
getDisplayValue(RecordInterface $record[, null|string $locale = null ]) : StringValueInterface
Parameters
- $record : RecordInterface
- $locale : null|string = null
Return values
StringValueInterface —getJavascriptRepresentation()
This creates a plain javascript object with the following structure: { getName(): string, getTitle(string|null locale): string, getValue(dict record): TBD, getMeasure(): nominal|ordinal|scale getDisplayValue(dict record, string|null locale): string }
public
getJavascriptRepresentation() : string
Return values
string —getMeasure()
Return the type of measure for this variable
public
getMeasure() : Measure
Return values
Measure —getName()
public
getName() : string
Return values
string —A unique identifier for the variable
getRawConfigurationValue()
public
getRawConfigurationValue(string $key) : mixed
Parameters
- $key : string
Return values
mixed —getTitle()
public
getTitle([null|string $locale = null ]) : string
Parameters
- $locale : null|string = null
Return values
string —The title text in the default language If a locale is given the display value should be returned using the given locale. If the locale is not available a fallback MUST be used and an exeception MUST NOT be thrown
getValue()
Extracts the variable value from a record
public
getValue(RecordInterface $record) : ValueInterface|ValueSetInterface
Parameters
- $record : RecordInterface