Copied!

ValueDefinitionInterface

ValueDefinitionInterface.php : 17
Interface

Interface for displaying User Preferences in the Admin UI.

User Preferences are not displayed by default unless ValueDefinitionInterface implementation is provided.

Methods

publicgetDefaultValue()

ValueDefinitionInterface.php : 37

Returns default value for User Preference if none is defined.

 
public getDefaultValue() : string

Return values

string

publicgetDescription()

ValueDefinitionInterface.php : 27

Returns description of a User Preference displayed in UI.

 
public getDescription() : string

Return values

string

publicgetDisplayValue()

ValueDefinitionInterface.php : 32

Returns formatted value to be displayed in UI.

 
public getDisplayValue(string $storageValue) : string

Parameters

Name Type Default value Description
$storageValue string - -

Return values

string

publicgetName()

ValueDefinitionInterface.php : 22

Returns name of a User Preference displayed in UI.

 
public getName() : string

Return values

string