CSItemMedium
in package
A medium object to store various options from a medium type
Tags
Table of Contents
- API = 'API'
- COMPARATOR = 'COMPARATOR'
- DEFAULT = ''
- EDITOR = 'EDITOR'
- EXPORT = 'EXPORT'
- HTML = 'HTML'
- MASSEDITOR = 'MASSEDITOR'
- TABLEAPI = 'TABLEAPI'
- TEXT = 'TEXT'
- TRANSLATIONMANAGER = 'TMS'
- __construct() : mixed
- getOption() : mixed
- Gets an option for a given key
- getOptions() : array<string|int, mixed>
- Gets stored options from the medium
- getType() : string
- Gets the medium type
- setOption() : void
- Sets an option at the options array
- setOptions() : void
- Sets various options from the medium
Constants
API
public
mixed
API
= 'API'
Tags
COMPARATOR
public
mixed
COMPARATOR
= 'COMPARATOR'
Tags
DEFAULT
public
mixed
DEFAULT
= ''
Tags
EDITOR
public
mixed
EDITOR
= 'EDITOR'
Tags
EXPORT
public
mixed
EXPORT
= 'EXPORT'
Tags
HTML
public
mixed
HTML
= 'HTML'
Tags
MASSEDITOR
public
mixed
MASSEDITOR
= 'MASSEDITOR'
Tags
TABLEAPI
public
mixed
TABLEAPI
= 'TABLEAPI'
Tags
TEXT
public
mixed
TEXT
= 'TEXT'
Tags
TRANSLATIONMANAGER
public
mixed
TRANSLATIONMANAGER
= 'TMS'
Tags
Methods
__construct()
public
__construct([mixed $sType = self::TEXT ]) : mixed
Parameters
- $sType : mixed = self::TEXT
Tags
Return values
mixed —getOption()
Gets an option for a given key
public
getOption(string $sKey[, string $sDefault = '' ]) : mixed
Parameters
- $sKey : string
-
A string with the key for a special option
- $sDefault : string = ''
-
A string with the default value if the option key is not set
Tags
Return values
mixed —The option value for the given key
getOptions()
Gets stored options from the medium
public
getOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —An array with various options from the medium
getType()
Gets the medium type
public
getType() : string
Tags
Return values
string —setOption()
Sets an option at the options array
public
setOption(string $sKey, mixed $mValue) : void
Parameters
- $sKey : string
-
The name of the new option
- $mValue : mixed
-
The value of the new option
Tags
Return values
void —setOptions()
Sets various options from the medium
public
setOptions(array<string|int, mixed> $aOptions) : void
Parameters
- $aOptions : array<string|int, mixed>
-
An array with various options from the medium