resource

Documentation

Index

• Variables
• func Decode(context *qor.Context, result interface{}, res Resourcer) (errs []error)
• func DecodeToResource(res Resourcer, result interface{}, metaValues *MetaValues, ...) *processor
• type MetaValue
• type MetaValues
  • func ConvertFormToMetaValues(request *http.Request, metaors []Metaor, prefix string) (*MetaValues, error)
  • func ConvertJSONToMetaValues(reader io.Reader, metaors []Metaor) (*MetaValues, error)
  • func (mvs *MetaValues) AddError(mv *MetaValue, err error)
  • func (mvs MetaValues) Get(name string) *MetaValue
• type Metaor
• type Resource
  • func New(value interface{}, names ...string) *Resource
  • func (res *Resource) AddProcessor(fc func(interface{}, *MetaValues, *qor.Context) error)
  • func (res *Resource) AddValidator(fc func(interface{}, *MetaValues, *qor.Context) error)
  • func (res *Resource) CallDeleter(result interface{}, context *qor.Context) error
  • func (res *Resource) CallFindMany(result interface{}, context *qor.Context) error
  • func (res *Resource) CallFindOne(result interface{}, metaValues *MetaValues, context *qor.Context) error
  • func (res *Resource) CallSaver(result interface{}, context *qor.Context) error
  • func (res *Resource) GetMetas([]string) []Metaor
  • func (res *Resource) GetResource() *Resource
  • func (res *Resource) NewSlice() interface{}
  • func (res *Resource) NewStruct() interface{}
  • func (res *Resource) PrimaryDBName() (name string)
  • func (res *Resource) PrimaryField() *gorm.Field
  • func (res *Resource) PrimaryFieldName() (name string)
• type Resourcer

Variables

var (
	ErrProcessorRecordNotFound = errors.New("resource: record not found")
	ErrProcessorSkipLeft       = errors.New("resource: skip left")
)

var DefaultDeleter = func(result interface{}, context *qor.Context) error {
	db := context.GetDB().Delete(result, context.ResourceID)
	if db.Error != nil {
		return db.Error
	} else if db.RowsAffected == 0 {
		return gorm.RecordNotFound
	}
	return nil
}

var DefaultFinder = func(result interface{}, metaValues *MetaValues, context *qor.Context) error {
	if metaValues == nil && context.ResourceID != "" {
		return context.GetDB().First(result, context.ResourceID).Error
	}
	return errors.New("failed to find")
}

var DefaultSaver = func(result interface{}, context *qor.Context) error {
	return context.GetDB().Save(result).Error
}

var DefaultSearcher = func(result interface{}, context *qor.Context) error {
	if noOrdering, ok := context.GetDB().Get("qor:no_ordering"); ok && noOrdering.(bool) {
		return context.GetDB().Find(result).Error
	} else {
		return context.GetDB().Set("gorm:order_by_primary_key", "DESC").Find(result).Error
	}
}

Functions

func Decode

func Decode(context *qor.Context, result interface{}, res Resourcer) (errs []error)

func DecodeToResource

func DecodeToResource(res Resourcer, result interface{}, metaValues *MetaValues, context *qor.Context) *processor

Types

type MetaValue

type MetaValue struct {
	Name       string
	Value      interface{}
	MetaValues *MetaValues
	Meta       Metaor
	// contains filtered or unexported fields
}

type MetaValues

type MetaValues struct {
	Values []*MetaValue
	Errors []error
}

func ConvertFormToMetaValues

func ConvertFormToMetaValues(request *http.Request, metaors []Metaor, prefix string) (*MetaValues, error)

func ConvertJSONToMetaValues

func ConvertJSONToMetaValues(reader io.Reader, metaors []Metaor) (*MetaValues, error)

func (*MetaValues) AddError

func (mvs *MetaValues) AddError(mv *MetaValue, err error)

func (MetaValues) Get

func (mvs MetaValues) Get(name string) *MetaValue

type Metaor

type Metaor interface {
	GetName() string
	GetFieldName() string
	GetMetas() []Metaor
	GetResource() Resourcer
	GetSetter() func(resource interface{}, metaValue *MetaValue, context *qor.Context)
	HasPermission(roles.PermissionMode, *qor.Context) bool
}

type Resource

type Resource struct {
	Name       string
	StructType string

	Value           interface{}
	FindManyHandler func(interface{}, *qor.Context) error
	FindOneHandler  func(interface{}, *MetaValues, *qor.Context) error
	Saver           func(interface{}, *qor.Context) error
	Deleter         func(interface{}, *qor.Context) error
	// contains filtered or unexported fields
}

func New

func New(value interface{}, names ...string) *Resource

func (*Resource) AddProcessor

func (res *Resource) AddProcessor(fc func(interface{}, *MetaValues, *qor.Context) error)

func (*Resource) AddValidator

func (res *Resource) AddValidator(fc func(interface{}, *MetaValues, *qor.Context) error)

func (*Resource) CallDeleter

func (res *Resource) CallDeleter(result interface{}, context *qor.Context) error

func (*Resource) CallFindMany

func (res *Resource) CallFindMany(result interface{}, context *qor.Context) error

func (*Resource) CallFindOne

func (res *Resource) CallFindOne(result interface{}, metaValues *MetaValues, context *qor.Context) error

func (*Resource) CallSaver

func (res *Resource) CallSaver(result interface{}, context *qor.Context) error

func (*Resource) GetMetas

func (res *Resource) GetMetas([]string) []Metaor

func (*Resource) GetResource

func (res *Resource) GetResource() *Resource

func (*Resource) NewSlice

func (res *Resource) NewSlice() interface{}

func (*Resource) NewStruct

func (res *Resource) NewStruct() interface{}

func (*Resource) PrimaryDBName

func (res *Resource) PrimaryDBName() (name string)

func (*Resource) PrimaryField

func (res *Resource) PrimaryField() *gorm.Field

func (*Resource) PrimaryFieldName

func (res *Resource) PrimaryFieldName() (name string)

type Resourcer

type Resourcer interface {
	GetResource() *Resource
	GetMetas([]string) []Metaor
	CallFindMany(interface{}, *qor.Context) error
	CallFindOne(interface{}, *MetaValues, *qor.Context) error
	CallSaver(interface{}, *qor.Context) error
	CallDeleter(interface{}, *qor.Context) error
	NewSlice() interface{}
	NewStruct() interface{}
}