CSItemValuesSetter
extends _CSItemValueHandler
in package
Defines an abstract class with the necessary methods for the CSItemValueGetter & CSItemValueSetter classes
Tags
Table of Contents
- TYPE_COMPLEX = \CSITEM_VALUES_ARRAY
- value type complex (array)
- TYPE_CSV = \CSITEM_VALUES_CSV
- value type complex (array)
- TYPE_EDITOR = 101
- value type editor
- TYPE_FORMATTED = \CSITEM_VALUES_FORMATTED
- value type formatted
- TYPE_PLAIN = \CSITEM_VALUES_UNFORMATTED
- value type plain (unformatted value)
- addValue() : void
- Adds a value for the specified item and attribute.
- allowInheritance() : void
- Enables inheritance
- disallowInheritance() : void
- Disables inheritance
- getContextId() : int
- Returns the context id
- getLanguageId() : int
- Returns the language id
- getMedium() : CSItemMedium
- Returns the medium
- getName() : mixed
- The method is not required anymore for the CSItemValuesSetter.
- getSubtype() : int
- Returns the sub type
- getType() : int
- Returns the value type
- getValue() : mixed
- The method is not required anymore for the CSItemValuesSetter.
- getValues() : array<string|int, mixed>
- Returns the values to be set as 2-dimensional array in the form
- isInheritanceAllowed() : bool
- Returns whether inheritance is be allowed or not.
- setContextId() : void
- Sets the context id to retrieve
- setLanguageId() : void
- Sets the language id to retrieve
- setMedium() : void
- Sets the medium to retrieve
- setSearchByExternalKey() : void
- Sets whether the item identifier should be considered to be an external key instead of id.
- setSubtype() : void
- Sets the sub type to retrieve
- setType() : void
- Sets the value type to retrieve
- setValue() : mixed
- The method is not required anymore for the CSItemValuesSetter.
- shouldSearchByExternalKey() : bool
- Returns whether identifier should be defined as external key.
Constants
TYPE_COMPLEX
value type complex (array)
public
mixed
TYPE_COMPLEX
= \CSITEM_VALUES_ARRAY
Tags
TYPE_CSV
value type complex (array)
public
mixed
TYPE_CSV
= \CSITEM_VALUES_CSV
Tags
TYPE_EDITOR
value type editor
public
mixed
TYPE_EDITOR
= 101
Tags
TYPE_FORMATTED
value type formatted
public
mixed
TYPE_FORMATTED
= \CSITEM_VALUES_FORMATTED
Tags
TYPE_PLAIN
value type plain (unformatted value)
public
mixed
TYPE_PLAIN
= \CSITEM_VALUES_UNFORMATTED
Tags
Methods
addValue()
Adds a value for the specified item and attribute.
public
addValue(mixed $mId, mixed $mName, mixed $mValue) : void
Parameters
- $mId : mixed
-
The item id (or external key)
- $mName : mixed
-
The attribute name
- $mValue : mixed
-
The value to be set
Tags
Return values
void —allowInheritance()
Enables inheritance
public
allowInheritance() : void
return void
Tags
Return values
void —disallowInheritance()
Disables inheritance
public
disallowInheritance() : void
return void
Tags
Return values
void —getContextId()
Returns the context id
public
getContextId() : int
Tags
Return values
int —The configured context id
getLanguageId()
Returns the language id
public
getLanguageId() : int
Tags
Return values
int —The configured language id
getMedium()
Returns the medium
public
getMedium() : CSItemMedium
Tags
Return values
CSItemMedium —The configured medium
getName()
The method is not required anymore for the CSItemValuesSetter.
public
getName() : mixed
Tags
Return values
mixed —getSubtype()
Returns the sub type
public
getSubtype() : int
Tags
Return values
int —The configured sub type
getType()
Returns the value type
public
getType() : int
Tags
Return values
int —The configured value type
getValue()
The method is not required anymore for the CSItemValuesSetter.
public
getValue() : mixed
Tags
Return values
mixed —getValues()
Returns the values to be set as 2-dimensional array in the form
public
getValues() : array<string|int, mixed>
array(ITEMID) => array(ATTRIBUTEID) => VALUE
Tags
Return values
array<string|int, mixed> —The item values
isInheritanceAllowed()
Returns whether inheritance is be allowed or not.
public
isInheritanceAllowed() : bool
Tags
Return values
bool —True, if inheritance is allowed, otherwise false.
setContextId()
Sets the context id to retrieve
public
setContextId(int $iContextId) : void
Parameters
- $iContextId : int
-
The context id to retrieve
Tags
Return values
void —setLanguageId()
Sets the language id to retrieve
public
setLanguageId(int $iLanguageId) : void
Parameters
- $iLanguageId : int
-
The language id to retrieve
Tags
Return values
void —setMedium()
Sets the medium to retrieve
public
setMedium(CSItemMedium $oMedium) : void
Parameters
- $oMedium : CSItemMedium
-
The medium to retrieve
Tags
Return values
void —setSearchByExternalKey()
Sets whether the item identifier should be considered to be an external key instead of id.
public
setSearchByExternalKey([bool $bSearchByExternalKey = true ]) : void
Parameters
- $bSearchByExternalKey : bool = true
-
True, if search should be done via external key, otherwise false.
Tags
Return values
void —setSubtype()
Sets the sub type to retrieve
public
setSubtype(int $iSubtype) : void
Parameters
- $iSubtype : int
Tags
Return values
void —setType()
Sets the value type to retrieve
public
setType(int $iType) : void
Parameters
- $iType : int
-
The value type to retrieve as one of the TYPE_*-constants
Tags
Return values
void —setValue()
The method is not required anymore for the CSItemValuesSetter.
public
setValue(mixed $mValue) : mixed
Parameters
- $mValue : mixed
Tags
Return values
mixed —shouldSearchByExternalKey()
Returns whether identifier should be defined as external key.
public
shouldSearchByExternalKey() : bool
Tags
Return values
bool —True, if search should be done based on external key, otherwise false.