CSItemValuesGetter
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)
- __construct() : mixed
- Defines a new getter for multiple values
- allowInheritance() : void
- Enables inheritance
- disallowInheritance() : void
- Disables inheritance
- getAdditionalOptions() : array<string|int, mixed>
- Returns additional options to be used.
- getContextId() : int
- Returns the context id
- getLanguageId() : int
- Returns the language id
- getLanguageIds() : array<string|int, mixed>
- Returns the language ids that should be included in the result.
- getLevel() : int
- Returns the level that should be used.
- getMedium() : CSItemMedium
- Returns the medium
- getName() : mixed
- The method is not required anymore for the CSItemValuesSetter.
- getNames() : array<string|int, mixed>
- Returnes the attribute names that should be retrieved.
- getRootIds() : array<string|int, mixed>
- Returns the root ids to be used for the result.
- getSortFields() : array<string|int, mixed>
- Returns the sort fields to be used.
- getSubtype() : int
- Returns the sub type
- getType() : int
- Returns the value type
- isInheritanceAllowed() : bool
- Returns whether inheritance is be allowed or not.
- setAddFolders() : void
- Sets whether folders should be returned or not.
- setAdditionalOptions() : void
- Sets additional options to be used.
- setCheckRights() : void
- Sets whether right check should be enabled.
- setContextId() : void
- Sets the context id to retrieve
- setGroupByLanguageIds() : void
- Sets whether result should be grouped by language ids.
- setLanguageId() : void
- Sets the language id to retrieve
- setLanguageIds() : void
- Sets the language ids to be retrieved.
- setLevel() : void
- Sets the level of items to be retrieved.
- setMedium() : void
- Sets the medium to retrieve
- setReturnSubtypes() : void
- Sets whether sub types should be returned.
- setRootIds() : void
- Sets the list of root ids for the result.
- setSortFields() : void
- Sets the sort fields for the result.
- setSubtype() : void
- Sets the sub type to retrieve
- setType() : void
- Sets the value type to retrieve
- shouldAddFolders() : bool
- Returns whether folders should be included in the result.
- shouldCheckRights() : bool
- Returns whether right check should be enabled or not.
- shouldGroupByLanguageIds() : bool
- Returns whether grouping by language ids should be enabled or not.
- shouldReturnSubtypes() : bool
- Returns whether sub types should be added to the result.
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
__construct()
Defines a new getter for multiple values
public
__construct(array<string|int, mixed> $aNames) : mixed
Parameters
- $aNames : array<string|int, mixed>
-
List of attributes to be retrieved.
Tags
Return values
mixed —allowInheritance()
Enables inheritance
public
allowInheritance() : void
return void
Tags
Return values
void —disallowInheritance()
Disables inheritance
public
disallowInheritance() : void
return void
Tags
Return values
void —getAdditionalOptions()
Returns additional options to be used.
public
getAdditionalOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —List of key/value pairs to be used as additional options.
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
getLanguageIds()
Returns the language ids that should be included in the result.
public
getLanguageIds() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —List of language ids to be retrieved.
getLevel()
Returns the level that should be used.
public
getLevel() : int
Tags
Return values
int —The level to be used.
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 —getNames()
Returnes the attribute names that should be retrieved.
public
getNames() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —List of attribute names.
getRootIds()
Returns the root ids to be used for the result.
public
getRootIds() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The root ids to be used.
getSortFields()
Returns the sort fields to be used.
public
getSortFields() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Sort fields to be used for the result.
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
isInheritanceAllowed()
Returns whether inheritance is be allowed or not.
public
isInheritanceAllowed() : bool
Tags
Return values
bool —True, if inheritance is allowed, otherwise false.
setAddFolders()
Sets whether folders should be returned or not.
public
setAddFolders(bool $bAddFolders) : void
Parameters
- $bAddFolders : bool
-
True, if folders should be returned, otherwise false.
Tags
Return values
void —setAdditionalOptions()
Sets additional options to be used.
public
setAdditionalOptions(array<string|int, mixed> $aAdditionalOptions) : void
Parameters
- $aAdditionalOptions : array<string|int, mixed>
-
Key/value paris of additional options to be used.
Tags
Return values
void —setCheckRights()
Sets whether right check should be enabled.
public
setCheckRights(bool $bCheckRights) : void
Parameters
- $bCheckRights : bool
-
True, if right check should be enabled, otherwise false.
Tags
Return values
void —setContextId()
Sets the context id to retrieve
public
setContextId(int $iContextId) : void
Parameters
- $iContextId : int
-
The context id to retrieve
Tags
Return values
void —setGroupByLanguageIds()
Sets whether result should be grouped by language ids.
public
setGroupByLanguageIds(bool $bGroupByLanguageIds) : void
Parameters
- $bGroupByLanguageIds : bool
-
True, if grouping by language should be enabled, otherwise false.
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 —setLanguageIds()
Sets the language ids to be retrieved.
public
setLanguageIds(array<string|int, mixed> $aLanguageIds) : void
Parameters
- $aLanguageIds : array<string|int, mixed>
-
The language ids to be included in the result.
Tags
Return values
void —setLevel()
Sets the level of items to be retrieved.
public
setLevel(int $iLevel) : void
Parameters
- $iLevel : int
-
The level to be used.
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 —setReturnSubtypes()
Sets whether sub types should be returned.
public
setReturnSubtypes(bool $bReturnSubtypes) : void
Parameters
- $bReturnSubtypes : bool
-
True, if subtypes should be returned, otherwise false.
Tags
Return values
void —setRootIds()
Sets the list of root ids for the result.
public
setRootIds(array<string|int, mixed> $aRootIds) : void
Parameters
- $aRootIds : array<string|int, mixed>
-
The root ids used for the result.
Tags
Return values
void —setSortFields()
Sets the sort fields for the result.
public
setSortFields(array<string|int, mixed> $aSortFields) : void
Parameters
- $aSortFields : array<string|int, mixed>
-
List of sort fields to be used for the result.
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 —shouldAddFolders()
Returns whether folders should be included in the result.
public
shouldAddFolders() : bool
Tags
Return values
bool —True, if folders should be included, otherwise false.
shouldCheckRights()
Returns whether right check should be enabled or not.
public
shouldCheckRights() : bool
Tags
Return values
bool —True, if right check should be enabled, otherwise false.
shouldGroupByLanguageIds()
Returns whether grouping by language ids should be enabled or not.
public
shouldGroupByLanguageIds() : bool
Tags
Return values
bool —True, if grouping by language ids should be enabled, otherwise false.
shouldReturnSubtypes()
Returns whether sub types should be added to the result.
public
shouldReturnSubtypes() : bool
Tags
Return values
bool —True if sub types should be returned, otherwise false.