API Documentation
Back to top  

GXModuleConfigurationStorage

Extends \ConfigurationStorage

subclass of ConfigurationStorage for parameters concerning GXModules

package

Default

Methods

constructor; initializes namespace for GXModule configuration with correct namespace

__construct(string $module)

Arguments

$module

string

VendorModulename directory of GXModule

Returns the default value of the configuration key

_getDefaultValueFromJsonFile( $key) : mixed

Arguments

$key

Response

mixed

Get the json configuration from GXModule.json file

_getGXModuleJSONConfiguration( $name) : array|boolean

Arguments

$name

Response

array|boolean

Returns a single configuration value by its key if stored as json decode automaticaly

get(string $key, \LanguageCode $languageCode = null) : string|array|null

Arguments

$key

string

a configuration key (relative to the namespace prefix)

$languageCode

\LanguageCode

Optional for language dependent config values.

Response

string|array|null

configuration value

Helper function to check if string is json formated

isJson(string $string) : boolean

Arguments

$string

string

Response

boolean

Properties

Holds the configuration from GXModule.json file

config : array|boolean
var

Type(s)

array|boolean