Contentserv PHP API

CSItemValueGetter 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
Constructs the value getter instance
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
Returns the name of the attribute to retrieve
getSubtype()  : int
Returns the sub type
getType()  : int
Returns the value type
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
setSubtype()  : void
Sets the sub type to retrieve
setType()  : void
Sets the value type to retrieve

Constants

TYPE_COMPLEX

value type complex (array)

public mixed TYPE_COMPLEX = \CSITEM_VALUES_ARRAY
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()

Constructs the value getter instance

public __construct(mixed $mName) : mixed
Parameters
$mName : mixed

The name of the attribute to retrieve

Tags
access

public

Return values
mixed —

The value for the given attribute

allowInheritance()

Enables inheritance

public allowInheritance() : void

return void

Tags
access

public

Return values
void —

disallowInheritance()

Disables inheritance

public disallowInheritance() : void

return void

Tags
access

public

Return values
void —

getContextId()

Returns the context id

public getContextId() : int
Tags
access

public

Return values
int —

The configured context id

getLanguageId()

Returns the language id

public getLanguageId() : int
Tags
access

public

Return values
int —

The configured language id

getName()

Returns the name of the attribute to retrieve

public getName() : mixed
Tags
access

public

Return values
mixed —

The name of the attribute

getSubtype()

Returns the sub type

public getSubtype() : int
Tags
access

public

Return values
int —

The configured sub type

getType()

Returns the value type

public getType() : int
Tags
access

public

Return values
int —

The configured value type

isInheritanceAllowed()

Returns whether inheritance is be allowed or not.

public isInheritanceAllowed() : bool
Tags
access

public

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
access

public

Return values
void —

setLanguageId()

Sets the language id to retrieve

public setLanguageId(int $iLanguageId) : void
Parameters
$iLanguageId : int

The language id to retrieve

Tags
access

public

Return values
void —

setSubtype()

Sets the sub type to retrieve

public setSubtype(int $iSubtype) : void
Parameters
$iSubtype : int
Tags
access

public

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
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results