settings

README

后台配置

Documentation

Index

• Variables
• func AddDefaultConfig(group string, configs map[string]*dbschema.NgingConfig)
• func ConfigAsStore(groups ...string) echo.H
• func ConfigDefaults() map[string]map[string]*dbschema.NgingConfig
• func ConfigDefaultsAsStore() echo.H
• func DecodeConfig(v *dbschema.NgingConfig, cfg echo.H, decoder Decoder) (echo.H, error)
• func DecodeConfigValue(v *dbschema.NgingConfig, decoder Decoder) (echo.H, error)
• func Decoders() map[string]Decoder
• func DefaultDecoder(v *dbschema.NgingConfig, r echo.H) error
• func DefaultEncoder(v *dbschema.NgingConfig, value string) string
• func EncodeConfigValue(_v *echo.Mapx, v *dbschema.NgingConfig, encoder Encoder) (value string, err error)
• func Encoders() map[string]Encoder
• func GetDefaultConfig(group string) map[string]*dbschema.NgingConfig
• func GetDefaultConfigOk(group string) (map[string]*dbschema.NgingConfig, bool)
• func Init() error
• func InsertBy(ctx echo.Context, configs map[string]*dbschema.NgingConfig, key string, ...) error
• func InsertDefaultConfig(ctx echo.Context, group, key string, values ...string) error
• func InsertMissing(ctx echo.Context, gm *echo.Mapx, added map[string]int, ...) error
• func InsertMissingDefaultConfig(ctx echo.Context, added map[string]map[string]struct{}) error
• func Register(sf ...*SettingForm)
• func RegisterDecoder(group string, decoder Decoder)
• func RegisterEncoder(group string, encoder Encoder)
• func RunHookGet(ctx echo.Context, groups ...string) error
• func RunHookPost(ctx echo.Context, groups ...string) error
• type Codec
• type Config
  • func NewConfig() *Config
  • func (c *Config) Apply()
• type Decoder
  • func GetDecoder(group string) Decoder
• type Encoder
  • func GetEncoder(group string) Encoder
• type SettingForm
  • func Get(group string) (int, *SettingForm)
  • func Settings() []*SettingForm
  • func (s *SettingForm) AddHookGet(hook func(echo.Context) error) *SettingForm
  • func (s *SettingForm) AddHookPost(hook func(echo.Context) error) *SettingForm
  • func (s *SettingForm) AddTmpl(tmpl string) *SettingForm
  • func (s *SettingForm) RunHookGet(ctx echo.Context) error
  • func (s *SettingForm) RunHookPost(ctx echo.Context) error

Variables

var ErrNotExists = errors.New(`Not exists`)

Functions

func AddDefaultConfig

func AddDefaultConfig(group string, configs map[string]*dbschema.NgingConfig)

func ConfigAsStore

func ConfigAsStore(groups ...string) echo.H

ConfigAsStore {Group:{Key:ValueObject}}

func ConfigDefaults

func ConfigDefaults() map[string]map[string]*dbschema.NgingConfig

func ConfigDefaultsAsStore

func ConfigDefaultsAsStore() echo.H

func DecodeConfig

func DecodeConfig(v *dbschema.NgingConfig, cfg echo.H, decoder Decoder) (echo.H, error)

func DecodeConfigValue

func DecodeConfigValue(v *dbschema.NgingConfig, decoder Decoder) (echo.H, error)

func Decoders

func Decoders() map[string]Decoder

func DefaultDecoder

func DefaultDecoder(v *dbschema.NgingConfig, r echo.H) error

func DefaultEncoder

func DefaultEncoder(v *dbschema.NgingConfig, value string) string

func EncodeConfigValue

func EncodeConfigValue(_v *echo.Mapx, v *dbschema.NgingConfig, encoder Encoder) (value string, err error)

func Encoders

func Encoders() map[string]Encoder

func GetDefaultConfig

func GetDefaultConfig(group string) map[string]*dbschema.NgingConfig

func GetDefaultConfigOk

func GetDefaultConfigOk(group string) (map[string]*dbschema.NgingConfig, bool)

func Init

func Init() error

func InsertBy

func InsertBy(ctx echo.Context, configs map[string]*dbschema.NgingConfig, key string, values ...string) error

func InsertDefaultConfig

func InsertDefaultConfig(ctx echo.Context, group, key string, values ...string) error

func InsertMissing

func InsertMissing(ctx echo.Context, gm *echo.Mapx, added map[string]int, configs map[string]*dbschema.NgingConfig, encoder Encoder) error

func InsertMissingDefaultConfig

func InsertMissingDefaultConfig(ctx echo.Context, added map[string]map[string]struct{}) error

func Register

func Register(sf ...*SettingForm)

func RegisterDecoder

func RegisterDecoder(group string, decoder Decoder)

RegisterDecoder 注册配置值解码器（用于从数据库读出来之后的解码操作） 名称支持"group"或"group.key"两种格式，例如: settings.RegisterDecoder(`sms`,...)对整个sms组的配置有效 settings.RegisterDecoder(`sms.twilio`,...)对sms组内key为twilio的配置有效

func RegisterEncoder

func RegisterEncoder(group string, encoder Encoder)

RegisterEncoder 注册配置值编码器（用于客户端提交表单数据之后的编码操作，编码结果保存到数据库） 名称支持"group"或"group.key"两种格式，例如: settings.RegisterDecoder(`sms`,...)对整个sms组的配置有效 settings.RegisterDecoder(`sms.twilio`,...)对sms组内key为twilio的配置有效

func RunHookGet

func RunHookGet(ctx echo.Context, groups ...string) error

func RunHookPost

func RunHookPost(ctx echo.Context, groups ...string) error

Types

type Codec

type Codec interface {
	Decode(string, ...string) string
	Encode(string, ...string) string
}

type Config

type Config struct {
	Group   string
	Items   map[string]*dbschema.NgingConfig
	Forms   []*SettingForm
	Encoder Encoder
	Decoder Decoder
}

func NewConfig

func NewConfig() *Config

func (*Config) Apply

func (c *Config) Apply()

type Decoder

type Decoder func(v *dbschema.NgingConfig, r echo.H) error

func GetDecoder

func GetDecoder(group string) Decoder

type Encoder

type Encoder func(v *dbschema.NgingConfig, r echo.H) ([]byte, error)

func GetEncoder

func GetEncoder(group string) Encoder

type SettingForm

type SettingForm struct {
	Short string   //简短标签
	Label string   //标签文本
	Group string   //组标识
	Tmpl  []string //输入表单模板路径
	// contains filtered or unexported fields
}

func Get

func Get(group string) (int, *SettingForm)

func Settings

func Settings() []*SettingForm

func (*SettingForm) AddHookGet

func (s *SettingForm) AddHookGet(hook func(echo.Context) error) *SettingForm

func (*SettingForm) AddHookPost

func (s *SettingForm) AddHookPost(hook func(echo.Context) error) *SettingForm

func (*SettingForm) AddTmpl

func (s *SettingForm) AddTmpl(tmpl string) *SettingForm

func (*SettingForm) RunHookGet

func (s *SettingForm) RunHookGet(ctx echo.Context) error

func (*SettingForm) RunHookPost

func (s *SettingForm) RunHookPost(ctx echo.Context) error