CSValueRangeValue
in package
This class represents a specific value of the ValueRange concept as you can find it in the backend settings dialog
Tags
Table of Contents
- __call() : mixed|null
- Forward API methods to the record object.
- __construct() : mixed
- The constructor
- delete() : mixed
- Deletes the current ValueRangeValue
- getExternalKey() : string
- Returns the ExternalKey of this value
- getIcon() : string
- Returns the custom icon configured for this value range value.
- getID() : int
- Returns the ID of this value
- getIsFolder() : bool
- Returns whether this value is a folder
- getParentID() : int
- Returns the ParentID of this value
- getSortOrders() : array<string|int, mixed>
- Returns all defined ValueRangeValue sort orders of this value
- getValue() : string
- Returns a value for a given key
- getValueRangeType() : CSValueRangeType
- Returns the CSValueRangeType of this value
- getValueRangeTypeID() : int
- Returns the CSValueRangeType ID of this value
- getValues() : array<string|int, mixed>
- Returns all defined ValueRangeValue values (not the database record values) of this value
- setExternalKey() : mixed
- Sets the External Key
- setIsFolder() : mixed
- Sets whether this value is a folder
- setParentID() : mixed
- Sets the ParentID of the value
- setValue() : mixed
- Sets a ValueRangeValue value to the given value for a given language.
- setValues() : mixed
- Sets all defined ValueRangeValue values (not the database record values) of this value
- store() : mixed
- Stores the current ValueRangeValue
Methods
__call()
Forward API methods to the record object.
public
__call(string $sMethodName, mixed $aMethodParams) : mixed|null
Parameters
- $sMethodName : string
- $aMethodParams : mixed
Tags
Return values
mixed|null —__construct()
The constructor
public
__construct(int|ValueRangeValue $record) : mixed
Parameters
- $record : int|ValueRangeValue
-
An ID as int or a ValueRangeValue database object
Tags
Return values
mixed —delete()
Deletes the current ValueRangeValue
public
delete() : mixed
Tags
Return values
mixed —getExternalKey()
Returns the ExternalKey of this value
public
getExternalKey() : string
Tags
Return values
string —the ExternalKey
getIcon()
Returns the custom icon configured for this value range value.
public
getIcon() : string
Tags
Return values
string —The custom icon path
getID()
Returns the ID of this value
public
getID() : int
Tags
Return values
int —ID
getIsFolder()
Returns whether this value is a folder
public
getIsFolder() : bool
Tags
Return values
bool —whether this value is a folder
getParentID()
Returns the ParentID of this value
public
getParentID() : int
Tags
Return values
int —the ID of the values parent
getSortOrders()
Returns all defined ValueRangeValue sort orders of this value
public
getSortOrders() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of values in the form [LanguageID] => [SortOrder]
getValue()
Returns a value for a given key
public
getValue([string $mLangOrKey = null ]) : string
Parameters
- $mLangOrKey : string = null
-
the optional languageID or the fieldname as string. If the language is set the database value for this key is returned. Otherwise the label for the current language.
Tags
Return values
string —the content of the requested value
getValueRangeType()
Returns the CSValueRangeType of this value
public
getValueRangeType() : CSValueRangeType
Tags
Return values
CSValueRangeType —the corresponding type
getValueRangeTypeID()
Returns the CSValueRangeType ID of this value
public
getValueRangeTypeID() : int
Tags
Return values
int —the ID of this values CSValueRangeType
getValues()
Returns all defined ValueRangeValue values (not the database record values) of this value
public
getValues() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of values in the form [LanguageID] => [Value]
setExternalKey()
Sets the External Key
public
setExternalKey(string $sKey) : mixed
Parameters
- $sKey : string
-
the new External Key
Tags
Return values
mixed —setIsFolder()
Sets whether this value is a folder
public
setIsFolder(bool $bIsFolder) : mixed
Parameters
- $bIsFolder : bool
-
whether this value is a folder
Tags
Return values
mixed —setParentID()
Sets the ParentID of the value
public
setParentID(int $iParentId) : mixed
Parameters
- $iParentId : int
-
the new ParentID
Tags
Return values
mixed —setValue()
Sets a ValueRangeValue value to the given value for a given language.
public
setValue(string $sValue[, int $mLanguageId = null ]) : mixed
Parameters
- $sValue : string
-
the new value
- $mLanguageId : int = null
-
the LanguageID for which the value should be set (if not set the ID of the default language is used)
Tags
Return values
mixed —setValues()
Sets all defined ValueRangeValue values (not the database record values) of this value
public
setValues(mixed $aValues) : mixed
Parameters
- $aValues : mixed
Tags
Return values
mixed —store()
Stores the current ValueRangeValue
public
store() : mixed