ParameterInterface
in
Table of Contents
Methods
- addTranslation() : self
- getDefault() : bool
- getDefaultOptionId() : int|null
- getDefaultValue() : string|null
- getDisallowBlacklistedWords() : ContentFilterMode
- getDisallowUrl() : ContentFilterMode
- getFileType() : string|null
- getFilterMatchAll() : bool
- Within-facet matching: true requires the set to have all selected values (N filters), false matches any of them (`IN`).
- getHasOptions() : bool
- getId() : int|null
- getImageId() : int|null
- getKey() : string|null
- getLft() : int
- getMaxLength() : int|null
- Max. number of characters of the value (visible text with the editor); null = no limit.
- getMaxSize() : int|null
- getOptions() : array<int, object>
- getParameterGroupId() : int|null
- getParentId() : int|null
- getSearchDefault() : bool
- getSearchDefaultOptionId() : int|null
- getSearchDefaultValue() : string|null
- getSearchType() : int|null
- getSourceRules() : array<int, object>
- getTargetRules() : array<int, object>
- getThrowErrorOnBlacklistedWord() : bool
- getThrowErrorOnUrl() : bool
- getTranslation() : ParameterTextInterface)|null
- getTranslations() : Collection<int, BaseEntity|ParameterTextInterface>
- getType() : int|null
- getUseEditor() : bool
- getVisibleOptionsCount() : int|null
- isActive() : bool
- isAlwaysRegenerate() : bool
- isDefault() : bool
- isHasOptions() : bool
- isRequired() : bool
- isSearchDefault() : bool
- isSubstitution() : bool
- isThrowErrorOnBlacklistedWord() : bool
- isThrowErrorOnUrl() : bool
- isUseEditor() : bool
- removeTranslation() : self
- setActive() : self
- setAlwaysRegenerate() : self
- setDefault() : self
- setDefaultValue() : self
- setDisallowBlacklistedWords() : self
- setDisallowUrl() : self
- setFileType() : self
- setHasOptions() : self
- setKey() : self
- setMaxLength() : self
- setMaxSize() : self
- setParameterGroupId() : self
- setRequired() : self
- setSearchDefault() : self
- setSearchDefaultValue() : self
- setSearchType() : self
- setSubstitution() : self
- setThrowErrorOnBlacklistedWord() : self
- setThrowErrorOnUrl() : self
- setType() : self
- setUseEditor() : self
- setVisibleOptionsCount() : self
Methods
addTranslation()
public
addTranslation(BaseEntity|ParameterTextInterface $translation) : self
Parameters
- $translation : BaseEntity|ParameterTextInterface
Return values
selfgetDefault()
public
getDefault() : bool
Return values
boolgetDefaultOptionId()
public
getDefaultOptionId() : int|null
Return values
int|nullgetDefaultValue()
public
getDefaultValue() : string|null
Return values
string|nullgetDisallowBlacklistedWords()
public
getDisallowBlacklistedWords() : ContentFilterMode
Return values
ContentFilterModegetDisallowUrl()
public
getDisallowUrl() : ContentFilterMode
Return values
ContentFilterModegetFileType()
public
getFileType() : string|null
Return values
string|nullgetFilterMatchAll()
Within-facet matching: true requires the set to have all selected values (N filters), false matches any of them (`IN`).
public
getFilterMatchAll() : bool
Return values
boolgetHasOptions()
public
getHasOptions() : bool
Return values
boolgetId()
public
getId() : int|null
Return values
int|nullgetImageId()
public
getImageId() : int|null
Return values
int|nullgetKey()
public
getKey() : string|null
Return values
string|nullgetLft()
public
getLft() : int
Return values
intgetMaxLength()
Max. number of characters of the value (visible text with the editor); null = no limit.
public
getMaxLength() : int|null
Return values
int|nullgetMaxSize()
public
getMaxSize() : int|null
Return values
int|nullgetOptions()
public
getOptions() : array<int, object>
Return values
array<int, object>getParameterGroupId()
public
getParameterGroupId() : int|null
Return values
int|nullgetParentId()
public
getParentId() : int|null
Return values
int|nullgetSearchDefault()
public
getSearchDefault() : bool
Return values
boolgetSearchDefaultOptionId()
public
getSearchDefaultOptionId() : int|null
Return values
int|nullgetSearchDefaultValue()
public
getSearchDefaultValue() : string|null
Return values
string|nullgetSearchType()
public
getSearchType() : int|null
Return values
int|nullgetSourceRules()
public
getSourceRules() : array<int, object>
Return values
array<int, object>getTargetRules()
public
getTargetRules() : array<int, object>
Return values
array<int, object>getThrowErrorOnBlacklistedWord()
public
getThrowErrorOnBlacklistedWord() : bool
Return values
boolgetThrowErrorOnUrl()
public
getThrowErrorOnUrl() : bool
Return values
boolgetTranslation()
public
getTranslation(int $langId) : ParameterTextInterface)|null
Parameters
- $langId : int
Return values
ParameterTextInterface)|nullgetTranslations()
public
getTranslations() : Collection<int, BaseEntity|ParameterTextInterface>
Return values
Collection<int, BaseEntity|ParameterTextInterface>getType()
public
getType() : int|null
Return values
int|nullgetUseEditor()
public
getUseEditor() : bool
Return values
boolgetVisibleOptionsCount()
public
getVisibleOptionsCount() : int|null
Return values
int|nullisActive()
public
isActive() : bool
Return values
boolisAlwaysRegenerate()
public
isAlwaysRegenerate() : bool
Return values
boolisDefault()
public
isDefault() : bool
Return values
boolisHasOptions()
public
isHasOptions() : bool
Return values
boolisRequired()
public
isRequired() : bool
Return values
boolisSearchDefault()
public
isSearchDefault() : bool
Return values
boolisSubstitution()
public
isSubstitution() : bool
Return values
boolisThrowErrorOnBlacklistedWord()
public
isThrowErrorOnBlacklistedWord() : bool
Return values
boolisThrowErrorOnUrl()
public
isThrowErrorOnUrl() : bool
Return values
boolisUseEditor()
public
isUseEditor() : bool
Return values
boolremoveTranslation()
public
removeTranslation(BaseEntity|ParameterTextInterface $translation) : self
Parameters
- $translation : BaseEntity|ParameterTextInterface
Return values
selfsetActive()
public
setActive(bool $active) : self
Parameters
- $active : bool
Return values
selfsetAlwaysRegenerate()
public
setAlwaysRegenerate(bool $alwaysRegenerate) : self
Parameters
- $alwaysRegenerate : bool
Return values
selfsetDefault()
public
setDefault(bool $default) : self
Parameters
- $default : bool
Return values
selfsetDefaultValue()
public
setDefaultValue(string|null $defaultValue) : self
Parameters
- $defaultValue : string|null
Return values
selfsetDisallowBlacklistedWords()
public
setDisallowBlacklistedWords(ContentFilterMode $disallowBlacklistedWords) : self
Parameters
- $disallowBlacklistedWords : ContentFilterMode
Return values
selfsetDisallowUrl()
public
setDisallowUrl(ContentFilterMode $disallowUrl) : self
Parameters
- $disallowUrl : ContentFilterMode
Return values
selfsetFileType()
public
setFileType(string|null $fileType) : self
Parameters
- $fileType : string|null
Return values
selfsetHasOptions()
public
setHasOptions(bool $hasOptions) : self
Parameters
- $hasOptions : bool
Return values
selfsetKey()
public
setKey(string|null $key) : self
Parameters
- $key : string|null
Return values
selfsetMaxLength()
public
setMaxLength(int|null $maxLength) : self
Parameters
- $maxLength : int|null
Return values
selfsetMaxSize()
public
setMaxSize(int|null $maxSize) : self
Parameters
- $maxSize : int|null
Return values
selfsetParameterGroupId()
public
setParameterGroupId(int|null $parameterGroupId) : self
Parameters
- $parameterGroupId : int|null
Return values
selfsetRequired()
public
setRequired(bool $required) : self
Parameters
- $required : bool
Return values
selfsetSearchDefault()
public
setSearchDefault(bool $searchDefault) : self
Parameters
- $searchDefault : bool
Return values
selfsetSearchDefaultValue()
public
setSearchDefaultValue(string|null $searchDefaultValue) : self
Parameters
- $searchDefaultValue : string|null
Return values
selfsetSearchType()
public
setSearchType(int|null $searchType) : self
Parameters
- $searchType : int|null
Return values
selfsetSubstitution()
public
setSubstitution(bool $substitution) : self
Parameters
- $substitution : bool
Return values
selfsetThrowErrorOnBlacklistedWord()
public
setThrowErrorOnBlacklistedWord(bool $throwErrorOnBlacklistedWord) : self
Parameters
- $throwErrorOnBlacklistedWord : bool
Return values
selfsetThrowErrorOnUrl()
public
setThrowErrorOnUrl(bool $throwErrorOnUrl) : self
Parameters
- $throwErrorOnUrl : bool
Return values
selfsetType()
public
setType(int|null $type) : self
Parameters
- $type : int|null
Return values
selfsetUseEditor()
public
setUseEditor(bool $useEditor) : self
Parameters
- $useEditor : bool
Return values
selfsetVisibleOptionsCount()
public
setVisibleOptionsCount(int|null $visibleOptionsCount) : self
Parameters
- $visibleOptionsCount : int|null