package
0.0.0-20230101183712-202847b4b89b
Repository: https://github.com/corestoreio/csfw.git
Documentation: pkg.go.dev

# Packages

Package mock implements mocking of the store.Service for tests.
Package scope defines the configuration of scopes default, website, group and store.

# Functions

CodeIsValid checks if a store code is valid.
MustNewService same as NewService, but panics on error.
NewService creates a new store Service which handles websites, groups and stores.
NewStoreGroups creates a new initialized collection.
NewStores creates a new initialized collection.
NewStoreWebsites creates a new initialized collection.
WithGroups upserts new groups to the Store service.
WithStores upserts new stores to the Store service.
WithWebsites upserts new websites to the Store service.

# Constants

CodeFieldName defines the filed name where store code has been saved.
CodeMaxLen defines the overall maximum length a store code can have.
CodeURLFieldName name of the GET parameter to set a new store in a current website/group context/request.
DefaultStoreID is always 0.

# Structs

Option type to pass options to the service type.
No description provided by the author
Store represents a single row for DB table store.
StoreGroup represents a single row for DB table store_group.
StoreGroups represents a collection type for DB table store_group Not thread safe.
Stores represents a collection type for DB table store Not thread safe.
StoreWebsite represents a single row for DB table store_website.
StoreWebsites represents a collection type for DB table store_website Not thread safe.

# Interfaces

CodeProcessor gets used in the middleware WithRunMode() to extract a store code from a Request and modify the response; for example setting cookies to persists the selected store.
Finder depends on the runMode from package scope and finds the active store depending on the run mode.