model

Documentation

Index

• Constants
• type Role
  • func NewRole(code RoleCode) (*Role, error)
  • func (*Role) EnsureIndexes(db mongo.Database)
  • func (role *Role) GetValue() *Role
  • func (role *Role) Validate() error
• type RoleCode
• type User
  • func NewUser(email string, pwdHash string, name string, profilePicUrl *string, ...) (*User, error)
  • func (*User) EnsureIndexes(db mongo.Database)
  • func (user *User) GetValue() *User
  • func (user *User) Validate() error

Constants

const RolesCollectionName = "roles"

const UserCollectionName = "users"

Types

type Role

type Role struct {
	ID        primitive.ObjectID `bson:"_id,omitempty"`
	Code      RoleCode           `bson:"code" validate:"required,rolecode"`
	Status    bool               `bson:"status" validate:"required"`
	CreatedAt time.Time          `bson:"createdAt" validate:"required"`
	UpdatedAt time.Time          `bson:"updatedAt" validate:"required"`
}

func NewRole

func NewRole(code RoleCode) (*Role, error)

func (*Role) EnsureIndexes

func (*Role) EnsureIndexes(db mongo.Database)

func (*Role) GetValue

func (role *Role) GetValue() *Role

func (*Role) Validate

func (role *Role) Validate() error

type RoleCode

type RoleCode string

const (
	RoleCodeLearner RoleCode = "LEARNER"
	RoleCodeAdmin   RoleCode = "ADMIN"
	RoleCodeAuthor  RoleCode = "AUTHOR"
	RoleCodeEditor  RoleCode = "EDITOR"
)

type User

type User struct {
	ID            primitive.ObjectID   `bson:"_id,omitempty"`
	Name          string               `bson:"name" validate:"required,max=200"`
	Email         string               `bson:"email" validate:"required,email"`
	Password      *string              `bson:"password" validate:"required,min=6,max=100"`
	ProfilePicURL *string              `bson:"profilePicUrl,omitempty" validate:"omitempty,max=500"`
	Roles         []primitive.ObjectID `bson:"roles,omitempty" validate:"required"`
	Verified      bool                 `bson:"verified" validate:"-"`
	Status        bool                 `bson:"status" validate:"-"`
	CreatedAt     time.Time            `bson:"createdAt" validate:"required"`
	UpdatedAt     time.Time            `bson:"updatedAt" validate:"required"`

	// docs
	RoleDocs []*Role `bson:"-" validate:"-"`
}

func NewUser

func NewUser(email string, pwdHash string, name string, profilePicUrl *string, roles []*Role) (*User, error)

func (*User) EnsureIndexes

func (*User) EnsureIndexes(db mongo.Database)

func (*User) GetValue

func (user *User) GetValue() *User

func (*User) Validate

func (user *User) Validate() error