package
0.0.0-20230101183712-202847b4b89b
Repository: https://github.com/corestoreio/csfw.git
Documentation: pkg.go.dev
# Functions
MakeEvent creates a new validated event from one of the four possible event names: before_set, before_get, after_set and after_get.
MakeFields wrapper to create a new Fields.
MakeGroups wrapper function, for now.
MakeLoadDataOption a wrapper helper function.
MakePath makes a new validated Path.
MakePathWithScope creates a new validate Path with a custom scope.
MakeSections wrapper function, for now.
MakeSectionsMerged creates a new validated Sections with a three level configuration.
MakeSectionsValidated creates a new validated Sections with a three level configuration.
MustMakePath same as MakePath but panics on error.
MustMakePathWithScope creates a new validate Path with a custom scope but panics on error.
MustMakeSectionsMerged same as MakeSectionsMerged but panics on error.
MustMakeSectionsValidate same as MakeSectionsValidated but panics on error.
MustNewService same as NewService but panics on error.
NewFakeService creates a new mocked Service for testing usage.
NewService creates the main new configuration for all scopes: default, website and store.
NewValue makes a new non-pointer value type.
WithApplySections sets the default values and permissible scopes for specific routes.
WithFieldMeta sets immutable default values and scope restrictions into the service for specific routes.
WithFieldMetaGenerator sets immutable default values and scope restrictions into the service for specific routes.
# Constants
CSVColumnSeparator separates CSV values.
DefaultOSEnvVariableName default name of the OS environment variable.
EnvNamePlaceHolder replaces in a file name or pattern argument applied to a WithFiles, WithFile or WithGlob function with the current environment name of *config.Service.
Event constants defines where and when a specific blocking event gets dispatched.
Event constants defines where and when a specific blocking event gets dispatched.
Event constants defines where and when a specific blocking event gets dispatched.
must start with zero.
PathLevels defines how many parts are at least in a path.
PathSeparator used in the database table core_config_data and in config.Service to separate the path parts.
must be + 1 because 0 is not set.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
Type* defines the type of the front end user input/display form.
# Structs
FakeService used for testing.
FakeWrite used for testing when writing configuration values.
Field contains the final path element of a configuration.
FieldMeta sets meta data for a field into the config.Service object.
Group defines the layout of a group containing multiple Fields.
LoadDataOption allows other storage backends to pump their data into the config.Service during or after initialization via an OS signal and hot reloading.
Options applies configurations to the NewService function.
Path represents a configuration path bound to a scope.
Scoped is equal to Getter but not an interface and the underlying implementation takes care of providing the correct scope: default, website or store and bubbling up the scope chain from store -> website -> default if a value won't get found in the desired scope.
Section defines the layout for the configuration section which contains groups and fields.
Service main configuration provider.
Value represents an immutable value returned from the configuration service.
# Interfaces
MessageReceiver allows you to listen to write actions.
Observer gets called when an event gets dispatched.
ObserverRegisterer adds or removes observers for different events and theirs routes.
Scoper creates a hierarchy based configuration retriever based on website and its store ID.
Setter thread safe storing of configuration values under different paths and scopes.
Storager is the underlying data storage for holding the keys and its values.
Subscriber represents the overall service to receive subscriptions from MessageReceiver interfaces.
# Type aliases
Fields contains a set of Fields, the final configuration value.
FieldType used in constants to define the frontend and input type.
Groups contains a set of Groups.
PathSlice represents a collection of Paths.
Route defines a string with at least two Separators denoting a route to the configuration value in a hierarchical manner.
Sections contains a set of Sections.