CSValueRangeType
in package
This class represents a type of value ranges as you can find it in the backend settings dialog
Tags
Table of Contents
- __call() : mixed
- Forward methods, that are not existing, to the record.
- __construct() : mixed
- The constructor
- addRangeValue() : CSValueRangeValue
- Creates and adds a new CSValueRangeValue
- delete() : mixed
- Deletes this type
- getAuthor() : null|string
- Return valid Author information (Name) of the User
- getCategory() : string
- Gets the category of the type
- getCreationDate() : string
- Returns 'CreationDate' time
- getDescription() : string
- Returns the description of the type
- getHasIcon() : bool
- Returns whether this type has icons
- getID() : int
- Returns the ID of the type
- getIsLanguageDependant() : bool
- Returns whether this type is language dependant
- getLabel() : string
- Returns the Label of the type
- getLastChange() : string
- Returns 'LastChange' time
- getLastEditor() : null|string
- Return valid LastEditor information (Name) of the User
- getRangeValues() : array<string|int, CSValueRangeValue>
- Returns all CSValueRangeValues for this type
- getValue() : string
- Returns a value of this type
- isManuallySorted() : bool
- Returns whether this type is manual sorted
- setCategory() : mixed
- Sets the category of the type
- setDescription() : mixed
- Sets the description of the type
- setHasIcon() : mixed
- Set this type to support icons
- setLabel() : mixed
- Sets a new label
- setLanguageDependant() : mixed
- Marks this type as languageDependant
- setManualSorting() : mixed
- Set this type to support icons
- setValue() : mixed
- Sets a value of this type
- store() : mixed
- Stores this type
Methods
__call()
Forward methods, that are not existing, to the record.
public
__call(string $sMethodName, mixed $aMethodParams) : mixed
Parameters
- $sMethodName : string
- $aMethodParams : mixed
Tags
Return values
mixed —__construct()
The constructor
public
__construct(mixed $record) : mixed
Parameters
- $record : mixed
-
either an ID as int or a ValueRangeType database object
Tags
Return values
mixed —addRangeValue()
Creates and adds a new CSValueRangeValue
public
addRangeValue(string $externalKey[, array<string|int, CSValueRangeLanguageValue>|array<string|int, mixed>|string $values = array() ], int $parentID, int $isFolder[, int $valueRangeValueID = null ][, string $sIcon = '' ]) : CSValueRangeValue
Parameters
- $externalKey : string
-
the External Key
- $values : array<string|int, CSValueRangeLanguageValue>|array<string|int, mixed>|string = array()
-
The value range values which should be created. Expected format if the range type is language independent:
- (string) Value
- (object) CSValueRangeLanguageValue
Expected format if the range type is language dependent:
- (array) array(LanguageID => Value)
- (array) array(CSValueRangeLanguageValue, CSValueRangeLanguageValue)
- $parentID : int
-
the ParentID
- $isFolder : int
-
whether the new value is a folder
- $valueRangeValueID : int = null
-
an optional ID to insert this value with - it must not be defined in the database
- $sIcon : string = ''
-
The icon to be used for each value
Tags
Return values
CSValueRangeValue —delete()
Deletes this type
public
delete() : mixed
Tags
Return values
mixed —getAuthor()
Return valid Author information (Name) of the User
public
getAuthor() : null|string
Tags
Return values
null|string —NULL if not valid or Name of the user
getCategory()
Gets the category of the type
public
getCategory() : string
Tags
Return values
string —the category
getCreationDate()
Returns 'CreationDate' time
public
getCreationDate() : string
Tags
Return values
string —getDescription()
Returns the description of the type
public
getDescription() : string
Tags
Return values
string —description the description of the type
getHasIcon()
Returns whether this type has icons
public
getHasIcon() : bool
Tags
Return values
bool —whether this type has icons
getID()
Returns the ID of the type
public
getID() : int
Tags
Return values
int —the ID of the type
getIsLanguageDependant()
Returns whether this type is language dependant
public
getIsLanguageDependant() : bool
Tags
Return values
bool —whether this type is language dependant
getLabel()
Returns the Label of the type
public
getLabel() : string
Tags
Return values
string —the Label of the Type
getLastChange()
Returns 'LastChange' time
public
getLastChange() : string
Tags
Return values
string —getLastEditor()
Return valid LastEditor information (Name) of the User
public
getLastEditor() : null|string
Tags
Return values
null|string —NULL if not valid or Name of the user
getRangeValues()
Returns all CSValueRangeValues for this type
public
getRangeValues() : array<string|int, CSValueRangeValue>
Tags
Return values
array<string|int, CSValueRangeValue> —array of CSValueRangeValue
getValue()
Returns a value of this type
public
getValue(string $key) : string
Parameters
- $key : string
-
the key of the types field
Tags
Return values
string —the value of the types field
isManuallySorted()
Returns whether this type is manual sorted
public
isManuallySorted() : bool
Tags
Return values
bool —whether this type is manual sorted
setCategory()
Sets the category of the type
public
setCategory(string $category) : mixed
Parameters
- $category : string
-
the new category
Tags
Return values
mixed —setDescription()
Sets the description of the type
public
setDescription(string $description) : mixed
Parameters
- $description : string
-
the new description
Tags
Return values
mixed —setHasIcon()
Set this type to support icons
public
setHasIcon(bool $boolean) : mixed
Parameters
- $boolean : bool
-
whether this type has icons
Tags
Return values
mixed —setLabel()
Sets a new label
public
setLabel(string $label) : mixed
Parameters
- $label : string
-
the new label
Tags
Return values
mixed —setLanguageDependant()
Marks this type as languageDependant
public
setLanguageDependant(bool $boolean) : mixed
Parameters
- $boolean : bool
-
whether this type is language dependant
Tags
Return values
mixed —setManualSorting()
Set this type to support icons
public
setManualSorting(bool $boolean) : mixed
Parameters
- $boolean : bool
-
whether this type is manual sorted
Tags
Return values
mixed —setValue()
Sets a value of this type
public
setValue(string $key, string $value) : mixed
Parameters
- $key : string
-
the key of the types field
- $value : string
-
the new value
Tags
Return values
mixed —store()
Stores this type
public
store() : mixed